cURL
curl --request GET \ --url https://api-{region}-{cluster}.benchmarkemail.com/api/reports/email/{id}/engagement \ --header 'X-API-Key: <api-key>'
{ "end": "2024-09-24T17:00:00.000Z", "histogram": [ { "date": "2024-09-23T17:00:00.000Z", "detail": { "uniqueClicks": 1, "uniqueOpens": 3 }, "total": 4 } ], "peak": { "endDate": "2024-09-23T17:00:00.000Z", "startDate": "2024-09-23T17:00:00.000Z", "total": 4 }, "start": "2024-09-23T17:00:00.000Z" }
API key authentication
email campaign identifier
The engage period criteria to generate the histogram.
24hours
week
month
The user timezone (IANA) code.
"America/La_Paz"
Successfully retrieved report
Campaign histogram details
"2024-09-24T17:00:00.000Z"
Show child attributes
"2024-09-23T17:00:00.000Z"