---
title: "Dashboard engagement report"
method: GET
path: "/dashboards/{dashboard_id}/engagement"
tags: ["Dashboard"]
---

# Dashboard engagement report

`GET /dashboards/{dashboard_id}/engagement`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/dashboards/{dashboard_id}/engagement`
- 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`

Who this board reached over the last `days` (7, 30 or 90; default 30) against the window before: the reach funnel over the people it is shared with (direct grants and collection members, editors excluded), totals, a daily series, pages and tiles, every shared or named person with a status, an hour-of-week grid (UTC), surface and device splits, outward actions and a timeline. `viewers` (all, named, anonymous) filters the board-wide figures; reach and people are always named. Editors only; editors' own visits never count.

## Path parameters

- `dashboard_id` integer, required

## Query parameters

- `days` integer
- `viewers` 'all' | 'named' | 'anonymous'

## Response `200`

Who the board reached and how they read it

- EngagementResponse
  - `range_days` integer, required
  - `as_of` string, required
  - `published` boolean, required
  - `published_at` string, nullable
  - `tz` string, required
  - `engaged_rule` EngagementRule, required
    - `seconds` integer, required
    - `pages` integer, required
  - `reach` EngagementReach, required
    - `shared` integer, required
    - `opened` integer, required
    - `returned` integer, required
    - `engaged` integer, required
    - `prev` EngagementReachCounts, required
      - `shared` integer, required
      - `opened` integer, required
      - `returned` integer, required
      - `engaged` integer, required
  - `totals` EngagementTotals, required
    - `views` integer, required
    - `people` integer, required
    - `anon_views` integer, required
    - `avg_engaged_s` integer, nullable
    - `questions` integer, required
    - `unanswered` integer, required
    - `prev` EngagementPrevTotals, required
      - `views` integer, required
      - `people` integer, required
      - `avg_engaged_s` integer, nullable
      - `questions` integer, required
  - `daily` EngagementDailyPoint[], required
    - `date` string, required
    - `views` integer, required
    - `people` integer, required
    - `prev_views` integer, required
    - `prev_people` integer, required
  - `pages` EngagementPage[], required
    - `page_id` string, required
    - `name` string, required
    - `reached` integer, required: Distinct people who reached the page
    - `views` integer, required: Distinct visits (sessions) that reached it
    - `avg_s` integer, nullable
    - `tiles` EngagementTile[], required
      - `tile_id` string, required
      - `title` string, nullable: An added tile's title from the published canvas; null for tiles the client names itself (base figures, KPIs)
      - `seen_pct` number, required
  - `people` EngagementPerson[], required
    - `user_id` integer, required
    - `name` string, required
    - `email` string, nullable
    - `visits` integer, required
    - `seconds` integer, required
    - `pages_read` integer, required
    - `last_seen` string, nullable
    - `status` 'engaged' | 'active' | 'drifting' | 'never', required
    - `daily` integer[], required
    - `shared` boolean, required: In the reach denominator (shared directly or via a collection)
    - `reminded_at` string, nullable
    - `can_remind` boolean, required
  - `anonymous` EngagementAnonymous, required
    - `views` integer, required
    - `seconds` integer, required
  - `hours` array[], required: 7 rows Mon..Sun x 24 hours, UTC
    - integer[]
  - `surface` EngagementSurface, required
    - `app` integer, required
    - `link` integer, required
    - `embed` integer, required
  - `devices` EngagementDevices, required
    - `desktop` integer, required
    - `mobile` integer, required
    - `tablet` integer, required
    - `coverage` number, required
  - `actions` EngagementActions, required
    - `pdf` integer, required
    - `link_copy` integer, required
    - `powerbi` integer, required
    - `tableau` integer, required
    - `video` integer, required
    - `daily` EngagementActionDay[], required
      - `pdf` integer, required
      - `link_copy` integer, required
      - `powerbi` integer, required
      - `tableau` integer, required
      - `video` integer, required
      - `date` string, required
  - `events` EngagementEvent[], required
    - `at` string, required
    - `kind` 'published' | 'edited' | 'refreshed' | 'shared', required
    - `count` integer, required
    - `label` string, required

## Other responses

- `400`: Bad request syntax or unsupported method
- `403`: Request forbidden -- authorization will not help

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/fe078afe239b?raw)