Retrieve a scheduled report run

GET/scheduled-report-runs/{runId}

This endpoint allows you to retrieve one of your scheduled report runs.

Path Parameters

runIdstringrequired

Response

OK

idstring<uuid>
report_type"fp_account_statement"
frequency"daily" | "monthly"
period_startstring<date-time>

Inclusive start of the reporting period (half-open interval [period_start, period_end)).

period_endstring<date-time>

Exclusive end of the reporting period (half-open interval [period_start, period_end)).

filesobject[]

Generated files, each with its download access_url. Null until the run has completed.

Show files properties
idstring<uuid>
typestring
access_urlstring<uri>

URL to fetch the file (see the download endpoint).

status"pending" | "processing" | "error" | "completed"
created_atstring<date-time>
updated_atstring<date-time>

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring

Error defines errors may be returned from the system.

messagestring
errorsobject[]
Show errors properties
errorCodestring
messagestring
Request
curl -X GET "https://api.uat.triple-a.io/api/fiat-payout/v1/scheduled-report-runs/<runId>" \
  -H "Authorization: Bearer <token>"
Response
{
  "id": "00000000-0000-0000-0000-000000000000",
  "report_type": {},
  "frequency": {},
  "period_start": "1970-01-01T00:00:00.000Z",
  "period_end": "1970-01-01T00:00:00.000Z",
  "files": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "string",
      "access_url": "string"
    }
  ],
  "status": {},
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z"
}