Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added description for how to get 500+ reviews from FB and DemandForce #92

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions source/includes/_reviews.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ profile-url | <span class="label label-required">Required</span> For requests to
country | <span class="label label-required">Required</span>
sort | 'rating' or 'date'. By default 'date'.
reviews-limit | Positive number or 'all'. By default 100.
next-page | Number for Google and a string value for the rest of directories.
date-from | Date Format: Y-m-d or Y-m-d H:i:s. By default not specified.
start-page | See [paging](#paging) table below for details.

Expand Down Expand Up @@ -315,6 +316,7 @@ else
"country": "USA",
"date-from": null,
"reviews-limit": 250,
"start-page": 51,
"sort-type": "date",
"api-key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
Expand Down Expand Up @@ -345,6 +347,7 @@ else
"country": "USA",
"date-from": null,
"reviews-limit": 250,
"next-page": "100001023529042%3A292061516392",
"sort-type": "date",
"api-key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
Expand Down Expand Up @@ -400,6 +403,7 @@ else
"country": "USA",
"date-from": null,
"reviews-limit": 250,
"next-page": 51,
"sort-type": "date",
"api-key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"parent-id": 549612293
Expand Down Expand Up @@ -437,6 +441,7 @@ else
"country": "USA",
"date-from": null,
"reviews-limit": 250,
"start-page": "100001023529042%3A292061516392",
"sort-type": "date",
"api-key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"parent-id": 549612304
Expand Down Expand Up @@ -506,18 +511,26 @@ country | <span class="label label-required">Required</span> Only USA.
telephone | A valid telephone number. Providing this will improve the quality of results returned.
sort | 'rating' or 'date'. By default 'date'.
reviews-limit | Positive number or 'all'. By default 100.
next-page | Number for Google and a string value for the rest of directories.
date-from | Date Format: Y-m-d or Y-m-d H:i:s. By default not specified.
start-page | See [paging](#paging) table below for details.

## Paging

We support up to 500 reviews per request to a given directory. If you need to retrieve more than 500 reviews you can use the start-page parameter and submit multiple requests to pick up older reviews. For example with Google to fetch 1000 reviews you'd need to make two requests:
We support up to 500 reviews per request to a given directory. If you need to retrieve more than 500 reviews you can use the start-page parameter and submit multiple requests to pick up older reviews. For example with Google to fetch 1000 reviews youd need to make two requests:

1. Without start-page (or with start-page=1) to fetch reviews 1 - 500.
2. With start-page=51 (Google returns 10 reviews per page) to fetch reviews 501 - 1000.

For directories such as DemandForce and Facebook, you will be returned next-start-page parameter with a string value in your payload. Pass that value in the start-page parameter of next request to pick up older reviews. For example with Facebook to fetch 1000 reviews you’d need to make two requests:

1. Without start-page to fetch reviews 1 - 500. Then take the string value returned in the next-start-page parameter, and
2. Pass next-start-page parameter's string value (from the previous request) in start-page parameter of your next request to fetch reviews 501 - 1000.

### Supported Directories

Directory | Number Reviews Per Page
--------- | -----------------------
Google | 10
Directory | Number Reviews Per Page
----------- | -----------------------
Google | 10
DemandForce |
Facebook |