provider web_analyticsweb_analytics GET /api/environments/{environment_id}/web_analytics/weekly_digest/
@utdk/posthog /api/environments/{environment_id}/web_analytics/weekly_digest/
Summarize web analytics
Summarizes a project's web analytics over a lookback window (default 7 days): unique visitors, pageviews, sessions, bounce rate, and average session duration with period-over-period comparisons, plus the top 5 pages, top 5 traffic sources, and goal conversions.
compare query
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 (faster).
boolean
days query
Lookback window in days (1–90). Defaults to 7.
integer
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
string

Try it

Authentication
Configure credentials for PostHog API
environmentsWebAnalyticsWeeklyDigest
GET/api/environments/{environment_id}/web_analytics/weekly_digest/
Summarizes a project's web analytics over a lookback window (default 7 days): unique visitors, pageviews, sessions, bounce rate, and average session duration with period-over-period comparisons, plus the top 5 pages, top 5 traffic sources, and goal conversions.

Parameters

required

Deprecated. Use /api/projects/{project_id}/ instead.

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 (faster).

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

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.environmentsWebAnalyticsWeeklyDigest({
  "compare": true,
  "days": 7
})