List reports
List your organization's reports, newest first, with cursor pagination. List entries never include files. To follow one report to ready, poll fetchReport: a report that is still processing is checked against the platform when you read it there.
Safe to retry: this operation is read-only and idempotent.
Request
- statusesstring[]
Only reports in these statuses.
Possible values: [ready, queued, processing, failed] - platformsstring[]
Only reports for these delivery platform slugs, e.g.
ubereats. - typesstring[]
Only reports of these platform report types.
- pagePageRequest
Page size and cursor.
page.limitdefaults to 50 and above 100 is a400.
{
"statuses": [
"ready"
],
"platforms": [
"<platforms>"
],
"types": [
"<types>"
],
"page": {
"limit": 50,
"cursor": "<cursor>"
}
}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.
- reportsReport[]
Your organization's reports, newest
requestedAtfirst. List entries never carryfiles: callfetchReportfor a download URL. - nextCursorstring
Pass back as
page.cursorfor the next page. Absent on the last page.
{
"reports": [
{
"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>"
}
],
"nextCursor": "<nextCursor>"
}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.