Campaigns

Get Campaign 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.

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

Path parameters

campaign_idstring required

Campaign id or slug.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataStudioContentPayload required

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

Changes

No recorded changes to this operation across all 2 revisions of this API.