Returns a collection of usage data aggregated by month.

get

https://api.talkdeskapp.com/express/usage/month

All the usage data will be returned for the accounts under the organization. The data is aggegated by month for each product. A 403 error is returned if the specified accounts are not under the organization performing the call. The results are paged.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

express-accounts-usage:read

Query Params

page

integer

≥ 1

Defaults to 1

The number of the page to be returned. The default value is 1.

per_page

integer

1 to 250

Defaults to 50

The number of results to be returned per page. The default value is 50.

filter

string

length ≤ 1600

Allows filtering the results by 'account_id' or 'month' using comparison or logical operators. Examples:

Returns the data for a specific account

accound_id eq '5ea75fe7aa224700012eae40'

Returns the data for a set of given accounts

account_id eq '5ea75fe7aa224700012eae40' or account_id eq '4ae75fe7aa224700012eae29'

Returns the data for a given account and specific month

(month eq '2003-12' and account_id eq '5ea75fe7aa224700012eae40')

order_by

string

length ≤ 40

Defaults to id:desc

Allows ordering the results by 'id'

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Scope

200successful operation

400Bad Request

401Unauthorized

403This caller is not authorized to query the given accounts. The accounts specified are not under the organization owning the current authentication token.