Widget

Get widget data including review statistics and display settings for embedding on your website.

Get Widget Data

GET/api/v1/public/widget

Returns review statistics and widget display settings for your project. Use this endpoint to build custom review widgets for your website.

Headers:

x-api-key: YOUR_API_KEY

Response:

Response
{
  "stats": {
    "totalReviews": 42,
    "averageRating": 4.3,
    "platforms": 3
  },
  "settings": {
    "language": "en",
    "theme": "light",
    "showAiBadge": true,
    "showBranding": true
  }
}

Response Fields

stats

  • totalReviews - Total number of reviews across all sources
  • averageRating - Average rating (1-5)
  • platforms - Number of connected review platforms

settings

  • language - Widget language ("de" or "en")
  • theme - Widget theme ("light" or "dark")
  • showAiBadge - Whether to display the AI analysis badge
  • showBranding - Whether to display Proofio branding

Note: On the Starter plan, showBranding is always true. Upgrade to Growth or Scale to customize branding settings.