---
title: "getProjectInsights"
description: "Get query insights for a project"
canonical: "https://pgbeam.com/docs/ts-sdk/analytics/getProjectInsights"
last-updated: "2026-10-30T13:32:17.000Z"
---

# getProjectInsights

> Get query insights for a project

URL: https://pgbeam.com/docs/ts-sdk/analytics/getProjectInsights

{/* Auto-generated from OpenAPI. Do not edit. Run `pnpm generate:sdk-docs` to regenerate. */}

Returns aggregated query-level analytics for a project including top queries by count, cache hit/miss summary, and latency statistics.

## Usage

```typescript
const result = await api.analytics.getProjectInsights({
  pathParams: { project_id: "prj_xxx" },
});
```

## Parameters

| Parameter             | Type                            | Required | Description                                         |
| --------------------- | ------------------------------- | -------- | --------------------------------------------------- |
| pathParams.project_id | `string`                        | Yes      | Unique project identifier (prefixed, e.g. prj_xxx). |
| queryParams.range     | `"1h" \| "6h" \| "24h" \| "7d"` | No       | Time range to query. Defaults to 24h.               |
| queryParams.limit     | `number`                        | No       | Maximum number of top queries to return (1-100).    |

## Response

`Promise<ProjectInsights>`: query insights for the project.

## Example

```typescript
import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: "pbu_...",
  baseUrl: "https://api.pgbeam.com",
});

const result = await client.api.analytics.getProjectInsights({
  pathParams: { project_id: "prj_xxx" },
  queryParams: { range: "24h", limit: 20 },
});
```

## Errors

| Status | Description                                                                                                                         |
| ------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| 400    | The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one. |
| 401    | Missing or invalid authentication. `code` is `UNAUTHORIZED`.                                                                        |
| 404    | The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`.                             |
| 429    | Rate limited. `code` is `RATE_LIMITED`.                                                                                             |
| 500    | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.                      |