API docs
Sous Chef Management API
Request access

List available report types

POST/management/reports/fetchReportCoverage

Reports reachable through the authenticated organization's connected platforms.

Safe to retry: this operation is read-only and idempotent.

Request

application/json
required

Responses

200: The coverage matrix: one entry per platform report type, with whether it is available to your organization and its window constraint.

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.

  • asOfstring<date-time>

    When this organization-scoped matrix was calculated.

  • coverageReportCoverage[]

    A small fixed matrix that is not paginated. Empty means no eligible connected stores.

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.