Skip to main content
POST
Get sender profile

Authorizations

X-API-KEY
string
header
required

Body

application/json

The sender ID, date range, and time interval for the profile.

end_date
string
required

The end of the date range, for example 2026-09-02T00:00:00. Must be on or after start_date.

senderid
string
required

The sender ID to retrieve a profile for.

start_date
string
required

The start of the date range, for example 2026-09-01T00:00:00. Must be on or before end_date.

interval
enum<string>

The time interval used to group message counts. Defaults to days.

Available options:
days,
hours,
weeks
timezoneoffset
string
default:+0000

Timezone offset.

Response

Successful response.

counts
object
required
policyDisposition
string
required

The policy disposition result for the provided sender ID.