Skip to content
Developers
Get an API token

Get several wells' production

Several existing wells' production in one request, each as GET /wells/{key}/production answers it, to overlay a forecast's contributing wells (their spread: POST /wells/typecurve).

Get several wells' production

POST/wells/production

Several existing wells' production in one request, each as GET /wells/{key}/production answers it, to overlay a forecast's contributing wells (their spread: POST /wells/typecurve).

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

Up to 50 keys, in request order, a repeated key once. ip_days keeps only those rows (1, then multiples of 30), each well's stopping where its history does. A key the dataset lacks is a 400 naming it (details.key).

Parameters

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.

Request bodyRequired

application/json

Wellbore keys, and optionally ip_days.

  • keysarray of stringsRequired

    1 to 50 itemsItems 1 to 200 characters

    Wellbore keys, 1 to 50; a repeat counts once.

  • ip_daysarray of integersOptional

    1 to 240 itemsItems ≥ 1

    Only the rows at these ip_days, at most 240 (a repeat counts once in the answer); absent, every row.

Responses

200 OK

Each well's production, in request order.

  • countintegerRequired

    ≥ 1

    Wells.

  • wellsarray of objectsRequired

    Each well as GET /wells/{key}/production answers it (its rows at ip_days, when sent), in request order.

    ShowHide 4 child fields in each item
    • 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.

Errors

StatusWhen
413

The request body is over 10 MB.

Shared errors400401403500503What they mean