Get Spend Users Table
GET
/metering-service/api/v2/organizations/{organization_id}/spend/users
A user's limit only makes sense for a whole billing period, so in date-range mode
limit_amount, pct_used, status and blocked_reason come back null, and has_open_increase_request comes back false.Only Organization admin can call this endpoint.
billing_period, or nothing at all, to report over a single calendar month.start_date and end_date together to report over an explicit span of days.organization_id: The Ejento AI organization ID.billing_period: Defines the billing period in YYYY-MM format. Defaults to the current month.start_date, end_date: Define the inclusive bounds of a date range in YYYY-MM-DD format. Both are always supplied together, in place of billing_period. Supplying a period and a range together, an end date earlier than its start, or a range longer than 92 days each return a 400.sort_by: Chooses the field that orders the results: spend or total_tokens. Prefix it with - for descending. Defaults to -spend, which puts the biggest spender first. Any other value is refused with a 400.query: Narrows the list to users whose name or email contains this text. Names are looked up live, so a search that matches nothing returns an empty list.paginated: Chooses whether the response carries the whole result set or a single page. Defaults to false, which returns everything and leaves meta null.page: Selects which page to return. It applies only when paginated is true.items_per_page: Sets how many users each page carries, from 1 to 100. It applies only when paginated is true.items, with collection metadata under meta, in a success envelope.Request
Path Params
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff 'https:///metering-service/api/v2/organizations//spend/users?billing_period=undefined&start_date=undefined&end_date=undefined&paginated=undefined&page=undefined&items_per_page=undefined&sort_by=undefined&query=undefined' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer 'Response Response Example
200 - Example 1
{
"success": true,
"message": "string",
"data": {
"items": [
{
"user_id": 0,
"first_name": "string",
"last_name": "string",
"email": "string",
"spend": "string",
"total_tokens": 0,
"sessions": 0,
"limit_amount": "string",
"pct_used": 0,
"status": "ACTIVE",
"blocked_reason": "USER_LIMIT",
"has_open_increase_request": true,
"avg_spend_per_session": "string"
}
],
"meta": {
"billing_period": "string",
"count": 0,
"truncated": true,
"current_page": 0,
"num_pages": 0,
"start_date": "2019-08-24",
"end_date": "2019-08-24"
}
}
}