Reviewr API

Introduction

The Reviewr API is designed to provide access to most common features in the Reviewr application. This API is a RESTful API, designed around our common data resources, and responding to JSON HTTP GET, POST, PUT, PATCH, and DELETE requests. This API can be used to automate the process of adding customer data to accounts, and to display reviews.

The Reviewr API is in Beta, with additional endpoints still expected to be added, in which backwards compatibility is not guaranteed. However, most of the endpoints are common resources so changes are more likely to be incremental and may not require changes.

Getting started
The reviewr.app API responds to standard HTTP, GET, POST, PUT, PATCH, and DELETE methods. These methods can be translated into the following activities:

GET – Read

POST – Create

PUT/PATCH – Update

DELETE – Destroy

Base URL

All API requests are made to the following URL: https://api.reviewr.app/api/v4

Obtaining API keys

Your API key is provided by support when requested.

Rate limits

The reviewr.app API does not generally impose rate limits, and that is subject to change.

Pagination

Sometimes, when calling our API, we have a lot of data to show you. In order to handle this massive amount of information efficiently, we allow our users to paginate through these results.

For instance, sending a GET request to https://api.reviewr.app/api/v4/profiles/:profile_id/reviews could return, in addition to the information you are expecting, a pagination hash indicating all the information you need for paginating.

To specify a different page to see more results, simply add the page parameter to your endpoint with the desired page number like so:

https://api.reviewr.app/api/v4/profiles/:profile_id/reviews?page=2

This will give you all the reviews from the following page, plus the paginations-information corresponding to the current pagination state.

{ "reviews": [ {...} ], "pagination": { "current_page": 1, "next_page": 2, "prev_page": null, "total_pages": 11, "total_count": 5260, "current_page_count" : 500 } }

Authentication
Reviewr authenticates your API requests using your account’s API key. If you do not include your key when making an API request, or use one that is incorrect or outdated, Reviewr returns an error.

Headers

All API requests require an API key, which should be stored in the request header:
- Authorization: YOUR-API-KEY
In addition to the Authorization header, all requests should include a Content-Type header set with value application/json.

Error handling
The Reviewr API returns HTTP response status codes indicating the success or failure of your API requests. If your request fails, Reviewr returns an error with a relevant status code.

In general, there are three status code ranges you can expect:
- 2xx success status codes confirm that your request worked as expected
- 4xx error status codes indicate an error because of the information provided (e.g., a required parameter was omitted)
- 5xx error status codes indicate an error with Reviewr’ servers

Endpoints
Reviews

Reviews are collected by Reviewr from sources that are provided through your account.
Get Reviews

Description

Get all Reviews.

Path

/profiles/{profile_id}/reviews/

Params

Name Type Description

profile_id String

Request

Request

GET https://api.reviewr.app/api/v4/profiles/a4d9b349-a318-47bf-99ce-a79c469fd878/reviews/

CURL

curl https://api.reviewr.app/api/v4/profiles/a4d9b349-a318-47bf-99ce-a79c469fd878/reviews/ -H "Authorization: API-KEY"

Response

Response code <200>

