Get alerts
const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
end_date: '<string>',
sender_id: '<string>',
start_date: '<string>',
env_sender: '<string>',
env_sender_domain: '<string>',
ip_address: '<string>',
sub_account_filter: '<string>'
})
};
fetch('https://api.mailchannels.net/outbound/v1/alerts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.mailchannels.net/outbound/v1/alerts"
payload = {
"end_date": "<string>",
"sender_id": "<string>",
"start_date": "<string>",
"env_sender": "<string>",
"env_sender_domain": "<string>",
"ip_address": "<string>",
"sub_account_filter": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mailchannels.net/outbound/v1/alerts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'end_date' => '<string>',
'sender_id' => '<string>',
'start_date' => '<string>',
'env_sender' => '<string>',
'env_sender_domain' => '<string>',
'ip_address' => '<string>',
'sub_account_filter' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}curl --request POST \
--url https://api.mailchannels.net/outbound/v1/alerts \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"end_date": "<string>",
"sender_id": "<string>",
"start_date": "<string>",
"env_sender": "<string>",
"env_sender_domain": "<string>",
"ip_address": "<string>",
"sub_account_filter": "<string>"
}
'[
{
"auth_id": "<string>",
"condition": {
"description": "<string>",
"type": "<string>"
},
"condition_name": "<string>",
"envelope_sender": "<string>",
"ip_address": "<string>",
"parent": "<string>",
"sender_id": "<string>",
"timestamp": "<string>"
}
]{
"code": 123,
"errors": [
"<string>"
],
"message": "<string>"
}{
"code": 123,
"errors": [
"<string>"
],
"message": "<string>"
}Get alerts
Returns alerts that match the specified filters and date range.
POST
/
alerts
Get alerts
const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
end_date: '<string>',
sender_id: '<string>',
start_date: '<string>',
env_sender: '<string>',
env_sender_domain: '<string>',
ip_address: '<string>',
sub_account_filter: '<string>'
})
};
fetch('https://api.mailchannels.net/outbound/v1/alerts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.mailchannels.net/outbound/v1/alerts"
payload = {
"end_date": "<string>",
"sender_id": "<string>",
"start_date": "<string>",
"env_sender": "<string>",
"env_sender_domain": "<string>",
"ip_address": "<string>",
"sub_account_filter": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mailchannels.net/outbound/v1/alerts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'end_date' => '<string>',
'sender_id' => '<string>',
'start_date' => '<string>',
'env_sender' => '<string>',
'env_sender_domain' => '<string>',
'ip_address' => '<string>',
'sub_account_filter' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}curl --request POST \
--url https://api.mailchannels.net/outbound/v1/alerts \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"end_date": "<string>",
"sender_id": "<string>",
"start_date": "<string>",
"env_sender": "<string>",
"env_sender_domain": "<string>",
"ip_address": "<string>",
"sub_account_filter": "<string>"
}
'[
{
"auth_id": "<string>",
"condition": {
"description": "<string>",
"type": "<string>"
},
"condition_name": "<string>",
"envelope_sender": "<string>",
"ip_address": "<string>",
"parent": "<string>",
"sender_id": "<string>",
"timestamp": "<string>"
}
]{
"code": 123,
"errors": [
"<string>"
],
"message": "<string>"
}{
"code": 123,
"errors": [
"<string>"
],
"message": "<string>"
}Authorizations
Body
application/json
The end of the date range, including the UTC offset, for example 2026-09-02T00:00:00-0700.
The ID of the sender.
The start of the date range, including the UTC offset, for example 2026-09-01T00:00:00-0700.
Filter by condition name.
Available options:
SENDING_SPAM, INVALID_RECIPIENTS, POOR_DELIVERABILITY, SB01, SB02, STF, ESA, IP_VOLUME, IP_NDR_VOLUME, IP_ENV_SENDER, FBL_BLOCK_550 Filter by envelope sender.
Filter by envelope sender domain.
Filter by IP address.
Filter for sub-accounts.
Was this page helpful?

