engineering_analytics
engineering_analytics

One author's median ready to merged time, split at the first approval, next to the same medians for the author's own team and for the whole repository, over pull requests merged in the window (date_from default -30d). The team is picked from the author's GitHub teams that own code: a team that pr_number asked to review, else the team the author's pull requests asked to review most often, else every team. Bots and drafts are excluded.

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

Request

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

authorstring required

GitHub login of the author to compare with their team and the repository.

date_fromstring

Window start: relative ('-30d', '-8w') or ISO8601. Defaults to -30d.

date_tostring

Window end: relative or ISO8601. Defaults to now.

pr_numberinteger

A pull request by the author. Needs repo. A team of the author's that this pull request asked to review is the team to compare with, and the pull request stays out of the medians.

repostring

'owner/name' repository. Required with pr_number; otherwise it picks the repository when the selected source syncs several.

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

authorstring required

The GitHub login the comparison is for.

has_membership_databoolean required

True when the team membership table is synced. Without it, team_basis is no_team.

review_data_availableboolean required

False when reviews aren't synced: the approval medians are then null.

ready_data_availableboolean required

False when issue events aren't synced: the ready-to-merge medians are then null.

team_basis'pull_request' | 'review_requests' | 'only_team' | 'all_teams' | 'no_team' required
  • pull_request - Pull Request
  • review_requests - Review Requests
  • only_team - Only Team
  • all_teams - All Teams
  • no_team - No Team

Changes

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