Dashboards v3 · live charts

Read a live chart

Its state, audience, data freshness, link, embed and oEmbed.

get/dashboards/v3/live-charts/{dashboard_id}

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/dashboards/v3/live-charts/{dashboard_id}
  • 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

Response

A live chart

dashboard_idinteger required
titlestring required
tokenstring required

The board's viewer token (/dashboard-v3/<token>)

state'pending' | 'live' | 'failed' | 'broken' required
audience'workspace' | 'public' | 'sites' required
allowed_originsstring[] required
view_idinteger required
view_namestring nullable
figureobject nullable

The chart's figure, for Add to a dashboard

data_updated_atinteger nullable

When the chart's data last refreshed (epoch seconds)

created_atstring date-time required
embed_urlstring required
share_urlstring required

The link tools unfurl (oEmbed discovery)

embed_snippetstring nullable

The iframe to paste; null for a workspace-only chart

oembedboolean required

Whether a pasted link unfurls as the chart

Changes

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