Businesses
Retrieve the segment usage for a business
GET
/
businesses
/
{id}
/
segment_usage
Defaults to the last 30 days. Can specify start_time
and end_time
for a specific time range
Authorizations
Authorization
string
headerrequiredBasic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
id
string
requiredThe ID of the business
Query Parameters
start_time
string
The start time of the usage period. Provided as a string in ISO 8601 format.
end_time
string
The end time of the usage period. Provided as a string in ISO 8601 format.
Response
200 - application/json
sms
integer
requiredThe number of SMS segments sent
email
integer
requiredThe number of email segments sent
start_time
string
requiredThe start time of the usage period in ISO 8601 format
end_time
string
requiredThe end time of the usage period in ISO 8601 format