---
title: "Get Interaction Analytics"
method: GET
path: "/locations/{locationId}/{type}"
tags: ["Reviews", "Analytics"]
---

# Get Interaction Analytics

`GET /locations/{locationId}/{type}`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/locations/{locationId}/{type}`
- 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)

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.

## Path parameters

- `locationId` string, required
- `type` 'review-analytics-overview' | 'review-analytics-timeline' | 'review-analytics-sites-stats', required

## Query parameters

- `startDate` string, date
- `endDate` string, date

## Headers

- `Authorization` string, required

## Response `200`

Successfully retrieved analytics data

- object

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)