Overview

get

https://api.yotpo.com/analytics/v1/emails/{store_id}

View a summary of all metrics as an itemized list for a specified email type. Data can be segmented by email type and grouped by various metrics.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

store_id

string

required

The store ID

Query Params

token

string

required

Your Yotpo account access token. See Yotpo Authentication to learn how to generate your access token.

email_type

string

Choose one email_type value from the table of Supported Email Types or exclude this parameter to retrieve data for all emails.

reminder_num

int32

The number of the MAP reminder email. Must be an integer greater than zero and can only be used when the email type is product_reminder or site_reminder

date_range.since

date

Defaults to Last 30 days

Retrieve email analytics until and including this date (Default: Last 30 days). Note: until is required when using this param.

ate_range.until

date

Defaults to Last 30 days

Retrieve email analytics until and including this date (Default: Last 30 days). Note: since is required when using this param.

group_by

string

Returns itemized grouped data. Choose a group_by value from this table

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400