---
title: "Read an example report into an editable spec"
method: POST
path: "/dashboards/v3/exemplar/extract"
tags: ["Dashboard v3 Surfaces"]
---

# Read an example report into an editable spec

`POST /dashboards/v3/exemplar/extract`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/dashboards/v3/exemplar/extract`
- 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`

An example the user SHOWS instead of describing -> the spec for rebuilding its shape: format, cover, ordered sections, palette and number convention, plus `not_matched` naming what the canvas cannot reproduce. A starting point the editor makes editable — never a promise to match the example.

## Request body

- ExemplarExtractSpec: An example report to read into an editable spec
  - `params` ExemplarExtractParams, required
    - `name` string, required
    - `size` integer
    - `type` string, nullable
    - `content` string, nullable
    - `text` string, nullable
    - `dataview_id` integer, nullable
    - `table_item_id` integer, nullable

## Response `200`

An editable spec read from an example report

- ExemplarExtractResponse
  - `spec` object, nullable
  - `rejected` object, nullable
  - `source` object
  - `palette` string[]
  - `measures` string[]
  - `countable` string[]
  - `brand` object
  - `scopes` object[]

## Other responses

- `201`: Document created, URL follows
- `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/5dfd1c296ded?raw)