Reviews

Get company review summary

Returns the rating breakdown, answer summaries, and media previews for the company.

GEThttps://api.widget.cevoid.com/v1/company-reviews/summary

Request

curl 'https://api.widget.cevoid.com/v1/company-reviews/summary' \
  -H "Authorization: Bearer ${CEVOID_PUBLISHABLE_KEY}"

fetch("https://api.widget.cevoid.com/v1/company-reviews/summary", {
  headers: {
    Authorization: "Bearer YOUR_PUBLISHABLE_KEY",
  },
})
  .then((response) => response.json())
  .then((data) => console.log(data))

const response = await fetch("https://api.widget.cevoid.com/v1/company-reviews/summary", {
  headers: {
    Authorization: `Bearer ${process.env.CEVOID_PUBLISHABLE_KEY}`,
  },
})
if (!response.ok) throw new Error(`Request failed: ${response.status}`)
const data = await response.json()
console.log(data)

import os

import requests

response = requests.get(
    "https://api.widget.cevoid.com/v1/company-reviews/summary",
    headers={
        "Authorization": f"Bearer {os.environ['CEVOID_PUBLISHABLE_KEY']}",
    },
)
response.raise_for_status()
print(response.json())

<?php

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.widget.cevoid.com/v1/company-reviews/summary',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('CEVOID_PUBLISHABLE_KEY'),
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://api.widget.cevoid.com/v1/company-reviews/summary", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer " + os.Getenv("CEVOID_PUBLISHABLE_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}

require "net/http"

uri = URI("https://api.widget.cevoid.com/v1/company-reviews/summary")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("CEVOID_PUBLISHABLE_KEY")}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.body

Response

{
  "data": {
    "rating_count": 2,
    "text_review_count": 2,
    "average_rating": 4.5,
    "rating_distribution": {
      "1": 0,
      "2": 0,
      "3": 0,
      "4": 1,
      "5": 1
    },
    "verified_purchase_count": 0,
    "reviews_with_media_count": 0,
    "media_count": 0,
    "languages": [
      {
        "language": "en",
        "rating_count": 2
      }
    ],
    "question_summaries": [],
    "media_preview": [],
    "ai_summary": {
      "text": "Reviewers describe a positive overall experience, with ratings of four and five stars.",
      "language": "en",
      "generated_at": "2026-09-01T10:00:00.000Z",
      "review_count": 2
    }
  }
}

Show all 31 linesShow fewer lines

{
  "additional_data": {
    "property1": null,
    "property2": null
  },
  "status": 400,
  "code": "bad_request",
  "message": "Bad request",
  "request_id": "req_abc123"
}

{
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "request_id": "req_abc123"
}

{
  "status": 403,
  "code": "forbidden",
  "message": "Forbidden",
  "request_id": "req_abc123"
}

{
  "additional_data": {
    "property1": null,
    "property2": null
  },
  "status": 404,
  "code": "not_found",
  "message": "Resource not found",
  "request_id": "req_abc123"
}

{
  "status": 409,
  "code": "conflict",
  "message": "Conflict",
  "request_id": "req_abc123"
}

{
  "additional_data": {
    "property1": null,
    "property2": null
  },
  "status": 422,
  "code": "validation_error",
  "message": "Validation error",
  "request_id": "req_abc123"
}

{
  "status": 429,
  "code": "too_many_requests",
  "message": "Too many requests",
  "request_id": "req_abc123"
}

{
  "status": 500,
  "code": "internal_server_error",
  "message": "Internal server error",
  "request_id": "req_abc123"
}

Authorizations

Authorizationbearer tokenheaderrequired

Send Authorization: Bearer <key>, where the key is your publishable key.

Query parameters

marketstring

Presentation market. Defaults to the workspace default; does not filter collection origin.

Length: 1 to 200
Example: mar_abc123

includeenum<string>

Include original prompts and labels for the returned question definitions. Does not include originals for AI summary text or preview media.

Allowed value: localization
Example: localization

Response

200 Successful response application/json

dataobjectrequired

Properties (11)

rating_countintegerrequired

Number of published, visible ratings, including reviews without text. Independent of review-list filters and presentation market.

Range: 0 <= x
Example: 2

text_review_countintegerrequired

Public reviews with a non-blank title or body.

Range: 0 <= x
Example: 2

average_ratingnumber | nullrequired

Arithmetic mean of all public ratings; null when empty.

Example: 4.5

rating_distributionobjectrequired

Properties (5)

1numberrequired

Example: 0

2numberrequired

Example: 0

3numberrequired

Example: 0

4numberrequired

Example: 1

5numberrequired

Example: 1

verified_purchase_countintegerrequired

Public reviews with a verified purchase.

Range: 0 <= x
Example: 1

