Transactional Email
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
GET | |
GET | |
GET | |
GET | |
GET | |
GET |
List all transactional email log
List the project's transactional email sends, newest first. The log keeps sends for 30 days.
Required API key scopes
hog_flow:readperson:readQuery parameters
- date_fromstring
- date_tostring
- limitintegerDefault:
50 - offsetintegerDefault:
0 - reasonstring
- searchstring
- statusstringOne of:
"queued""failed""sent""delivered""bounced""complained" - workflow_idstring
Response
Example request
GET /api /projects /:project_id /transactional_email_logExample response
Status 200
Retrieve transactional email log
Get one send with its timeline: when it was queued, sent, delivered, opened and clicked.
Required API key scopes
hog_flow:readperson:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /transactional_email_log /:idExample response
Status 200
Status 404 No send of this project has this ID, or it is older than the log keeps.
Retrieve transactional email log activity
The recipient's events in the 7 days before and after one send, with the sessions they belong to.
Required API key scopes
hog_flow:readperson:readquery:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /transactional_email_log /:id /activityExample response
Status 200
Status 403 The user has no access to persons or to querying events.
Status 404 No send of this project has this ID, or it is older than the log keeps.
Retrieve transactional email log impact
Count one email's sends that were sent, delivered, opened and clicked. With an event, also count the clicked sends whose person did it within a week of the click, against delivered sends nobody clicked.
Required API key scopes
hog_flow:readquery:readQuery parameters
- date_fromstring
- date_tostring
- eventstring
- workflow_idstring
Response
Example request
GET /api /projects /:project_id /transactional_email_log /impactExample response
Status 200
Status 403 The personal API key or OAuth token lacks the `hog_flow:read` or `query:read` scope, the user has no access to workflows in this project, or an event was named and the user has no access to querying events.
Status 404 The project has no such workflow, or the user may not view it.
Retrieve transactional email log results
Of the people a transactional email was sent to, count those who did an event within a window after their first send, and add up the revenue on those events.
Required API key scopes
hog_flow:readquery:readQuery parameters
- date_fromstring
- date_tostring
- eventstring
- revenue_propertystring
- window_daysintegerDefault:
7 - workflow_idstring
Response
Example request
GET /api /projects /:project_id /transactional_email_log /resultsExample response
Status 200
Status 403 The personal API key or OAuth token lacks the `hog_flow:read` or `query:read` scope, or the user has no access to workflows in this project or to querying events.
Status 404 The project has no such workflow, or the user may not view it.
Retrieve transactional email log stats
Count sends by delivery status, opens and clicks, per template or per sending domain.
Required API key scopes
hog_flow:readQuery parameters
- date_fromstring
- date_tostring
- group_bystringDefault:
templateOne of:"template""sending_domain"
Response
Example request
GET /api /projects /:project_id /transactional_email_log /statsExample response
Status 200
Retrieve transactional email log stats over time
Count sends by delivery status per time bucket, with totals for the period before.
Required API key scopes
hog_flow:readQuery parameters
- date_fromstring
- date_tostring
Response
Example request
GET /api /projects /:project_id /transactional_email_log /stats_over_time




