API docs
Sous Chef Management API
Request access

List reports

POST/management/reports/fetchReports

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

application/json
required
  • 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.limit defaults to 50 and above 100 is a 400.

Responses

200: A page of your organization's reports, newest first, and the cursor for the next page.

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 requestedAt first. List entries never carry files: call fetchReport for a download URL.

  • nextCursorstring

    Pass back as page.cursor for the next page. Absent on the last page.

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.