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

# GetOrganizationUsage

> Get organization usage

URL: https://pgbeam.com/docs/go-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

```go
result, err := client.Analytics.GetOrganizationUsage(ctx, "org_abc123", &pgbeam.GetOrganizationUsageParams{
    StartDate: openapi_types.Date{Time: time.Now()},
    EndDate: openapi_types.Date{Time: time.Now()},
  })
```

## Parameters

| Parameter          | Type                                 | Required | Description                                                                                                                                                                                                                                                                                                                                             |
| ------------------ | ------------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ctx                | `context.Context`                    | Yes      | Request context                                                                                                                                                                                                                                                                                                                                         |
| orgID              | `string`                             | Yes      | Unique organization identifier.                                                                                                                                                                                                                                                                                                                         |
| params             | `*pgbeam.GetOrganizationUsageParams` | Yes      | Query and header parameters                                                                                                                                                                                                                                                                                                                             |
| params.StartDate   | `openapi_types.Date`                 | Yes      | Start date (inclusive, YYYY-MM-DD).                                                                                                                                                                                                                                                                                                                     |
| params.EndDate     | `openapi_types.Date`                 | Yes      | End date (inclusive, YYYY-MM-DD).                                                                                                                                                                                                                                                                                                                       |
| params.IfNoneMatch | `*string`                            | No       | Entity tag the client already holds, taken from the `ETag` of an earlier response. When it still matches the current representation the server answers `304 Not Modified` with no body, so a poll that finds nothing changed costs a round trip rather than a transfer. A comma-separated list is accepted, and `*` matches any current representation. |

## Response

`(*pgbeam.UsageResponse, error)`: daily usage data.

## Example

```go
import pgbeam "go.pgbeam.com/sdk"

client := pgbeam.NewClient(&pgbeam.ClientOptions{
  APIKey: "pbu_...",
})

result, err := client.Analytics.GetOrganizationUsage(ctx, "org_abc123", &pgbeam.GetOrganizationUsageParams{
    StartDate: openapi_types.Date{Time: time.Now()},
    EndDate: openapi_types.Date{Time: time.Now()},
  })
if err != nil {
  log.Fatal(err)
}
fmt.Println(result)
```

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