---
title: "getOrganizationUsage"
description: "Get organization usage"
canonical: "https://pgbeam.com/docs/ts-sdk/analytics/getOrganizationUsage"
last-updated: "2026-10-30T02:48:39.000Z"
---

# getOrganizationUsage

> Get organization usage

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

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

Returns daily usage data aggregated across all projects in the organization.

## Usage

```typescript
const result = await api.analytics.getOrganizationUsage({
  pathParams: { org_id: "org_abc123" },
  queryParams: { start_date: "2024-01-01", end_date: "2024-01-31" },
});
```

## Parameters

| Parameter              | Type     | Required | Description                         |
| ---------------------- | -------- | -------- | ----------------------------------- |
| pathParams.org_id      | `string` | Yes      | Unique organization identifier.     |
| queryParams.start_date | `string` | Yes      | Start date (inclusive, YYYY-MM-DD). |
| queryParams.end_date   | `string` | Yes      | End date (inclusive, YYYY-MM-DD).   |

## Response

`Promise<UsageResponse>`: daily usage data.

## Example

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

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

const result = await client.api.analytics.getOrganizationUsage({
  pathParams: { org_id: "org_abc123" },
  queryParams: { start_date: "2024-01-01", end_date: "2024-01-31" },
});
```

## 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`.                                                                                                                                                                                                                                          |
| 403    | The caller is authenticated but not allowed to perform this operation. `code` is `FORBIDDEN` when the caller's role is insufficient, and `PLAN_LIMIT_REACHED` when the organization's plan is what stands in the way. The two are answered differently, so branch on the code rather than the status. |
| 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.                                                                                                                                                                                        |