Search for feedback results

curl --request GET \
  --url https://api.partoo.co/v2/feedback/feedback_result \
  --header 'x-APIKey: <api-key>'

{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "items": [
    {
      "id": 1,
      "business_id": "5409c35a97bbc544d8e26737",
      "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.",
      "state": "treated",
      "optin": true,
      "created": "2024-10-25T15:12:11+00:00",
      "feedback_form": {
        "id": "674d791c13c9d976e20001b1",
        "display_name": "Global Satisfaction"
      },
      "feedback_result_fields": [
        {
          "rating": 4,
          "content": null,
          "choices": null,
          "feedback_form_field": {
            "id": "674d7aaa13e599deae0001b2",
            "field_type": "CSAT",
            "field_label": "How would you rate our service?",
            "field_choices": null
          }
        }
      ],
      "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",
          "is_reply_suggestion": false
        }
      ],
      "extra": {
        "extra_field": "value",
        "extra_field_2": "value_2"
      }
    }
  ]
}

GET

feedback

feedback_result

Search for feedback results

curl --request GET \
  --url https://api.partoo.co/v2/feedback/feedback_result \
  --header 'x-APIKey: <api-key>'

{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "items": [
    {
      "id": 1,
      "business_id": "5409c35a97bbc544d8e26737",
      "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.",
      "state": "treated",
      "optin": true,
      "created": "2024-10-25T15:12:11+00:00",
      "feedback_form": {
        "id": "674d791c13c9d976e20001b1",
        "display_name": "Global Satisfaction"
      },
      "feedback_result_fields": [
        {
          "rating": 4,
          "content": null,
          "choices": null,
          "feedback_form_field": {
            "id": "674d7aaa13e599deae0001b2",
            "field_type": "CSAT",
            "field_label": "How would you rate our service?",
            "field_choices": null
          }
        }
      ],
      "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",
          "is_reply_suggestion": false
        }
      ],
      "extra": {
        "extra_field": "value",
        "extra_field_2": "value_2"
      }
    }
  ]
}

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.

Query Parameters

business__in

string[]

Filter by business ids. Use a comma-separated list to provide multiple ids.

Example:

"a1c9f37b4deca92f83b61d02,9f4e2a8c0d73b154e621bc97,c73b15e9fa42d60b3a8c21ef"

business__notin

string[]

Excludes from the request all businesses provided

Business id

state__in

enum<string>[]

State of the feedback result

Available options:

treated,

not_treated

Example:

"treated,not_treated"

created__lte

string<datetime>

Max date the feedback result was created on

Example:

"2024-10-01T00:00:00Z"

created__gte

string<datetime>

Min date the feedback result was created on

Example:

"2024-11-01T00:00:00Z"

nps__lte

integer

NPS of the feedback result

Required range: 0 <= x <= 10

Example:

9

nps__gte

integer

NPS of the feedback result

Required range: 0 <= x <= 10

Example:

9

nps__in

integer[]

The possible NPS values of the feedback result

NPS of the feedback result

Required range: 0 <= x <= 10

Example:

"0,1,2,8,9,10"

string[]

The possible words contained in the text field of the feedback result

Maximum array length: 6

optin

enum<boolean>

Whether the respondent accepts to be contacted

Available options:

true,

false

feedback_form_ids

string[]

The forms for which the feedback result is for

The unique identifier of the form

Response

page

integer

Current page number

Example:

1

max_page

integer

Last page number

Example:

10

count

integer

Number of resources complying with filters

Example:

287

items

object[]

Filtered feedback results

Show child attributes

items.id

integer

Example:

1

items.business_id

string

Business id

Example:

"5409c35a97bbc544d8e26737"

items.firstname

string

Firstname of the respondent

Example:

"John"

items.lastname

string

Lastname of the respondent

Example:

"Doe"

items.nps

integer

NPS of the feedback result

Required range: 0 <= x <= 10

Example:

9

items.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."

items.state

enum<string>

State of the feedback result

Available options:

treated,

not_treated

items.optin

enum<boolean>

Whether the respondent accepts to be contacted

Available options:

true,

false

items.created

string<datetime>

Date the feedback result was created on

Example:

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

items.feedback_form

object

Information about the corresponding feedback form

Show child attributes

items.feedback_form.id

string

Unique identifier of the form

Example:

"674d791c13c9d976e20001b1"

items.feedback_form.display_name

string

Name of your form

Example:

"Global Satisfaction"

items.feedback_result_fields

object[]

The various fields of the feedback result

Show child attributes

items.feedback_result_fields.rating

integer | null

Rating assigned by the respondent, if any

Is set for CSAT and NPS fields

Example:

4

items.feedback_result_fields.content

string | null

Text content written by the respondent, if any

Is set for FREE_FORM fields

Example:

null

items.feedback_result_fields.choices

string[] | null

Choices selected by the respondent

Is set for MULTIPLE_CHOICE fields

Example:

null

items.feedback_result_fields.feedback_form_field

object

Show child attributes

items.feedback_result_fields.feedback_form_field.id

string

Unique identifier of the field

Example:

"674d7aaa13e599deae0001b2"

items.feedback_result_fields.feedback_form_field.field_type

enum<string>

Available options:

NPS,

FREE_FORM,

CSAT,

MULTIPLE_CHOICE

Example:

"CSAT"

items.feedback_result_fields.feedback_form_field.field_label

string

The label of the field (i.e. the question that was answered)

Example:

"How would you rate our service?"

items.feedback_result_fields.feedback_form_field.field_choices

object[] | null

All choices that were ever available for this field

Only set for MULTIPLE_CHOICE fields

Show child attributes

items.feedback_result_fields.feedback_form_field.field_choices.id

string

items.feedback_result_fields.feedback_form_field.field_choices.text

string

items.feedback_result_fields.feedback_form_field.field_choices.isOtherOption

boolean

Whether this is the "Other" option

Example:

false

Example:

null

items.comments

object[]

The replies of the feedback result

Show child attributes

items.comments.id

integer

Unique identifier of the reply

Example:

1

items.comments.created

string<datetime>

Date the reply was created

Example:

"2024-11-15T10:00:15+00:00"

items.comments.author_name

string

Author of the reply

Example:

"Jane Doe"

items.comments.content

string

Content of the reply

Example:

"Thank you for your feedback"

items.comments.feedback_result_id

integer

Identifier of the feedback result

Example:

1

items.comments.user_id

string

User id

Example:

"5309c3a237bbc544d8e26737"

items.comments.is_reply_suggestion

boolean

Whether the reply was created using an AI suggestion

Example:

false

items.extra

object

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

Example:

{
  "extra_field": "value",
  "extra_field_2": "value_2"
}

Update a feedback form Reply to a feedback result

ApiKeys

Businesses

Business Fields

Categories

Connection Tokens

Messages

Custom Channels

Message Reply Templates

Messaging Settings

Custom Fields

Custom Fields Section

Custom Roles

Google

Groups and Sections

Holidays

Organizations

Posts

Place Action Links

Presence

Reviews

Presence analytics

Review analytics

Review Booster

Subscriptions

Users

Feedback Management

Webhooks

Webhooks Events

Search for feedback results

Authorizations

Query Parameters

Response