{
“reviews": [
{
“id": “174c2425-f462-4b6e-9d9e-879db583cca5",
“unique_id": “116214088871125344044",
“category": “google",
“date": “2020-01-01T11:45:20.000-06:00",
“rating": 4.0,
“attribution": “Stephen Hinson",
“title": null,
“content": “Excellent service from scheduling, convenience and the result. A bit pricey but that’s what you pay for ease and outcome.",
“url": “http://search.google.com/local/writereview?placeid=ChIJlSIb2ZRmZIgRShYHsUPW-NU",
“created_at": “2020-01-08T11:45:25.541-06:00"
},
{
“id": “22ca4d58-8f40-4f17-a94e-e2c46e873423",
“unique_id": “108467467483720766165",
“category": “google",
“date": “2019-12-18T11:45:20.000-06:00",
“rating": 5.0,
“attribution": “Rob Ruzicka",
“title": null,
“content": “I have been using Aussie Pet Mobile since 2010 and have really been satisfied with their services and groomers. Sebastian stresses out riding in the car so having them come to my place works out really well. They def aren't the most reasonable but when it comes to Sebastian and how they care for him it;s totally worth every penny. Sebastian loved his former groomer Rachelle at Aussie but she moved away. Now his new groomer Lauren is awesome and I am glad he feels comfortable with her giving him a stress free haircut and bath. Def give them a try when you want the very best for you cat or dog!",
“url": “http://search.google.com/local/writereview?placeid=ChIJlSIb2ZRmZIgRShYHsUPW-NU",
“created_at": “2020-01-08T11:45:25.578-06:00"
},
{
“id": “11d5d3b2-91ca-4554-99e9-a3fea0e16240",
“unique_id": “108645385002145733315",
“category": “google",
“date": “2019-12-08T11:45:20.000-06:00",
“rating": 5.0,
“attribution": “Mark Kelly",
“title": null,
“content": “Great price and awesome service. The only issue is it can be a little difficult to get an appointment, sometimes taking a month or so. But they have a wait list and are usually able to accommodate!",
“url": “http://search.google.com/local/writereview?placeid=ChIJlSIb2ZRmZIgRShYHsUPW-NU",
“created_at": “2020-01-08T11:45:25.653-06:00"
},
{
“id": “744e989a-55bd-48d8-8a66-b0210b2c68fc",
“unique_id": “117068420619110007466",
“category": “google",
“date": “2019-12-08T11:45:20.000-06:00",
“rating": 5.0,
“attribution": “Kathy Ross",
“title": null,
“content": “Keith is a wonderful groomer and our Emma does not like “anything done to her”! She totally trusts Keith and is always so beautiful after her “spa” morning!We appreciate that Keith is always so punctual and patient with our princess!Thanks, Aussie Pet Mobile!Kathy Ross",
“url": “http://search.google.com/local/writereview?placeid=ChIJlSIb2ZRmZIgRShYHsUPW-NU",
“created_at": “2020-01-08T11:45:25.925-06:00"
},
{
“id": “002474d3-4976-4dee-bbbc-fc833a8f7f0e",
“unique_id": “102633421124055576267",
“category": “google",
“date": “2019-12-08T11:45:20.000-06:00",
“rating": 5.0,
“attribution": “Stefanie O'Reilly Stricker",
“title": null,
“content": “We have used Aussie for a year now, and we absolutely love them. Our two dogs are always excited to see their groomer, Reve, who is patient, kind, and detail-oriented. Reve does a beautiful job with hair cuts and even gets lots of tail-wagging from our slightly nervous 7 year-old lab mix. We love the convenience of having Aussie come to our home and of having a pre-planned year-long schedule. The office staff and groomer always provide great customer service and are a pleasure to work with every time.",
“url": “http://search.google.com/local/writereview?placeid=ChIJlSIb2ZRmZIgRShYHsUPW-NU",
“created_at": “2020-01-08T11:45:25.755-06:00"
},
{
“id": “b0110fb4-9b81-45c9-be8d-6f36cdae2eee",
“unique_id": “115500661296713177409",
“category": “google",
“date": “2019-12-08T11:45:20.000-06:00",
“rating": 5.0,
“attribution": “LeNisha Walker",
“title": null,
“content": “Destiny did such a wonderful job with my pup. His cut is the cutest and he smells awesome!",
“url": “http://search.google.com/local/writereview?placeid=ChIJlSIb2ZRmZIgRShYHsUPW-NU",
“created_at": “2020-01-08T11:45:25.962-06:00"
}
],
“pagination": {
“current_page": 1,
“next_page": null,
“prev_page": null,
“total_pages": 1,
“total_count": 6,
“current_page_count": 6
}
}

