Insights#

Get intelligence and alerts about your workspace to surface opportunities and risks.

Authentication required

All endpoints require a Bearer token in the Authorization header. See the Authentication guide for setup instructions.

GET /v1/insights#

List intelligence insights and alerts for a workspace. Returns a mix of positive intelligence (campaign outperformance, creator efficiency) and actionable alerts (stale metrics, data gaps).

bash

GET /v1/insights?workspace_id=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
workspaceId	`string (UUID)`	Required	Workspace identifier.

Response#

Returns { items, totalCount, facets, _meta } with paginated results.

PATCH /v1/insights/:id/dismiss#

Update an insight to mark it dismissed so it is hidden from future list responses for the workspace.

bash

PATCH /v1/insights/:id/dismiss
Authorization: Bearer {token}
Content-Type: application/json

{
  "insight_id": "..."
}

Parameters#

Name	Type	Required	Description
insightId	`string (UUID)`	Required	Insight identifier to dismiss.

Response#

Returns { data, _meta } with the result.