Fetch a report as JSON
GET /reports/{id}
GET /reports/{id}
Operation
GET
/reports/{id}
Fetches a report by major alias or exact materialized-view name. Periodized major aliases accept a period query parameter. Admin callers may optionally override publisher_id for publisher-scoped variants.
Operation ID:
getReport
·
Tags: Reports
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id
|
path | Yes | string | Major alias or raw materialized-view name |
period
|
query | No | string | Reporting period for period-based major reports |
publisher_id
|
query | No | integer | Admin-only publisher override for publisher-scoped report variants |
limit
|
query | No | integer | Maximum number of rows to return |
Request Body
No request body is defined for this operation.
Responses
Content Types
application/json
{
"description": "Report payload",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"report": {
"allOf": [
{
"$ref": "#/components/schemas/ReportMetadata"
},
{
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportRow"
}
},
"meta": {
"type": "object",
"properties": {
"row_count": {
"type": "integer"
},
"limit": {
"type": "integer"
}
},
"required": [
"row_count",
"limit"
]
}
},
"required": [
"rows",
"meta"
]
}
]
}
},
"required": [
"report"
]
}
}
}
}{
"$ref": "#/components/responses/Unauthorized"
}{
"$ref": "#/components/responses/NotFound"
}API Playground
Run this GET request with your API key, or open it in a new tab. Path uses sample IDs where the OpenAPI path has {parameters}.
Sign in to enable live testing with your API key.
| Action | Method | Endpoint | Description |
|---|---|---|---|
| Fetch a report as JSON | GET |
/api/v1/reports/top_advertisers_by_sales |
OpenAPI operationId: getReport. |
GET /api/v1/reports/top_advertisers_by_sales
OpenAPI
Fetch a report as JSON