Skip to content
Developers
Get an API token

Read each well's cumulative curves to EUR

A done plan's wells, a page at a time, each with its cumulative volume per stream and P-level every 30 days from the first model month to its EUR.

Read each well's cumulative curves to EUR

GET/plans/{id}/curves

A done plan's wells, a page at a time, each with its cumulative volume per stream and P-level every 30 days from the first model month to its EUR. A Legacy Forecast answers too.

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

cum[m-1] is the cumulative at day 30·m, to 0.01, as POST /exports writes it in the monthly table; volumes for any period are their differences, and a month without a value is null. The first model_months come from the model, the rest from the decline extension to the EUR, whose kind is extension. A curve without one ends at model_months, with extension null and note saying why: the plan has no EUR, water was fit without eur_water, a P10 or P90 on a plan made without band_eur, or an extension that misses its EUR.

A well that couldn't be placed or has no forecast for the design, a failed stream and a missing band are each {error}. PlanCurvesWell lists each well's fields.

Calendar months

With start_date, each curve has calendar (PlanCurves and PlanCurvesWell name the other fields it adds): its volume in each calendar month, C at the next month's first day minus C at this one's, to 0.01. C is 0 on and before the start date, runs straight between the cum points (day 30·m after the start date) and holds the last one after it. The first month runs from the start date, so it is partial unless that is a 1st; the last holds the last point, day 30·N after the start date, and when that day is a 1st it is there with volume 0.

Errors and caching

A running or failed plan is a 409 conflict with details.status. Each page has an ETag, and If-None-Match answers 304.

Parameters

Path parameters

Query parameters

  • designintegerOptional

    Default 0≥ 0

    The design whose forecasts are read, as its index in the plan's designs; 400 past the last one. A Legacy Forecast has one.

  • streamsstringOptional

    Streams to read, comma-separated, such as oil,gas; default every stream the plan serves. A stream it doesn't serve is a 400 with details.allowed.

  • p_levelsstringOptional

    P-levels to read, comma-separated from P50, P10 and P90; default P50. Novi's P10 is the low curve. P10 or P90 on a plan without bands is a 400 with details.allowed.

  • limitintegerOptional

    Default 100≥ 1, ≤ 200

    Wells on a page, 1 to 200; default 100.

  • cursorstringOptional

    Page to read: next_cursor from the previous page. Wells come in plan order. Any other nonempty value is a 400.

  • start_datestringOptional

    Dates each well and adds calendar months. til: each well's TIL date, else the plan's day (plan_day). A date as YYYY-MM-DD, from 1900-01-01 to 2199-12-31: that day for every well. Anything else is a 400.

  • 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

A page of wells; an ETag on each page.

  • plan_idstringRequired

    Format uuid

    Plan id.

  • designintegerRequired

    ≥ 0

    The design, as its index in designs.

  • step_daysintegerRequired

    Days between points: 30.

    30
  • streamsarray of stringsRequired

    The streams read, in oil, gas, water order.

    "oil""gas""water"
  • p_levelsarray of stringsRequired

    The P-levels read, in P50, P10, P90 order.

    "P50""P10""P90"
  • wellsarray of objectsRequired

    The page's wells, in plan order.

    ShowHide 14 child fields in each item
    • indexintegerRequired

      ≥ 0

      Plan well index.

    • keystringRequired

      The well's key, unique within this plan only.

    • well_uidstringRequired

      pattern ^[0-9a-f]{32}$

      The well's id across plans: the first 32 lowercase hex characters of the SHA-256 of the UTF-8 string <plan_id>:<key>. 32 characters, the same on every read of the plan. A plan run again (from_plan) has a new id, so its wells get new ones.

    • labelstringRequired

      Plan well N.

    • namestringOptional

      Only when the well has a name.

    • til_datestringOptional

      Format date

      Only when the well has a TIL date.

    • shl[number, number]Optional

      Surface hole location, [lng, lat], as the well's include=wells inputs give it. Left out when the well has no inputs.

    • heel[number, number]Optional

      Heel, [lng, lat], as the well's include=wells inputs give it. Only when the well has one.

    • bhl[number, number]Optional

      Bottom hole (toe) location, [lng, lat], as the well's include=wells inputs give it. Left out when the well has no inputs.

    • scenariostringOptional

      The well's scenario, only on a plan made with scenarios.

    • curvesobjectOptional

      Each stream read.

      ShowHide 3 child fields
      • oilobjectOptional

        One stream's curves, or why it has none.

        ShowHide 2 variants

        One of

        • Each P-level read object

          Each P-level read.

          • unitstringRequired

            Volume unit: bbl for oil and water, mcf for gas.

            "bbl""mcf"
          • P50objectOptional

            One curve, or why the well has none at this P-level.

            ShowHide 2 variants

            One of

            • A curve object

              A curve.

              • cumarray of numbersRequired

                cum[m-1] is the cumulative at day 30·m; null where the month has no value.

              • model_monthsintegerRequired

                ≥ 0

                Months from the model; the rest come from the extension.

              • extensionstring or nullRequired

                The extension's kind, or null when the curve has none.

                "arps""flat""table"
              • notestring or nullRequired

                Why there is no extension; null with one.

              • calendarobjectOptional

                Only with start_date: the curve's volume by calendar month.

                ShowHide 2 child fields
                • first_monthstringRequired

                  pattern ^\d{4}-\d{2}$

                  The start date's month, as YYYY-MM.

                • volumesarray of numbersRequired

                  One per calendar month from first_month: the first from the start date, the last the month that holds the curve's last point.

            • No curve object

              No curve.

              • errorstringRequired

                Why the well has no curve at this P-level.

          • P10objectOptional

            One curve, or why the well has none at this P-level.

            Same fields as PlanCurve.

          • P90objectOptional

            One curve, or why the well has none at this P-level.

            Same fields as PlanCurve.

        • No curves object

          No curves.

          • errorstringRequired

            Why the stream failed.

      • gasobjectOptional

        One stream's curves, or why it has none.

        Same fields as PlanCurveStream.

      • waterobjectOptional

        One stream's curves, or why it has none.

        Same fields as PlanCurveStream.

    • start_datestringOptional

      Format date

      Only with start_date: the day this well's calendar months are counted from.

    • start_date_sourcestringOptional

      Only with start_date: til (its TIL date), plan_day (it has none, so the plan's day) or request (start_date named the day).

      "til""plan_day""request"
    • errorstringOptional

      Why the well has no curves: it couldn't be placed, or has no forecast for the design.

  • next_cursorstring or nullRequired

    Pass as cursor for the next page; null on the last.

  • stream_labelsobjectOptional

    Only when a stream holds another product: condensate in the oil stream.

    ShowHide 1 child field
    • oilstringOptional

      What the oil stream holds.

      "condensate"
  • plan_daystringOptional

    Format date

    Only with start_date: the plan's day, fixed when the plan was made. A Legacy Forecast's day is its run date, else its results file's date. With start_date=til, a well without a TIL date starts on it.

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

Errors

StatusWhen
404

No such well, grid, plan or route.

409

The request conflicts with the state of the plan or resource it names, and message says how: for example a plan still running or failed, a stale If-Match, an Idempotency-Key reused with another body, or a server without a state store.

Shared errors400401403500503What they mean