sdk_health
sdk_health

Get SDK health report for a project

Returns a pre-digested health assessment of the PostHog SDKs the project is using. Covers which SDKs are current vs outdated (smart-semver rules with grace periods and traffic-percentage thresholds), per-version breakdown, and a human-readable reason for each assessment. Use this to diagnose SDK version issues, surface upgrade recommendations, or check overall SDK health.

get/api/projects/{project_id}/sdk_health/report/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/sdk_health/report/
  • 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

force_refreshboolean

When true, bypasses the Redis cache and re-queries ClickHouse for SDK usage. A background job refreshes this data once a day, so the cached answer is usually current. Use sparingly.

Response

overall_health'healthy' | 'needs_attention' required
  • healthy - healthy
  • needs_attention - needs_attention
health'success' | 'warning' | 'danger' required
  • success - success
  • warning - warning
  • danger - danger
needs_updating_countinteger required

Number of SDKs that need updating.

team_sdk_countinteger required

Number of distinct PostHog SDKs the project is actively using.

Changes

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