Skip to main content
GET
Every scheduled run, whose access answered it, and — when nothing was sent — the reason in a sentence.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
report_schedule_id
string
report_definition_id
string
report_code
string
report_name
string
period_start
string
run_as_user_id
string
run_as_name
string
format
string
status
string
row_count
string
file_id
string
file_name
string
file_status
string
recipients_notified
string
refusal_reason
string
rendered_at
string
delivered_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

delivered_at
string<timestamp with time zone>
file_id
string<uuid>
file_name
string<character varying>
Maximum string length: 250
file_status
string<character varying>
Maximum string length: 20
format
string<character varying>
Maximum string length: 10
id
string<uuid>

Note: This is a Primary Key.

period_start
string<timestamp with time zone>
recipients_notified
integer<integer>
refusal_reason
string<text>
rendered_at
string<timestamp with time zone>
report_code
string<character varying>
Maximum string length: 60
report_definition_id
string<uuid>

Note: This is a Foreign Key to report_definitions.id.

report_name
string<character varying>
Maximum string length: 150
report_schedule_id
string<uuid>

Note: This is a Foreign Key to report_schedules.id.

row_count
integer<integer>
run_as_name
string<character varying>
Maximum string length: 200
run_as_user_id
string<uuid>

Note: This is a Foreign Key to my_profile.user_id.

status
string<character varying>
Maximum string length: 20