Return stats for email campaigns
Endpoint: /reports/emailActivityMetrics
HTTP method: GET
URL: https://e1.envoke.com/v1/reports/emailActivityMetrics
Get a list of sent email campaigns. The fields returned are "message_id", "message_name", "subject", "sends", "opens", "clicks", "bounces", "revoked_consent".
Automated messages are included in the results.
There's a hardcoded cap on the results size at 100 records. You can use "page" to get additional results:
https://e1.envoke.com/v1/reports/emailActivityMetrics.csv?limit=100&page=2
NOTE: All examples below are formatted for readability, actual GET requests require URI encoding. Each example below also includes a cURL request. Make sure to change the API_ID and API_KEY with your values.
Return stats by message ID
https://e1.envoke.com/v1/reports/emailActivityMetrics?message_id=MESSAGE_ID
curl -X GET -u API_ID:API_KEY "https://e1.envoke.com/v1/reports/emailActivityMetrics?message_id=MESSAGE_ID"
You can filter for multiple messages using array format.
message_id[]=MESSAGE_ID_1&message_id[]=MESSAGE_ID_2
Return stats by date range
The parameters start_date and end_date must by in YYYY-MM-DD format.
https://e1.envoke.com/v1/reports/emailActivityMetrics?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD
curl -X GET -u API_ID:API_KEY "https://e1.envoke.com/v1/reports/emailActivityMetrics?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD"
Return stats by recipient list
The parameter segment can be used to return messages sent to a tag or segment. The required value is pipe separated: iid| for tags, fid| for segments.
For tags use the format: iid|TAG_ID
For segments use the format: fid|SEGMENT_ID
https://e1.envoke.com/v1/reports/emailActivityMetrics?segment=iid|TAG_ID
curl -X GET -u API_ID:API_KEY "https://e1.envoke.com/v1/reports/emailActivityMetrics?segment=iid|TAG_ID"
Return data as CSV
By default data is returned as JSON. Change the format to ".csv" to return as comma separated values.
This example includes the limit parameter.
https://e1.envoke.com/v1/reports/emailActivityMetrics.csv?limit=1
curl -X GET -u API_ID:API_KEY "https://e1.envoke.com/v1/reports/emailActivityMetrics.csv?limit=1"