Links
Comment on page

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 partial není aplikovatelný.
date string, optional
end_completed_at
Odpovědi rozhovoru dokončeného před tímto datem. U odpovědí se statusem partial není aplikovatelný.
date string, optional
status
Status odpovědi: completed, disqualified, quotafull, partial. Výchozí hodnota completed.
string, optional
Příklad
curl --request GET \
--url https://api.click4survey.com/v1/surveys/{survey_id}/responses \
--header 'Accept: application/json' \
--header 'X-API-TOKEN: {api-token}' \
--header 'User-Agent: app-name ([email protected])' \
--header 'Content-Type: application/json'
Ú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
Příklad odpovědi
{
"result": {
"per_page": 5,
"page": 1,
"total": 4796,
"data": [
{
"response_id": "08936903-8572-402f-99d8-95909391e03c",
"href": "https://api.click4survey.com/v1/surveys/158/responses/08936903-8572-402f-99d8-95909391e03c"
},
{
"response_id": "fe801a95-8726-4374-9ef9-40d26b78b747",
"href": "https://api.click4survey.com/v1/surveys/158/responses/fe801a95-8726-4374-9ef9-40d26b78b747"
},
{
"response_id": "baa1db04-514e-4251-8cd0-bf9ce00fe8a4",
"href": "https://api.click4survey.com/v1/surveys/158/responses/baa1db04-514e-4251-8cd0-bf9ce00fe8a4"
},
{
"response_id": "46aa5e79-17b2-461e-a04a-4823c253327f",
"href": "https://api.click4survey.com/v1/surveys/158/responses/46aa5e79-17b2-461e-a04a-4823c253327f"
},
{
"response_id": "8636c50e-e1e7-49ca-b41f-8bd83a805982",
"href": "https://api.click4survey.com/v1/surveys/158/responses/8636c50e-e1e7-49ca-b41f-8bd83a805982"
}
]
},
"meta": {
"request_id": "15e38522-baf6-42fe-af86-a1ef5557c73d",
"http_status": 200
}
}

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
Příklad kódu
curl --request GET \
--url https://api.click4survey.com/v1/surveys/{survey_id}/responses/{response_id} \
--header 'Accept: application/json' \
--header 'X-API-TOKEN: {api-token}' \
--header 'User-Agent: app-name ([email protected])' \
--header 'Content-Type: application/json'
Ú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
Příklad odpovědi
{
"result": {
"response_id": "1368d7f9-63a1-41e6-a993-88be3b46f12f",
"survey_id": 46192,
"distribution_id": 158039,
"survey_name": "Exit Interview",
"ip_address": "95.85.245.103",
"date_created": "2021-10-14T12:28:32.787Z",
"date_completed": "2021-10-14T13:59:24.527Z",
"total_time": 1532,
"response_status": "completed",
"url_parameters": [
{
"name": "email",
"value": "[email protected]"
},
{
"name": "lang",
"value": "cs"
}
],
"pages": [
{
"id": 213638,
"questions": [
{
"id": 628132,
"type": "url_parameter",
"variable": "email",
"answers": [
{
}
]
},
{
"id": 628131,
"type": "url_parameter",
"variable": "lang",
"answers": [
{
"text": "cs"
}
]
},
{
"id": 627985,
"type": "single",
"variable": "reason",
"answers": [
{
"choice_id": 1980702,
"choice_label": "Používám jiný účet v Click4Survey",
"value": 2
}
]
},
{
"id": 628171,
"type": "essay",
"answers": [
{
"text": "Přecházím na vyšší plán"
}
]
}
]
}
]
},
"meta": {
"requestId": "863c65c3-a895-4575-8f32-ae8b16648d26",
"http_status": 200
}
}

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 modified 2mo ago