Skip to main content
GET
/
businesses
/
{id}
/
segment_usage
Retrieve the segment usage for a business
curl --request GET \
  --url https://api.pocketflows.com/businesses/{id}/segment_usage \
  --header 'Authorization: Basic <encoded-value>'
{
  "sms": 123,
  "mms": 123,
  "email": 123,
  "start_time": "<string>",
  "end_time": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The 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

The segment usage for the business within the time window

​
sms
integer
required

The number of SMS segments sent

​
mms
integer
required

The number of MMS segments sent

​
email
integer
required

The number of email segments sent

​
start_time
string
required

The start time of the usage period in ISO 8601 format

​
end_time
string
required

The end time of the usage period in ISO 8601 format

⌘I