Text request usage

See how many text requests each location plan has used. Use this to watch usage or show it to a business. Returns one row per location plan with its text request count (paginated); allowances and overage aren't included. With a Partner token, pass the account's company_id, otherwise the list is empty.

Prerequisites: a bearer token; with a Partner token, the account's company_id.

Authentication: Partner or Account token. company_id and store_id must be inside your own account tree (otherwise 422). Without company_id the rows are for your own account, so a Partner token must pass an account's company_id.

Rate limit: 120 requests per minute, counted per user (the token’s user).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 5994

The account to report on. Must be inside your account tree. Default: the account of the user behind the token.

integer
Defaults to 3007

Only this location. Must be inside your account tree.

string
enum
Defaults to store_plan_status

The field to search, used with search_value: store_name (also matches your location reference and client location id), account_name, store_plan_status, store_plan_end (a date) or store_plan_id. Other values are ignored.

Allowed:
string
Defaults to active

The value to search for, without < or >. Names match part of the value; the other fields must match exactly.

string
enum
Defaults to store_name

The field to sort by: account_name, store_name, store_plan_id, store_plan_status, store_plan_end, sms_sent_count. Other values fall back to the location name.

Allowed:
string
enum
Defaults to asc

asc or desc (either case). Default asc.

Allowed:
integer
≥ 1
Defaults to 1

The page to return, from 1. Default 1.

integer
≤ 100
Defaults to 20

Rows per page, 10–100. Default 20. Values below 10 are raised to 10; above 100 returns 422.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json