Skip to content
Ona Docs

GetCoAuthorTimeSeries

POST/gitpod.v1.UsageService/GetCoAuthorTimeSeries

Gets co-author contribution data as a time series.

Use this method to:

  • Chart AI-assisted commits and line changes over time
  • Select hourly, daily, weekly, or monthly buckets
  • Scope co-author insights to a project, user, or team

Example

dateRange:
  startTime: "2024-01-01T00:00:00Z"
  endTime: "2024-02-01T00:00:00Z"
resolution: RESOLUTION_WEEKLY
projectId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
Body ParametersJSONExpand Collapse
dateRange: DateRange { endTime, startTime }

Date range to query within.

endTime: string

End time of the date range (exclusive).

formatdate-time
startTime: string

Start time of the date range (inclusive).

formatdate-time
projectId: optional string

Optional project ID to scope results.

resolution: optional Resolution

Time resolution for the series data.

One of the following:
"RESOLUTION_UNSPECIFIED"
"RESOLUTION_HOURLY"
"RESOLUTION_DAILY"
"RESOLUTION_WEEKLY"
"RESOLUTION_MONTHLY"
teamId: optional string

Optional team ID to scope results to a specific team. Mutually exclusive with user_id.

userId: optional string

Optional user ID to scope results to a specific user. Mutually exclusive with team_id.

ReturnsExpand Collapse
timeSeries: optional array of CoAuthorTimeBucket { aiRatio, byTool, distinctAuthors, 4 more }

Time series of contribution stats, bucketed by the requested resolution.

aiRatio: optional number

Ratio of AI-assisted lines added to total lines added (0.0–1.0).

formatdouble
byTool: optional array of ToolBreakdown { commits, distinctAuthors, linesAdded, 2 more }

Per-tool breakdown for this bucket.

commits: optional string

Number of commits attributed to this tool.

distinctAuthors: optional string

Distinct authors who used this tool.

linesAdded: optional string

Lines added by this tool.

linesRemoved: optional string

Lines removed by this tool.

tool: optional CoAuthorTool

The tool these stats are for.

One of the following:
"CO_AUTHOR_TOOL_UNSPECIFIED"
"CO_AUTHOR_TOOL_NO_COAUTHOR"
"CO_AUTHOR_TOOL_HUMAN_COAUTHOR"
"CO_AUTHOR_TOOL_ONA"
"CO_AUTHOR_TOOL_GITHUB_COPILOT"
"CO_AUTHOR_TOOL_CURSOR"
"CO_AUTHOR_TOOL_OTHER"
"CO_AUTHOR_TOOL_CLAUDE"
"CO_AUTHOR_TOOL_CODEX"
distinctAuthors: optional string

Number of distinct authors (by author_hash) in this bucket.

startTime: optional string

Start of this time bucket.

formatdate-time
totalCommits: optional string

Total number of commits in this bucket (across all tools).

totalLinesAdded: optional string

Total lines added in this bucket (across all tools).

totalLinesRemoved: optional string

Total lines removed in this bucket (across all tools).

GetCoAuthorTimeSeries

curl https://app.gitpod.io/api/gitpod.v1.UsageService/GetCoAuthorTimeSeries \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{
          "dateRange": {
            "endTime": "2024-02-01T00:00:00Z",
            "startTime": "2024-01-01T00:00:00Z"
          }
        }'
{
  "timeSeries": [
    {
      "aiRatio": 0,
      "byTool": [
        {
          "commits": "commits",
          "distinctAuthors": "distinctAuthors",
          "linesAdded": "linesAdded",
          "linesRemoved": "linesRemoved",
          "tool": "CO_AUTHOR_TOOL_UNSPECIFIED"
        }
      ],
      "distinctAuthors": "distinctAuthors",
      "startTime": "2019-12-27T18:11:19.117Z",
      "totalCommits": "totalCommits",
      "totalLinesAdded": "totalLinesAdded",
      "totalLinesRemoved": "totalLinesRemoved"
    }
  ]
}
Returns Examples
{
  "timeSeries": [
    {
      "aiRatio": 0,
      "byTool": [
        {
          "commits": "commits",
          "distinctAuthors": "distinctAuthors",
          "linesAdded": "linesAdded",
          "linesRemoved": "linesRemoved",
          "tool": "CO_AUTHOR_TOOL_UNSPECIFIED"
        }
      ],
      "distinctAuthors": "distinctAuthors",
      "startTime": "2019-12-27T18:11:19.117Z",
      "totalCommits": "totalCommits",
      "totalLinesAdded": "totalLinesAdded",
      "totalLinesRemoved": "totalLinesRemoved"
    }
  ]
}