You can easily transfer the feedback you have collected from external systems to Pisano with a single API call.
First, you need to define the questions related to the feedback you want to transfer by creating a Flow in Pisano. (For details on how to create a flow: How To Create a Flow in Pisano? )
When creating a Flow, it's important to ensure that the Question Key Value is defined for each question. These values will be used during the API call.
For example;
The question key provided here will be used during the API call to assign a value to the corresponding question.
After all the fields intended for transfer have been defined on the flow in Pisano, the API call can be made.
Attention: With each API call, only one feedback is transferred to Pisano. Bulk transfer is not possible. When the transfer is completed via API, it returns the UUID value of the new feedback created in Pisano.
For large-scale transfer operations, it is advisable to coordinate with Pisano teams and perform the transfer outside of working hours to avoid overloading the system.
Details of API Requests Based on Question and Data Types:
When calling API; fields related to questions such as plain text, date, code should be sent in the following pattern (by body):
{
"question_key": "shorttext",
"body": "Information"
},
Selected questions such as NPS, Satisfaction question should be sent as: (with option_key):
{
"question_key": "NPS",
"option_key": "10"
},
The details of which question's key corresponds to what and what values it can take within the relevant flow can be accessed via the api.pisano.com.tr/external/v1/flows/{flow_id} API endpoint.
As shown below for each question type, a return will be received based on each question.
In the returned details, the key value of the question can be accessed via questions.key. If the question is a choice question, the possible values it can take can also be accessed via question.key.options[n].key.
Question Types:
- Sentiment
Question Options:
"id": "b0c319c1-4fff-466a-83b8-fff48d3291cc",
"key": "sentiment",
"body": {
"TR": "Pisano'dan aldığınız hizmeti nasıl değerlendirirsiniz?"
},
"style": "plain",
"options": [
{
"id": "acc1e7c9-2145-4634-b2d4-034c57fb90e1",
"key": "Very Bad",
"body": {
"TR": ":frowning:"
}
},
{
"id": "0883f3c2-97fc-4fb7-a190-99016b662108",
"key": "Bad",
"body": {
"TR": ":slight_frown:"
}
},
{
"id": "f37b377e-5d29-4248-8c45-9335652367cb",
"key": "Average",
"body": {
"TR": ":neutral_face:"
}
},
{
"id": "e82f5f8f-db77-44c8-8961-f3d9ab2c953b",
"key": "Good",
"body": {
"TR": ":slight_smile:"
}
},
{
"id": "5b6b1126-a547-4e2e-b408-62012722aa3d",
"key": "Very Good",
"body": {
"TR": ":smiley:"
}
}
]
} Sample Submission Format:
{
"question_key": "sentiment",
"option_key": "Very Good"
},
- NPS:
Question Options:
"id": "3a767e40-1053-43d1-bb6e-16d971944a7e",
"key": "nps",
"body": {
"TR": "Do you recommend the service you receive from Pisano?"
},
"style": "score",
"options": [
{
"id": "fa9f40fc-2f2c-4896-8ef7-14cdade599d5",
"key": "0",
"body": {
"TR": "0"
}
},
{
"id": "bcae07d9-a9f7-45b6-a0bb-b1850b2d8526",
"key": "1",
"body": {
"TR": "1"
}
},
{
"id": "2f78686c-2e10-4961-be16-54c9ef691155",
"key": "2",
"body": {
"TR": "2"
}
},
{
"id": "51fa7688-a1ae-43c0-a939-ed812b0a0a6b",
"key": "3",
"body": {
"TR": "3"
}
},
{
"id": "1eeb66c8-c68c-489b-8d6d-ca64c36445f7",
"key": "4",
"body": {
"TR": "4"
}
},
{
"id": "0b15d90b-bb50-4dc1-9bfb-c62d1ee1f3e6",
"key": "5",
"body": {
"TR": "5"
}
},
{
"id": "184cdd6b-35c6-41db-9f84-454751b1facb",
"key": "6",
"body": {
"TR": "6"
}
},
{
"id": "c5385b90-2aa7-4fd3-a2d3-7bd8e4d1a044",
"key": "7",
"body": {
"TR": "7"
}
},
{
"id": "38b609f2-7507-4926-bb42-86017bedbcdf",
"key": "8",
"body": {
"TR": "8"
}
},
{
"id": "d783fbad-46e6-46d6-8acd-59dd4eba8241",
"key": "9",
"body": {
"TR": "9"
}
},
{
"id": "6665939a-de77-4c0b-ae10-0fe00f88739a",
"key": "10",
"body": {
"TR": "10"
}
}
]
}
Sample Submission Format:
{
"question_key": "nps",
"option_key": "9"
},- Single Choice:
Question Options:
"id": "99df85de-c02a-4b51-b32d-a4cee6d3a0a0",
"key": "singlechoice",
"body": {
"EN": "The product is easy to use"
},
"style": "radio",
"options": [
{
"id": "f92a9add-1aeb-4158-8f4f-9efe352ba517",
"key": "Yes",
"body": {
"EN": "Yes"
}
},
{
"id": "6bc59b21-8469-4597-99ef-9eb416ca1e9e",
"key": "No",
"body": {
"En": "No"
}
}
]
}
Sample Submission Format:
{
"question_key": "singlechoice",
"option_key": "Evet"
},
- Multiple Choice:
Question Options:
"id": "3dbf3019-4ecb-4a1a-99fc-692fe231a630",
"key": "multiplechoice",
"body": {
"EN": "Qualities you like the most"
},
"style": "checklist",
"options": [
{
"id": "a1964278-c7a9-4f46-84b6-8fa5b09f21ae",
"key": "Interface",
"body": {
"EN": "Simple and comprehensible interface"
}
},
{
"id": "19a25f68-781b-4954-89a5-85d7f95250ab",
"key": "Reporting",
"body": {
"EN": "Easy to use reportings"
}
},
{
"id": "4500373f-69a6-4507-b861-f8530f19625e",
"key": "Design",
"body": {
"EN": "Easy design"
}
},
{
"id": "7c119933-1e53-4205-a5c4-30dad589eb25",
"key": "Sharing options",
"body": {
"EN": "Easy sharing options"
}
},
{
"id": "49476d89-7d6e-421d-ad2a-b3d68dfb0e9d",
"key": "Other",
"body": {
"EN": "Other"
}
}
]
},
Sample Submission Format:
{
"question_key": "multiplechoice",
"body": "Interface,Reporting,Design"
},
- Short Text:
Question Options:
{
"id": "3e9fbae6-aba2-416e-ba19-e064a5724bc4",
"key": "shorttext",
"body": {
"EN": "Can you give details (Short Text)"
},
"style": "text",
"options": []
},
Sample Submission Format:
{
"question_key": "shorttext",
"body": "Short text value"
},
- Long Text:
Question Options:
{
"id": "bf678c5e-db10-417d-81a9-72353e496804",
"key": "longtext",
"body": {
"EN": "Can you give details? (Long Text)"
},
"style": "textarea",
"options": []
},
Sample Submission Format:
{
"question_key": "longtext",
"body": "Long text value"
},- Date:
Question Options:
{
"id": "3378d548-5ece-481b-8e21-ffdb037bea6c",
"key": "date",
"body": {
"EN": "Date"
},
"style": "datepicker",
"options": []
},Sample Submission Format:
{
"question_key": "date",
"body": "28/02/2024"
},
- Numeric:
Question Options:
{
"id": "1b37683f-e816-4e55-b809-cef618d4e973",
"key": "numeric",
"body": {
"EN": "Numeric"
},
"style": "numeric",
"options": []
},
Sample Submission Format:
{
"question_key": "numeric",
"body": "5363563"
},
- Star
Question Options:
{
"id": "be9eaa06-2203-4e8e-9460-a28a01c54fcb",
"key": "star",
"body": {
"EN": "Star"
},
"style": "star",
"options": [
{
"id": "fe68c3af-1df8-46bb-8c85-14f5a13c5cb7",
"key": "1",
"body": {
"EN": "1"
}
},
{
"id": "7ce17d8b-e42b-447d-85ca-09442188d91e",
"key": "2",
"body": {
"En": "2"
}
},
{
"id": "cccff0de-8b92-4ffa-b65f-03d351ea0118",
"key": "3",
"body": {
"EN": "3"
}
},
{
"id": "8aa4c96c-934a-45fa-beb9-e6f706f536c5",
"key": "4",
"body": {
"EN": "4"
}
},
{
"id": "6e4f75db-e478-44be-ada7-ce3df0a4b4d6",
"key": "5",
"body": {
"EN": "5"
}
}
]
},
Sample Submission Format:
{
"question_key": "star",
"option_key": "4"
},Full Request Sample:
curl --location 'https://api.pisano.com.tr/external/v1/feedbacks' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token token="{Token}"' \
--data '{
"node_id": "fa5fa92f-b308-4b0f-b662-76fe22683759", //Taken from interface
"flow_id": "3cf2da01-00ea-4962-8d98-c3fa191c630b", // Taken from interface
"created_at": "1709118000", // Timestamp 28/02/2024 14:00
"customer": {
"name": "Customer Name",
"phone_number": "909999999999"
},
"responses": [
{
"question_key": "sentiment",
"option_key": "Very Good"
},
{
"question_key": "nps",
"option_key": "9"
},
{
"question_key": "singlechoice",
"option_key": "Yes"
},
{
"question_key": "multiplechoice",
"body": "Interface,Reporting,Design"
},
{
"question_key": "shorttext",
"body": "Short text value"
},
{
"question_key": "longtext",
"body": "Long text value"
},
{
"question_key": "date",
"body": "28/02/2024"
},
{
"question_key": "numeric",
"body": "5363563"
},
{
"question_key": "star",
"option_key": "4"
}
]
}'
Response Values:
'201':
description: Feedback Created
content:
application/json:
'404':
description: error payload
content:
application/json:
examples:
question_not_found:
value:
error_message: "Requested resource not found!"
data: "Requested resource not found!"
code: 13002
errors:
question_id: null
no_options:
value:
error_message: "Requested resource not found!"
data: "Requested resource not found!"
code: 13002
errors: "There is no options for this question key: q2 and id: 271b4039-f3a3-4f61-b7a0-8d5b6abe522e"
'400':
description: error payload
content:
application/json:
example:
error_message: "Invalid parameters"
data: "Invalid parameters"
code: 13028
errors:
details:
- node:
error: "blank"
- customer_form:
error: "custom_identity_keys"
- customer:
error: "is invalid"
messages:
node:
- "can't be blank"
customer_form:
- "must contain custom customer identity keys"
customer:
- "is invalid"
full_messages:
- "Node can't be blank"
- "Customer form must contain custom customer identity keys"
- "Customer is invalid"
'401':
description: "Error: Unauthorized"