> ## Documentation Index
> Fetch the complete documentation index at: https://ona.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Pr Summary

> Gets aggregated PR speed summary for the organization or a specific project.

`Unary` · [`Usage`](https://ona.com/docs/api-reference/generated/usage/overview)

Gets aggregated PR speed summary for the organization or a specific project.

Use this method to:

* Measure pull request lead time and review latency
* Calculate deployment frequency from merged pull requests
* Scope PR speed insights to a project, user, or team

### Example

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

## Endpoint

```text theme={null}
POST /api/gitpod.v1.UsageService/GetPrSummary
```

Send a Bearer token as described in [Authentication](https://ona.com/docs/api-reference.md#authenticate-requests). If your organization uses a custom management-plane domain, replace `https://app.ona.com` with that domain.

## Request example

```bash cURL theme={null}
export ONA_HOST=https://app.ona.com
export ONA_API_KEY=<your-token>

curl --request POST \
  --url "$ONA_HOST/api/gitpod.v1.UsageService/GetPrSummary" \
  --header "Authorization: Bearer $ONA_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "dateRange": {
    "endTime": "2026-01-01T00:00:00Z",
    "startTime": "2026-01-01T00:00:00Z"
  }
}'
```

```python Python theme={null}
import gitpod.v1.usage_pb2 as usage_pb2
import google.protobuf.timestamp_pb2 as timestamp_pb2
from ona_sdk import create_client_from_env

ona = create_client_from_env()
request = usage_pb2.GetPrSummaryRequest(
    date_range=usage_pb2.DateRange(
        start_time=timestamp_pb2.Timestamp(seconds=1767225600),
        end_time=timestamp_pb2.Timestamp(seconds=1767225600),
    ),
)
response = ona.services.usage.get_pr_summary(request)
print(response)
```

```typescript TypeScript theme={null}
import { create } from "@bufbuild/protobuf";
import { createClientFromEnv } from "@gitpod/sdk";
import { GetPrSummaryRequestSchema } from "@gitpod/sdk/gitpod/v1/usage_pb";
import { timestampFromDate } from "@bufbuild/protobuf/wkt";

async function main() {
  const ona = createClientFromEnv();
  const request = create(GetPrSummaryRequestSchema, {
    dateRange: {
      startTime: timestampFromDate(new Date("2026-01-01T00:00:00Z")),
      endTime: timestampFromDate(new Date("2026-01-01T00:00:00Z")),
    },
  });
  const response = await ona.services.usage.getPrSummary(request);
  console.log(response);
}

main().catch(console.error);
```

```go Go theme={null}
package main

import (
	"context"
	"fmt"
	"log"

	"connectrpc.com/connect"
	"github.com/gitpod-io/gitpod-sdk-go/sdk"
	gitpodpb "github.com/gitpod-io/gitpod-sdk-go/v1"
	timestamppb "google.golang.org/protobuf/types/known/timestamppb"
)

func main() {
	ona, err := sdk.NewFromEnv()
	if err != nil {
		log.Fatal(err)
	}

	request := connect.NewRequest(&gitpodpb.GetPrSummaryRequest{
		DateRange: &gitpodpb.DateRange{
			StartTime: &timestamppb.Timestamp{Seconds: 1767225600},
			EndTime: &timestamppb.Timestamp{Seconds: 1767225600},
		},
	})
	response, err := ona.Services.Usage.GetPrSummary(context.Background(), request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response.Msg)
}
```

```json Request body theme={null}
{
  "dateRange": {
    "endTime": "2026-01-01T00:00:00Z",
    "startTime": "2026-01-01T00:00:00Z"
  }
}
```

## Request

`gitpod.v1.GetPrSummaryRequest`

| Field | Type | Required | Description |
| - | - | - | - |
| `dateRange` | [DateRange](#type-gitpod-v1-date-range) | Yes | Date range to query within. Constraints: `required=true`. |
| `projectId` | string | No | Optional project ID to scope results. |
| `userId` | string | No | Optional user ID to scope results to a specific user. Mutually exclusive with team\_id. |
| `teamId` | string | No | Optional team ID to scope results to a specific team. Mutually exclusive with user\_id. |

## Response

`gitpod.v1.GetPrSummaryResponse`

| Field | Type | Required | Description |
| - | - | - | - |
| `summary` | [PrSummary](#type-gitpod-v1-pr-summary) | No | Summary totals and trends for the requested date range. |
| `sparkline` | array of [TimeSeriesPoint](#type-gitpod-v1-time-series-point) | No | Sparkline data for card rendering. |

## Related types

> [accordion] DateRange
>
> DateRange specifies a time period for queries.
>
> `gitpod.v1.DateRange`
>
> | Field | Type | Required | Description |
> | - | - | - | - |
> | `startTime` | RFC 3339 timestamp | Yes | Start time of the date range (inclusive). Constraints: `required=true`. |
> | `endTime` | RFC 3339 timestamp | Yes | End time of the date range (exclusive). Constraints: `required=true`. |

> [accordion] PrSummary
>
> PrSummary contains aggregate PR speed metrics for a date range.
>
> `gitpod.v1.PrSummary`
>
> | Field | Type | Required | Description |
> | - | - | - | - |
> | `leadTimeSeconds` | number | No | Median lead time for changes in seconds (first commit → merge). |
> | `leadTimeTrend` | number | No | Fractional change in lead\_time\_seconds vs previous period. Computed as (current - previous) / previous. |
> | `prsMergedCount` | 64-bit integer string | No | Total PRs merged in the date range. |
> | `prsMergedTrend` | number | No | Fractional change in prs\_merged\_count vs previous period. Computed as (current - previous) / previous. |
> | `timeToFirstApprovalSeconds` | number | No | Median time to first approval in seconds. Zero when no PRs in the range had approvals. |
> | `timeToFirstApprovalTrend` | number | No | Fractional change in time\_to\_first\_approval\_seconds vs previous period. Computed as (current - previous) / previous. |
> | `deploymentFrequency` | number | No | PRs merged to the default branch per week. |
> | `deploymentFrequencyTrend` | number | No | Fractional change in deployment\_frequency vs previous period. Computed as (current - previous) / previous. |

> [accordion] TimeSeriesPoint
>
> `gitpod.v1.TimeSeriesPoint`
>
> | Field | Type | Required | Description |
> | - | - | - | - |
> | `time` | RFC 3339 timestamp | No | Timestamp for this data point. |
> | `value` | integer | No | The numerical value for this data point. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.