Get default completions
The fluid and proppant per ft a drawn well gets when you leave them blank: medians over wells brought online in the dataset's last 180 days.
Get default completions
/completions/defaultsThe fluid and proppant per ft a drawn well gets when you leave them blank: medians over wells brought online in the dataset's last 180 days. On a model set whose models read stage length, clusters per stage or frac rate, each such field's median over the same wells, less those without it, where they give one.
Parameters
Query parameters
includestringOptionalinputsaddsinputs: the completion fields the set's models read, each with its label, unit, default and the model inputs it feeds; any other value is a 400 with details.field include."inputs"model_setstringOptionalpattern ^[a-z0-9][a-z0-9-]{0,62}$
The model set to answer from, an
idfrom GET /model-sets. Absent: the set GET /model-sets names asdefault, the base dataset unless the server answers from a published set.model_set=defaultreaches the base dataset; once the server retires it, a 400 naming the set answering instead.- An unknown id, or a set scoped to other tenants, is a 400 listing the ids the caller may use in
details.allowed(published sets only oncedefaultis retired); a set that can't load, a 503 with the reason. - Plans and exports stay in their set: a call naming them (by path,
plan,ids,source.plan, a scenario'splan.id, or a comparison'sa.planandb.plan, also undersource.comparison) reaches it withoutmodel_set. - An explicit
model_setwins; naming resources of two sets in one request is a 400.
Responses
200 OK
Default completions.
fluid_bbl_per_ftnumberRequiredFluid, bbl per ft.
proppant_lb_per_ftnumberRequiredProppant, lb per ft.
sourcestringRequiredHow the defaults were made.
wellsintegerRequiredWells in the median.
windowobjectRequiredOnline window.
ShowHide 3 child fields
startstringRequiredFormat
dateFirst online date.
endstringRequiredFormat
dateLast online date.
daysintegerRequiredWindow length.
formationsarray of objectsRequiredFormations with completions in the window; a blank design value uses its well's formation here, else the play-wide value.
ShowHide 9 child fields in each item
formationstringRequiredFormation.
fluid_bbl_per_ftnumberRequiredFluid, bbl per ft.
proppant_lb_per_ftnumberRequiredProppant, lb per ft.
wellsintegerRequiredWells in the median.
sourcestringRequiredHow the defaults were made.
stage_length_ftnumberOptionalStage length, ft: the formation's median. Only on a model set whose models read it, where its wells give one.
clusters_per_stagenumberOptionalClusters per stage: the formation's median, as stage_length_ft.
frac_rate_bbl_per_minnumberOptionalFrac rate, bbl/min: the formation's median, as stage_length_ft.
sourcesobjectOptionalHow each stage median here was made; only beside one.
ShowHide 3 child fields
stage_length_ftstringOptionalHow the median was made.
clusters_per_stagestringOptionalHow the median was made.
frac_rate_bbl_per_minstringOptionalHow the median was made.
stage_length_ftnumberOptionalStage length, ft: the play's median. Only on a model set whose models read it, where its wells give one.
clusters_per_stagenumberOptionalClusters per stage: the play's median, as stage_length_ft.
frac_rate_bbl_per_minnumberOptionalFrac rate, bbl/min: the play's median, as stage_length_ft.
sourcesobjectOptionalHow each stage median here was made; only beside one.
ShowHide 3 child fields
stage_length_ftstringOptionalHow the median was made.
clusters_per_stagestringOptionalHow the median was made.
frac_rate_bbl_per_minstringOptionalHow the median was made.
inputsarray of objectsOptionalWith include=inputs: the completion fields the set's models read, in the order designs list them; empty when the server has no model list.
ShowHide 7 child fields in each item
fieldstringRequiredThe design field.
"fluid_bbl_per_ft""proppant_lb_per_ft""stage_length_ft""clusters_per_stage""frac_rate_bbl_per_min"labelstringRequiredA readable label.
unitstringRequiredIts unit; empty for a count.
requiredbooleanRequiredWhether a forecast needs a value: true for every field listed, which a blank fills from the defaults here; with none, the request is a 400 naming it.
defaultnumber or nullRequiredWhat a blank design value takes: the play's median here; null when the set's wells give none.
maxnumberRequiredThe exclusive upper bound a value takes, in the field's unit, as the design inputs' exclusiveMaximum; the lower bound is 0, also exclusive.
model_inputsarray of stringsRequiredThe model inputs (GET /models features) the field feeds, as the statics a planned well's header derives from it.
304 Unchanged since the ETag in If-None-Match.Errors
Shared errors400401403500503What they mean