younifyd
Menu

Raw Data

Raw data

GET/analytics/v1/emails/{app_key}/export/raw_data

Use it in a workflow

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

Request

Path parameters

app_keystringrequired

The store ID

Default "Mandatory"

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 raw data since and including this date (Default: Last 30 days). Note: `until` is required when using this param.

Default "Last 30 days"

untilstring (date)

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

Default "Last 30 days"

sortstring

Sort by Ascending (oldest first by sent date) or Descending (newest first by sent date)

Default "Descending"

pageinteger (int32)

Return page number from paginated response. Must be an integer greater than zero.

per_pageinteger (int32)

The number of items to return in one paginated page. Must be an integer between 1 and 1,000

Response

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

recordsarray<object>
email_addressstring
order_idany
order_timestampany
product_idany
skuany
email_typestring
reminder_numany
trr_bundle_idstring
trr_bundle_subjectstring
review_typestring
coupon_codeany
email_sent_timestampstring
opened_timestampstring
clicked_through_timestampany
content_creation_timestampstring
platformstring
invalid_address_timestampany
failed_timestampany
unsubscribed_timestampany
marked_spam_timestampany
arrived_early_timestampany
json
{
  "records": [
    {
      "email_address": "max@greatstore.net",
      "order_id": null,
      "order_timestamp": null,
      "product_id": null,
      "sku": null,
      "email_type": "targeted_site_review_request",
      "reminder_num": null,
      "trr_bundle_id": "4b010d38-c3e3-4a35-84c9-7f25cef05a7d",
      "trr_bundle_subject": "{store_name} - We would love to hear your thoughts",
      "review_type": "site",
      "coupon_code": null,
      "email_sent_timestamp": "2017-09-19T15:45:30.000Z"
    }
  ]
}

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