OneTablet API Documentation

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, echoed on every response — a 200 exactly as much as a 400, 401 or 500. Quote it when reporting a problem and we can find every log line for the request, in every service it touched. You may also send your own x-mealco-tx-id on the request and we adopt it, so your correlation id becomes ours. Not marked required for one reason: a request whose JSON body is malformed is rejected before it reaches an operation, so no id exists yet and that single response carries neither this header nor the txId field of the error body. Everything that reaches an operation carries it.

  • asOfstring<date-time>

    When this organization-scoped matrix was calculated.

  • coverageReportCoverage[]

    Small fixed matrix; deliberately 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 today, so a retried createReport requests a second report with a new reportId. That wastes platform budget but corrupts nothing — each report is an independent file. Treat a timeout as "may have succeeded" and check fetchReports before retrying.