---
title: "Get Campaign Dashboard"
method: GET
path: "/campaigns/{campaign_id}/dashboard"
tags: ["Campaigns"]
---

# Get Campaign Dashboard

`GET /campaigns/{campaign_id}/dashboard`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/campaigns/{campaign_id}/dashboard`
- Auth: HTTP bearer

The AI campaign dashboard. A GET THAT CAN SPEND CREDIT.

On a cache hit it is free and instant. On a MISS - or when the cached copy
is stale and the campaign's documents have changed - it dispatches a
background job that generates the assessment with a model, and returns
`is_generating: true`. So the first call for a campaign costs money even
though it is a GET.

That is why it is tiered `billable` rather than `read`: the heuristic's
`ACTIVE_GET_MARKERS` exist for exactly this shape and none of them matches
`/dashboard`. Poll every few seconds while `is_generating` is true;
polling does not re-dispatch.

## Path parameters

- `campaign_id` string, required: Campaign id or slug.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseStudioContentPayload
  - `data` StudioContentPayload, required: One Studio object, open-shaped. See the module docstring.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)