Skip to main content
GET
When a report goes out without being asked, to whom, when it is next due, and what would stop it.

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_definition_id
string
report_code
string
report_name
string
report_status
string
report_is_active
string
report_category
string
cadence
string
hour_utc
string
day_of_week
string
day_of_month
string
recipients
string
format
string
is_active
string
last_sent_at
string
include_chart
string
report_chart_type
string
recipient_names
string
recipient_ids
string
recipients_unknown
string
next_due_at
string
due_now
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

cadence
string<character varying>
Maximum string length: 20
day_of_month
integer<smallint>
day_of_week
integer<smallint>
due_now
boolean<boolean>
format
string<character varying>
Maximum string length: 10
hour_utc
integer<smallint>
id
string<uuid>

Note: This is a Primary Key.

include_chart
boolean<boolean>
is_active
boolean<boolean>
last_sent_at
string<timestamp with time zone>
next_due_at
string<timestamp with time zone>
recipient_ids
string[]
recipient_names
string[]
recipients
string<jsonb>
recipients_unknown
integer<integer>
report_category
string<character varying>
Maximum string length: 60
report_chart_type
string<character varying>
Maximum string length: 10
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_is_active
boolean<boolean>
report_name
string<character varying>
Maximum string length: 150
report_status
string<character varying>
Maximum string length: 20