Skip to content

Get data coverage per series

Request

First and last observation, and the number of observations, per series. A series with no data yet returns row_count 0 rather than being omitted.

Security
HTTPBearer or ApiKeyAuth
Query
series_idsstring(Series Ids)required

Comma-separated identifiers. Accepts series_label (preferred), entity, legacy ID or series_id, and may mix them.

revisionstring(RevisionEnum)

restated = after later revisions; point_in_time = as known on the date. The values differ.

Default:"restated"
Enum:"restated""point_in_time"
metricstring(MetricEnum)

Measure to report on

Default:"combined_positioning"
Value:"combined_positioning"
versionstring or null(Version)
Any of:

Model version, e.g. "V1". Omit for the latest.

string
curl -i -X GET \
  'https://docs.vanda-analytics.com/_mock/apis/positioning/vanda-msvc-positioning/positioning/availability?series_ids=string&revision=restated&metric=combined_positioning&version=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
dataArray of objects(Data)required

Coverage per series

metricstring(Metric)required

Measure the coverage refers to

revisionstring(RevisionEnum)required

Which revision the coverage is for

Enum:"restated""point_in_time"
countinteger(Count)required

Number of series returned

Response
{ "data": [ { "series_id": 0, "first_ts": "2019-08-24T14:15:22Z", "last_ts": "2019-08-24T14:15:22Z", "row_count": 0 } ], "metric": "string", "revision": "restated", "count": 0 }