Get one report
Get one report. When it is ready, each entry in files carries a signed downloadUrl that works for 24 hours (expiresAt) with no credentials, so treat it as a secret. Every call signs a fresh URL, so an expired one never requires regenerating the report: call this operation again.
404 when reportId does not exist or belongs to another organization. The two cases are indistinguishable.
Safe to retry: this operation is read-only and idempotent.
Request
- reportIdstring
The
reportIdreturned bycreateReportor listed byfetchReports. Required.
{
"reportId": "00000000-0000-0000-0000-000000000000"
}Responses
Headers
- x-mealco-tx-idstringoptional
The correlation id for this call, returned on every response that an operation produces, successful or not. Quote it when you report a problem so that we can trace the request. You may send your own x-mealco-tx-id on the request and it is used as the id. It is optional in the schema because a request with a malformed JSON body is rejected before an id is assigned, so that one response carries neither this header nor the txId field of the error body.
- reportReport
The report. When
statusisreadyit carriesfiles, each with a fresh download URL.
{
"report": {
"reportId": "00000000-0000-0000-0000-000000000000",
"type": "<type>",
"platform": "<platform>",
"status": "ready",
"periodStart": "<periodStart>",
"periodEnd": "<periodEnd>",
"requestedAt": "2026-01-01T00:00:00Z",
"completedAt": "2026-01-01T00:00:00Z",
"files": [
{
"downloadUrl": "<downloadUrl>",
"expiresAt": "2026-01-01T00:00:00Z",
"sizeBytes": 50,
"format": "csv"
}
],
"error": "<error>"
}
}About Reports
Partner reporting. Coverage and every report are tenant-scoped and never global: the organization is the one the API key authenticates, and no request field can name another.
createReport is a write: a read-only API key is refused with 403.
Idempotency-Key is accepted on createReport and ignored, so a retried createReport requests a second report with a new reportId. The duplicate uses platform request budget but does not affect the first report: each report is an independent file. Treat a timeout as "may have succeeded" and check fetchReports before retrying.