API

Create a resource subscription

post
https://core-api.ternary.app/api/resource-subscriptions

Create an email subscription for automated delivery of reports or dashboards. Subscriptions send scheduled emails at the specified frequency.

Frequency options: DAILY, WEEKLY, MONTHLY

For weekly subscriptions, specify dayOfWeek. For monthly subscriptions, specify weekOfMonth.

See Reports for more details.

Body Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Dashboard ID. Required if creating a Dashboard Subscription.

string
enum
required
Allowed:
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Unique identifier for an organization

uuid
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Report ID. Required if creating a Report Subscription.

emails
array of strings
required
length ≥ 1

Subscription emails

emails*
string
enum
required

Report frequency

Allowed:
string
enum
required

Report delivery hour

string
enum

Report delivery day

Allowed:
slackChannelIDs
array of strings

Slack channel IDs to send notifications to

slackChannelIDs
string
enum

Report delivery week of the month

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?