---
title: "SSB arbitrary PxWeb data query"
method: POST
path: "/api/v1/statistical-agencies/ssb/data/{table_id}"
tags: ["Statistical Agencies"]
---

# SSB arbitrary PxWeb data query

`POST /api/v1/statistical-agencies/ssb/data/{table_id}`

POST a raw PxWeb query to any SSB numeric table ID. The body is the same as SSB's native PxWeb API. Sugra wraps the response in its standard envelope and extracts `metadata[0].updated` as `meta.data_time`. When the body is omitted or empty, Sugra auto-builds a `top 12` query over the time dimension using every ContentsCode value from the schema.

## Path parameters

- `table_id` string, required — SSB numeric table ID.

## Request body

- object, nullable — Raw PxWeb query body with shape `{"query": [...], "response": {"format": "json"}}`. Omit to use Sugra's default `top 12` auto-query.

## Response `200`

Tidy observation rows for the target table.

- EnvelopeSsbTablePayload
  - `data` SsbTablePayload, required — Ad-hoc pass-through to any SSB PxWeb leaf table by numeric ID.
    - `title` string, nullable — Sugra-friendly title for the SSB table.
    - `path` string, required — SSB PxWeb numeric table ID (globally unique under /en/table/).
    - `frequency` string, nullable — Publication frequency: monthly, quarterly, or annual.
    - `category` string, nullable — Sugra category tag (inflation, growth, labour, trade, etc).
    - `dimensions` string[] — PxWeb dimension codes present in the response, excluding time.
    - `measures` string[] — ContentsCode values requested; each becomes a numeric column in observations.
    - `observations` SsbObservation[] — Tidy observation rows sorted by time ascending.
      - `time` string, required — Observation period in ISO form. YYYY-MM for monthly series, YYYY-QN for quarterly, YYYY for annual.
    - `row_count` integer, required — Number of observation rows returned.
    - `labels` object — Dimension label map: {dim_code: {value_code: human_label}}.
  - `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.
- `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/4e2740743eb4/schema)