Aggregations

Aggregate data based on dimensions and measures from a specified source such as campaigns or flows. The data for each store is available from the Yotpo account creation date.

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

Suggested Filters

You can use Filters to get specific dimension value, for example:
source_type=campaign, channel_type=email

🚧

Important:

The data via API is returned on an hourly basis and in UTC. The data on the Yotpo admin is shown in EST.

It is recommended to convert to EST and sum up the data for each day. Don't use the date aggregation since it won't match between the UTC and EST - always convert and then sum up the hours.

To learn more about how to query a range of dates in the aggregation API you can look here.

Example

Below is an example of a request that can be sent.

https://developers.yotpo.com/messaging/v3/stores/{store_id}/analytics/query/aggregations?dimensions[]=channel_type&dimensions[]=source_type&dimensions[]=source_name&filters[]=source_type=campaign&dimensions[]=source_id&dimensions[]=aggregation_date&measures[]=all_sent&measures[]=all_delivered&measures[]=all_open&measures[]=all_unique_open&measures[]=opened_delivered_rate&measures[]=unique_opened_delivered_rate&measures[]=all_clicks&measures[]=all_unique_clicks&measures[]=click_through_rate&measures[]=unique_click_through_rate&measures[]=all_orders&measures[]=all_revenue&measures[]=all_unsubscribed&measures[]=unsubscribe_rate&measures[]=average_order_value
Path Params
string
required

The store ID (app_key)

Query Params
string
required

Your Yotpo access token. Click here to learn how to generate one

dimensions[]
array of strings
required

Retrieve required qualitative values, such as marketing channel (SMS or email), aggregation date, etc.

dimensions[]*
measures[]
array of strings
required

Retrieve required quantitive values, such as how many messages were sent, or how much revenue was earned

measures[]*
filters[]
array of strings

Filter results by a dimension or measure

filters[]
string

Sort results by a dimension or measure

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json