engineering_analytics
engineering_analytics

Current default-branch CI verdict over the fixed last-24-hours window. Counts every workflow whose latest completed run failed or timed out; failing workflow names are a bounded preview. The default branch is detected from the same window, independently of analytics date filters.

get/api/projects/{project_id}/engineering_analytics/current_branch_health/

Request

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

repostring

'owner/name' repository to scope to when the selected source syncs several repositories (from the sources list). Defaults to the source's first repository.

source_idstring uuid

Connected GitHub data warehouse source to read from. Defaults to the oldest connected GitHub source when the team has more than one.

Response

default_branchstring required

Detected default branch ('master' or 'main') from runs in the same 24-hour window.

settled_workflowsinteger required

Workflows with at least one completed run in the last 24 hours.

failing_workflowsinteger required

Workflows whose latest completed run in the last 24 hours failed or timed out.

failing_workflow_namesstring[] required

Alphabetical preview of failing workflow names, capped at 20; use failing_workflows for the complete count.

Changes

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