Before you start
- A key with
analytics:readandreviews:read, plusanalytics:writeto save a report in step 5. - The API is part of the Premium plan (see pricing). API-only plans start at $300 a month: book a 30-minute call for a custom quote.
1. Get the totals
GET /v3/stats counts the reviews you filter and gives their average rating, the split by star and the reply rate. It takes every filter of GET /v3/reviews. Everything posted since October 1:
curl "https://api.reviewflowz.com/v3/stats?date_after=2026-10-01" \-H "Authorization: Bearer rfz_live_..."
const res = await fetch("https://api.reviewflowz.com/v3/stats?date_after=2026-10-01", {method: "GET",headers: {"Authorization": "Bearer rfz_live_...",},});console.log(await res.json());
import requestsres = requests.get("https://api.reviewflowz.com/v3/stats",headers={"Authorization": "Bearer rfz_live_...",},params={"date_after": "2026-10-01"},)print(res.json())
Edit the request
- group_by · One total (none), or a row per period, source, location or platform.
- interval · With group_by=period: the length of each period, by the date the...
- id · Comma-separated review ids, up to 500.
- 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.
- 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_before · Posted on the platform before.
- created_after · Found by Reviewflowz at or after.
- created_before · Found by Reviewflowz before.
- updated_after · Reviews found, edited, removed, reinstated, replied to, tagged or...
- 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) or with none (false). A draft...
- 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.
- versions · latest counts only the current version of an edited review; all...
GET /v3/stats in the reference
Example answer
reply_rate goes from 0 to 1. removed reviews are counted in count too: add removed=false to leave them out. sentiment counts topic mentions, not reviews.
2. Break them down
group_by gives a row per period, source, location or platform. By month:
curl "https://api.reviewflowz.com/v3/stats?group_by=period&interval=month&date_after=2026-09-01" \-H "Authorization: Bearer rfz_live_..."
const res = await fetch("https://api.reviewflowz.com/v3/stats?group_by=period&interval=month&date_after=2026-09-01", {method: "GET",headers: {"Authorization": "Bearer rfz_live_...",},});console.log(await res.json());
import requestsres = requests.get("https://api.reviewflowz.com/v3/stats",headers={"Authorization": "Bearer rfz_live_...",},params={"group_by": "period", "interval": "month", "date_after": "2026-09-01"},)print(res.json())
Edit the request
- id · Comma-separated review ids, up to 500.
- 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.
- 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_before · Posted on the platform before.
- created_after · Found by Reviewflowz at or after.
- created_before · Found by Reviewflowz before.
- updated_after · Reviews found, edited, removed, reinstated, replied to, tagged or...
- 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) or with none (false). A draft...
- 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.
- versions · latest counts only the current version of an edited review; all...
GET /v3/stats in the reference
Example answer
Shortened: each row has the same fields as the total. interval takes day, week, month, quarter or year. Periods come oldest first, other groups biggest first.
3. Read what customers say
GET /v3/topics lists your topics. GET /v3/excerpts gives the sentences themselves: here, the good things said about staff.
curl "https://api.reviewflowz.com/v3/excerpts?topic=Staff&sentiment=positive&date_after=2026-10-01" \-H "Authorization: Bearer rfz_live_..."
const res = await fetch("https://api.reviewflowz.com/v3/excerpts?topic=Staff&sentiment=positive&date_after=2026-10-01", {method: "GET",headers: {"Authorization": "Bearer rfz_live_...",},});console.log(await res.json());
import requestsres = requests.get("https://api.reviewflowz.com/v3/excerpts",headers={"Authorization": "Bearer rfz_live_...",},params={"topic": "Staff", "sentiment": "positive", "date_after": "2026-10-01"},)print(res.json())
Edit the request
- subtopic · Comma-separated subtopic names.
- id · Comma-separated review ids, up to 500.
- 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.
- rating · Star ratings of the review, comma-separated: rating=1,2 (4 includes...
- rating_min · Reviews scored at least this: rating_min=4.
- rating_max · Reviews scored at most this: rating_max=3 (3.5 is out).
- date_before · Reviews posted on the platform before.
- created_after · Reviews found by Reviewflowz at or after.
- created_before · Reviews found by Reviewflowz before.
- updated_after · Reviews found, edited, removed, reinstated, replied to, tagged or...
- language · Comma-separated ISO 639-1 codes of the review.
- 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).
- has_reply · Reviews with a live reply (true) or with none (false). A draft...
- removed · Reviews the platform took down (true), or the ones still up (false).
- q · Full-text search of the review (title, text, pros, cons, reviewer);...
- 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 review text.
- versions · latest reads only the current version of an edited review; all...
- limit · Rows per page: 1 to 500 (default 50).
- cursor · The next_cursor from the previous page. Leave it out for the first...
GET /v3/excerpts in the reference
Example answer
topic and sentiment pick the mentions; every other filter of GET /v3/reviews picks the reviews they come from. Topics need sentiment analysis turned on once, in the app under Reports → Sentiment.
4. Build a report
A report is a table: a row per value of its dimensions, a column per metric. GET /v3/reports/options lists the dimensions and metrics you can use. POST /v3/reports/query runs one without saving it:
curl "https://api.reviewflowz.com/v3/reports/query?from=2026-10-01&to=2026-11-17" \-H "Authorization: Bearer rfz_live_..." \-H "Content-Type: application/json" \-d '{"dimensions": ["platform"], "metrics": ["average_rating", "review_velocity"]}'
const res = await fetch("https://api.reviewflowz.com/v3/reports/query?from=2026-10-01&to=2026-11-17", {method: "POST",headers: {"Authorization": "Bearer rfz_live_...","Content-Type": "application/json",},body: JSON.stringify({"dimensions": ["platform"], "metrics": ["average_rating", "review_velocity"]}),});console.log(await res.json());
import requestsres = requests.post("https://api.reviewflowz.com/v3/reports/query",headers={"Authorization": "Bearer rfz_live_...","Content-Type": "application/json",},params={"from": "2026-10-01", "to": "2026-11-17"},json={"dimensions": ["platform"], "metrics": ["average_rating", "review_velocity"]},)print(res.json())
Edit the request
- compare_from · Comparison window start.
- compare_to · Comparison window end.
- sort_by
- sort_direction
- limit · Rows per page: 1 to 500 (default 50).
- cursor · The next_cursor from the previous page. Leave it out for the first...
POST /v3/reports/query in the reference
Example answer
- Dates:
fromandto, the last 30 days when you leave them out.compare_fromandcompare_toadd acomparison_column per metric. - Filters: a
filtersobject, like{"rating": [1, 2], "has_reply": false}. A name it doesn't take answers400invalid_parameterwith the names it does. - A combination that can't be computed answers
422invalid_report, with the dimensions and metrics that do work.
5. Save it and run it again
Send the same body with a name to POST /v3/reports. The report also shows in the app, at its url.
curl https://api.reviewflowz.com/v3/reports \-H "Authorization: Bearer rfz_live_..." \-H "Content-Type: application/json" \-d '{"name": "Rating by platform","dimensions": ["platform"],"metrics": ["average_rating", "review_velocity"]}'
const res = await fetch("https://api.reviewflowz.com/v3/reports", {method: "POST",headers: {"Authorization": "Bearer rfz_live_...","Content-Type": "application/json",},body: JSON.stringify({"name": "Rating by platform", "dimensions": ["platform"], "metrics": ["average_rating", "review_velocity"]}),});console.log(await res.json());
import requestsres = requests.post("https://api.reviewflowz.com/v3/reports",headers={"Authorization": "Bearer rfz_live_...","Content-Type": "application/json",},json={"name": "Rating by platform", "dimensions": ["platform"], "metrics": ["average_rating", "review_velocity"]},)print(res.json())
Edit the request
POST /v3/reports in the reference
Example answer
Then GET /v3/reports/rpt_7/results runs it for any dates:
curl "https://api.reviewflowz.com/v3/reports/rpt_7/results?from=2026-11-01&to=2026-11-17" \-H "Authorization: Bearer rfz_live_..."
const res = await fetch("https://api.reviewflowz.com/v3/reports/rpt_7/results?from=2026-11-01&to=2026-11-17", {method: "GET",headers: {"Authorization": "Bearer rfz_live_...",},});console.log(await res.json());
import requestsres = requests.get("https://api.reviewflowz.com/v3/reports/rpt_7/results",headers={"Authorization": "Bearer rfz_live_...",},params={"from": "2026-11-01", "to": "2026-11-17"},)print(res.json())
Edit the request
- compare_from · Comparison window start.
- compare_to · Comparison window end.
- sort_by
- sort_direction
- limit · Rows per page: 1 to 500 (default 50).
- cursor · The next_cursor from the previous page. Leave it out for the first...
What it costs and where it stops
GET /v3/statsanswers every group at once. Excerpts and report rows come up to 500 a page.- Saving a report needs custom reports in your plan: without them,
403plan_restricted. Running one withPOST /v3/reports/querydoesn't. - Rate limits.
When something else fits better
- For each source's rating and how it moves: Track ratings across locations and competitors.
- To compute your own numbers from the reviews themselves: Keep a warehouse or BI tool in sync.