| Required role: | SystemAdministrator |
| All Verbs | /ai/usage |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | query | string | No | Filter by account ID. If not specified will return entries for all customers in all accounts in the date range |
| CustomerId | query | string | No | Filter by customer ID. If not specified, will return all customers for the accounts considered |
| StartDate | query | string | No | The start of the date range to consider |
| EndDate | query | string | No | The end of the date range to consider |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountUsage | form | List<AIAccountUsage> | No | |
| CustomerUsage | form | List<AICustomerUsage> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | form | string | No | The account ID this customer belongs to |
| AIMinutes | form | int | No | The total number of AI minutes used in the date range |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountId | form | string | No | The account ID this customer belongs to |
| CustomerId | form | string | No | The customer ID for this uage |
| AIMinutes | form | int | No | The total number of AI minutes used in the date range |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ai/usage HTTP/1.1
Host: team.evovoice.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
accountId: String,
customerId: String,
startDate: String,
endDate: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
accountUsage:
[
{
accountId: String,
aiMinutes: 0
}
],
customerUsage:
[
{
accountId: String,
customerId: String,
aiMinutes: 0
}
]
}