Usage of a product, by customer
How a product record is used across customers over the last 30 days: customers using it, uses and the change on the 30 days before, 12 weekly buckets, top customers, customers slipping, and active customers who have never tried it. Requires scopes: usage:read and records:read.
The module is found from the record’s object, so none is passed. breakdown is null when no module meters that object on this side. Counts cover every customer; named lists only include records the key can read, and a record with no usable name has name: "", never its id. A record that does not exist, that the key cannot read, or that is not in {object} is not_found.
Authorizations
A Custral secret API key (sk_…), created in Settings → Applications. Sent as Authorization: Bearer sk_…. The X-Api-Key: sk_… header is also accepted and takes precedence. Never expose a secret key in a browser.
Path Parameters
The object, by id or key.
The product record id (rec_…).
Query Parameters
The usage module (umod_…) to read, when several meter the record's object. Defaults to the oldest.