## GetCoAuthorSummary

`client.Usage.GetCoAuthorSummary(ctx, body) (*UsageGetCoAuthorSummaryResponse, error)`

**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

- `body UsageGetCoAuthorSummaryParams`

  - `DateRange param.Field[DateRange]`

    Date range to query within.

  - `ProjectID param.Field[string]`

    Optional project ID to scope results.

  - `TeamID param.Field[string]`

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

  - `UserID param.Field[string]`

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

### Returns

- `type UsageGetCoAuthorSummaryResponse struct{…}`

  - `Sparkline []TimeSeriesPoint`

    Sparkline data for card rendering.

    - `Time Time`

      Timestamp for this data point.

    - `Value int64`

      The numerical value for this data point.

  - `Summary CoAuthorSummary`

    Summary totals and trends for the requested date range.

    - `ByTool []ToolBreakdown`

      Per-tool breakdown of contribution stats.

      - `Commits string`

        Number of commits attributed to this tool.

      - `DistinctAuthors string`

        Distinct authors who used this tool.

      - `LinesAdded string`

        Lines added by this tool.

      - `LinesRemoved string`

        Lines removed by this tool.

      - `Tool CoAuthorTool`

        The tool these stats are for.

        - `const CoAuthorToolUnspecified CoAuthorTool = "CO_AUTHOR_TOOL_UNSPECIFIED"`

        - `const CoAuthorToolNoCoauthor CoAuthorTool = "CO_AUTHOR_TOOL_NO_COAUTHOR"`

        - `const CoAuthorToolHumanCoauthor CoAuthorTool = "CO_AUTHOR_TOOL_HUMAN_COAUTHOR"`

        - `const CoAuthorToolOna CoAuthorTool = "CO_AUTHOR_TOOL_ONA"`

        - `const CoAuthorToolGitHubCopilot CoAuthorTool = "CO_AUTHOR_TOOL_GITHUB_COPILOT"`

        - `const CoAuthorToolCursor CoAuthorTool = "CO_AUTHOR_TOOL_CURSOR"`

        - `const CoAuthorToolOther CoAuthorTool = "CO_AUTHOR_TOOL_OTHER"`

        - `const CoAuthorToolClaude CoAuthorTool = "CO_AUTHOR_TOOL_CLAUDE"`

        - `const CoAuthorToolCodex CoAuthorTool = "CO_AUTHOR_TOOL_CODEX"`

    - `DistinctAuthors string`

      Number of distinct authors (by author_hash).

    - `DistinctAuthorsTrend float64`

      Fractional change in distinct_authors compared to the previous period.

    - `TotalCommits string`

      Total number of commits in the date range.

    - `TotalCommitsTrend float64`

      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.

    - `TotalLinesAdded string`

      Total lines added across all commits.

    - `TotalLinesAddedTrend float64`

      Fractional change in total_lines_added compared to the previous period.

    - `TotalLinesRemoved string`

      Total lines removed across all commits.

    - `TotalLinesRemovedTrend float64`

      Fractional change in total_lines_removed compared to the previous period.

### Example

```go
package main

import (
  "context"
  "fmt"
  "time"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
  "github.com/gitpod-io/gitpod-sdk-go/shared"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.Usage.GetCoAuthorSummary(context.TODO(), gitpod.UsageGetCoAuthorSummaryParams{
    DateRange: gitpod.F(shared.DateRangeParam{
      EndTime: gitpod.F(time.Now()),
      StartTime: gitpod.F(time.Now()),
    }),
    ProjectID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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
  }
}
```