Sign in
ReportRuns

Get a report run by ID

Get a reportRun by ID.

get/analytics/reportRuns/{reportRunId}

Path parameters

reportRunIdstring uuid required

Identifier of the resource in Payrails.

Response

Success.

idstring uuid required

The unique identifier of the report run.

workspaceIdstring uuid

Unique identifier of a workspace in Payrails.

createdAtstring date-time required

Time at which the reportRun was created.

status'pending' | 'successful' | 'failed' required

The status of the report run.

errorstring nullable

If the report run fails (i.e. status=failed), a message about the failure.

completedAtstring date-time nullable

The time at which the report run completes.

Changes

No recorded changes to this endpoint across all 1 revision of this API.