IN THIS ARTICLE:
From the Deliverability tab, you can check the client's performance in a given period of time. For more general information about it, check the article about what you can find in there here »
GET deliverability
To check the deliverability of your Agency account, use the following request:
GET https://api.woodpecker.co/rest/v2/agency/deliverability
Sample response:
{
"content": [{
"id": 123,
"name": "My super client",
"emails_sent": {
"current_period": 34039,
"previous_period": 12354
},
"delivered_emails": {
"current_period": 33198,
"previous_period": 11583
},
"views": {
"current_period": 30126,
"previous_period": 9724
},
"replies": {
"current_period": 20437,
"previous_period": 5346
},
"bounces": {
"current_period": 749,
"previous_period": 138
}
},
{
"id": 234,
"name": "The best client of all time",
"emails_sent": {
"current_period": 34039,
"previous_period": 12354
},
"delivered_emails": {
"current_period": 33198,
"previous_period": 11583
},
"views": {
"current_period": 30126,
"previous_period": 9724
},
"replies": {
"current_period": 20437,
"previous_period": 5346
},
"bounces": {
"current_period": 749,
"previous_period": 138
}
}
],
"pagination_data": {
"total_count": 1,
"pages_count": 1,
"current_page_number": 1,
"page_size": 20
}
}Response data type:
content - JSON object, includes the details of the response,
id - integer, company ID,
name - string, client's name,
emails_sent - JSON object, detailed information about the emails sent from the client,
current_period - number, stats from the current period,
previous_period - number, stats from the previous period,
delivered_emails - JSON object, stats about the delivered emails,
views - JSON object, views stats for the client,
replies - JSON object, replies stats for the client,
bounces - JSON object, bounced messages stats in a client,
pagination_data - JSON object, information about total elements available to check, total pages, etc.
We provide default statistics for the last 30 days if you don't specify a time range. Data is calculated according to the time zone set in the Settings. We can provide data starting from January 1st, 2021.
If you want to get more clients or go to another page, use one of the following requests:
GET /rest/v2/deliverability?page=2
GET /rest/v2/deliverability?per_page=50
Remember that you can have up to 50 clients shown in the response. By default, we return 20 after request.
Getting data for a specific time period
To check the data for a custom time period, use the following request:
GET /rest/v2/agency/deliverability?&from=2022-01-01&to=2022-06-30
To check the data for a specific time period, use the following request:
GET /rest/v2/agency/deliverability?period=all_time
Available period values:
all_time - the value of "previous_period" will be then returned as null
last_week
last_month - the last 30 days, not the previous month
last_year
Note:
Previous_period is the value calculated for the same date range counted backward.
For example, last_week on 08.01.2023, the data is as follows:
current_period - data for the last 7 days: 01-07.01.2023
previous period - data for even earlier 7 days: 25.12.2022-31.12.2022