Raw data

Use this request to return detailed data about every email sent from Yotpo including the email recipient, when the email was received, order information, delivery success or failure, when the email was opened, clicks, unsubscribe, etc.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

How to use this endpoint

  • For example responses, click the relevant status code on the right.
🚧

Note:

The since and until parameters always refer to sent emails, regardless of which metric was requested. Metrics are retrieved from emails which were sent within the date range defined.

For example, if you're requesting data on reviews within the date range of Jan 01 (since) - Jan 05 (until), note that while the review request emails were sent within the date range, the actual reviews may have only been created after Jan 05 (until).

Path Params
string
required
Defaults to Mandatory

The store ID

Query Params
string

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

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
Defaults to Last 30 days

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

date
Defaults to Last 30 days

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

string
Defaults to Descending

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

int32

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

int32

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

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json