Skip to content
English
  • There are no suggestions because the search field is empty.

Pisano External API - Feedback - Get Feedback

Get a feedback

Retrieve a specific feedback by ID

GET /external/v1/feedbacks/{id}

Authentication

Authorization Token token=<TOKEN>

Request

Path Parameters

Parameter Type Required Description Example
id string Yes Feedback ID id

Headers

Header Required Description Example
Accept No Specifies the expected response media type. application/json
Authorization Yes Pisano API token used to authenticate the request. Token token=<TOKEN>

Responses

200 Feedback details

Response Fields

Field Type Required Description
id string Unique identifier of the feedback.
status string Current status of the feedback.
created_at string Creation timestamp of the feedback.
updated_at string Last update timestamp of the feedback.
title string Title of the feedback.
average_positivity number / nullable Average positivity value of the feedback when available.
responses array Responses submitted for the feedback.
responses[].question object Question associated with the response.
responses[].question.id string Unique identifier of the question.
responses[].question.body object Localized question text.
responses[].question.body.<language_code> string Question text for the specified language.
responses[].question.style string Question type/style.
responses[].question.key string / nullable Question key. Can be null.
responses[].question.category_id
responses[].question.masked boolean Indicates whether the question is masked.
responses[].question.node_id
responses[].question.required boolean Indicates whether the question is required.
responses[].question.weight number / nullable Question weight when applicable.
responses[].response string Submitted response value.
responses[].positivity number / nullable Positivity value of the response when available.
responses[].created_at string Creation timestamp of the response.
responses[].custom_score
responses[].feedback_id string Identifier of the related feedback.
responses[].id string Unique identifier of the response.
responses[].order number Order value of the response.
responses[].power_score
responses[].ranking
responses[].score number / nullable Score of the response when applicable.
responses[].submitted_at string Submission timestamp of the response.
responses[].updated_at string Last update timestamp of the response.
node object Node associated with the feedback.
node.id string Unique identifier of the node.
node.type string Node type.
node.name string Node name.
node.code string Node code.
node.timezone string Timezone configured for the node.
node.external_id
node.flow_id string Identifier of the associated flow.
node.parent_id string Identifier of the parent node.
tags array Tags associated with the feedback.
flow object Flow associated with the feedback.
flow.id string Unique identifier of the flow.
flow.name string Name of the flow.
flow.created_at string Creation timestamp of the flow.
flow.deleted_at
flow.node_id string / nullable Node identifier associated with the flow when available.
flow.parent_flow_id
flow.question_category_parent_id
flow.status string Current status of the flow.
flow.updated_at string Last update timestamp of the flow.
customer object Customer associated with the feedback.
customer.id string Unique identifier of the customer.
customer.email
customer.phone_number string / nullable Customer phone number when available.
customer.name string / nullable Customer name when available.
customer.gender
customer.birth_year
customer.external_id string / nullable External customer identifier when available.
customer.unsubscribed boolean Indicates whether the customer is unsubscribed.
customer.custom_attrs object / nullable Customer custom attributes when available.
customer.call_permission boolean Indicates whether call permission is granted.
customer.created_at string Creation timestamp of the customer.
customer.deleted_at
customer.node_id string Node identifier associated with the customer.
customer.status string Customer status.
customer.updated_at string Last update timestamp of the customer.
customer.language string Customer language.
assignee
archiving_user_id
creator_id string Identifier of the feedback creator.
flow_id string Identifier of the associated flow.
is_negative boolean Indicates whether the feedback is negative.
is_spam boolean Indicates whether the feedback is marked as spam.
language_id string Identifier of the feedback language.
node_id string Identifier of the associated node.
origin_url string URL from which the feedback originated.
positivity number / nullable Positivity value of the feedback when available.
power_score
priority
content_categories array Content categories associated with the feedback.
sentiment_score
time_spent_in_seconds number Time spent completing the feedback, in seconds.
user_agent string User agent information of the client.
deleted_at

Response Example

JSON Response Example
{
  "id": "<feedback_id>",
  "status": "open",
  "created_at": "<created_at>",
  "updated_at": "<updated_at>",
  "title": "<feedback_title>",
  "average_positivity": 100,
  "responses": [
    {
      "question": {
        "id": "<question_id>",
        "body": {
          "TR": "<question_text>"
        },
        "style": "score",
        "key": "<question_key>",
        "masked": false,
        "required": false,
        "weight": 1.0
      },
      "response": "10",
      "score": 100.0,
      "feedback_id": "<feedback_id>",
      "id": "<response_id>"
    }
  ],
  "node": {
    "id": "<node_id>",
    "type": "Web",
    "name": "<node_name>"
  },
  "flow": {
    "id": "<flow_id>",
    "name": "<flow_name>",
    "status": "active"
  },
  "customer": {
    "id": "<customer_id>",
    "language": "TR"
  },
  "flow_id": "<flow_id>",
  "node_id": "<node_id>",
  "is_negative": false,
  "is_spam": false,
  "origin_url": "<origin_url>",
  "positivity": 100.0,
  "content_categories": [],
  "time_spent_in_seconds": 9,
  "user_agent": "<user_agent>"
}
401 Error: Unauthorized

Error: Unauthorized

Error Code
13001
Error Message
Wrong authentication token
{"error_message":"Wrong authentication token","data":"Wrong authentication token","code":13001,"errors":null}
404 Feedback not found

Feedback not found

Error Code
0
Error Message
string
{"error_message":"string","data":"string","code":0,"errors":{}}