younifyd
Menu

Summary

Overview

GET/analytics/v1/emails/{app_key}&date_range.since=2017-07-01&date_range.until=2017-08-20

Use it in a workflow

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

Request

Path parameters

app_keystringrequired

The store ID

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.

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.

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`

sincestring (date)

Retrieve email analytics until 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"

group_bystring

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

Response

Returns 200 with an object. Read it in later steps with {{summary.response.data.<field>}}.

valuesobject
all_emailsobject1 fields
json
{
  "values": {
    "all_emails": {
      "values": {
        "answers_from_emails": 1,
        "arrived_early": 0,
        "click_throughs": 0,
        "emails_failed": 1,
        "emails_opened": 5,
        "emails_sent": 10,
        "invalid_address": 1,
        "marked_spam": 0,
        "reviews_from_emails": 3,
        "unsubscribed": 0
      }
    }
  }
}

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