Pardon our mess These API docs are a work in progress. Endpoints, examples, and behavior may change as we continue to develop the Partner API v2.

Partner API

Path Analytics report

GET /api/v2/analytics/paths - Returns summary, step retention, version breakdown, device/browser mix, and contacts by state. Discover path_uuid values via List paths.

GET/api/v2/analytics/paths

Returns summary, step retention, version breakdown, device/browser mix, and contacts by state. Discover path_uuid values via List paths.

Required scope: analytics (or *).

Query parameters

NameRequiredDescription
fromYesYYYY-MM-DD start date (inclusive)
toYesYYYY-MM-DD end date (inclusive). Span must be 1–90 days.
path_uuidNoStable path id from GET /api/v2/paths. When omitted, returns all paths rolled up plus by_path.
versionNoFunnel version string, or none to aggregate all versions. Defaults to live/latest when path_uuid is set.
 
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/analytics/paths?from=2026-07-01&to=2026-07-13&path_uuid=c0a80101-0000-4000-8000-000000000005&version=3"
{
  "success": true,
  "from": "2026-07-01",
  "to": "2026-07-13",
  "selectedPathUuid": "c0a80101-0000-4000-8000-000000000005",
  "selectedFunnel": "medicare-quiz",
  "selectedVersion": "3",
  "pathOptions": [{ "path_uuid": "c0a80101-0000-4000-8000-000000000005", "slug": "medicare-quiz", "label": "Medicare Quiz", "version": "3" }],
  "by_path": [],
  "summary": { "visits": 1200, "starts": 840, "completions": 410 },
  "retention": { "averageCompletionSeconds": null, "steps": [] },
  "contacts_by_state": [{ "state": "TX", "count": 42 }]
}

Response fields

  • from / to - echo of the requested range
  • selectedPathUuid, selectedFunnel (slug), selectedVersion, liveVersion
  • pathOptions - { path_uuid, slug, label, version } for follow-up requests
  • by_path - per-path summary when path_uuid is omitted
  • summary - visits, starts, completions, rates, activeSessions, ctaBreakdown
  • retention - step drop-off with average time in step
  • versionBreakdown - per-version visits/starts/completions and publish metadata
  • deviceMix, browserMix
  • contacts_by_state - US state abbreviations with contact counts

Errors

  • 401 - missing or invalid Bearer token
  • 400 - missing/invalid from/to, range longer than 90 days, or unknown path_uuid
  • 403 - token lacks the analytics scope

See Errors for the standard error envelope and rate limits.

Discover paths via List paths.

See Errors for the standard error envelope and rate limits.