---
title: "Dataflow metadata"
method: GET
path: "/api/v1/norges-bank/dataflow/{flow_id}"
tags: ["Central Banks & Monetary"]
---

# Dataflow metadata

`GET /api/v1/norges-bank/dataflow/{flow_id}`

Structure definition (dimensions, codelists, attributes) for a Norges Bank dataflow. Returns the ordered dimension key so callers know how to construct filter keys for /data/{flow}/{key}.

## Path parameters

- `flow_id` string, required — Dataflow identifier (see /catalog).

## Response `200`

Dataflow metadata object.

- EnvelopeNorgesBankDataflowMeta
  - `data` NorgesBankDataflowMeta, required
    - `id` string, required — Dataflow identifier.
    - `agency` string, required — SDMX agency identifier (always NB for Norges Bank).
    - `name` string, required — Dataflow name.
    - `version` string, nullable — Dataflow version.
    - `dimensions` NorgesBankDataflowDimension[], required — Ordered list of dimensions in the data structure definition.
      - `position` integer, required — Position of this dimension in the SDMX series key.
      - `id` string, required — Dimension identifier.
      - `codelist` string — Referenced SDMX codelist identifier.
    - `attributes` string[], required — Attribute identifiers attached to series or observations.
    - `time_dimension` string, required — Name of the time dimension (always TIME_PERIOD).
    - `codelist_count` integer, required — Number of codelists referenced by this dataflow.
  - `meta` SugraMeta, required — Metadata attached to every /api/v1/* response envelope.
    - `endpoint` string, required — Requested endpoint path.
    - `data_time` string, required — ISO 8601 UTC timestamp of the source data, not of the request.
    - `response_time` string, required — ISO 8601 UTC timestamp when this response was produced.
    - `provider` string, required — API name and version.
    - `source` string, nullable — Identifier of the primary upstream source used for this response.
    - `attribution` string, nullable — Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response.
    - `fallback_used` boolean, nullable — True when the primary source failed and a fallback produced the data.
    - `fallback_chain` string[], nullable — Ordered list of sources attempted, in the order they were tried.
    - `cached` boolean, nullable — True when this response was served from the internal cache.
    - `stale` boolean, nullable — True when the cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data.

## Other responses

- `401` — Missing or invalid `x-api-key` header. JSON body with a stable `code` distinguishing `missing_api_key` (no header sent) from `invalid_api_key` (header sent, key not accepted); any other 401 source carries the generic `unauthorized` with its detail as `reason`. Plus `hint`. `plan` is always null on 401 - an unauthenticated request has no plan; quota exhaustion is 429, not 401.
- `422` — Validation Error
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

---

[API](https://skmtc.net/sugra/apis/sugra-api.md) · [All operations](https://skmtc.net/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sugra/sugra-api/versions/d3e3d9c28132/schema)