Skip to content

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 ​

MethodPathPurpose
GET/api/2026-04/stats/engagementGet 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:

FilterDescription
from_dateStart date in YYYY-MM-DD format. Defaults to 29 days before to_date.
to_dateEnd date in YYYY-MM-DD format. Defaults to today.
id_storeStore ID, or a comma-separated list of numeric store IDs. Store-scoped API keys are automatically restricted to their store.
granularityday or month. Defaults to day.

Metrics ​

MetricSource
emails_sentCount of rows in businesses_invitations.
emails_openedSum of the maintained open flag.
clicksVisits to the review page from invitation links. Public name for the internal review_page_visits metric, sourced from the maintained viewpage flag.
reviews_generatedCount 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.

Public API documentation for Revi.