---
title: "Get App Usage"
method: GET
path: "/apps/{app_id}/usage"
tags: ["Apps"]
---

# Get App Usage

`GET /apps/{app_id}/usage`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/apps/{app_id}/usage`
- Auth: HTTP bearer

PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.

Credits this app consumed in a calendar month, broken down per client org.

The breakdown keys on the client whose DATA was touched, not on who paid —
the builder pays for all of them. A month with no usage returns zeroes rather
than 404: "nothing happened" is an answer, and a 404 would read as "no such
app".

## Path parameters

- `app_id` string, required

## Query parameters

- `period` string, nullable: Calendar month `YYYY-MM`. Defaults to the current month.

## Headers

- `Authorization` string, nullable
- `X-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseUsageSummaryResponse
  - `data` UsageSummaryResponse, required: Credits an app consumed in one calendar month. Mirrors `UsageSummaryDto`.
    - `app_id` string, required
    - `period` string, required: Calendar month, `YYYY-MM`.
    - `total_credits` integer, required
    - `event_count` integer, required
    - `per_client_credits` object: Credits per CLIENT org — whose data was touched, not who paid. The builder pays for all of them.
    - `gross_credits` integer: Undiscounted list total for the period. `gross_credits - discount_credits == total_credits`.
    - `discount_credits` integer: Everything deducted from list: the builder discount AND any hard-cap clamp. One compound number, not 'the 25%'.
    - `per_payer_credits` object: Net credits per BILLING org, who pays. The mirror of `per_client_credits`, which is whose data was touched.
    - `per_operation_credits` object: Net credits per operation id, so you can see which calls cost money.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)