Skip to main content
GET
When a dashboard is sent, to whom, with which site and period frozen, 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
dashboard_id
string
dashboard_code
string
dashboard_name
string
dashboard_status
string
dashboard_is_active
string
cadence
string
hour_utc
string
day_of_week
string
day_of_month
string
recipients
string
site_id
string
period
string
format
string
is_active
string
last_sent_at
string
recipient_names
string
recipient_ids
string
recipients_unknown
string
next_due_at
string
due_now
string
site_name
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
dashboard_code
string<character varying>
Maximum string length: 60
dashboard_id
string<uuid>

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

dashboard_is_active
boolean<boolean>
dashboard_name
string<character varying>
Maximum string length: 150
dashboard_status
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.

is_active
boolean<boolean>
last_sent_at
string<timestamp with time zone>
next_due_at
string<timestamp with time zone>
period
string<character varying>
Maximum string length: 20
recipient_ids
string[]
recipient_names
string[]
recipients
string<jsonb>
recipients_unknown
integer<integer>
site_id
string<uuid>

Note: This is a Foreign Key to entry_currencies.for_site_id.

site_name
string<character varying>
Maximum string length: 200