GETapi.synup.com/api/v4/locations/{locationId}/{type}

Get Interaction Analytics

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.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Path

Name	Type	Required	Description
`locationId`	string	required	Base64 encoded location ID (e.g., TG9jYXRpb246MTA1NTk0Nw==)
`type`	string	required	Type of analytics data to retrieve

Query

Name	Type	Required	Description
`startDate`	string	optional	Required for timeline analytics. Format YYYY-MM-DD
`endDate`	string	optional	Required for timeline analytics. Format YYYY-MM-DD

Request

curl -X GET 'https://api.synup.com/api/v4/locations/:locationId/:type?startDate=&endDate=' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const res = await fetch('https://api.synup.com/api/v4/locations/:locationId/:type?startDate=&endDate=', {
  method: 'GET',
  headers: {
    Authorization: 'API YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
});
const data = await res.json();

import requests
res = requests.get(
    "https://api.synup.com/api/v4/locations/:locationId/:type?startDate=&endDate=",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = res.json()

req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/locations/:locationId/:type?startDate=&endDate=", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

res, err := http.DefaultClient.Do(req)

Responses

Status	Description
`200`	Successfully retrieved analytics data

Example response (generated from the schema)

{}