Analytics API
The VTO Analytics API provides read-only reporting endpoints for your VTO experience. Use it for operational reports, partner dashboards and business intelligence workflows.
It's separate from the Partner API and is scoped by an analytics app key (app_key), not by project_key.
Open the interactive API reference →
Prefer no code?
The same data is available in Studio, with Excel export. See Analytics.
Base URL
https://api.pulpoar.com/vto-partner-analytics/v1
Authentication
- Send your API key in the
X-API-Keyheader. - Each request is authorized against the
app_keyin the URL. Use the analytics app key assigned to the VTO experience you want to report on.
curl --request GET \
--url 'https://api.pulpoar.com/vto-partner-analytics/v1/apps/<app_key>/summary?start_date=2026-01-01&end_date=2026-01-31' \
--header 'X-API-Key: <partner-api-key>'
const response = await fetch(
'https://api.pulpoar.com/vto-partner-analytics/v1/apps/<app_key>/events/onProductSelect/segments/productId?start_date=2026-01-01&end_date=2026-01-31&limit=20',
{ headers: { 'X-API-Key': '<partner-api-key>' } }
);
const payload = await response.json();
Endpoints
All endpoints are under /v1/apps/{app_key}:
| Endpoint | Use it for |
|---|---|
/summary | Headline traffic and engagement metrics for a reporting window |
/timeseries/{metric} | Daily trend of a metric |
/events/{event_key}/timeseries | Daily trend of an event |
/events | Raw events, newest first, with the partner analytics ID attached. Paginated: follow meta.next_cursor until it's null. |
/events/{event_key}/segments/{segment_key} | An event broken down by a segment, for example onProductSelect by productId |
/breakdowns/{dimension} | Country, device, platform, browser and similar breakdowns |
/effectiveness/{dimension} | Product effectiveness |
/journeys/{report} | User-journey reports |
/funnel | VTO conversion stages and completion rates |
/activity/hourly | Hourly engagement distribution |
/retention/loyalty | Returning users |
/retention/slipping-away | Users becoming inactive |
Event keys match the SDK event names, for example onProductSelect.
Reporting windows
Pass start_date and end_date (YYYY-MM-DD) with each request.
- Most endpoints support windows of up to 93 days.
- These endpoints are limited to 31 days:
/events,/funnel,/effectiveness/{dimension},/journeys/{report},/events/{event_key}/segments/{segment_key},/activity/hourlyand/breakdowns/browser. - Retention endpoints accept an optional
as_of_datefor reproducible snapshots in scheduled reports or exports.
Rate limits
- 500 requests per 15 minutes per API key.
- Every response includes the
X-RateLimit-Limit,X-RateLimit-RemainingandX-RateLimit-Resetheaders.
Linking events to your users
To connect analytics events to your own user or account IDs, set a partner analytics ID in the plugin, with the #partnerAnalyticsId URL hash or the setPartnerAnalyticsId action.