Dashboard

Turn a dashboard's email updates on, off, or change them

put/dashboards/{dashboard_id}/email-updates

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/dashboards/{dashboard_id}/email-updates
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

dashboard_idinteger required

Request body

enabledboolean required
trigger'new_data' | 'schedule'

What decides that an email update goes out.

timezonestring required
frequency'daily' | 'weekdays' | 'weekly' | 'monthly'

How often an update repeats (a new-data update is checked daily).

weekdayinteger nullable
monthdayinteger nullable
time_of_daystring
numbersobject

{dashboard_id: [KPI keys]} — at most 3 per dashboard

Response

Email updates

peopleinteger required
unsubscribedstring[] required
covered_bystring[]

Collections holding this dashboard whose updates are on

Changes

No recorded changes to this operation across all 3 revisions of this API.