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.

get/locations/{locationId}/{type}

Request

Base URL
https://api.synup.com/api/v4
Auth
none required
TypeScript
https://skmtc.dev/synup/apis/synup-api/docs/locations/:locationId/:type/get.ts
A function with typed inputs. Its response is checked against the schema.

locationIdstring required

Base64 encoded location ID (e.g., TG9jYXRpb246MTA1NTk0Nw==)

type'review-analytics-overview' | 'review-analytics-timeline' | 'review-analytics-sites-stats' required

Type of analytics data to retrieve

startDatestring date

Required for timeline analytics. Format YYYY-MM-DD

endDatestring date

Required for timeline analytics. Format YYYY-MM-DD

Authorizationstring required

API key for authentication

Successfully retrieved analytics data

object required

No recorded changes to this operation across all 1 revision of this API.