Skip to content
IForevents Docs
IForevents Docs
InicioPanelGitHubPrivacidadTérminosSeguridadIntroducción
Referencia de la API
Query events with optional property filters POSTEvent names and the property keys seen on them GETDistinct values for one property GETExport events as CSV GETExport tracked users as CSV GETPaths after or before one event POSTOrdered step conversion POSTThe users behind one funnel step POSTEvery dashboard panel in one call POSTServer-sent events stream of the dashboard payload POSTA bucketed metric over a window, optionally broken down by a property POSTThe events or users behind one insights point POSTFormulas over named Insights queries POSTHeadline counters GETTraffic KPIs GETProjects owned by the caller's organization GETCustom property keys for the explorer filter and breakdown pickers GETDistinct values of one property, most frequent first GETCohort retention: daily, weekly or monthly, with optional entry and return events and an entry-event breakdown POSTBreak one event down by a property value POSTUsers and events per day GETMost frequent events GETPaginated tracked users GET
Soporte y SLA
API ReferenceEndpointsAnalytics

Every dashboard panel in one call

POST
/v1/analytics/init

Metrics, top events, recent events, traffic overview, users and the daily series for one range. The body is optional.

Authorization

AuthorizationBearer <token>

Session token issued by the accounts service (or the legacy /v1/auth routes).

In: header

Header Parameters

X-Project-UUID?string

Project to query; defaults to the organization's selected project. Ignored for project-credential callers, who are pinned to their project.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/analytics/init" \  -H "Content-Type: application/json" \  -d '{    "end": "2026-09-13T12:30:45Z",    "limit": 50,    "start": "2026-08-14T00:00:00Z"  }'
{  "data": {    "events": [      {        "created_at": "2026-09-13T12:30:45Z",        "organization_uuid": "0b7e2b1a-0a1b-4c2d-8e3f-4a5b6c7d8e9f",        "parent_name": "checkout_completed",        "project_uuid": "5f1c2e7a-1c2d-4b3e-9f10-1a2b3c4d5e6f",        "properties": {          "order_id": "ord_456",          "total": "99.99"        },        "type": "track",        "user_uuid": "00000000-0000-0000-8b20-15635fadf462",        "uuid": "00000000-0000-0000-3c9e-5b7a1d24f086"      }    ],    "metrics": {      "avg_events_per_user": 40.2,      "events_today": 1930,      "total_events": 48210,      "total_users": 1200,      "unique_users_today": 87    },    "overview": {      "avg_visit_duration_seconds": 184.6,      "bounce_rate": 31.2,      "total_pageviews": 30110,      "total_visits": 4020,      "unique_visitors": 1180,      "users": 1200,      "views_per_visit": 7.5    },    "time_series": [      {        "date": "2026-09-12T00:00:00Z",        "events": 1802,        "users": 84      }    ],    "top_events": [      {        "count": 30110,        "name": "screen_view",        "percentage": 62.4      }    ],    "users": [      {        "created_at": "2026-09-13T12:30:45Z",        "custom_id": "user_12345",        "email": "[email protected]",        "events_count": 42,        "name": "Ada Lovelace",        "project_uuid": "5f1c2e7a-1c2d-4b3e-9f10-1a2b3c4d5e6f",        "properties": {          "plan": "pro"        },        "updated_at": "2026-09-13T12:30:45Z",        "uuid": "00000000-0000-0000-8b20-15635fadf462"      }    ]  }}

The users behind one funnel step POST

Previous Page

Server-sent events stream of the dashboard payload POST

Next Page

end?string
Formatdate-time
event_type?string

Value in

  • "track"
  • "identify"
  • "page_view"
events?array<>

Optional filters: only events with these names, each with optional property key/value pairs.

filters?array<>
groups?array<>
limit?integer
match?string
offset?integer
q?string
start?string
Formatdate-time
user?string