Skip to main content

GET /api/v1/dashboard/campaign-analytics/

Returns aggregated analytics for campaigns with optional workspace filtering. Authentication: Session-based (JWT Cookie) OR API Key (X-API-Key header)

Query Parameters

  • workspace_id (string, optional): Filter analytics by workspace
    • Omit parameter: Returns analytics from current workspace
    • workspace_id=123: Returns analytics from workspace 123 (if user has access)
    • workspace_id=ALL: Returns analytics from all workspaces user has access to

Security

Users can only access analytics from workspaces they are linked to via linked_workspaces.

Response

Examples

Using API Key (recommended for integrations):
Using Session Cookie (for web apps):

Error Responses

403 Forbidden - User doesn’t have access to specified workspace:

Use Cases

  1. Dashboard Overview: Use workspace_id=ALL to show aggregated metrics across all user’s workspaces
  2. Workspace-Specific View: Use specific workspace_id to filter analytics for a single workspace
  3. Current Workspace: Omit parameter for default behavior (current workspace only)