Skip to main content
Version: 1.0.0

VTO Partner Analytics API

Overview​

The VTO Partner Analytics API provides resource-based, read-only analytics for authorized VTO experiences.

The contract is intentionally explicit: traffic, event activity, funnels, effectiveness reports, journeys, breakdowns, and retention are exposed as separate resources so clients can compose the views they need without depending on dashboard-shaped payloads.

Event Discovery​

Use GET /v1/events to discover the broader known set of SDK-emitted VTO analytics event keys, what they represent, and the known segmentation keys exposed by this API.

Event path parameters remain open strings in this API version so existing ingest-backed event keys continue to pass through without a breaking validation change.

Authentication​

All app-scoped analytics endpoints require the X-API-Key header. The event catalog is public.

Authorization Model​

A partner API key can be linked to one or more VTO projects. Every analytics request must include an app_key path parameter, and the request is authorized only when that app_key belongs to a project linked to the provided API key.

Reporting Window​

Date-based routes require start_date and end_date in YYYY-MM-DD format.

Standard routes support windows up to 93 days.

High-cost exact routes are limited to 31 days: events (raw event list), funnel, effectiveness, journeys, breakdowns/browser, events/*/segments/*, and activity/hourly.

Retention routes support an optional as_of_date parameter for reproducible reporting snapshots.

Authentication​

Partner API key linked to one or more VTO projects.

Security Scheme Type:

apiKey

Header parameter name:

X-API-Key