PApartoo
Feedback Management

Get a feedback result by ID

Changed on
<Warning> The Feedback Management API is currently in **BETA**, therefore the following endpoints are subject to modification, given a **2 week notice**.

If 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 retrieve a single feedback result by its ID.

get/feedback/feedback_result/{feedback_result_id}

Request

Path parameters

feedback_result_idinteger required

ID of the feedback result

Response

OK

idinteger required
business_idstring required

Business id

store_codestring nullable required

Your own code for the business, if the survey link carried one

firstnamestring nullable required

Firstname of the respondent, if the survey collected it

lastnamestring nullable required

Lastname of the respondent, if the survey collected it

npsinteger required

NPS of the feedback result

contentstring nullable required

Content of the FREE_FORM answer, or null when the survey has none.

When the survey has several FREE_FORM questions, this holds the last one only: read feedback_result_fields to get every answer.

state'treated' | 'not_treated' required

State of the feedback result

optintrue | false required

Whether the respondent accepts to be contacted

createdstring date-time required

Date the feedback result was created on

extraobject required

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

issuesstring[] nullable

Data quality issues flagged on the feedback result, if any

Example response

{
  "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

  • dcb8190f5a29Revision 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 from datetime to date-time for 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