Skip to content
Developers
Get an API token

Get a well's spacing features

The well's spacing features at its latest ip_day, as its set's dataset was built: depletion, spacing counts and distances, drainage areas and the closest neighbors per position, plus each neighbor's impact columns (prefix novi_spacing_neighbor_ removed).

Get a well's spacing features

GET/wells/{key}/features

The well's spacing features at its latest ip_day, as its set's dataset was built: depletion, spacing counts and distances, drainage areas and the closest neighbors per position, plus each neighbor's impact columns (prefix novi_spacing_neighbor_ removed).

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

The well's spacing features.

  • wellbore_keystringRequired

    Wellbore key.

  • ip_dayinteger or nullRequired

    ip_day of the features.

  • featuresobject or nullRequired

    Node features, or null when not computed.

  • neighborsarray of objectsRequired

    Per-neighbor features.

    ShowHide 1 child field in each item
    • neighborstringRequired

      Neighbor wellbore key.

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