---
title: "Get Dataset Metadata"
method: GET
path: "/datasets/metadata"
---

# Get Dataset Metadata

`GET /datasets/metadata`

Retrieve the matching dataset metadata, given the survey_id and period_id.

Parameters:
survey_id (str): The survey id of the dataset being queried.
period_id (str): The period id of the dataset being queried.

## Query parameters

- `survey_id` string, nullable
- `period_id` string, nullable

## Response `200`

Successful Response

- DatasetMetadata[]
  - `dataset_id` string, required
  - `survey_id` string, required
  - `period_id` string, required
  - `form_types` string[], required
  - `sds_published_at` string, required
  - `total_reporting_units` integer, required
  - `sds_dataset_version` integer, required
  - `filename` string, required
  - `title` string, nullable

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/office-of-national-statistics/apis/supplementary-data-service.md) · [All operations](https://skmtc.net/office-of-national-statistics/apis/supplementary-data-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/office-of-national-statistics/supplementary-data-service/revisions/9a87e51baf13/schema)
