Dashboard

Track Dashboard View

Track a dashboard view event. Returns session_id for subsequent heartbeats.

post/dashboards/url/{url}/track-view

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/dashboards/url/{url}/track-view
  • 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

urlstring required

Request body

viewport_winteger nullable

window.innerWidth at load

surfacestring nullable

'viewer' | 'embed' | 'shared'

page_idstring nullable

The page the viewer opened on

Response

Document created, URL follows

session_idstring nullable

Unique session ID for tracking, or null when the caller is an editor/author whose visit should not be recorded as a view.

Changes

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