Get Interaction Analytics

GET

https://api.synup.com/api/v4/locations/{locationId}/{type}

This API retrieves interaction analytics data based on the requested analytics type.

Available Analytics Types:

review-analytics-overview – Provides overall statistics, including total interactions, average ratings, and response rates.

review-analytics-timeline – Returns time-based analytics, showing interaction trends over a selected period.

review-analytics-sites-stats – Provides site-wise breakdown, showing performance across platforms like Google, Facebook, and Yelp.

Request

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.synup.com/api/v4/locations//?startDate&endDate' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx'

Responses

🟢200OK

application/json

Successfully retrieved analytics data

Body

Examples

Overall Analytics StatsAnalytics TimelineSite-wise Analytics

{
    "data": {
        "interactionsAnalyticsStats": {
            "stats": [
                {
                    "name": "total-reviews",
                    "value": 24575,
                    "delta": 100
                },
                {
                    "name": "new-reviews",
                    "value": 24575,
                    "delta": 100
                },
                {
                    "name": "overall-rating",
                    "value": 1.628321464903357,
                    "delta": 100
                },
                {
                    "name": "review-response-rate",
                    "value": 0.10579857578840285,
                    "delta": 100
                }
            ]
        }
    }
}

Modified at 2025-07-21 06:48:31

Archive Response for Interaction

Add Review Widget