Skip to main content
GET
/
usage
Get usage summary
curl --request GET \
  --url https://app.gc.ai/api/external/v1/usage \
  --header 'Authorization: <api-key>'
{
  "start_date": "<string>",
  "end_date": "<string>",
  "timezone": "<string>",
  "web": {
    "messages": 123,
    "web_pages_scraped": 123,
    "files_uploaded": 123
  },
  "word": {
    "messages": 123,
    "redlines_applied": 123,
    "drafts_applied": 123
  },
  "api": {
    "requests": 123,
    "by_operation": {}
  }
}

Authorizations

Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

Create API keys in the GC AI app under Settings → API.

Query Parameters

start_date
string
required

Inclusive range start (YYYY-MM-DD).

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-06-01T00:00:00.000Z"

end_date
string
required

Inclusive range end (YYYY-MM-DD).

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-06-30T00:00:00.000Z"

timezone
string
default:UTC

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

Response

Usage summary for the requested range

start_date
string
required

Inclusive range start.

end_date
string
required

Inclusive range end.

timezone
string
required

IANA timezone used for day boundaries.

web
object
required

Web-app activity.

word
object
required

Word add-in activity.

api
object
required

API activity.