The history of a review
include=events adds what happened to the review, oldest first.
curl "https://api.reviewflowz.com/v3/reviews?include=events&fields=rating,date,events&limit=1" \-H "Authorization: Bearer rfz_live_..."
const res = await fetch("https://api.reviewflowz.com/v3/reviews?include=events&fields=rating,date,events&limit=1", {method: "GET",headers: {"Authorization": "Bearer rfz_live_...",},});console.log(await res.json());
import requestsres = requests.get("https://api.reviewflowz.com/v3/reviews",headers={"Authorization": "Bearer rfz_live_...",},params={"include": "events", "fields": "rating,date,events", "limit": "1"},)print(res.json())
Edit the request
- id · Comma-separated review ids, up to 500: id=rev_1 reads one review. A...
- source · Comma-separated source ids.
- platform · Comma-separated platform ids.
- location · Comma-separated location ids.
- product · Comma-separated product ids (accounts that group sources into...
- dimension[key] · Reviews of sources with this custom dimension value...
- source_created_after · Reviews of sources added at or after (bulk imports).
- rating · Star ratings, comma-separated: rating=1,2 (4 includes 4.5).
- rating_min · Scores of at least this: rating_min=4.
- rating_max · Scores of at most this: rating_max=3 (3.5 is out).
- date_after · Posted on the platform at or after.
- date_before · Posted on the platform before.
- created_after · Found by Reviewflowz at or after.
- created_before · Found by Reviewflowz before.
- updated_after · Catch up after downtime: reviews found, edited, removed,...
- language · Comma-separated ISO 639-1 codes.
- country · The reviewer's country, where the platform gives one:...
- tag · Comma-separated tag ids: reviews with any of them.
- owner · Comma-separated owner ids (confirmed assignments).
- topic · Comma-separated topic names.
- subtopic · Comma-separated subtopic names. With topic or sentiment, the same...
- sentiment · With topic, a mention of that topic with that sentiment.
- has_reply · Reviews with a live reply (true), posted from Reviewflowz or found...
- removed · Reviews the platform took down (true), or the ones still up...
- q · Full-text search (title, text, pros, cons, reviewer). Every word...
- keywords · Like q, but any of the words: keywords=refund,late.
- has_text · Reviews with written text (true) or a rating alone (false).
- text_length_min · At least this many characters of text.
- columns · Comma-separated export columns (rating, date, reviewer,...
- versions · latest lists only the current version of an edited review; all...
- sort · created: newest found first. date: newest posted on the platform...
- cursor · The next_cursor from the previous page. Leave it out for the first...
GET /v3/reviews in the reference
Example answer
The reply
include=reply adds the business's current reply, or null when there is none.
curl "https://api.reviewflowz.com/v3/reviews?include=reply&fields=rating,text,reply&limit=1" \-H "Authorization: Bearer rfz_live_..."
const res = await fetch("https://api.reviewflowz.com/v3/reviews?include=reply&fields=rating,text,reply&limit=1", {method: "GET",headers: {"Authorization": "Bearer rfz_live_...",},});console.log(await res.json());
import requestsres = requests.get("https://api.reviewflowz.com/v3/reviews",headers={"Authorization": "Bearer rfz_live_...",},params={"include": "reply", "fields": "rating,text,reply", "limit": "1"},)print(res.json())
Edit the request
- id · Comma-separated review ids, up to 500: id=rev_1 reads one review. A...
- source · Comma-separated source ids.
- platform · Comma-separated platform ids.
- location · Comma-separated location ids.
- product · Comma-separated product ids (accounts that group sources into...
- dimension[key] · Reviews of sources with this custom dimension value...
- source_created_after · Reviews of sources added at or after (bulk imports).
- rating · Star ratings, comma-separated: rating=1,2 (4 includes 4.5).
- rating_min · Scores of at least this: rating_min=4.
- rating_max · Scores of at most this: rating_max=3 (3.5 is out).
- date_after · Posted on the platform at or after.
- date_before · Posted on the platform before.
- created_after · Found by Reviewflowz at or after.
- created_before · Found by Reviewflowz before.
- updated_after · Catch up after downtime: reviews found, edited, removed,...
- language · Comma-separated ISO 639-1 codes.
- country · The reviewer's country, where the platform gives one:...
- tag · Comma-separated tag ids: reviews with any of them.
- owner · Comma-separated owner ids (confirmed assignments).
- topic · Comma-separated topic names.
- subtopic · Comma-separated subtopic names. With topic or sentiment, the same...
- sentiment · With topic, a mention of that topic with that sentiment.
- has_reply · Reviews with a live reply (true), posted from Reviewflowz or found...
- removed · Reviews the platform took down (true), or the ones still up...
- q · Full-text search (title, text, pros, cons, reviewer). Every word...
- keywords · Like q, but any of the words: keywords=refund,late.
- has_text · Reviews with written text (true) or a rating alone (false).
- text_length_min · At least this many characters of text.
- columns · Comma-separated export columns (rating, date, reviewer,...
- versions · latest lists only the current version of an edited review; all...
- sort · created: newest found first. date: newest posted on the platform...
- cursor · The next_cursor from the previous page. Leave it out for the first...
GET /v3/reviews in the reference
Example answer
origin says where it was written: reviewflowz, or platform for a reply written on the platform itself, which has no id. editable and deletable say what PATCH /v3/replies/rpl_7 and DELETE /v3/replies/rpl_7 can do with it.
Photos and videos
include=media adds media, with the reviewer's photos and videos, each a list of { "url": ... }.
Only the fields you need
fields keeps the top-level fields you name. id always comes, and a name that isn't a field is ignored. A part added with include must be named in fields too, as events and reply are above.
curl "https://api.reviewflowz.com/v3/reviews?fields=rating,text,date&limit=2" \-H "Authorization: Bearer rfz_live_..."
const res = await fetch("https://api.reviewflowz.com/v3/reviews?fields=rating,text,date&limit=2", {method: "GET",headers: {"Authorization": "Bearer rfz_live_...",},});console.log(await res.json());
import requestsres = requests.get("https://api.reviewflowz.com/v3/reviews",headers={"Authorization": "Bearer rfz_live_...",},params={"fields": "rating,text,date", "limit": "2"},)print(res.json())
Edit the request
- id · Comma-separated review ids, up to 500: id=rev_1 reads one review. A...
- source · Comma-separated source ids.
- platform · Comma-separated platform ids.
- location · Comma-separated location ids.
- product · Comma-separated product ids (accounts that group sources into...
- dimension[key] · Reviews of sources with this custom dimension value...
- source_created_after · Reviews of sources added at or after (bulk imports).
- rating · Star ratings, comma-separated: rating=1,2 (4 includes 4.5).
- rating_min · Scores of at least this: rating_min=4.
- rating_max · Scores of at most this: rating_max=3 (3.5 is out).
- date_after · Posted on the platform at or after.
- date_before · Posted on the platform before.
- created_after · Found by Reviewflowz at or after.
- created_before · Found by Reviewflowz before.
- updated_after · Catch up after downtime: reviews found, edited, removed,...
- language · Comma-separated ISO 639-1 codes.
- country · The reviewer's country, where the platform gives one:...
- tag · Comma-separated tag ids: reviews with any of them.
- owner · Comma-separated owner ids (confirmed assignments).
- topic · Comma-separated topic names.
- subtopic · Comma-separated subtopic names. With topic or sentiment, the same...
- sentiment · With topic, a mention of that topic with that sentiment.
- has_reply · Reviews with a live reply (true), posted from Reviewflowz or found...
- removed · Reviews the platform took down (true), or the ones still up...
- q · Full-text search (title, text, pros, cons, reviewer). Every word...
- keywords · Like q, but any of the words: keywords=refund,late.
- has_text · Reviews with written text (true) or a rating alone (false).
- text_length_min · At least this many characters of text.
- include · Parts to add to each review, comma-separated: `media` (the...
- columns · Comma-separated export columns (rating, date, reviewer,...
- versions · latest lists only the current version of an edited review; all...
- sort · created: newest found first. date: newest posted on the platform...
- cursor · The next_cursor from the previous page. Leave it out for the first...
GET /v3/reviews in the reference
Example answer
The export's columns
columns adds a columns object with the values a CSV export writes for that review. Name the columns, or send columns=all for every column your account has, custom dimensions included. With fields=id, each review is its id and those columns alone.
curl "https://api.reviewflowz.com/v3/reviews?fields=id&columns=rating,date,reply_text&limit=1" \-H "Authorization: Bearer rfz_live_..."
const res = await fetch("https://api.reviewflowz.com/v3/reviews?fields=id&columns=rating,date,reply_text&limit=1", {method: "GET",headers: {"Authorization": "Bearer rfz_live_...",},});console.log(await res.json());
import requestsres = requests.get("https://api.reviewflowz.com/v3/reviews",headers={"Authorization": "Bearer rfz_live_...",},params={"fields": "id", "columns": "rating,date,reply_text", "limit": "1"},)print(res.json())
Edit the request
- id · Comma-separated review ids, up to 500: id=rev_1 reads one review. A...
- source · Comma-separated source ids.
- platform · Comma-separated platform ids.
- location · Comma-separated location ids.
- product · Comma-separated product ids (accounts that group sources into...
- dimension[key] · Reviews of sources with this custom dimension value...
- source_created_after · Reviews of sources added at or after (bulk imports).
- rating · Star ratings, comma-separated: rating=1,2 (4 includes 4.5).
- rating_min · Scores of at least this: rating_min=4.
- rating_max · Scores of at most this: rating_max=3 (3.5 is out).
- date_after · Posted on the platform at or after.
- date_before · Posted on the platform before.
- created_after · Found by Reviewflowz at or after.
- created_before · Found by Reviewflowz before.
- updated_after · Catch up after downtime: reviews found, edited, removed,...
- language · Comma-separated ISO 639-1 codes.
- country · The reviewer's country, where the platform gives one:...
- tag · Comma-separated tag ids: reviews with any of them.
- owner · Comma-separated owner ids (confirmed assignments).
- topic · Comma-separated topic names.
- subtopic · Comma-separated subtopic names. With topic or sentiment, the same...
- sentiment · With topic, a mention of that topic with that sentiment.
- has_reply · Reviews with a live reply (true), posted from Reviewflowz or found...
- removed · Reviews the platform took down (true), or the ones still up...
- q · Full-text search (title, text, pros, cons, reviewer). Every word...
- keywords · Like q, but any of the words: keywords=refund,late.
- has_text · Reviews with written text (true) or a rating alone (false).
- text_length_min · At least this many characters of text.
- include · Parts to add to each review, comma-separated: `media` (the...
- versions · latest lists only the current version of an edited review; all...
- sort · created: newest found first. date: newest posted on the platform...
- cursor · The next_cursor from the previous page. Leave it out for the first...
GET /v3/reviews in the reference
Example answer
An unknown column answers 400 invalid_parameter with the list of columns you can use. Keep a warehouse or BI tool in sync uses them.
Every version of an edited review
When a reviewer edits a review, the edit is a new review with a new id. Lists hold the latest version only. versions=all lists the earlier ones too.
curl "https://api.reviewflowz.com/v3/reviews?versions=all&fields=previous_version,root_review,latest_version&limit=5" \-H "Authorization: Bearer rfz_live_..."
const res = await fetch("https://api.reviewflowz.com/v3/reviews?versions=all&fields=previous_version,root_review,latest_version&limit=5", {method: "GET",headers: {"Authorization": "Bearer rfz_live_...",},});console.log(await res.json());
import requestsres = requests.get("https://api.reviewflowz.com/v3/reviews",headers={"Authorization": "Bearer rfz_live_...",},params={"versions": "all", "fields": "previous_version,root_review,latest_version", "limit": "5"},)print(res.json())
Edit the request
- id · Comma-separated review ids, up to 500: id=rev_1 reads one review. A...
- source · Comma-separated source ids.
- platform · Comma-separated platform ids.
- location · Comma-separated location ids.
- product · Comma-separated product ids (accounts that group sources into...
- dimension[key] · Reviews of sources with this custom dimension value...
- source_created_after · Reviews of sources added at or after (bulk imports).
- rating · Star ratings, comma-separated: rating=1,2 (4 includes 4.5).
- rating_min · Scores of at least this: rating_min=4.
- rating_max · Scores of at most this: rating_max=3 (3.5 is out).
- date_after · Posted on the platform at or after.
- date_before · Posted on the platform before.
- created_after · Found by Reviewflowz at or after.
- created_before · Found by Reviewflowz before.
- updated_after · Catch up after downtime: reviews found, edited, removed,...
- language · Comma-separated ISO 639-1 codes.
- country · The reviewer's country, where the platform gives one:...
- tag · Comma-separated tag ids: reviews with any of them.
- owner · Comma-separated owner ids (confirmed assignments).
- topic · Comma-separated topic names.
- subtopic · Comma-separated subtopic names. With topic or sentiment, the same...
- sentiment · With topic, a mention of that topic with that sentiment.
- has_reply · Reviews with a live reply (true), posted from Reviewflowz or found...
- removed · Reviews the platform took down (true), or the ones still up...
- q · Full-text search (title, text, pros, cons, reviewer). Every word...
- keywords · Like q, but any of the words: keywords=refund,late.
- has_text · Reviews with written text (true) or a rating alone (false).
- text_length_min · At least this many characters of text.
- include · Parts to add to each review, comma-separated: `media` (the...
- columns · Comma-separated export columns (rating, date, reviewer,...
- sort · created: newest found first. date: newest posted on the platform...
- cursor · The next_cursor from the previous page. Leave it out for the first...
GET /v3/reviews in the reference
Example answer
root_review is the first version, shared by every version of the review. previous_version is the one this version replaced, and latest_version is true on the current one.
In webhook events
A review in a webhook event already carries media and reply: nothing to ask for.