---
title: "Report metadata"
method: GET
path: "/metadata/report"
tags: ["Metadata"]
---

# Report metadata

`GET /metadata/report`

## Request

- The document declares no server URL.
- Auth: HTTP basic

Machine readable metadata on report related information like documentation, translation, display, etc. This can be used to create reports equivalent to the main application.

## Response `200`

Success

- MetadataReportResponse
  - `api_version` string, required
  - `report` object, required
    - `data` object, required: A collection of the report's items.
    - `hierarchy` object, required: A hierarchical representation of the report's items. Divided based on the report type (web or email). The item names are the same as the `data` structure.
      - `web` MetadataReportHierarchyItem[], required: Items present in the web report.
        - `name` string, required: The item's name. Same as `<item_name>` in the outer `data` structure.
        - `children` MetadataReportHierarchyItem[]: This key is only present if this item has items below it.
      - `mail` MetadataReportHierarchyItem[], required: Items present in the mail report.
        - `name` string, required: The item's name. Same as `<item_name>` in the outer `data` structure.
        - `children` MetadataReportHierarchyItem[]: This key is only present if this item has items below it.

## Other responses

- `400`: Bad request
- `401`: Unauthorised
- `500`: General server error

---

[API](https://skmtc.dev/internetstandards/apis/override-this-value-in-internetnl-batch-api-doc-conf-py.md) - [All operations](https://skmtc.dev/internetstandards/apis/override-this-value-in-internetnl-batch-api-doc-conf-py/llms.txt) - [OpenAPI document](https://skmtc.dev/internetstandards/apis/override-this-value-in-internetnl-batch-api-doc-conf-py/revisions/04dfb2002730?raw)