younifyd
Menu

Email Analytics

Email analytics

GET/analytics/v1/emails/{app_key}/{metric_name}

Use it in a workflow

  1. Add a step and choose the Yotpo connector.
  2. Pick the Email Analytics action (under Reviews & Ratings).
  3. Fill in the fields below, then reference the result from later steps as {{emailAnalytics.response.data}}.

Request

Path parameters

app_keystringrequired

The store ID

metric_namestringrequired

Supports one metric per request. Choose a metric from the table of [Email Analytics Metrics](http://apidocs.yotpo.com/reference#section-email-analytics-metrics)

Query parameters

tokenstringrequired

Your Yotpo account access token. See [Yotpo Authentication](https://apidocs.yotpo.com/reference#yotpo-authentication) to learn how to generate your utoken.

sincestring (date)

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

Default "Last 30 days"

untilstring (date)

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

Default "Last 30 days"

date_bucketstring (date)

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

Default "Month"

reminder_numinteger (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`

Default 2

email_typestring

Choose one `email_type` value from the table of [Supported Email Types](https://apidocs.yotpo.com/reference/about-analytics#supported-email-types) or exclude this parameter to retrieve data for all emails.

Default "All email types supported for this metric"

group_bystring

Returns itemized grouped data. Choose a `group_by` value from [this table](http://apidocs.yotpo.com/reference#section-group-by)

Default "email_type"

Response

Returns 200 with a oneOf. Read it in later steps with {{emailAnalytics.response.data.<field>}}.

Need more? See the Yotpo guide for connection setup and behaviour shared by every action.