## GetCoAuthorSummary

`usage.get_co_author_summary(UsageGetCoAuthorSummaryParams**kwargs)  -> UsageGetCoAuthorSummaryResponse`

**post** `/gitpod.v1.UsageService/GetCoAuthorSummary`

Gets aggregated co-author summary for the organization or a specific project.

Use this method to:

- Measure AI-assisted commits and line changes
- Scope co-author insights to a project, user, or team
- Compare the requested date range against the previous period

### Example

```yaml
dateRange:
  startTime: "2024-01-01T00:00:00Z"
  endTime: "2024-02-01T00:00:00Z"
projectId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```

### Parameters

- `date_range: DateRange`

  Date range to query within.

  - `end_time: datetime`

    End time of the date range (exclusive).

  - `start_time: datetime`

    Start time of the date range (inclusive).

- `project_id: Optional[str]`

  Optional project ID to scope results.

- `team_id: Optional[str]`

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

- `user_id: Optional[str]`

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

### Returns

- `class UsageGetCoAuthorSummaryResponse: …`

  - `sparkline: Optional[List[TimeSeriesPoint]]`

    Sparkline data for card rendering.

    - `time: Optional[datetime]`

      Timestamp for this data point.

    - `value: Optional[int]`

      The numerical value for this data point.

  - `summary: Optional[CoAuthorSummary]`

    Summary totals and trends for the requested date range.

    - `by_tool: Optional[List[ToolBreakdown]]`

      Per-tool breakdown of contribution stats.

      - `commits: Optional[str]`

        Number of commits attributed to this tool.

      - `distinct_authors: Optional[str]`

        Distinct authors who used this tool.

      - `lines_added: Optional[str]`

        Lines added by this tool.

      - `lines_removed: Optional[str]`

        Lines removed by this tool.

      - `tool: Optional[CoAuthorTool]`

        The tool these stats are for.

        - `"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"`

    - `distinct_authors: Optional[str]`

      Number of distinct authors (by author_hash).

    - `distinct_authors_trend: Optional[float]`

      Fractional change in distinct_authors compared to the previous period.

    - `total_commits: Optional[str]`

      Total number of commits in the date range.

    - `total_commits_trend: Optional[float]`

      Fractional change in total_commits compared to the previous period of equal
      length. Computed as (current - previous) / previous. Zero when there is no
      previous data.

    - `total_lines_added: Optional[str]`

      Total lines added across all commits.

    - `total_lines_added_trend: Optional[float]`

      Fractional change in total_lines_added compared to the previous period.

    - `total_lines_removed: Optional[str]`

      Total lines removed across all commits.

    - `total_lines_removed_trend: Optional[float]`

      Fractional change in total_lines_removed compared to the previous period.

### Example

```python
import os
from datetime import datetime
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
response = client.usage.get_co_author_summary(
    date_range={
        "end_time": datetime.fromisoformat("2024-02-01T00:00:00"),
        "start_time": datetime.fromisoformat("2024-01-01T00:00:00"),
    },
    project_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
)
print(response.sparkline)
```

#### Response

```json
{
  "sparkline": [
    {
      "time": "2019-12-27T18:11:19.117Z",
      "value": 0
    }
  ],
  "summary": {
    "byTool": [
      {
        "commits": "commits",
        "distinctAuthors": "distinctAuthors",
        "linesAdded": "linesAdded",
        "linesRemoved": "linesRemoved",
        "tool": "CO_AUTHOR_TOOL_UNSPECIFIED"
      }
    ],
    "distinctAuthors": "distinctAuthors",
    "distinctAuthorsTrend": 0,
    "totalCommits": "totalCommits",
    "totalCommitsTrend": 0,
    "totalLinesAdded": "totalLinesAdded",
    "totalLinesAddedTrend": 0,
    "totalLinesRemoved": "totalLinesRemoved",
    "totalLinesRemovedTrend": 0
  }
}
```