Meisei

    Rating

    These endpoints are called from a shopper's browser, so they take your publishable key rather than a secret one. Anything specific to one customer also takes a signed email and timestamp. Identifying the customer explains how to produce the signature.

    To call them from your own server instead, send a secret key as a bearer token and leave apiPublishableKey out. See Calling the widget API from a server.

    GET /widgets/rating

    Get rating summary for products

    Query parameters

    apiPublishableKeystring

    Your organization's publishable key, from Settings, API keys. Leave it out when the request carries a secret key as a bearer token instead, which is how a server calls these endpoints.

    productSlugsstring

    Comma-separated product slugs to summarize, one per widget on the page.

    productExternalIdsstring

    Comma-separated product IDs on site, such as Shopify product IDs, sent instead of productSlugs.

    sitestring

    The slug of the site productExternalId belongs to. Only needed when the same ID is on more than one of your sites.

    Request
    curl \
  "https://your-store.meisei.app/api/widgets/rating?apiPublishableKey=pk_YOUR_PUBLISHABLE_KEY"
    Response
    {
  "data": [
    {
      "productSlug": "string",
      "productExternalId": "string",
      "title": "string",
      "imageUrl": "string",
      "totalReviews": 0,
      "averageRating": 0,
      "metadata": "..."
    }
  ]
}