web_analytics
web_analytics

Weekly web analytics recap

The 'Wrapped'-style weekly recap: everything in the weekly digest (visitors, pageviews, sessions, bounce rate, average session duration with period-over-period comparisons, top pages, top sources, and goals) plus a single derived weekly persona and a short list of screenshot-worthy highlights for the period.

get/api/projects/{project_id}/web_analytics/recap/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/web_analytics/recap/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

compareboolean

When true (default), include period-over-period change for each metric comparing against the prior equal-length period. Set to false to skip the comparison query.

daysinteger

Lookback window in days (1–90). Defaults to 7.

Response

dashboard_urlstring uri required

Link to the Web analytics dashboard for this project.

period_labelstring required

Human-readable period label, e.g. 'Last 7 days'.

period_startstring date required

First date included in the recap period, in the project timezone.

period_endstring date required

Final date included in the recap period, in the project timezone.

project_namestring required

Name of the project this recap is for.

recap_urlstring uri required

Canonical link to this project's weekly recap.

Changes

No recorded changes to this operation across all 1 revision of this API.