Feedback

Get a feedback by ID

get
Query parameters
idstringRequired

The UUID of the feedback to retrieve

Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Responses
chevron-right
200

The feedback has been successfully retrieved.

application/json
idstringRequired

Unique identifier

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

sourcestring · enumRequired

Data sources associated with the customer

Possible values:
classstring · enumRequired

Class of the review

Possible values:
textstring · nullableRequired

Review text content

Default: null
htmlstring · nullableRequired

Review html content - Email only

Default: null
externalIdstring · nullableRequired

External identifier of the review

Default: null
ratingnumber · nullableRequired

Review rating - from 0 to 5 (can be null if the review has no rating)

Default: null
languagestring · enumRequired

Language used to generate review responses

Possible values:
polaritystring · enumRequired

Detected review polarity

Possible values:
spamScorenumber · nullableRequired

Spam score, if available. Lower is better; scores can be negative or positive. Messages above 5 are generally considered spam.

Default: null
likeRecommendedboolean · nullableRequired

Only for social network comments. Determines whether the post comment should be liked or not

Default: null
replyRecommendedboolean · nullableRequired

Only for social network comments. Determines whether the post comment should have a reply or not

Default: null
hideRecommendedboolean · nullableRequired

Only for social network comments. Determines whether the post comment should be hidden or not

Default: null
analyzedbooleanRequired

Whether or not the review has been analyzed by the system

csatIndexnumber · nullableRequired

Customer Satisfaction Index for the content's feedback. Only for survey feedbacks with CSAT question type.

Default: null
npsValuenumber · nullableRequired

Net Promoter Score value for the content's feedback. Only for survey feedbacks with NPS question type.

Default: null
deletedbooleanRequired

Determines whether review has been removed from its source platform

importedbooleanRequired

Determines if the review has been imported manually (eg. via CSV import) or automatically via an integration

get
/partners/feedback

List feedbacks

post
Header parameters
X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Body
limitnumber · min: 1 · max: 100Optional

Pagination limit

Default: 10
pagenumber · min: 1Optional

Page to retrieve

Default: 1
fromstring · nullableOptional

Date range start

tostring · nullableOptional

Date range end

storesstring · uuid[] · min: 1 · max: 100 · nullableOptional

Store IDs to filter feedbacks

brandsstring · uuid[] · min: 1 · max: 100 · nullableOptional

Brand IDs to filter feedbacks

customersstring · uuid[] · min: 1 · max: 100 · nullableOptional

Customer IDs to filter feedbacks

externalIdsstring[] · min: 1 · max: 100 · nullableOptional

External IDs to filter feedbacks

surveysstring · uuid[] · min: 1 · max: 100 · nullableOptional

Survey IDs to filter feedbacks

contactFormsstring · uuid[] · min: 1 · max: 100 · nullableOptional

Contact form IDs to filter feedbacks

Responses
post
/partners/feedback/list

Last updated