Request
GET /v1/usage
Authenticate with a bearer token. Create one with POST /v1/tokens or cluck login.
Parameters
| Name | Type | Description |
|---|---|---|
period | string | day, week, or month |
group_by | string | service, 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
HEN-2001(401): Not logged inHEN-2004(403): Insufficient pecking orderHEN-5001(429): Too many pecks
IdempotencyThis endpoint is safe to retry. Reads do not lay eggs.