suppressions
Get Suppressions Data
Get Suppressions Data
get/suppressions
Query parameters
pageinteger nullable
Page number. Must be an integer greater than 0.
Example:1
Page number
limitinteger nullable
The number of rows per page to return. Must be an integer greater than 0.
Example:10
The numbers of rows per page to return
fromstring date required
Start date
Example:2020-01-01
Start date (format YYYY-MM-DD). Must be less than or equal to the 'to' parameter.
tostring date required
End date
Example:2025-12-31
End date (format YYYY-MM-DD). Must be greater than or equal to the 'from' parameter.
tzstring
Timezone Offset
Example:-07:00
Timezone Offset
filterstring
Query to search
Text to search (recipient, sender, email subject or reason for suppression)
filter_bySuppressionSource[]
Filter by
smart_searchboolean nullable
Smart search
Smart search
orderby'date' | 'source' | 'recipient' | 'reason'
Field to sort by
Example:date
ordertype'asc' | 'desc'
Order Ascending or Descending.
Example:desc
Response
Sucess
Get Filtered Suppressions Data.
Example response
{
"count": 5,
"results": [
{
"date": "2021-03-17 00:00:00",
"sender": "andrea@emailchef.com",
"source": "bounce",
"subject": "Newsletter - September 2022",
"recipient": "bounce1@turbo-smtp.com",
"reason": "550 Error"
},
{
"date": "2021-03-15 00:00:00",
"sender": "alberto@emailchef.com",
"source": "manual",
"subject": "",
"recipient": "bounce2@turbo-smtp.com",
"reason": "manual inserted"
},
{
"date": "2021-03-14 00:00:00",
"sender": "alberto@emailchef.com",
"source": "spam",
"subject": "Newsletter - September 2022",
"recipient": "topolino@turbo-smtp.com",
"reason": "spam complaint"
},
{
"date": "2021-03-14 00:00:00",
"sender": "alberto@emailchef.com",
"source": "unsubscribe",
"subject": "Newsletter - September 2022",
"recipient": "pippo@turbo-smtp.com",
"reason": "unsubscribe from list pippo"
},
{
"date": "2021-03-13 00:00:00",
"sender": "alberto@emailchef.com",
"source": "validation_failed",
"subject": "Newsletter - September 2022",
"recipient": "minnie@turbo-smtp.com",
"reason": "validation failed last import"
}
]
}