Skip to content
Developers
Get an API token

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

GET/wells/{key}/production

Monthly production by ip_day: daily average rates over each period and cumulative volumes to its end.

Send a Novi API token as a bearer token on every request. Authentication

Parameters

Path parameters

  • keystringRequired

    Wellbore 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_setstringOptional

    pattern ^[a-z0-9][a-z0-9-]{0,62}$

    The model set to answer from, an id from GET /model-sets. Absent: the set GET /model-sets names as default, the base dataset unless the server answers from a published set.

    • model_set=default reaches 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 once default is 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's plan.id, or a comparison's a.plan and b.plan, also under source.comparison) reaches it without model_set.
    • An explicit model_set wins; naming resources of two sets in one request is a 400.

Responses

200 OK

Production history.

  • wellbore_keystringRequired

    Wellbore key.

  • countintegerRequired

    Rows.

  • unitsobjectRequired

    Units per column.

    ShowHide 6 child fields
    • oilstringRequired

      Unit of oil.

    • gasstringRequired

      Unit of gas.

    • waterstringRequired

      Unit of water.

    • cum_oilstringRequired

      Unit of cum_oil.

    • cum_gasstringRequired

      Unit of cum_gas.

    • cum_waterstringRequired

      Unit of cum_water.

  • rowsarray of objectsRequired

    Periods by ip_day.

    ShowHide 8 child fields in each item
    • datestring or nullRequired

      Format date

      Production date, the end of the period.

    • ip_dayintegerRequired

      Days since first production.

    • oilnumber or nullRequired

      Oil rate, bbl/d.

    • gasnumber or nullRequired

      Gas rate, mcf/d.

    • waternumber or nullRequired

      Water rate, bbl/d.

    • cum_oilnumber or nullRequired

      Cumulative oil, bbl.

    • cum_gasnumber or nullRequired

      Cumulative gas, mcf.

    • cum_waternumber or nullRequired

      Cumulative water, bbl.

Conditional requests 304 Unchanged since the ETag in If-None-Match.

Errors

StatusWhen
404

No such well, grid, plan or route.

Shared errors400401403500503What they mean