cURL
curl --request GET \ --url https://api-{region}-{cluster}.benchmarkemail.com/api/reports/dashboard \ --header 'X-API-Key: <api-key>'
{ "campaign": { "delivered": { "count": 2203, "diff": 11.3 }, "sent": { "count": 2379, "diff": 0.76 }, "uniqueClicks": { "count": { "diff": -21.52, "value": 569 }, "rate": { "diff": 20.47, "value": 25.83 } }, "uniqueOpens": { "count": { "diff": -23.41, "value": 733 }, "rate": { "diff": -22.41, "value": 33.27 } } }, "contact": { "count": { "diff": 29.55, "value": 5900 }, "histogram": { "end": "2024-10-29T00:00:00.000Z", "histogram": [ { "date": "2024-09-23T17:00:00.000Z", "total": 4 } ], "peak": { "date": "2024-09-23T17:00:00.000Z", "total": 4 }, "start": "2024-09-29T00:00:00.000Z" } } }
API key authentication
The number of past days (between 1 and 90) to retrieve report stats and precedent stats.
1 <= x <= 90
The user timezone (IANA) code.
"America/La_Paz"
Successfully report retrieved
campaign reports
Show child attributes