Skip to content
English
Submit A Ticket Customer Portal
LOGIN
  • There are no suggestions because the search field is empty.

Pisano External API - Feedback - List Feedbacks

List feedbacks

Retrieve a list of feedbacks

GET /external/v1/feedbacks

Authentication

Authentication Method Bearer <token>

Request

Query Parameters

Parameter Type Required Description Example
flow_id Conditional Flow identifier used to retrieve feedback for a specific survey. <flow_id>
from No Filter feedback created after this Unix timestamp. <unix_timestamp>
to No Filter feedback created before this Unix timestamp. <unix_timestamp>
range string No Named date range such as today, yesterday, this_week, last_week, this_month, last_month, last_7_days, previous_7_days, last_30_days, previous_30_days, or older_than_30_days. last_7_days
time_from No Start time in HHMM style, e.g. 1000 for 10:00. 1000
time_to No End time in HHMM style, e.g. 1330 for 13:30. 1330
page No Page number for paginated retrieval. 1

Headers

Header Required Description Example
Accept No Specifies the expected response media type. application/json
Authorization Yes Bearer authorization token obtained from Pisano. Bearer <token>

Responses

200 List of feedbacks

Response Fields

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

Response Example

JSON Response Example 
{
  "data": [
    {
      "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>"
          },
          "response": "10",
          "score": 100.0
        }
      ],
      "flow_id": "<flow_id>",
      "node_id": "<node_id>",
      "is_negative": false,
      "is_spam": false
    }
  ],
  "total_count": 42,
  "per_page": 20
}
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}

Additional Information

Rate Limits

Maximum 10 requests within 5 seconds.

Pagination

Maximum 20 feedback records per response; use the page query parameter for additional pages. The response includes per_page, which is set to 20.

Notes