reviews_with_media_countintegerrequired

Public reviews with at least one displayable image or video.

Range: 0 <= x
Example: 1

media_countintegerrequired

Displayable images and videos across all public reviews, not only the preview.

Range: 0 <= x
Example: 1

languagesobject[]required

Item properties (2)

languagestringrequired

Example: en

rating_countnumberrequired

Example: 2

question_summariesobject[]required

Item properties (12)

question_idstringrequired

Opaque Cevoid identifier.

Length: 1 to 200
Example: rvq_abc123

answer_countintegerrequired

Public responses counted for this question. Summaries require at least two responses.

Range: 0 <= x
Example: 2

averagenumber

Example: 4.5

distributionobject[]

Item properties (2)

valuestring | numberrequired

Example: blue

countintegerrequired

Range: 0 <= x
Example: 1

yes_countinteger

Range: 0 <= x
Example: 2

no_countinteger

Range: 0 <= x
Example: 0

typeenum<string>required

Allowed values: PRODUCT_ATTRIBUTE COMPANY_ATTRIBUTE PROFILE_PROPERTY
Example: PRODUCT_ATTRIBUTE

promptstringrequired

Example: How does it fit?

formatenum<string>required

Allowed values: SCALE CENTERED_RANGE SINGLE_SELECT MULTI_SELECT WOULD_RECOMMEND NUMERIC
Example: SCALE

scaleobject

Current scale size and labels, localized for the selected market. Not a submission-time snapshot.

Properties (5)

stepsnumberrequired

Example: 5

start_labelstringrequired

Example: Too small

end_labelstringrequired

Example: Too large

center_labelstring

Example: Just right

step_labelsstring[]

optionsobject[]

Current selection options. Labels are localized; values remain stable selection keys.

Item properties (2)

valuestringrequired

Example: blue

labelstringrequired

Example: Blue

numericobject

Properties (1)

unitstring

Example: cm

media_previewobject[]required

Maximum items: 4

Item properties (2)

review_idstringrequired

Opaque Cevoid identifier.

Length: 1 to 200
Example: rev_abc123

mediaobjectrequired

Properties (11)

typeenum<string>required

Whether the item is an image or a video.

Allowed values: IMAGE VIDEO
Example: IMAGE

urlstringrequired

Delivery URL for the full asset.

Example: https://example.com/reviews/123

thumbnail_urlstringrequired

Delivery URL for the thumbnail.

Example: https://example.com/reviews/123

aspect_rationumberrequired

Width divided by height.

Example: 1.5

aspect_ratio_typeenum<string>required

Coarse orientation bucket.

Allowed values: LANDSCAPE PORTRAIT SQUARE
Example: LANDSCAPE

video_lengthnumber

Video duration in seconds.

Example: 12

idstringrequired

Stable opaque asset identity shared by detail and preview.

Example: rmed_abc123

altstring

Available image alternative text, localized with source fallback.

Example: Blue shirt worn outdoors

thumbnail_altstring

Available video poster alternative text.

Example: Blue shirt video preview

video_descriptionstring

Available description of video imagery.

Example: A shopper shows the fit of a blue shirt.

video_captionsstring

Available WebVTT captions with cue timing, localized with source fallback.

Example: WEBVTT 00:00.000 --> 00:01.000 The fit is comfortable.

ai_summaryobject

Properties (4)

textstringrequired

Example: Shoppers praise the comfortable fit.

languagestringrequired

Example: en

generated_atstring<date-time>required

Example: 2026-09-01T10:00:00.000Z

review_countnumberrequired

Example: 2

includedobject

Properties (1)

localizationobjectrequired

Properties (1)

questionsobject[]

Item properties (3)

idstringrequired

Public ID matching the returned entity or nested item.

Length: 1 to 200
Example: rev_abc123

has_translationsbooleanrequired

True when the returned translatable content differs from its source representation. Does not mean every field was translated.

Example: true

originalobject | nullrequired

Complete source projection of translatable fields, with the same visibility and masking rules. Null when no returned content differs. Not edit history.

Properties (3)

promptstringrequired

Example: How does it fit?

optionsobject[]

Current selection options. Labels are localized; values remain stable selection keys.

Item properties (2)

valuestringrequired

Example: blue

labelstringrequired

Example: Blue

scaleobject

Properties (4)

start_labelstringrequired

Example: Too small

end_labelstringrequired

Example: Too large

center_labelstring

Example: Just right

step_labelsstring[]

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

400 Bad request application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

401 Unauthorized application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

403 Forbidden application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

404 Not found application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

409 Conflict application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

422 Validation error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

429 Too many requests application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (6)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

Retry-Afterinteger

Seconds to wait before retrying the request

500 Internal server error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available