Usage

Get usage summary

Organization-wide product-usage summary by channel: web (web app), word (Word add-in), and api.

Requires an org-scoped API key: usage is reported org-wide, so a user-scoped key receives a 403. For credit/billing totals, use GET /v1/credit-usage.

Note: web/word counts are sourced from product analytics; day boundaries for those channels are approximate (UTC).

get/usage

Request

Base URL
https://app.gc.ai/api/external/v1
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/gc-ai/apis/gc-ai-external-api/docs/usage/get.ts
A function with typed inputs. Its response is checked against the schema.

start_datestring required

Inclusive range start (YYYY-MM-DD).

Example:2026-06-01

end_datestring required

Inclusive range end (YYYY-MM-DD).

Example:2026-06-30

timezonestring

IANA timezone for the api channel day boundaries (default UTC).

Usage summary for the requested range

start_datestring required

Inclusive range start.

end_datestring required

Inclusive range end.

timezonestring required

IANA timezone used for day boundaries.

No recorded changes to this operation across all 1 revision of this API.