Skip to content

Shop Guide ​

Shop endpoints return the business profile and review statistics resolved from the API key.

Endpoints ​

MethodPathPurpose
GET/api/2026-04/shopRead the current shop profile and aggregate rating.
GET/api/2026-04/shop/statsRead review statistics, rating distribution, and product review coverage.

Shop Profile ​

Use GET /api/2026-04/shop to confirm which business the API key resolves to and to display aggregate shop information.

bash
curl "https://api.revi.io/api/2026-04/shop" \
  -H "Accept: application/json" \
  -H "X-API-KEY: revi_test_xxxxxxxxx"

Typical response:

json
{
  "success": true,
  "data": {
    "website": "example.com",
    "avg_rating": "4.68",
    "total_reviews": 7263,
    "default_language": "en"
  },
  "meta": {
    "api_version": "2026-04"
  }
}

Review Statistics ​

Use GET /api/2026-04/shop/stats for dashboards and periodic reporting.

The response includes:

FieldDescription
avg_ratingCurrent average rating for the business.
total_reviewsTotal review count for the business.
rating_breakdownCounts grouped by star rating from 5 to 1.
reviews_by_type.shopShop review count.
reviews_by_type.productProduct review count.
products_with_reviewsNumber of synchronized products with at least one review.

Caching ​

Shop profile and statistics can be cached by clients for short periods. Revi may also cache these endpoints server-side, so they are best for dashboards and sync checks rather than per-request transactional decisions.

Public API documentation for Revi.