Sign in
Analytics

Get general statistics across all projects for a time frame

get/analytics/general-stats

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/analytics/general-stats
  • Auth: HTTP bearer

Query parameters

start_datestring required

Start date in format YYYY-MM-DD HH:MM:SS

end_datestring required

End date in format YYYY-MM-DD HH:MM:SS

project_idsinteger[]

Optional: Filter by specific project IDs (comma-separated)

environment_idinteger

Environment ID (optional)

include_project_breakdownboolean

Whether to include per-project breakdown (default: false)

Response

Successfully retrieved general statistics

avg_bounce_ratenumber double required
avg_engagement_ratenumber double required
page_views_trend_percentagenumber double nullable

Percentage change in page views vs previous period

previous_page_viewsinteger nullable

Previous period page views

previous_unique_visitorsinteger nullable

Previous period unique visitors (same duration, shifted back)

total_eventsinteger required
total_page_viewsinteger required
total_projectsinteger required
total_unique_visitorsinteger required
total_visitsinteger required
visitors_trend_percentagenumber double nullable

Percentage change in unique visitors vs previous period

Changes