General

Overview

The Basic API will allow you to query for review data for every business associated with your account(s). By using this API, you will be able to:

Update businesses about new reviews
Display aggregated review content
Display analytics on a dashboard
Report account level, group level, or individual business data

1631 — An example of high-level data that can be displayed with Reply Pro's API

Reply Pro API Resources

The Reply Pro API has 6 endpoints.

End Point	Description
Accounts	An account is the highest-level container for your companies.
Businesses	A business is a single location that is associated to it's own unique social profiles.
Company	A company is a container for multiple businesses.
Groups	Groups are a smaller container for businesses within a single company.
Reviews	Review data associated to a specific business.
Suggested Actions	Handles retrieving and updating Suggested Actions, e.g suggested responses, flags, or shares.

Return Keys

When making requests to our api, the response object will contain basic keys to access the data returned:

Keys	Description
results	A list of objects returned by the endpoint
next	If pagination is needed due to a large list this will contain the pagination link for the set of data following the current set in the list. If the list is not large enough to need pagination this value will be null.
previous	If pagination is used this will be a pagination link for the set of data before the current page. If the current page is the first page in the list this value will be null.

Keys

Description

results

A list of objects returned by the endpoint

If pagination is needed due to a large list this will contain the pagination link for the set of data following the current set in the list.

If the list is not large enough to need pagination this value will be null.

If pagination is used this will be a pagination link for the set of data before the current page.

If the current page is the first page in the list this value will be null.

Filters

All of our endpoints support filtering. The table below provides detail on what filter parameters are supported by each endpoint.

End Point	Optional Filters
Accounts	name, start_id, end_id
Businesses	name, locality, address, start_id, end_id, remote_id
Groups	name, start_id, end_id, remote_id
Profiles	address, address_exact, claimed, data_source, end_id, name, name_exact, phone, start_id
Reviews	data_source, rating, start_rating, end_rating, start_date (YYYY-MM-DD), end_date (YYYY-MM-DD), exact_date(YYYY-MM-DD), start_id, end_id
Suggested Actions	original_content, data_source, review, end_id, start_id

Each filter operates as a contains query with case insensitivity. Providing multiple queries together will act as a logic AND, returning only entries that match both query parameters.

Example request to the review endpoint:

https://ad1.replypro.io/api/public/account/<id>/companies/<id>/businesses/<id>/reviews?data_source=Google&rating=4&start_date=2017-11-01&end_date=2017-11-08