Report API
Read-only reporting endpoints for email performance data: opens, clicks, attributed orders, reviews, and email delivery records. All endpoints require authentication.
All report endpoints support filtering and pagination and return the standard list envelope: { "items": [...], "search_criteria": {...}, "total_count": N }.
Opens
Records each time a recipient opens an email.
Open object
| Field | Type | Description |
|---|---|---|
open_id | Int | Unique identifier (read-only) |
trigger_id | Int | Trigger that sent the email |
queue_id | Int | Queue item that was opened |
session_id | String | Browser session identifier |
created_at | String | When the open was recorded |
List opens
GET /rest/V1/mst-email/report/opens
Get open
GET /rest/V1/mst-email/report/opens/:id
Clicks
Records each time a recipient clicks a link in an email.
Click object
| Field | Type | Description |
|---|---|---|
click_id | Int | Unique identifier (read-only) |
trigger_id | Int | Trigger that sent the email |
queue_id | Int | Queue item containing the link |
session_id | String | Browser session identifier |
created_at | String | When the click was recorded |
List clicks
GET /rest/V1/mst-email/report/clicks
Get click
GET /rest/V1/mst-email/report/clicks/:id
Orders
Records orders attributed to a Follow Up Email campaign.
Order object
| Field | Type | Description |
|---|---|---|
order_id | Int | Unique record identifier (read-only) |
trigger_id | Int | Trigger attributed with the order |
queue_id | Int | Queue item attributed with the order |
parent_id | Int | Magento order ID |
store_id | Int | Store view of the order |
amount | Float | Order revenue in store currency |
base_amount | Float | Order revenue in base currency |
created_at | String | When the attribution was recorded |
List orders
GET /rest/V1/mst-email/report/orders
Get order
GET /rest/V1/mst-email/report/orders/:id
Reviews
Records product reviews attributed to a Follow Up Email campaign.
Review object
| Field | Type | Description |
|---|---|---|
review_id | Int | Unique record identifier (read-only) |
trigger_id | Int | Trigger attributed with the review |
queue_id | Int | Queue item attributed with the review |
parent_id | Int | Magento review ID |
created_at | String | When the attribution was recorded |
List reviews
GET /rest/V1/mst-email/report/reviews
Get review
GET /rest/V1/mst-email/report/reviews/:id
Emails
Delivery records for every email sent by Follow Up Email.
Email object
| Field | Type | Description |
|---|---|---|
email_id | Int | Unique record identifier (read-only) |
trigger_id | Int | Trigger that sent the email |
queue_id | Int | Corresponding queue item |
created_at | String | When the delivery record was created |
List emails
GET /rest/V1/mst-email/report/emails
Get email
GET /rest/V1/mst-email/report/emails/:id
Example: campaign performance summary
To calculate open rate for a specific trigger, combine the report/emails and report/opens endpoints filtered by trigger_id:
GET /rest/V1/mst-email/report/emails
?searchCriteria[filter_groups][0][filters][0][field]=trigger_id
&searchCriteria[filter_groups][0][filters][0][value]=5
&searchCriteria[filter_groups][0][filters][0][condition_type]=eq
&searchCriteria[pageSize]=1
Read total_count from the response — that is the total emails sent. Repeat the same filter on report/opens to get the total opens. Divide to get the open rate.