Browse the flow catalog

Request

Every published series, with its identifiers, classification, measure and coverage. Filter by any dimension from /flow/catalog/facets, or search with q.

Store identity.slug: series_id changes when the pipeline reloads.

Security

HTTPBearer or ApiKeyAuth

Query

qstring or null(Q)

Any of:

Free-text search over names, descriptions and identifiers

string

records_per_pageinteger, [ 1 .. 1000 ](Records Per Page)

Rows per page

Default:100

page_numberinteger, >= 1(Page Number)

1-indexed

Default:1

curl -i -X GET \
  'https://docs.vanda-analytics.com/_mock/apis/flow/vanda-msvc-flow/flow/catalog?q=string&records_per_page=100&page_number=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json

dataArray of objects(Data)

Catalog entries, keyed by series_label

countinteger(Count)

Entries on this page

Default:0

paginationPaginationMeta (object) or null

Any of:

Pagination metadata attached to list responses.

Response

{
  "data": [
    {
      "identity": {
        "series_label": "string",
        "series_ids": [
          0
        ],
        "slugs": [
          "string"
        ],
        "dataset_ids": [
          "string"
        ],
        "entities": [
          "string"
        ],
        "entity_types": [
          "string"
        ],
        "frequencies": [
          "string"
        ],
        "version": "string",
        "model_id": "string",
        "legacy_series_id": "string",
        "name": "string",
        "description": "string",
        "start_date": "2019-08-24",
        "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"
      },
      "measure": {
        "metrics": [
          "string"
        ],
        "units": [
          "string"
        ],
        "currency": "string",
        "scale": 0,
        "measure_class": "string",
        "aggregation_rule": "string",
        "sign_convention": "string",
        "derivation": "string",
        "zero_policy": "string"
      },
      "sector": "string",
      "series": [
        {
          "series_id": 0,
          "slug": "string",
          "metric": "string",
          "unit": "string",
          "frequency": "string",
          "measure_class": "string",
          "entity": "string",
          "entity_type": "string",
          "dataset_id": "string",
          "start_date": "2019-08-24",
          "is_active": true,
          "staleness_days": 0
        }
      ],
      "series_count": 0,
      "is_active": true,
      "staleness_days": 0
    }
  ],
  "count": 0,
  "pagination": {
    "page_number": 0,
    "records_per_page": 0,
    "total_record_count": 0,
    "total_pages": 0,
    "has_next": true,
    "has_previous": true
  }
}