Report

Fields

• reportIdstring

  OneTablet's identifier (a UUID) for this report request — pass it to fetchReport.

• typestring

  The platform's own report type, as requested.

• platformstring

  Delivery platform slug, as requested.

• statusstring

  Lifecycle state. queued — accepted and recorded, not yet being fetched from the platform; processing — OneTablet is retrieving the report from the platform; ready — the files are available (see files on fetchReport); failed — the platform request did not succeed (see error). ready and failed are terminal and stamp completedAt.

  Possible values: [ready, queued, processing, failed]
• periodStartstring<date>

  First day of the reported period, inclusive, as requested (YYYY-MM-DD).

• periodEndstring<date>

  Last day of the reported period, inclusive, as requested (YYYY-MM-DD).

• requestedAtstring<date-time>

  When the report was requested, as an ISO-8601 UTC instant.

• completedAtstring<date-time>

  Present once the report is ready or failed.

• filesReportFile[]

  Present only when status is ready.

• errorstring

  Present only when status is failed. A human-readable summary.