Get a well's production
Monthly production by ip_day: daily average rates over each period and cumulative volumes to its end.
Get a well's production
/wells/{key}/productionMonthly production by ip_day: daily average rates over each period and cumulative volumes to its end.
Parameters
Path parameters
keystringRequiredWellbore key, as SB329-01414. GET /wells/facets, /wells/search, /wells/typecurve and /wells/production are paths, not wells: keys are API numbers or SBnnn-nnnnn, so no well is shadowed.
Query parameters
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
Production history.
wellbore_keystringRequiredWellbore key.
countintegerRequiredRows.
unitsobjectRequiredUnits per column.
ShowHide 6 child fields
oilstringRequiredUnit of oil.
gasstringRequiredUnit of gas.
waterstringRequiredUnit of water.
cum_oilstringRequiredUnit of cum_oil.
cum_gasstringRequiredUnit of cum_gas.
cum_waterstringRequiredUnit of cum_water.
rowsarray of objectsRequiredPeriods by ip_day.
ShowHide 8 child fields in each item
datestring or nullRequiredFormat
dateProduction date, the end of the period.
ip_dayintegerRequiredDays since first production.
oilnumber or nullRequiredOil rate, bbl/d.
gasnumber or nullRequiredGas rate, mcf/d.
waternumber or nullRequiredWater rate, bbl/d.
cum_oilnumber or nullRequiredCumulative oil, bbl.
cum_gasnumber or nullRequiredCumulative gas, mcf.
cum_waternumber or nullRequiredCumulative water, bbl.
304 Unchanged since the ETag in If-None-Match.Errors
| Status | When |
|---|---|
| 404 | No such well, grid, plan or route. |
Shared errors400401403500503What they mean