ReportRunOutput

Body of GET /saved/{report_id}/runs/{run_id}: where one run stands.

Use it when the completion event may have been missed, for example after a socket reconnect. attachmentId is set once the run succeeds. On failure it stays null and error says why.

  • firedAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • reportId
    Type: string
    required
  • runId
    Type: string
    required
  • status
    Type: enum
    required
    values
    pendingrunningsuccessfailed
  • trigger
    Type: enum
    required

    What started a run. A MANUAL run (Run now) is delivered to the user's open tabs only and never becomes a chat message; a SCHEDULED run keeps the chat delivery. A NULL trigger is a row written before the column existed and is read as SCHEDULED.

    values
    scheduledmanual
  • attachmentId
    Type: stringnullable
  • completedAt
    Type: stringFormat: date-timenullable

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • error
    Type: stringnullable
Previous
ReportPeriod
Next
ReportRunTrigger