← Umney Connect/Developers

Analytics

Conversion metrics, events, and daily series for BI tools and AI reporting workflows. Separate from Live Chat inbox reports.

Generally availableOpenAPIMarkdown

Overview

Analytics Suite manages conversion metrics and events. Live Chat reports (`/dashboard/chat/reports`) are a separate Live Chat surface—do not conflate them.

ItemValue
ServiceAnalytics
Permissionsanalytics:read
Key exampleumk_live_analytics_<8>_<secret>
Dashboard UIDashboard → Email Suites
JWT Growth API/api/growth/… (see below)
Public umk_* RESTLive — see public API table
Markdown/developers/analytics.md
Public /v1/analytics/* is live and read-only (metrics, events, series, statistics). JWT Growth still owns writes. Chat inbox reports remain under Live Chat docs. No public exports endpoint.

Get started

  1. Enable Analytics in Dashboard → Billing.
  2. Open Dashboard → Email Suites for the product tab UI.
  3. Create an API token for Analytics with permission analytics:read.
  4. Store the secret server-side only (Cloudflare-style least privilege).
  5. Use JWT /api/growth/* for dashboard session flows; public /v1/* paths when documented as Live.

API tokens (Cloudflare-style)

Authorization: Bearer umk_live_analytics_<8>_<secret>
Scope: analytics:read — Read metrics and events on the public Analytics API
Guide: /developers/api-tokens

Concepts

ResourceDescription
Conversion metricMetric definition
EventTracked conversion/event row
Statistics30d-style suite aggregates
Metric seriesDaily event/revenue buckets for a metric

Dashboard Growth API (JWT — available now)

Tenant JWT under /api/growth/*. Generic PATCH|DELETE /api/growth/:suite/:resource/:id also applies for some resources. Check GET /api/growth/entitlements for access.

MethodPathPurpose
GET|POST|PATCH|DELETE/api/growth/analytics/conversion-metricsMetrics CRUD
GET|POST|PATCH|DELETE/api/growth/analytics/eventsEvents CRUD
GET/api/growth/analytics/statisticsStats

Public API contract

MethodPathScopeStatus
GET/v1/analytics/metricsanalytics:readLive
GET/v1/analytics/metrics/{id}analytics:readLive
GET/v1/analytics/metrics/{id}/seriesanalytics:readLive
GET/v1/analytics/eventsanalytics:readLive
GET/v1/analytics/events/{id}analytics:readLive
GET/v1/analytics/statisticsanalytics:readLive
Do not invent URLs. Public handlers ship without changing your key model.

Agent recipe

# Enable Analytics → create token (analytics:read)
# Today: JWT /api/growth/… listed above
# Public: paths in the contract table
# Read /developers/analytics.md before answering
# See also Live Chat + Business Email complete docs