AM
EN
Get Started Free
Menu

Contents

User feedback collection, search, and deletion

GET/api/users/{user_id}/feedback

List feedback entries for a user.

Responses
200application/json
OK
schemaobject
dataarrayrequired
itemobjectrequired
idstringrequired
Unique identifier for user feedback.
user_idstringrequired
Unique identifier for a user.
account_idstring | nullrequired
Unique identifier for an account.
overall_ratingintegerrequired
feedbackstringrequired
screenobjectrequired
Nested fields truncated. Expand to continue inline, or use the model link.
urlstring · urirequired
languagestringrequired
color_moderequired
metaobjectrequired
created_atstringrequired
updated_atstringrequired
linksobjectrequired
selfstringrequired
URL of the current page
nextstring
URL of the next page
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
404application/problem+jsonProblemDetails
Not Found
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
POST/api/users/{user_id}/feedback

Create a new feedback entry for a user.

Body application/json
overall_ratingintegerrequired
feedbackstringrequired
account_idstringrequired
Unique identifier for an account.
user_idstringrequired
Unique identifier for a user.
screenobjectrequired
widthintegerrequired
heightintegerrequired
device_pixel_rationumberrequired
urlstring · urirequired
languagestringrequired
color_moderequired
metaobject
Responses
200application/json
OK
schemaobject
dataobjectrequired
idstringrequired
Unique identifier for user feedback.
user_idstringrequired
Unique identifier for a user.
account_idstring | nullrequired
Unique identifier for an account.
overall_ratingintegerrequired
feedbackstringrequired
screenobjectrequired
widthintegerrequired
heightintegerrequired
device_pixel_rationumberrequired
urlstring · urirequired
languagestringrequired
color_moderequired
metaobjectrequired
created_atstringrequired
updated_atstringrequired
linksobjectrequired
selfstringrequired
URL of the created resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
404application/problem+jsonProblemDetails
Not Found
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
DELETE/api/users/{user_id}/feedback/{feedback_id}

Delete a feedback entry for a user.

Responses
200application/json
OK
schemaobject
dataobjectrequired
idstringrequired
Unique identifier for user feedback.
user_idstringrequired
Unique identifier for a user.
account_idstring | nullrequired
Unique identifier for an account.
overall_ratingintegerrequired
feedbackstringrequired
screenobjectrequired
widthintegerrequired
heightintegerrequired
device_pixel_rationumberrequired
urlstring · urirequired
languagestringrequired
color_moderequired
metaobjectrequired
created_atstringrequired
updated_atstringrequired
linksobjectrequired
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
404application/problem+jsonProblemDetails
Not Found
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
GET/api/users/{user_id}/feedback/{feedback_id}

Get a single feedback entry for a user.

Responses
200application/json
OK
schemaobject
dataobjectrequired
idstringrequired
Unique identifier for user feedback.
user_idstringrequired
Unique identifier for a user.
account_idstring | nullrequired
Unique identifier for an account.
overall_ratingintegerrequired
feedbackstringrequired
screenobjectrequired
widthintegerrequired
heightintegerrequired
device_pixel_rationumberrequired
urlstring · urirequired
languagestringrequired
color_moderequired
metaobjectrequired
created_atstringrequired
updated_atstringrequired
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
404application/problem+jsonProblemDetails
Not Found
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
POST/api/users/{user_id}/feedback/search

Search user feedback using Lucene syntax.

Body application/json
querystringrequired
limitinteger
offsetinteger
sort
Responses
200application/json
OK
schemaobject
dataarrayrequired
itemobjectrequired
idstringrequired
Unique identifier for user feedback.
user_idstringrequired
Unique identifier for a user.
account_idstring | nullrequired
Unique identifier for an account.
overall_ratingintegerrequired
feedbackstringrequired
screenobjectrequired
Nested fields truncated. Expand to continue inline, or use the model link.
urlstring · urirequired
languagestringrequired
color_moderequired
metaobjectrequired
created_atstringrequired
updated_atstringrequired
metaobjectrequired
querystringrequired
totalnumberrequired
limitnumberrequired
offsetnumberrequired
sortrequired
linksobjectrequired
selfstringrequired
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
404application/problem+jsonProblemDetails
Not Found
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
POST/api/users/{user_id}/feedback/search-delete

Delete user feedback by Lucene query. Use dry_run=true to preview.

Body application/json
querystringrequired
dry_runboolean
limitinteger
Responses
200application/json
OK
schemaobject
dataobjectrequired
deleted_countnumberrequired
deleted_idsarrayrequired
itemstringrequired
Unique identifier for user feedback.
dry_runbooleanrequired
metaobjectrequired
querystringrequired
linksobjectrequired
selfstringrequired
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
404application/problem+jsonProblemDetails
Not Found
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring

Models

ProblemDetails
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
ValidationProblemDetails
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring