Get review stats over different time frames.

NB: This endpoint is currently not publicly accessible. Please reach out to your respective CSMs our account executive if you will like to use this API.

You can combine a number of filters known as tags to select specific reviews you will like to collect stats on.

Here is the list of supported tags:

• Channel: You can include reviews belonging to a single or group of channels to be aggregated for the stats.

• Event type (touchpoint): You can also filter out reviews based on the event type (touchpoint),

• Metadata properties: You can get the stats based on specific metadata properties that you added when creating an event.

NB: Besides metadata properties, all other keywords must be prefixed with the $ sign to denote that they are reserved keywords within the system eg: channel should be $channel and touchpoint $touchpoint.
Also, stats are collected for only approved reviews.

Example

To fetch the stats for reviews belonging to the channel chl-abc and chl-xyz at touchpoint checkout and a productCategory of shoes from the metadata your request payload will look something like the one below:

{
    "tags": [
    {
        "category": "$channel",
        "value": "chl-abc"
    },
    {
        "category": "$channel",
        "value": "chl-xyz"
    },
    {
        "category": "$touchpoint",
        "value": "checkout"
    },
    {
        "category": "productCategory",
        "value": "shoes"
    }
    ]
}