Click4Survey Web Plány a ceny Blog

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:

Volitelné URL parametry API požadavku:

GET /surveys/{survey_id}/responses?page=1&per_page=50

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 (support@example.net)' \
  --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:

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:

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 (support@example.net)' \
  --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:

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": "info@example.net"
            },
            {
                "name": "lang",
                "value": "cs"
            }
        ],
        "pages": [
            {
                "id": 213638,
                "questions": [
                    {
                        "id": 628132,
                        "type": "url_parameter",
                        "variable": "email",
                        "answers": [
                            {
                                "text": "info@example.net"
                            }
                        ]
                    },
                    {
                        "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:

Úspěšně zpracovaný požadavek vrací stavový kód 200 OK a binární data souboru.

PreviousMessagesNextWebhooky

Last updated