Developer SiteLocations Endpoint
GET https://dashboard.reviewpush.com/api/user/locations
Options
| GET Param | Description |
|---|---|
limit |
Set the number of reviews per page |
search |
Limit the results to locations matching the search term |
Includes
You can optionally include the location's profiles:
?include=profiles
These entities will be included in a separate "included" group following the "data" collection.
The links will be specified in a "relationships" section on each data entry.
See the single location response below for an example. Parser libraries may be available for your platform.
Sample Response:
{
"data": [
{
"type": "locations",
"id": "123",
"attributes": {
"name": "Sample Location",
"unique_identifier": "0",
"display_name": "Sample Location - 0",
"address_1": "123 Sample St.",
"address_2": "",
"city": "Austin",
"state": "TX",
"zip": "78701",
"phone": "5965554610",
"email": "[email protected]",
"latitude": 34.092,
"longitude": -97.234,
"aggregate": {
"rating": 1.33,
"reviews": 756
},
"landing_pages": {
"Review Request": "https:\/\/go.reviewpush.com\/review\/c\/123",
"Feedback": "https:\/\/go.reviewpush.com\/feedback\/c\/123"
},
"created": "2015-10-21 16:38:14",
"links": {
"self": "https:\/\/dashboard.reviewpush.com\/api\/user\/locations\/123"
}
}
},
{
"type": "locations",
"id": "234",
"attributes": {
"name": "Sample Two",
"unique_identifier": "1",
"display_name": "Sample Two - 1",
"address_1": "456 Sample Two St.",
"address_2": "",
"city": "New York",
"state": "NY",
"zip": "10294",
"phone": "5865559640",
"email": "[email protected]",
"latitude": null,
"longitude": null,
"aggregate": {
"rating": 4,
"reviews": 194
},
"landing_pages": {
"Review Request": "https:\/\/go.reviewpush.com\/review\/c\/234",
"Feedback": "https:\/\/go.reviewpush.com\/feedback\/c\/234"
},
"created": "2015-10-21 16:38:14",
"links": {
"self": "https:\/\/dashboard.reviewpush.com\/api\/user\/locations\/234"
}
}
}
],
"meta": {
"pagination": {
"total": 2,
"count": 2,
"per_page": 20,
"current_page": 1,
"total_pages": 1,
"links": []
}
}
}The meta section will contain pagination information, including next/previous links if they are available. On the first page, the previous link will not be present, and the next link will not appear on the last page.
Single Location
GET https://dashboard.reviewpush.com/api/user/locations/123?include=profiles
Note: Shown with profiles included. This can be omitted as needed.
Sample Response
{
"data": {
"type": "locations",
"id": "1",
"attributes": {
"name": "Sample Location",
"unique_identifier": "0",
"display_name": "Sample Location - 0",
"address_1": "123 Sample St.",
"address_2": "",
"city": "Austin",
"state": "TX",
"zip": "78701",
"phone": "5965554610",
"email": "[email protected]",
"latitude": 34.092,
"longitude": -97.234,
"aggregate": {
"rating": 1.33,
"reviews": 756
},
"landing_pages": {
"Review Request": "https:\/\/go.reviewpush.com\/review\/c\/1",
"Feedback": "https:\/\/go.reviewpush.com\/feedback\/c\/1"
},
"created": "2015-10-21 16:38:14",
"links": {
"self": "https:\/\/dashboard.reviewpush.com\/api\/user\/locations\/123"
}
},
"relationships": {
"profiles": {
"data": [
{
"type": "profiles",
"id": "192"
},
{
"type": "profiles",
"id": "193"
}
]
}
}
},
"included": [
{
"type": "profiles",
"id": "192",
"attributes": {
"location_id": 1,
"name": "",
"url": "http:\/\/example.com\/",
"site": {
"name": "Yelp",
"logo": "http:\/\/go.reviewpush.com\/img\/logos\/yelp2.png",
"icon": "http:\/\/go.reviewpush.com\/img\/icons\/sites\/icon-yelp.png"
},
"aggregate": {
"rating": "0.00",
"reviews": 0
},
"created": "2015-10-21 16:38:35"
}
},
{
"type": "profiles",
"id": "193",
"attributes": {
"location_id": 1,
"name": "",
"url": "http:\/\/example.com\/",
"site": {
"name": "Google",
"logo": "http:\/\/go.reviewpush.com\/img\/logos\/google.png",
"icon": "http:\/\/go.reviewpush.com\/img\/icons\/sites\/icon-google.png"
},
"aggregate": {
"rating": "0.00",
"reviews": 0
},
"created": "2015-10-21 16:38:35"
}
}
]
}Locations By Rating Endpoint
GET https://dashboard.reviewpush.com/api/user/locations/ratings
Options
| GET Param | Description |
|---|---|
location_id |
Limit the result set to the specific location specified |
Includes
You can optionally include the location's profiles:
?include=profiles
These entities will be included in a separate "included" group following the "data" collection.
The links will be specified in a "relationships" section on each data entry.
See the single location response below for an example. Parser libraries may be available for your platform.
Sample Response:
{
"data": [
{
"type": "locations",
"id": "123",
"attributes": {
"rank": 1,
"name": "Sample Location",
"unique_identifier": "0",
"display_name": "Sample Location - 0",
"address_1": "123 Sample St.",
"address_2": "",
"city": "Austin",
"state": "TX",
"zip": "78701",
"phone": "5965554610",
"email": "[email protected]",
"latitude": 34.092,
"longitude": -97.234,
"aggregate": {
"rating": 2.33,
"rating_weighted": 2.56,
"reviews": 734
},
"landing_pages": {
"Review Request": "https:\/\/go.reviewpush.com\/review\/c\/123",
"Feedback": "https:\/\/go.reviewpush.com\/feedback\/c\/123"
},
"per_site": {
"Google": {
"url": "http:\/\/example.com\/",
"review_count": 185,
"average_rating": "4.00"
},
"Total": {
"url": "",
"review_count": 185,
"average_rating": 4
}
},
"created": "2016-05-16 23:12:38",
"links": {
"self": "https:\/\/dashboard.reviewpush.com\/api\/user\/locations\/123"
}
}
},
{
"type": "locations",
"id": "234",
"attributes": {
"rank": 2,
"name": "Sample Two",
"unique_identifier": "1",
"display_name": "Sample Two - 1",
"address_1": "456 Sample Two St.",
"address_2": "",
"city": "New York",
"state": "NY",
"zip": "10294",
"phone": "5865559640",
"email": "[email protected]",
"latitude": null,
"longitude": null,
"aggregate": {
"rating": 3.33,
"rating_weighted": 3.64,
"reviews": 631
},
"landing_pages": {
"Review Request": "https:\/\/go.reviewpush.com\/review\/c\/234",
"Feedback": "https:\/\/go.reviewpush.com\/feedback\/c\/234"
},
"per_site": [],
"created": "2016-05-16 23:12:38",
"links": {
"self": "https:\/\/dashboard.reviewpush.com\/api\/user\/locations\/234"
}
}
}
],
aggregate": {
"overall_site_stats": {
"Yelp": {
"reviews": 1096,
"rating": 2.4,
"locations": 5,
"historical_average": "3.80"
},
"Google": {
"reviews": 631,
"rating": 2.6666666666667,
"locations": 3,
"historical_average": "4.25"
},
"Facebook": {
"reviews": 1436,
"rating": 2,
"locations": 6,
"historical_average": "3.50"
}
},
"overall_stats": {
"reviews": 3163,
"rating": 2.2857142857143
}
}
}Reviews By Source Endpoint
GET https://dashboard.reviewpush.com/api/user/locations/review/sources
Options
| GET Param | Description |
|---|---|
location_id |
Limit the result set to reviews for a specific location |
date_from |
Limit the result set to reviews greater than or equal to the date specified |
date_to |
Limit the result set to reviews less than or equal to the date specified |
If not specified, data for the last 30 days will be returned.
The data is in percentage
Sample Response:
[
{
"name": "Google",
"num": 48
},
{
"name": "ReviewPush",
"num": 47
},
{
"name": "Yelp",
"num": 5
}
]Reviews By Sentiment Endpoint
GET https://dashboard.reviewpush.com/api/user/locations/review/sentiment
Options
| GET Param | Description |
|---|---|
location_id |
Limit the result set to reviews for a specific location |
date_from |
Limit the result set to reviews greater than or equal to the date specified |
date_to |
Limit the result set to reviews less than or equal to the date specified |
If not specified, data for the last 30 days will be returned.
Sample Response:
{
"total": 236,
"positive": 224,
"neutral": 3,
"negative": 9
}