Reviewflowz API Get an API key

Analyze reviews: stats, topics and reports

You end up with the numbers behind your reviews: totals for any set of reviews, the same numbers by month, source, location or platform, what customers say about each topic, and report tables you define.

Run calls

Sign in to run every call on this page on your account's data. No key needed.

Before you start

  • A key with analytics:read and reviews:read, plus analytics:write to 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_..."
Edit the request

GET /v3/stats in the reference

Example answer
{"data": [{"group": {},"count": 48,"average_rating": 4.46,"ratings": {"5": 33,"4": 9,"3": 3,"2": 1,"1": 2},"replied": 41,"reply_rate": 0.8542,"removed": 1,"sentiment": {"positive": 71,"neutral": 9,"negative": 14}}],"group_by": "none"}​

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_..."
Edit the request

GET /v3/stats in the reference

Example answer
{"data": [{"group": {"period": "2026-09-01","interval": "month"},"count": 31,"average_rating": 4.42,"reply_rate": 0.871},{"group": {"period": "2026-10-01","interval": "month"},"count": 35,"average_rating": 4.51,"reply_rate": 0.8857},{"group": {"period": "2026-11-01","interval": "month"},"count": 13,"average_rating": 4.31,"reply_rate": 0.7692}],"group_by": "period","interval": "month"}​

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_..."
Edit the request

GET /v3/excerpts in the reference

Example answer
{"next_cursor": null,"has_more": false,"data": [{"id": "exc_5521","text": "the staff on the second floor were patient with our kids","topic": "Staff","subtopic": "Friendliness","sentiment": "positive","sentiment_score": 0.92,"review": "rev_918273","source": "src_4812","rating": 5,"date": "2026-11-09T18:32:00Z"}]}​

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"]}'
Edit the request

POST /v3/reports/query in the reference

Example answer
{"data": [{"platform": "Google Maps","average_rating": 4.52,"review_velocity": 39},{"platform": "Tripadvisor","average_rating": 4.11,"review_velocity": 9}],"next_cursor": null,"has_more": false,"from": "2026-10-01","to": "2026-11-17"}​
  • Dates: from and to, the last 30 days when you leave them out. compare_from and compare_to add a comparison_ column per metric.
  • Filters: a filters object, like {"rating": [1, 2], "has_reply": false}. A name it doesn't take answers 400 invalid_parameter with the names it does.
  • A combination that can't be computed answers 422 invalid_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"]}'
Edit the request

POST /v3/reports in the reference

Example answer
{"id": "rpt_7","name": "Rating by platform","dimensions": ["platform"],"metrics": ["average_rating","review_velocity"],"url": "https://app.reviewflowz.com/custom_reports/7"}​

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_..."
Edit the request

GET /v3/reports/{id}/results in the reference

What it costs and where it stops

When something else fits better