Analytics API

Retrieve flow performance metrics and click heatmaps. All endpoints require JWT authentication.

Overview Metrics

curl "https://api.breakground.io/api/analytics/overview?startDate=2026-01-01&endDate=2026-01-31" \
  -H "Authorization: Bearer $TOKEN"

Query parameters:

Param	Type	Description
startDate	string	ISO date for range start
endDate	string	ISO date for range end

Response:

{
  "data": {
    "totalFlows": 24,
    "publishedFlows": 18,
    "activeUsers": 1340,
    "totalEvents": 52800,
    "flowCompletions": 4120,
    "completionRate": 0.73,
    "dateRange": { "startDate": "2026-01-01", "endDate": "2026-01-31" }
  }
}

Per-Flow Analytics

curl "https://api.breakground.io/api/analytics/flows/:flowId?startDate=2026-01-01&endDate=2026-01-31" \
  -H "Authorization: Bearer $TOKEN"

Returns detailed metrics for a single flow, including step-level drop-off analysis.

Response:

{
  "data": {
    "flowId": "a1b2c3d4-...",
    "flowName": "Onboarding Walkthrough",
    "totalStarts": 1250,
    "completed": 912,
    "dismissed": 210,
    "skipped": 128,
    "completionRate": 0.73,
    "stepDropOff": [
      {
        "stepId": "s1-...",
        "stepOrder": 0,
        "stepTitle": "Welcome",
        "reached": 1250,
        "dropOffCount": 50,
        "dropOffRate": 0.04
      },
      {
        "stepId": "s2-...",
        "stepOrder": 1,
        "stepTitle": "Profile Setup",
        "reached": 1200,
        "dropOffCount": 120,
        "dropOffRate": 0.1
      }
    ],
    "dateRange": { "startDate": "2026-01-01", "endDate": "2026-01-31" }
  }
}

Heatmap Data

curl "https://api.breakground.io/api/analytics/heatmaps?url=https://app.example.com/dashboard&startDate=2026-01-01&endDate=2026-01-31" \
  -H "Authorization: Bearer $TOKEN"

Query parameters:

Param	Type	Required	Description
url	string	Yes	Page URL to retrieve heatmap data for
startDate	string	No	Filter from this date
endDate	string	No	Filter up to this date

Returns click coordinates, element selectors, and flags for rage clicks and dead clicks on the specified page.