Skip to main content
Returns per-contributor statistics for a reporting period, ranked by descending productivity score. Aggregates are workspace-wide and are not filtered by repository.
To choose a date range, use List workspace reporting periods (GET /reportingPeriods) with operation=CONTRIBUTOR_STATISTICS. Pass a returned period’s from and to to this endpoint. Discovery is guidance, not an exhaustive list of accepted ranges: partial or gapped ranges are also accepted. The current period can extend beyond the discovered end; read from and to in the response for the range actually used.
Requires workspace Read and Productivity. Historical activity from inaccessible repositories can contribute; external-contributor inclusion follows the workspace setting. Secret-team associations are omitted for API keys without removing those contributors or changing their statistics.

Authorization

string
required
Bearer <key>. See Authentication.

Path parameters

string
required
GITHUB_ORGANIZATION or GITHUB_USER.
string
required
Numeric GitHub ID of the organization or user.

Query parameters

string
Inclusive start (RFC 3339). If from or to is omitted, both are ignored and the latest available portion of the current reporting period is used, or the previous period if the current one has no elapsed working hours. When both are supplied, each must fall on a UTC quarter-hour (minute 00, 15, 30, or 45, zero seconds), and from must be on or after 0001-01-15T00:00:00Z. Values are not rounded.
string
End (RFC 3339). Must be after from, and the range can be at most 366 days. Commits at either endpoint are included, so adjacent ranges can overlap. If from is the start of the current reporting period, the effective end can extend to the latest processed data. Read from and to in the response for the period actually used.
integer
Maximum number of contributors to return, applied after ranking. Omit for all contributors. 0 returns none. Does not affect workingMinutes. There is no pagination.
string
default:"all"
all counts all tracked activity. shipped counts landed activity and accounts for squashed commits. Neither measures deployments.

Response

object[]
Contributors sorted by descending productivityScore.value. Tie order is not guaranteed.
string
Start of the effective period (RFC 3339).
string
End of the effective period (RFC 3339).
string
Start of the comparison period, 7 or 14 days before from depending on the workspace schedule.
string
End of the comparison period. Equal to from.
string
Workspace IANA timezone used for calendar and working-time calculations.
string
Workspace working minutes in the period (int64 as string). Not summed contributor effort.
string
Workspace working minutes in the comparison period (int64 as string).
string
Oldest calculation time for current-period data (RFC 3339). Not a completeness guarantee.
boolean
true when part of either period is still being processed. Results can change.
boolean
true when shipped metrics for either period are not ready yet.
An empty contributors list can mean no activity, shipped metrics not ready, or limit=0. Fields with false, zero, or empty values are omitted from the JSON.

Metric

number
Current-period value.
number
Comparison-period value. Counts and minutes are scaled to the current period’s length, so they can be fractional. Scores are normalized independently.
number
value - previousValue. Zero when previous data is unavailable.
number
Relative change as a percentage (25 means 25%). Zero when previousValue is zero or unavailable.

Contributor

string
GitHub user ID.
string
GitHub username.
string
GitHub display name, when set.
string
GitHub avatar URL.
string
GitHub GraphQL node ID.

Team

string
GitHub team ID.
string
GitHub team slug.
string
Team name.
string
Team description, when set.
string
GitHub team visibility, closed or secret.
boolean
Whether team metrics are enabled for this team in Settings → Teams.
string
GitHub GraphQL node ID.