Skip to content
Get API key (opens in a new tab)

Reviews

Get company review

Returns one company review and its public replies.

GEThttps://api.widget.cevoid.com/v1/company-reviews/{review_id}

Authorizations

Authorizationbearer tokenheaderrequired

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

Path parameters

review_idstringrequired

Opaque Cevoid identifier.

  • Length: 1 to 200
  • Example: rev_abc123

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 compact original content alongside localized fields. Review reads include reviews, public replies, visible media accessibility text, and returned questions. Summary reads include returned questions only.

  • Allowed value: localization
  • Example: localization

Response

200 Successful response application/json

dataobjectrequired
Properties (17)
idstringrequired

Opaque Cevoid identifier.

  • Length: 1 to 200
  • Example: rev_abc123
ratingintegerrequired

Score from 1 to 5.

  • Range: 1 <= x <= 5
  • Example: 5
titlestring

Reviewer-supplied headline. In localized responses, title and body both use source text unless a complete translation is available.

  • Example: Comfortable everyday fit
bodystring

Reviewer-supplied text. Absent for star-only reviews. In localized responses, title and body both use source text unless a complete translation is available.

  • Example: Comfortable and true to size.
languagestringrequired

BCP-47 language of the original submission, even when the returned text is translated.

  • Example: en
purchase_verificationenum<string>required

Purchase evidence state behind verified-buyer display.

  • Allowed values: VERIFIED UNVERIFIED
  • Example: UNVERIFIED
is_incentivizedbooleanrequired

Whether a reward influenced submission.

  • Example: false
is_insiderbooleanrequired

Whether the reviewer is brand-connected.

  • Example: false
channelenum<string>required

How the review entered Cevoid.

  • Allowed values: REQUEST WIDGET LINK IMPORT SYNDICATED_IN
  • Example: IMPORT
submitted_atstring<date-time>

ISO 8601 timestamp when submission completed.

  • Example: 2026-09-01T10:00:00.000Z
published_atstring<date-time>

ISO 8601 timestamp when it first became public.

  • Example: 2026-09-01T10:00:00.000Z
edited_atstring<date-time>

Last reviewer edit; unrelated processing does not change this timestamp.

  • Example: 2026-09-01T10:00:00.000Z
reviewerobjectrequired
Properties (2)
display_namestringrequired
  • Example: Jane S
avatar_urlstring
  • Example: https://example.com/reviews/123
mediaobject[]required
Item 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.
answersobject[]required
Item properties (8)
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
question_idstringrequired

Opaque Cevoid identifier.

  • Length: 1 to 200
  • Example: rvq_abc123
valuenumber | string | boolean | string[]required
  • Example: 4
responsesobject[]required
Item properties (5)
idstringrequired

Opaque Cevoid identifier.

  • Length: 1 to 200
  • Example: rrsp_abc123
bodystringrequired
  • Example: Comfortable and true to size.
created_atstring<date-time>required
  • Example: 2026-09-01T10:00:00.000Z
updated_atstring<date-time>
  • Example: 2026-09-01T10:00:00.000Z
authorobjectrequired
Properties (1)
display_namestringrequired
  • Example: Jane S
helpfulobject
Properties (2)
up_countnumberrequired
  • Example: 3
down_countnumber
  • Example: 0
includedobject
Properties (1)
localizationobjectrequired
Properties (4)
company_reviewsobject[]
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 (2)
titlestring

Reviewer-supplied headline. In localized responses, title and body both use source text unless a complete translation is available.

  • Example: Comfortable everyday fit
bodystring

Reviewer-supplied text. Absent for star-only reviews. In localized responses, title and body both use source text unless a complete translation is available.

  • Example: Comfortable and true to size.
review_responsesobject[]
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 (1)
bodystringrequired

Reply text as published.

  • Example: Comfortable and true to size.
review_mediaobject[]
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 (4)
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.
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