Get one series' metadata and coverage

Request

Metadata for a single series with its coverage attached. Accepts series_label, entity, legacy ID or series_id.

Security

HTTPBearer or ApiKeyAuth

Path

identifierstring(Identifier)required

Registry ID, entity, or legacy series ID

Query

revisionstring(RevisionEnum)

Which revision the reported coverage refers to

Default:"restated"

Enum:"restated""point_in_time"

curl -i -X GET \
  'https://docs.vanda-analytics.com/_mock/apis/positioning/vanda-msvc-positioning/positioning/catalog/{identifier}?revision=restated' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json

identityobject(SeriesIdentity)required

Identity block of a catalog entry.

classificationobject(SeriesClassification)required

Classification block — the Unified Data Model hierarchy.

assetobject(SeriesAssetDimensions)required

geographicobject(SeriesGeographicDimensions)required

investorobject(SeriesInvestorDimensions)required

sectorstring or null(Sector)

Any of:

string

unitstring or null(Unit)

Any of:

string

metricstring or null(Metric)

Any of:

string

is_activeboolean(Is Active)

Default:true

availabilitySeriesAvailability (object) or null

Any of:

Coverage of one series in the fact table.

Response

{
  "identity": {
    "series_id": 0,
    "series_label": "string",
    "version": "string",
    "dataset_id": "string",
    "model_id": "string",
    "entity": "string",
    "legacy_series_id": "string",
    "aliases": [
      "string"
    ],
    "name": "string",
    "description": "string",
    "start_date": "2019-08-24",
    "frequency": "string",
    "lag": 0,
    "update_time": "string"
  },
  "classification": {
    "product": "string",
    "domain": "string",
    "universe": "string",
    "dataset": "string",
    "model": "string"
  },
  "asset": {
    "asset_type": "string",
    "asset_subtype": "string",
    "asset_code": "string",
    "benchmark": "string",
    "benchmark_code": "string"
  },
  "geographic": {
    "geography": "string",
    "region": "string",
    "country": "string",
    "country_code": "string",
    "dm_em": "string"
  },
  "investor": {
    "investor_category": "string",
    "investor_type": "string",
    "investor_origin": "string",
    "investor_subtype": "string"
  },
  "sector": "string",
  "unit": "string",
  "metric": "string",
  "is_active": true,
  "availability": {
    "series_id": 0,
    "first_ts": "2019-08-24T14:15:22Z",
    "last_ts": "2019-08-24T14:15:22Z",
    "row_count": 0
  }
}