Get App Usage
GET /apps/{app_id}/usage
PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.
Credits this app consumed in a calendar month, broken down per client org.
The breakdown keys on the client whose DATA was touched, not on who paid — the builder pays for all of them. A month with no usage returns zeroes rather than 404: “nothing happened” is an answer, and a 404 would read as “no such app”.
Authorizations
Parameters
Path Parameters
Query Parameters
Header Parameters
Responses
200
Successful Response
object
Credits an app consumed in one calendar month. Mirrors UsageSummaryDto.
object
Everything deducted from list: the builder discount AND any hard-cap clamp. One compound number, not ‘the 25%’.
Undiscounted list total for the period. gross_credits - discount_credits == total_credits.
Credits per CLIENT org — whose data was touched, not who paid. The builder pays for all of them.
object
Net credits per operation id, so you can see which calls cost money.
object
Net credits per BILLING org, who pays. The mirror of per_client_credits, which is whose data was touched.
object
Calendar month, YYYY-MM.
422
Validation Error