Recipients

Recipients are people that will be sent a campaign of email requesting review.

Get Recipients

Description

Get all Recipients.

Path

/profiles/{profile_id}/recipients

Params

Name Type Description
profile_id String

Request

Request

GET https://api.reviewr.app/api/v4/profiles/a4d9b349-a318-47bf-99ce-a79c469fd878/recipients

CURL

curl https://api.reviewr.app/api/v4/profiles/a4d9b349-a318-47bf-99ce-a79c469fd878/recipients -H “Authorization: API-KEY"

Response

Response code <200>

{
“recipients": [
{
“id": “e391b862-4872-11ea-abb0-4a8a1824297b",
“email_address": “[email protected]",
“phone_number": null,
“first_name": null,
“last_name": null,
“sent_count": 1,
“started_at": “2020-02-06T10:54:46.938+11:00",
“last_sent_at": “2020-02-06T10:54:51.634+11:00",
“is_pending": false,
“is_active": true,
“is_archived": false,
“rejected": false,
“blocked": false,
“bounced": false,
“clicked": false,
“flagged": false,
“opened": false,
“unsubscribed": false,
“custom_field_1": null
}
],
“pagination": {
“current_page": 1,
“next_page": null,
“prev_page": null,
“total_pages": 1,
“total_count": 1,
“current_page_count": 1
}
}

Get Recipient

Description

Get a Recipient.

Path

/profiles/{profile_id}/recipients/{recipient_id}

Params

Name Type Description
profile_id String

recipient_id String

Request

Request

GET https://api.reviewr.app/api/v4/profiles/a4d9b349-a318-47bf-99ce-a79c469fd878/recipients/e391b862-4872-11ea-abb0-4a8a1824297b

CURL

curl https://api.reviewr.app/api/v4/profiles/a4d9b349-a318-47bf-99ce-a79c469fd878/recipients/e391b862-4872-11ea-abb0-4a8a1824297b -H “Authorization: API-KEY"

Response

Response code <200>

{
“id": “e391b862-4872-11ea-abb0-4a8a1824297b",
“email_address": “[email protected]",
“phone_number": null,
“first_name": null,
“last_name": null,
“sent_count": 1,
“started_at": “2020-02-05T18:54:46.938-05:00",
“last_sent_at": “2020-02-05T18:54:51.634-05:00",
“is_pending": false,
“is_active": true,
“is_archived": false,
“rejected": false,
“blocked": false,
“bounced": false,
“clicked": false,
“flagged": false,
“opened": false,
“unsubscribed": false,
“custom_field_1": null
}

Create Recipients

Description

Create one or more Recipients. Prior to creating a Recipient, phone and/or email service must be enabled.

Path

/profiles/{profile_id}/recipients

Params

Name Type Description
email_address
Optional String The email address of the Recipient, if an email campaign is desired.
first_name
Optional String First name of Recipient.
last_name
Optional String Last name of Recipient.
profile_id String

Request

Request

POST https://api.reviewr.app/api/v4/profiles/a4d9b349-a318-47bf-99ce-a79c469fd878/recipients body: {“recipients":[{“email_address":"[email protected]"}]}

CURL

curl -d “recipients=[%7B:email_address=%3E%[email protected]%22%7D]" https://api.reviewr.app/api/v4/profiles/a4d9b349-a318-47bf-99ce-a79c469fd878/recipients -H “Authorization: API-KEY"

Response

Response code <422>

{
“results": [

],
“errors": [
“Dropped [email protected] (Recipient already exists)"
],
“notices": [

]
}

Base URL

Obtaining API keys

Rate limits

Pagination

Headers

Reviews

Get Reviews

Description

Path

Params

Request

Request

CURL

Response

Recipients

Get Recipients

Description

Path

Params

Request

Response

Get Recipient

Description

Path

Params

Request

Response

Create Recipients

Description

Path

Params

Request

Response