ROroarkhq
Live Report

Generate a live report document

Changed on

Writes the report now, for its latest closed period or a custom window (periodStart + periodEnd, at most 92 days, ended). Returns 202 with the document in PENDING; poll GET /v1/live-report/{reportId}/document/{documentId} until status is READY or FAILED (typically a few minutes). An identical request already in flight is returned as-is. A generated document is not emailed.

post/v1/live-report/{reportId}/generate

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/live-report/{reportId}/generate
  • Auth
    HTTP bearer

Path parameters

reportIdstring uuid required

The live report ID

Request body

periodStartstring date-time

ISO 8601 start of a custom window. Omit both for the latest closed period.

periodEndstring date-time

ISO 8601 end (exclusive) of a custom window. Requires periodStart.

Example request

{}

Response

The document being written

Changes