Engagement Stats Guide
The engagement stats endpoint returns precomputed daily or monthly metrics for dashboards and reporting without running expensive live aggregates. These values come from the same materialized engagement source used by UGC.
Endpoint
| Method | Path | Purpose |
|---|---|---|
GET | /api/2026-04/stats/engagement | Get email, click, and review engagement metrics. |
Request
bash
curl "https://api.revi.io/api/2026-04/stats/engagement?from_date=2026-05-01&to_date=2026-05-31&granularity=day" \
-H "Accept: application/json" \
-H "X-API-KEY: revi_test_xxxxxxxxx"Supported filters:
| Filter | Description |
|---|---|
from_date | Start date in YYYY-MM-DD format. Defaults to 29 days before to_date. |
to_date | End date in YYYY-MM-DD format. Defaults to today. |
id_store | Store ID, or a comma-separated list of numeric store IDs. Store-scoped API keys are automatically restricted to their store. |
granularity | day or month. Defaults to day. |
Metrics
| Metric | Source |
|---|---|
emails_sent | Count of rows in businesses_invitations. |
emails_opened | Sum of the maintained open flag. |
clicks | Visits to the review page from invitation links. Public name for the internal review_page_visits metric, sourced from the maintained viewpage flag. |
reviews_generated | Count of reviews by date_review. |
The response includes a summary object for the whole range and a series array for each period bucket. Ranges with no data return zero-filled periods.