Pisano Harici API - Geri Bildirim - Geri Bildirimleri Listele
Geri Bildirimleri Listele
Geri bildirimlerin listesini getirir.
GET
/external/v1/feedbacks
Kimlik Doğrulama
Kimlik Doğrulama Yöntemi
Bearer <token>
İstek
Sorgu Parametreleri
| Parametre | Tip | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
flow_id |
Koşullu | Belirli bir ankete ait geri bildirimleri getirmek için kullanılan akış tanımlayıcısı. | <flow_id> |
|
from |
Hayır | Bu Unix zaman damgasından sonra oluşturulan geri bildirimleri filtreler. | <unix_timestamp> |
|
to |
Hayır | Bu Unix zaman damgasından önce oluşturulan geri bildirimleri filtreler. | <unix_timestamp> |
|
range |
string | Hayır | today, yesterday, this_week, last_week, this_month, last_month, last_7_days, previous_7_days, last_30_days, previous_30_days veya older_than_30_days gibi önceden tanımlanmış tarih aralıklarını belirtir. | last_7_days |
time_from |
Hayır | HHMM biçiminde başlangıç saatini belirtir. Örneğin, 10:00 için 1000. | 1000 |
|
time_to |
Hayır | HHMM biçiminde bitiş saatini belirtir. Örneğin, 13:30 için 1330. | 1330 |
|
page |
Hayır | Sayfalandırılmış veri alımında kullanılacak sayfa numarası. | 1 |
Header Bilgileri
| Header | Zorunlu | Açıklama | Örnek |
|---|---|---|---|
Accept |
Hayır | Beklenen yanıtın medya türünü belirtir. | application/json |
Authorization |
Evet | Pisano üzerinden alınan Bearer kimlik doğrulama anahtarı. | Bearer <token> |
Yanıtlar
200
Geri Bildirim Listesi
Yanıt Alanları
| Alan | Tip | Zorunlu | Açıklama |
|---|---|---|---|
data |
array | Geri bildirimlerin listesi. | |
total_count |
number | İstekle eşleşen toplam geri bildirim sayısı. | |
per_page |
number | Sayfa başına döndürülen geri bildirim sayısı. | |
data[].id |
string | Geri bildirimin benzersiz tanımlayıcısı. | |
data[].status |
string | Geri bildirimin mevcut durumu. | |
data[].created_at |
string | Geri bildirimin oluşturulma zaman damgası. | |
data[].updated_at |
string | Geri bildirimin son güncellenme zaman damgası. | |
data[].title |
string | Geri bildirimin başlığı. | |
data[].average_positivity |
number / nullable | Mevcut olduğunda geri bildirimin ortalama pozitiflik değeri. | |
data[].responses |
array | Geri bildirim kapsamında gönderilen yanıtlar. | |
data[].responses[].question |
object | Yanıtla ilişkili soru. | |
data[].responses[].question.id |
string | Sorunun benzersiz tanımlayıcısı. | |
data[].responses[].question.body |
object | Yerelleştirilmiş soru metni. | |
data[].responses[].question.body.<language_code> |
string | Belirtilen dildeki soru metni. | |
data[].responses[].question.style |
string | Soru türü/stili. | |
data[].responses[].question.key |
string / nullable | Soru anahtarı. Null olabilir. | |
data[].responses[].question.category_id |
|||
data[].responses[].question.masked |
boolean | Sorunun maskelenip maskelenmediğini belirtir. | |
data[].responses[].question.node_id |
|||
data[].responses[].question.required |
boolean | Sorunun zorunlu olup olmadığını belirtir. | |
data[].responses[].question.weight |
number / nullable | Uygulanabilir olduğunda sorunun ağırlık değeri. | |
data[].responses[].response |
string | Gönderilen yanıt değeri. | |
data[].responses[].positivity |
number / nullable | Mevcut olduğunda yanıtın pozitiflik değeri. | |
data[].responses[].created_at |
string | Yanıtın oluşturulma zaman damgası. | |
data[].responses[].custom_score |
|||
data[].responses[].feedback_id |
string | İlişkili geri bildirimin tanımlayıcısı. | |
data[].responses[].id |
string | Yanıtın benzersiz tanımlayıcısı. | |
data[].responses[].order |
number | Yanıtın sıralama değeri. | |
data[].responses[].power_score |
|||
data[].responses[].ranking |
|||
data[].responses[].score |
number / nullable | Uygulanabilir olduğunda yanıtın puanı. | |
data[].responses[].submitted_at |
string | Yanıtın gönderilme zaman damgası. | |
data[].responses[].updated_at |
string | Yanıtın son güncellenme zaman damgası. | |
data[].node |
object | Geri bildirimle ilişkili birim. | |
data[].node.id |
string | Birimin benzersiz tanımlayıcısı. | |
data[].node.type |
string | Birim türü. | |
data[].node.name |
string | Birim adı. | |
data[].node.code |
string | Birim kodu. | |
data[].node.timezone |
string | Birim için yapılandırılmış saat dilimi. | |
data[].node.external_id |
|||
data[].node.flow_id |
string | İlişkili akışın tanımlayıcısı. | |
data[].node.parent_id |
string | Üst birimin tanımlayıcısı. | |
data[].tags |
array | Geri bildirimle ilişkili etiketler. | |
data[].flow |
object | Geri bildirimle ilişkili akış. | |
data[].flow\.id |
string | Akışın benzersiz tanımlayıcısı. | |
data[].flow\.name |
string | Akışın adı. | |
data[].flow\.created_at |
string | Akışın oluşturulma zaman damgası. | |
data[].flow\.deleted_at |
|||
data[].flow\.node_id |
string / nullable | Mevcut olduğunda akışla ilişkili birimin tanımlayıcısı. | |
data[].flow\.parent_flow_id |
|||
data[].flow\.question_category_parent_id |
|||
data[].flow\.status |
string | Akışın mevcut durumu. | |
data[].flow\.updated_at |
string | Akışın son güncellenme zaman damgası. | |
data[].customer |
object | Geri bildirimle ilişkili müşteri. | |
data[].customer.id |
string | Müşterinin benzersiz tanımlayıcısı. | |
data[].customer.email |
|||
data[].customer.phone_number |
string / nullable | Mevcut olduğunda müşterinin telefon numarası. | |
data[].customer.name |
string / nullable | Mevcut olduğunda müşterinin adı. | |
data[].customer.gender |
|||
data[].customer.birth_year |
|||
data[].customer.external_id |
string / nullable | Mevcut olduğunda müşterinin harici tanımlayıcısı. | |
data[].customer.unsubscribed |
boolean | Müşterinin abonelikten çıkıp çıkmadığını belirtir. | |
data[].customer.custom_attrs |
object / nullable | Mevcut olduğunda müşteriye ait özel nitelikler. | |
data[].customer.call_permission |
boolean | Arama izninin verilip verilmediğini belirtir. | |
data[].customer.created_at |
string | Müşterinin oluşturulma zaman damgası. | |
data[].customer.deleted_at |
|||
data[].customer.node_id |
string | Müşteriyle ilişkili birimin tanımlayıcısı. | |
data[].customer.status |
string | Müşterinin durumu. | |
data[].customer.updated_at |
string | Müşterinin son güncellenme zaman damgası. | |
data[].customer.language |
string | Müşterinin dili. | |
data[].assignee |
|||
data[].archiving_user_id |
|||
data[].creator_id |
string | Geri bildirimi oluşturan kullanıcının tanımlayıcısı. | |
data[].flow_id |
string | İlişkili akışın tanımlayıcısı. | |
data[].is_negative |
boolean | Geri bildirimin olumsuz olup olmadığını belirtir. | |
data[].is_spam |
boolean | Geri bildirimin spam olarak işaretlenip işaretlenmediğini belirtir. | |
data[].language_id |
string | Geri bildirimin dil tanımlayıcısı. | |
data[].node_id |
string | İlişkili birimin tanımlayıcısı. | |
data[].origin_url |
string | Geri bildirimin geldiği URL. | |
data[].positivity |
number / nullable | Mevcut olduğunda geri bildirimin pozitiflik değeri. | |
data[].power_score |
|||
data[].priority |
|||
data[].content_categories |
array | Geri bildirimle ilişkili içerik kategorileri. | |
data[].sentiment_score |
|||
data[].time_spent_in_seconds |
number | Geri bildirimin tamamlanması için harcanan süre (saniye). | |
data[].user_agent |
string | İstemciye ait user agent bilgisi. | |
data[].deleted_at |
Yanıt Örneği
JSON
Yanıt Örneği
{
"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
Hata: Yetkisiz Erişim
Hata: Yetkisiz Erişim
- Hata Kodu
13001- Hata Mesajı
- Hatalı kimlik doğrulama anahtarı
{"error_message":"Wrong authentication token","data":"Wrong authentication token","code":13001,"errors":null}
Ek Bilgiler
İstek Sınırları
5 saniye içinde en fazla 10 istek gönderilebilir.
Sayfalandırma
Her yanıtta en fazla 20 geri bildirim kaydı döndürülür. Diğer sayfalardaki kayıtları almak için page sorgu parametresini kullanın. Yanıtta yer alan per_page değeri 20 olarak ayarlanmıştır.
Notlar