Email analytics

get

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

Retrieve aggregated data for email metrics based on the defined email type value and group data by metrics.

Path Params

store_id

string

required

The store ID

metric_name

string

required

Supports one metric per request. Choose a metric from the table of Email Analytics Metrics

Query Params

token

string

required

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

since

date

Defaults to Last 30 days

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

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.

date_bucket

date

Defaults to Month

Retrieve dates by date_bucket. Values can be day, month, or year. Default=month

reminder_num

int32

Defaults to 2

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

email_type

string

Defaults to All email types supported for this metric

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

group_by

string

Defaults to email_type

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

Response

Language

Credentials

Header

Request

Response

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

application/json

200200