SYsynup
Reviews
Interactions

Fetch all interactions

This API retrieves interactions for a specific location, supporting multiple filters to refine results.

Filtering Options:

  • Date Range – Fetch interactions within a specified time frame.
  • Interaction Type – Filter by reviews, social engagements, or directory interactions.
  • Platform – Retrieve interactions from specific sources (e.g., Google, Facebook, Yelp).
  • Response Status – Show only responded or unresponded interactions.
  • Rating – Filter reviews by star ratings (if applicable).
  • Keyword – Filter reviews whose content matches a search keyword.
get/locations/{locationId}/reviews

Request

Path parameters

locationIdstring required

Base64 encoded location ID

Query parameters

siteUrlsstring[]

Filter by source websites

categorystring[]

Filter by interaction category

startDatestring date

Start date for filtering (YYYY-MM-DD)

endDatestring date

End date for filtering (YYYY-MM-DD)

ratingFiltersinteger[]

Filter by rating (1-5). Pass multiple values as an array. Example: [3,4]

searchStringstring

Filter interactions by keyword. Returns only interactions whose content matches the keyword. Example: pizza

beforestring

If specified, records after the cursor are returned

afterstring

If specified, records before the cursor are returned

firststring

Specifies the number of records to fetch from the beginning

laststring

Specifies the number of records to fetch from the end

Headers

Authorizationstring required

API key for authentication

Response

Interactions retrieved successfully

Changes

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