Skip to content

Get Campaign Dashboard

GET
/campaigns/{campaign_id}/dashboard

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.

Authorizations

Parameters

Path Parameters

campaign_id
required

Campaign id or slug.

string

Campaign id or slug.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

One Studio object, open-shaped. See the module docstring.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string