Responses
Stažení všech odpovědí průzkumu
Stažení seznamu všech vyplněných dotazníku z průzkumu.
GET /surveys/{survey_id}/responses
Parametry:
Jméno parametru | Popis | Typ |
---|---|---|
survey_id | Identifikátor průzkumu, jehož seznam dotazníku chcete stáhnout | integer |
Volitelné URL parametry API požadavku:
GET /surveys/{survey_id}/responses?page=1&per_page=50
Jméno parametru | Popis | Typ |
---|---|---|
page | Číslo strany při stránkování odpovědí. Výchozí hodnota 1. | integer, optional |
per_page | Počet odpovědí na stránku v rozsahu 1 - 1000. Výchozí hodnota 50. | integer, optional |
start_started_at | Odpovědi rozhovoru zahájeného po tomto datu. | date string, optional |
end_started_at | Odpovědi rozhovoru zahájeného před tímto datem. | date string, optional |
start_completed_at | Odpovědi rozhovoru dokončeného po tomto datu.
U odpovědí se statusem | date string, optional |
end_completed_at | Odpovědi rozhovoru dokončeného před tímto datem.
U odpovědí se statusem | date string, optional |
status | Status odpovědi: | string, optional |
Úspěšně zpracovaný požadavek vrací stavový kód 200 OK
a v poli result
jsou data odpovědí. V případě vrácení jiného kódu došlo při stahování dat odpovědí k chybě. Zde je přehled chybových stavů.
Struktura vrácených dat:
Jméno pole | Popis | Typ |
---|---|---|
per_page | Počet odpovědí na stránku | integer |
page | Aktuální číslo stránky dat odpovědí | integer |
total | Celkový počet dostupných odpovědí | integer |
data | Data stránky seznamu odpovědí | [object] |
↳ response_id | Identifikátor odpovědi | guid string |
↳ href | URL adresa API akce pro stažení dat odpovědi | string |
Stažení dat odpovědí
Stažení dat odpovědí vyplněného dotazníku z průzkumu.
GET /surveys/{survey_id}/responses/{response_id}
Parametry:
Jméno parametru | Popis | Typ |
---|---|---|
survey_id | Identifikátor průzkumu, jehož dotazník byl vyplněn | integer |
response_id | Identifikátor odpovědi respondenta | guid string |
Úspěšně zpracovaný požadavek vrací stavový kód 200 OK
a v poli result
jsou data odpovědí. V případě vrácení jiného kódu došlo při stahování dat odpovědí k chybě. Zde je přehled chybových stavů.
Struktura vrácených dat:
Jméno pole | Popis | Typ |
---|---|---|
response_id | Identifikátor odpovědi respondenta, obvykle získaný z webhooku Obdržení odpovědi | guid string |
survey_id | Identifikátor průzkumu, jehož dotazník byl vyplněn | integer |
contact_id | Pokud odpověď vyplnil respondent z e-mailové kampaně/CATI, jde o identifikátor kontaktu respondenta | integer |
distribution_id | Identifikátor distribučního kanálu, přes který byl dotazník vyplněn | integer |
survey_name | Jméno průzkumu | string |
ip_address | IP adresa, ze které byl dotazník vyplněn | string |
date_created | Datum a čas prvního otevření dotazníku | date string |
date_completed | Datum a čas dokončení dotazníku | date string, optional |
total_time | Celkový doba vyplňování dotazníku v sekundách | integer, optional |
response_status | Stav vyplňování dotazníku: 'partial', 'completed', 'disqualified', 'deleted' | string |
url_parameters | Seznam URL parametrů, se kterými byl dotazník otevřen | [object] |
↳ name | Jméno URL parametru | string |
↳ value | Hodnota URL parametru | string |
pages | Seznam stránek dotazníku | [object] |
↳ id | Identifikátor stránky dotazníku | integer |
↳ questions | Seznam otázek stránky dotazníku | [object] |
↳ id | Identifikátor otázky dotazníku | integer |
↳ type | Typ otázky | string |
↳ variable | Jméno proměnné identifikující otázku | string, optional |
↳ answers | Seznam odpovědí na otázku | [object] |
↳ row_id | Identifikátor řádku baterie, ve kterém vznikla odpověď | integer, optional |
↳ row_label | Text řádku baterie, ve které vznikla odpověď | string, optional |
↳ column_id | Identifikátor sloupce baterie, ve kterém vznikla odpověď | integer, optional |
↳ column_label | Text sloupce baterie, ve kterém vznikla odpověď | string, optional |
↳ choice_id | Identifikátor varianty odpovědi, která byla vybrána respondentem | integer, optional |
↳ choice_label | Text varianty odpovědi, která byla vybrána respondentem | string, optional |
↳ other_id | Identifikátor varianty odpovědi, u které byla vyplněna respondentem textová odpověď 'Jiné' | integer, optional |
↳ text | Textová odpověď na otázku | string, optional |
↳ value | Hodnota odpovědi, která byla vybrána respondentem | integer, optional |
Stažení nahraného souboru
Stažení respondentem nahraného souboru v dotazníku.
GET /surveys/{survey_id}/responses/{response_id}/uploaded-files/{file_id}
Parametry:
Jméno parametru | Popis | Typ |
---|---|---|
survey_id | Identifikátor průzkumu, jehož dotazník byl vyplněn | integer |
response_id | Identifikátor odpovědi respondenta | guid string |
file_id | Identifikátor vloženého souboru | guid string |
Úspěšně zpracovaný požadavek vrací stavový kód 200 OK
a binární data souboru.
Last updated