Search for feedback results
Changed onIf you are planning to use any of them, please notify us so we will be able to keep you informed about upcoming changes. </Warning>
This endpoint lets you search for the feedback results of your businesses.
The response is paginated (30 results per page).
Request
- Base URLhttps://api.partoo.co/v2
- AuthAPI key in header x-APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Filter by business ids. Use a comma-separated list to provide multiple ids.
[ "5409c35a97bbc544d8e26737" ]
Excludes from the request all businesses provided
[ "5409c35a97bbc544d8e26737" ]
State of the feedback result
Max date the feedback result was created on
Min date the feedback result was created on
NPS of the feedback result
Max NPS of the feedback result
NPS of the feedback result
Min NPS of the feedback result
The possible NPS values of the feedback result
[ 9 ]
The possible words contained in the text field of the feedback result
Whether the respondent accepts to be contacted
The forms for which the feedback result is for
[ "674d791c13c9d976e20001b1" ]
Response
OK
Example response
{
"page": 1,
"max_page": 10,
"count": 287,
"items": [
{
"id": 1,
"business_id": "5409c35a97bbc544d8e26737",
"store_code": "FR-0042",
"firstname": "John",
"lastname": "Doe",
"nps": 9,
"content": "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.",
"created": "2024-10-25T15:12:11+00:00",
"feedback_form": {
"id": "674d791c13c9d976e20001b1",
"display_name": "Global Satisfaction",
"custom_hidden_fields": {
"field_1": "Campaign"
}
},
"feedback_result_fields": [
{
"rating": 4,
"feedback_form_field": {
"id": "674d7aaa13e599deae0001b2",
"field_type": "CSAT",
"field_label": "How would you rate our service?"
}
}
],
"comments": [
{
"id": 1,
"created": "2024-11-15T10:00:15+00:00",
"author_name": "Jane Doe",
"content": "Thank you for your feedback",
"feedback_result_id": 1,
"user_id": "5309c3a237bbc544d8e26737"
}
],
"extra": {
"extra_field": "value",
"extra_field_2": "value_2"
}
}
]
}Changes
- breaking
the response property
///became nullable for the status - breaking
the response property
///became nullable for the status - breaking
the response property
///became nullable for the status - breaking
the
///response's property format changed fromdatetimetodate-timefor status - info
the response property
///became required for the status - info
the response property
///became required for the status - info
the response property
///became required for the status - info
the response property
///became required for the status - info
the response property
///became required for the status - info
the response property
///became required for the status - info
the response property
////became required for the status - info
the response property
////became required for the status - info
the response property
///became required for the status - info
the response property
/////became required for the status - info
the response property
/////became required for the status - info
the response property
/////became required for the status - info
the response property
/////became required for the status - info
the response property
///became required for the status - info
the response property
///became required for the status - info
the response property
///became required for the status - info
the response property
///became required for the status - info
the response property
///became required for the status - info
the response property
///became required for the status - info
the response property
///became required for the status
- breaking