Skip to Content

Insights API

The Insights API provides analytics and monitoring data for your Zeotap workspace. Use it to track sync health, sync throughput, sync duration, SLA compliance, audience trends, audience velocity, activation coverage, and audience overlap.

Endpoints

MethodPathDescription
GET/api/v1/workspaces/{id}/insights/sync-healthSync health overview
GET/api/v1/workspaces/{id}/insights/sync-durationSync duration trends
GET/api/v1/workspaces/{id}/insights/sync-throughputRows-per-second throughput trends
GET/api/v1/workspaces/{id}/insights/sync-slaSync SLA compliance
GET/api/v1/workspaces/{id}/insights/audience-trendsAudience size trends
GET/api/v1/workspaces/{id}/insights/audience-velocityAudience growth velocity
GET/api/v1/workspaces/{id}/insights/activation-coverageActivation coverage
GET/api/v1/workspaces/{id}/insights/audience-overlapAudience overlap analysis

Sync Health

GET /api/v1/workspaces/{id}/insights/sync-health

Returns health metrics for all Reverse ETL pipelines and Syncs in the workspace, including success rates, failure counts, and recent run history.

Query Parameters

ParameterTypeDefaultDescription
daysinteger7Number of days to look back

Response

{ "total_syncs": 12, "active_syncs": 10, "healthy_syncs": 9, "failing_syncs": 1, "paused_syncs": 2, "syncs": [ { "sync_id": "550e8400-e29b-41d4-a716-446655440000", "sync_name": "Customers to Salesforce", "status": "active", "last_run_status": "completed", "last_run_at": "2024-01-15T15:00:00Z", "success_rate": 0.98, "total_runs": 42, "failed_runs": 1, "avg_duration_seconds": 145, "total_rows_synced": 125000 } ] }

Example

curl -X GET "https://composable.zeotap.com/api/v1/workspaces/{id}/insights/sync-health?days=7" \ -H "Authorization: Bearer <token>" \ -H "X-Workspace-ID: <workspace-id>"

GET /api/v1/workspaces/{id}/insights/audience-trends

Returns audience size changes over time for selected audiences.

Query Parameters

ParameterTypeDefaultDescription
audience_idsstring (comma-separated)AllAudience IDs to include
daysinteger30Number of days to look back

Response

{ "audiences": [ { "audience_id": "550e8400-e29b-41d4-a716-446655440000", "audience_name": "High-Value Customers", "data_points": [ {"date": "2024-01-01", "size": 4100}, {"date": "2024-01-08", "size": 4200}, {"date": "2024-01-15", "size": 4250} ], "current_size": 4250, "change_absolute": 150, "change_percent": 3.66 } ] }

Example

curl -X GET "https://composable.zeotap.com/api/v1/workspaces/{id}/insights/audience-trends?days=30" \ -H "Authorization: Bearer <token>" \ -H "X-Workspace-ID: <workspace-id>"

Activation Coverage

GET /api/v1/workspaces/{id}/insights/activation-coverage

Shows which audiences are being synced to which destinations, and identifies gaps in activation.

Response

{ "total_audiences": 15, "activated_audiences": 12, "unactivated_audiences": 3, "destinations": [ { "destination_id": "550e8400-e29b-41d4-a716-446655440000", "destination_name": "Google Ads", "destination_type": "google_ads", "audience_count": 8, "audiences": [ { "audience_id": "660e8400-e29b-41d4-a716-446655440000", "audience_name": "High-Value Customers", "sync_status": "active", "last_synced_at": "2024-01-15T15:00:00Z" } ] } ], "unactivated": [ { "audience_id": "770e8400-e29b-41d4-a716-446655440000", "audience_name": "Churned Users", "estimated_size": 850 } ] }

Audience Overlap

GET /api/v1/workspaces/{id}/insights/audience-overlap

Analyzes the overlap between two or more audiences to help identify redundancy or opportunities for exclusion targeting.

Query Parameters

ParameterTypeRequiredDescription
audience_idsstring (comma-separated)YesTwo or more audience IDs to compare

Response

{ "audiences": [ {"id": "550e8400-...", "name": "High-Value", "size": 4250}, {"id": "660e8400-...", "name": "Recent Buyers", "size": 8100} ], "overlap": { "size": 3200, "percent_of_first": 75.3, "percent_of_second": 39.5 } }

Example

curl -X GET "https://composable.zeotap.com/api/v1/workspaces/{id}/insights/audience-overlap?audience_ids=550e8400-...,660e8400-..." \ -H "Authorization: Bearer <token>" \ -H "X-Workspace-ID: <workspace-id>"

Sync Duration

GET /api/v1/workspaces/{id}/insights/sync-duration

Returns trends in sync run duration over the lookback window.


Sync Throughput

GET /api/v1/workspaces/{id}/insights/sync-throughput

Returns rows-per-second throughput trends for sync runs over the lookback window.


Sync SLA

GET /api/v1/workspaces/{id}/insights/sync-sla

Returns SLA compliance metrics (e.g., percentage of runs that finished within the configured SLA window).


Audience Velocity

GET /api/v1/workspaces/{id}/insights/audience-velocity

Returns the rate of change (additions/removals per period) for audiences in the workspace.

Last updated on