Skip to main content
GET
Get a feedback result by ID

Authorizations

x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Path Parameters

feedback_result_id
integer
required

ID of the feedback result

Response

OK

id
integer
Example:

1

business_id
string

Business id

Example:

"5409c35a97bbc544d8e26737"

store_code
string | null

Store code of the business, as reported in the hidden fields at survey time

Example:

"STORE-042"

firstname
string

Firstname of the respondent

Example:

"John"

lastname
string

Lastname of the respondent

Example:

"Doe"

nps
integer

NPS of the feedback result

Required range: 0 <= x <= 10
Example:

9

content
string

Content of the FREE_FORM field

Example:

"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse vulputate efficitur augue, ac auctor nibh scelerisque at. Nulla facilisi. Maecenas luctus efficitur sem sit amet ullamcorper. Donec tempor augue lorem, vitae convallis sapien aliquam id. Maecenas eu odio non est pretium eleifend. Nullam at odio eu ligula ultrices tincidunt. Nulla euismod aliquet ex eget efficitur."

state
enum<string>

State of the feedback result

Available options:
treated,
not_treated
optin
enum<boolean>

Whether the respondent accepts to be contacted

Available options:
true,
false
created
string<datetime>

Date the feedback result was created on

Example:

"2024-10-25T15:12:11+00:00"

feedback_form
object

Information about the corresponding feedback form

feedback_result_fields
object[]

The various fields of the feedback result

comments
object[]

The replies of the feedback result

extra
object

The additional hidden fields (other than firstname, lastname, store_code, email and date)

Example:
issues
enum<string>[] | null

Data-quality issues flagged on this feedback result, if any

A data-quality issue flagged on the feedback result

Available options:
deleted_business,
missing_store_code,
deleted_user