Skip to main content
GET
/
metrics
/
senders
/
{sender_type}
Retrieve Sender Metrics
curl --request GET \
  --url https://api.mailchannels.net/tx/v1/metrics/senders/{sender_type} \
  --header 'X-Api-Key: <x-api-key>'
{
  "limit": 123,
  "offset": 123,
  "senders": [
    {
      "bounced": 1,
      "delivered": 1,
      "dropped": 1,
      "name": "<string>",
      "processed": 1
    }
  ],
  "total": 123,
  "end_time": "2023-11-07T05:31:56Z",
  "start_time": "2023-11-07T05:31:56Z"
}

Headers

​
X-Api-Key
string
required

Path Parameters

​
sender_type
enum<string>
required
Available options:
campaigns,
sub-accounts

Query Parameters

​
start_time
string

The beginning of the time range for retrieving top senders metrics (inclusive). Formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ Defaults to one month ago if not provided.

​
end_time
string

The end of the time range for retrieving top senders metrics (exclusive). Formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ Defaults to the current time if not provided.

​
limit
integer
default:10

The maximum number of senders to return The default is 10.

Required range: 1 <= x <= 1000
​
offset
integer
default:0

The number of senders to skip before returning results.

Required range: x >= 0
​
sort_order
enum<string>
default:desc

The order in which to sort the results, based on total messages (processed + dropped).

Available options:
asc,
desc

Response

Successfully retrieved top senders metrics

​
limit
integer
required
​
offset
integer
required
​
senders
object[]
required
​
total
integer
required

The total number of senders in this category that sent messages in the given time range.

​
end_time
string<date-time>
​
start_time
string<date-time>