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 — Path Analytics for an inclusive date range with your Partner API Bearer token.

GET/api/v2/analytics/paths

Returns agency-scoped Path Analytics for an inclusive date range — summary, step retention, version breakdown, device/browser mix, and contacts by state.

Authenticate with a Bearer token that includes the analytics scope. Data is always scoped to the agency that owns the token. Discover path_uuid values via List paths.

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 a by_path breakdown.
versionNoFunnel version string, or none to aggregate all versions for the selected path. When a path_uuid is set, defaults to the live (or latest) version.
 
# All paths for the range
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/analytics/paths?from=2026-07-01&to=2026-07-13"

# One path
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/analytics/paths?from=2026-07-01&to=2026-07-13&path_uuid=a1b2c3d4-..."

Response fields

Successful responses use the standard envelope and include:

  • 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 (empty when filtering one path)
  • 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 for the range
{
  "success": true,
  "from": "2026-07-01",
  "to": "2026-07-13",
  "selectedPathUuid": null,
  "selectedFunnel": "",
  "pathOptions": [{ "path_uuid": "...", "slug": "my-path", "label": "My Path", "version": "3" }],
  "by_path": [
    {
      "path_uuid": "...",
      "slug": "my-path",
      "label": "My Path",
      "summary": { "visits": 1200, "starts": 840, "completions": 410 }
    }
  ],
  "summary": { "visits": 1200, "starts": 840, "completions": 410 },
  "retention": { "averageCompletionSeconds": null, "steps": [] },
  "contacts_by_state": [{ "state": "TX", "count": 42 }]
}

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.