Sign in
Segment usage

Retrieve the segment usage for a business

get/businesses/{id}/segment_usage

Path parameters

idstring required

The ID of the business

Query parameters

start_timestring

The start time of the usage period. Provided as a string in ISO 8601 format.

end_timestring

The end time of the usage period. Provided as a string in ISO 8601 format.

Response

The segment usage for the business within the time window

smsinteger required

The number of SMS segments sent

mmsinteger required

The number of MMS segments sent

emailinteger required

The number of email segments sent

start_timestring required

The start time of the usage period in ISO 8601 format

end_timestring required

The end time of the usage period in ISO 8601 format

Changes