DOCS / API REFERENCE

Get usage by service

GET /v1/usage

GETHenHouse API v1

Request

GET /v1/usage

Authenticate with a bearer token. Create one with POST /v1/tokens or cluck login.

Parameters

NameTypeDescription
periodstringday, week, or month
group_bystringservice, tag, or coop

Example

curl -X GET https://api.pollosoft.example/v1/usage?period=example&group_by=example \
  -H "Authorization: Bearer $COOP_TOKEN"

Response

A successful call returns 200 OK with JSON like this:

{
  "period": "month",
  "total_cents": 151500,
  "top_service": "HenHouse"
}

Errors

IdempotencyThis endpoint is safe to retry. Reads do not lay eggs.