Retrieve the segment usage for a business

GET

businesses

{id}

segment_usage

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>"
}

Defaults to the last 30 days. Can specify start_time and end_time for a specific time range

Authorization

string

header

required

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

string

required

The ID of the business

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.

200 - application/json

The segment usage for the business within the time window

The response is of type object.

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>"
}