Widgets

Featurable Widgets let you embed reviews on your website without coding, and for developers let you fetch reviews without using the accounts and locations endpoints.

The widget model

The Widget object represents a Google My Business profile and configuration options setup in your Featurable dashboard. Widgets are public top-level entities used to power the no-code embed options, but can also be used for full customization and control over displaying reviews on your website.

Each widget object contains a maximum of 50 reviews, Google profile URL, the business's average rating, total number of reviews, and a configuration object.

Properties

  • Name
    success
    Type
    boolean
    Description

    Whether the request was successful

  • Name
    layout
    Type
    string
    Description

    Widget layout configuration (e.g. "grid")

  • Name
    config
    Type
    Config
    Description

    Object containing configuration settings

  • Name
    pinnedReviews
    Type
    string[]
    Description

    Array of review IDs to be pinned, as defined in the dashboard

  • Name
    highlights
    Type
    Highlight[]
    Description

    Array of Highlight objects representing highlighted text in reviews

  • Name
    published
    Type
    boolean
    Description

    Whether the widget is published or not.

  • Name
    profileUrl
    Type
    string
    Description

    URL to the Google My Business profile listing

  • Name
    batchSize
    Type
    number
    Description

    Number of reviews (maximum of 50)

  • Name
    totalReviewCount
    Type
    number
    Description

    Total number of reviews the business location has

  • Name
    averageRating
    Type
    number
    Description

    Average rating of reviews from 0 to 5

  • Name
    reviews
    Type
    Review[]
    Description

    Array of Review objects

  • Name
    titles
    Type
    Title[]
    Description

    Array of Title objects for AI-enhanced titles pulled out of reviews

GET/v1/widgets/:widgetId

Get widget data

This endpoint allows you to retrieve the Widget data by a widget ID. After creating a widget, you can retrieve the widget ID when embedding the widget.

Request

GET
/v1/widgets
curl -G https://featurable.com/api/v1/widgets/:widgetId

Response

{
  "success": true,
  "layout": "grid",
  "config": {
    // ...
  },
  "pinnedReviews": [
    "WAz8eIbvDR60..."
  ],
  "highlights": [
    {
        "reviewId": "WAz8eIbvDR60...",
        "text": "Amazing" 
    }
  ],
  "published": true,
  "profileUrl": "https://google.com/...",
  "batchSize": 50,
  "totalReviewCount": "123",
  "averageRating": 4.5,
  "reviews": [
    {
      "reviewId": "WAz8eIbvDR60...",
      // ...
    },
  ],
  "titles": [
    {
        "reviewId": "WAz8eIbvDR60...",
        "title": "Great product"
    }
  ]
}

The Config model

The Config object contains configuration settings for a widget, as defined in the Featurable dashboard.

The Config object is currently not documented because it isn't intended for developer use.

The Highlight model

The Highlight object contains in-review highlights when using the highlighter feature in the widget editor. For example:

Example of Rendered Highlights

Properties

  • Name
    reviewId
    Type
    string
    Description

    Unique ID of the review associated with the title

  • Name
    text
    Type
    string
    Description

    Text snippet used in the highlight

The Title model

The Title object represents AI-generated titles. Titles are generated using LLMs to pull direct quotations out of reviews that emphasize the most compelling snippets from the reviews.

Example of AI Generated Title

Properties

  • Name
    reviewId
    Type
    string
    Description

    Unique ID of the review associated with the title

  • Name
    title
    Type
    string
    Description

    Direct quotation snippet from the review used as a title

Was this page helpful?