---
title: "Weekly audience email setting"
method: GET
path: "/dashboards/{dashboard_id}/audience/digest"
tags: ["Dashboard"]
---

# Weekly audience email setting

`GET /dashboards/{dashboard_id}/audience/digest`

## Request

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

The caller's weekly audience email for this board: `enabled` is the effective answer, `explicit` the stored choice (null = never chose, in which case it is on above 5 people a week). Editors only.

## Path parameters

- `dashboard_id` integer, required

## Response `200`

The caller's weekly-email setting for this board

- DigestPrefResponse
  - `enabled` boolean, required: Whether the weekly email is effectively on
  - `explicit` boolean, nullable: The stored explicit choice, or null when never chosen
  - `default_on` boolean: Whether the email turns on by itself for this editor once the board is busy (the creator and directly-granted editors); project editors otherwise opt in

## 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)