Skip to content
Developers
Get an API token

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

GET/completions/defaults

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. 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.

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

Parameters

Query parameters

  • includestringOptional

    inputs adds inputs: 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_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

Default completions.

  • fluid_bbl_per_ftnumberRequired

    Fluid, bbl per ft.

  • proppant_lb_per_ftnumberRequired

    Proppant, lb per ft.

  • sourcestringRequired

    How the defaults were made.

  • wellsintegerRequired

    Wells in the median.

  • windowobjectRequired

    Online window.

    ShowHide 3 child fields
    • startstringRequired

      Format date

      First online date.

    • endstringRequired

      Format date

      Last online date.

    • daysintegerRequired

      Window length.

  • formationsarray of objectsRequired

    Formations 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
    • formationstringRequired

      Formation.

    • fluid_bbl_per_ftnumberRequired

      Fluid, bbl per ft.

    • proppant_lb_per_ftnumberRequired

      Proppant, lb per ft.

    • wellsintegerRequired

      Wells in the median.

    • sourcestringRequired

      How the defaults were made.

    • stage_length_ftnumberOptional

      Stage length, ft: the formation's median. Only on a model set whose models read it, where its wells give one.

    • clusters_per_stagenumberOptional

      Clusters per stage: the formation's median, as stage_length_ft.

    • frac_rate_bbl_per_minnumberOptional

      Frac rate, bbl/min: the formation's median, as stage_length_ft.

    • sourcesobjectOptional

      How each stage median here was made; only beside one.

      ShowHide 3 child fields
      • stage_length_ftstringOptional

        How the median was made.

      • clusters_per_stagestringOptional

        How the median was made.

      • frac_rate_bbl_per_minstringOptional

        How the median was made.

  • stage_length_ftnumberOptional

    Stage length, ft: the play's median. Only on a model set whose models read it, where its wells give one.

  • clusters_per_stagenumberOptional

    Clusters per stage: the play's median, as stage_length_ft.

  • frac_rate_bbl_per_minnumberOptional

    Frac rate, bbl/min: the play's median, as stage_length_ft.

  • sourcesobjectOptional

    How each stage median here was made; only beside one.

    ShowHide 3 child fields
    • stage_length_ftstringOptional

      How the median was made.

    • clusters_per_stagestringOptional

      How the median was made.

    • frac_rate_bbl_per_minstringOptional

      How the median was made.

  • inputsarray of objectsOptional

    With 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
    • fieldstringRequired

      The design field.

      "fluid_bbl_per_ft""proppant_lb_per_ft""stage_length_ft""clusters_per_stage""frac_rate_bbl_per_min"
    • labelstringRequired

      A readable label.

    • unitstringRequired

      Its unit; empty for a count.

    • requiredbooleanRequired

      Whether 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 nullRequired

      What a blank design value takes: the play's median here; null when the set's wells give none.

    • maxnumberRequired

      The 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 stringsRequired

      The model inputs (GET /models features) the field feeds, as the statics a planned well's header derives from it.

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

Errors

Shared errors400401403500503What they mean