Cloutly Reviews API & SDK
  • Introduction
    • Background & Motivations
    • System Overview
    • Setup & Authentication
    • Ping
  • Swagger Docs
    • Swagger Specs
  • Vendor API
    • Create Vendor
    • Get Vendor
    • Update Vendor
  • Review Collection API
    • Send Review Invite
  • Review Submission API
    • Submit Review
  • Review Insights API
    • Get Reviews
    • Get Review Insights
  • Review Widgets SDK
    • Enriched Review Widgets UI
    • Custom HTML Review Widgets
Powered by GitBook
On this page
  • GET /vendors/{vendorId}/insights
  • Request
  • Response
  • Comments
  • Example of Review Insights
  1. Review Insights API

Get Review Insights

Endpoint returns a snapshot of reputation insights along with the vendors competitors insights

GET /vendors/{vendorId}/insights

Pulls a summary of online reputation insights for a vendor. Note: you need to connect the source as an integration in the dashboard and have the competitors prefilled.

Request

GET https://marketplace.cloutly.com/api/v2/vendors/{vendorId}/review-insights

Response

{
  "topInsights": [
    {
      "category": "Food",
      "topic": "Overcooked Pasta",
      "mentions": 7,
      "label": "7 people complained about the pasta being cooked.",
      "sentiment": "negative"
    }
  ],
  "recentInsights": [
    {
      "category": "Food",
      "topic": "Overcooked Pasta",
      "mentions": 7,
      "label": "7 people complained about the pasta being cooked.",
      "sentiment": "negative"
    }
  ],
  "statistics": {
    "totalReviews": 140,
    "averageRating": 4.2,
    "averageRatingTrend": -2.1
  }
}

Comments

  • You can display this to the vendor in your dashboard or by weekly email digests

  • recentInsights are Insights within the last 30 days.

  • topInsights are Insights since all time.

Example of Review Insights

PreviousGet ReviewsNextEnriched Review Widgets UI

Last updated 7 months ago