Email analytics endpoints allow you to retrieve data on review request emails, reminder emails, coupons, comments, and other correspondences sent through the Yotpo system. Receive analytics on emails sent, read, and bounced as well as content generated through emails, click through rate from emails, and more. Retrieve analytics data as raw or grouped data for the data range specified and export data as a .csv file.
The tables below contain the email analytics metric types and supported email types.
Use these values for the metric_name and email_type parameters.
Note:
The
sinceanduntilparameters always refer to sent emails, regardless of which metric was requested. Metrics are retrieved from emails which were sent within the date range defined.For example, if you're requesting data on reviews within the date range of Jan 01 (
since) - Jan 05 (until), note that while the review request emails were sent within the date range, the actual reviews may have only been created after Jan 05 (until).
Email analytics metrics
Use the metric names listed below to retrieve aggregated email analytics data.
Metric names are path parameters which describe the aggregated metric you'll receive in the response. Use one metric per request.
Note:
Each metric supports all parameters with the exception of
answers_from_emailswhich only supports the date rangesince/untilanddate_bucketparameters.Each metric supports all email types with the exception of
reviews_from_emailswhich does not support:answer_request,comment_notification,answer_notification,coupon_email,coupon_reminder,coupons_and_notifications
Use the metrics listed below for the metric_name parameter for the following endpoints:
| Metric Name | Description |
|---|---|
emails_sent | The sum of all emails sent through Yotpo. |
emails_opened | The sum of emails opened out of emails_sent |
reviews_from_emails | The sum of reviews out of emails_sentSupports all email types except: answer_requestcomment_notificationanswer_notificationcoupon_emailcoupon_remindercoupons_and_notifications |
answers_from_emails | The sum of answers out of emails_sentAn 'Answer Request' is a request to provide an answer to a question. |
click_throughs | The sum of clicks which drive customers from the email to the website. e.g. clicking on the product page link |
invalid_address | The sum of hard bounces. A hard bounce might occur because the email address is invalid or because the recipient is unknown. |
emails_failed | The sum of emails which were not delivered for reasons other than a hard bounce. |
arrived_early | The sum of unique users that clicked on "Did not receive the product" within the email. |
marked_spam | The sum of unique users that clicked on "Mark as spam" within the email. |
unsubscribed | The sum of unique users that clicked "unsubscribe" within the email. |
Supported email types
Use the email type values below for the email_type parameter for the following endpoints:
Tip:
To retrieve data for all email types sent through Yotpo, exclude
email_typefrom your request.
| Supported Email Types | Description |
|---|---|
all_review_emails | All review request emails sent. e.g. mail after purchase, reminder, targeted_review_request, mail_after_service, mail_after_invoice |
all_maps | All Mail After Purchase product and site review request emails including reminder emails. e.g. mail after purchase, reminder |
map | Mail After Purchase review request emails excluding reminder emails. Includes only the first email sent to a customer to request a site or product review. |
all_reminders | All reminder emails. Includes all emails sent to remind a customer about pending site or product review requests. |
reminder | A specific site or product review request reminder email. To target a specific reminder, the reminder email type should be accompanied by the reminder_num parameter.e.g. If there are 3 emails configured and you'd like to retrieve analytics for the second email reminder sent, request reminder_num: 2 |
all_product_map | All sent Mail After Purchase product review request emails including reminders. |
product_map | The first Mail After Purchase product review request email sent. |
all_product_reminders | All subsequent reminder emails sent for product reviews. e.g. If you have configured 3 emails to be sent (MAP +Reminder 1, Reminder 2) this value will return analytics for the two reminder emails. |
product_reminder | A specific product review request reminder email. To target a specific reminder, the reminder email type should be accompanied by the reminder_num parameter.e.g. If there are 3 emails configured and you'd like to retrieve analytics for the second email reminder sent, request reminder_num: 2 |
all_site_map | All mail after purchase requests for site review request emails including reminders. |
site_map | The first email sent after purchase to request site reviews. |
all_site_reminders | All subsequent reminder emails sent for site reviews. e.g. If you have configured 3 emails to be sent (MAP +Reminder 1, Reminder 2) this value will return analytics for the two reminder emails. |
site_reminder | A specific site review request reminder email. To target a specific reminder, the reminder email type should be accompanied by the reminder_num parameter.e.g. If there are 3 emails configured and you'd like to retrieve analytics for the second email reminder sent, request reminder_num: 2 |
targeted_review_request | All emails sent by .csv upload including site and product review requests. |
targeted_site_review_request | All site review request emails sent by .csv upload. |
targeted_product_review_request | All product review request emails sent by .csv upload. |
mail_after_service | The site review request email sent following a closed support ticket through Help Desk Integration. |
mail_after_invoice | The email sent due to the configuration of site review automation. |
answer_request | The answer request email sent to past shoppers. e.g. Ask a past shopper to answer a question asked on site. |
resend_map | A request to resend a review request email submitted through Moderation in the Yotpo Admin. |
comment_notification | Emails sent to notify reviewers that the merchant has made a comment on their review. |
answer_notification | Emails sent to notify shoppers that their question has been answered. |
coupon_email | Emails which include a coupon code sent to eligible customers or reviewers. |
coupon_reminder | A reminder email sent to coupon recipients which reminds them to use their coupon. |
coupons_and_notifications | All coupons including the initial coupon email as well as any coupon reminder emails. |
Group by
Use the grouping values below for the {group_by} parameter for the following endpoints:
| group_by | Description |
|---|---|
batch_subject | The subject of the CSV upload. * eg TRR |
email_type | The type of email from this list. |
reminder_num | The number of the MAP reminder email. Must be an integer greater than zero. |