---
title: "getOrganizationUsage"
description: "Get organization usage"
canonical: "https://pgbeam.com/docs/ts-sdk/analytics/getOrganizationUsage"
last-updated: "2026-09-14T19:37:21.000Z"
---

# getOrganizationUsage

> Get organization usage

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

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

## Usage

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

## 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.