Przejdź do głównej zawartości
Wyniki
Artur Zbiejcik avatar
Napisane przez Artur Zbiejcik
Zaktualizowano ponad 6 miesiące temu

Lista operacji dla zasobu

Nazwa

URL

Opis

/results/single-sheets

Operacja, która wraca wyniki w poprawnym JSON-schema.

/results/single-sheets

Punkt dostępowy https://www.webankieta.pl/api/v3

Nowa wersja operacji Wyniki surowe (JSON), która wraca wyniki w poprawnym JSON-schema. Zalecamy korzystanie z tej operacji zamiast starej wersji - dodatkowo zwracana jest informacja o tym, ile rekordów spełnia żądanie

/results/aggregated/:id_survey

Operacja zwraca wyniki ankiety w formacie CSV. Postać odpowiedzi jest identyczna z postacią pliku CSV z zbiorczymi wynikami eksportowanymi w interfejsie webankieta.pl. Przykładowy plik ze zbiorczymi wynikami można pobrać tutaj

/results/meta/:id_survey

Operacja zwraca meta informacje o zebranych wynikach ankiety w formacie JSON. Format odpowiedzi jest opisany poniżej.


Pojedyncze wypełnienia (v2)

URL

(GET) https://www.webankieta.pl/api/v2/results/single-sheets/:id_survey

Parametry opcjonalne (GET) (w tej operacji wyjątkowo GET)

Nazwa

Opis

responseId

ID wypełnienia wykorzystywane przy wypełnianiu. Nie można przekazać parametru jeżeli jednocześnie przekazano token

token

Token respondenta użyty do wypełnienia ankiety. Nie można przekazać parametru jeżeli jednocześnie przekazano id_response

externalKey

Zewnętrzny paramter śledzący respondenta nadawany przez system klienta

lowerResponseDate

Najstarsza możliwa data wypełnienia ankiety. Przy wykorzystaniu tego paramteru zostaną zwrócone tylko takie wypełnienia, które miały miejsce później niż przekazana data Data musi być przekazana w formacie YYYY-MM-DD (np. 2011-11-20).

upperResponseDate

Najmłodsza możliwa data wypełnienia ankiety. Przy wykorzystaniu tego paramteru zostaną zwrócone tylko takie wypełnienia, które miały miejsce wcześniej niż przekazana data Data musi być przekazana w formacie YYYY-MM-DD (np. 2011-11-20).

unfinished

Parametr decydujący o tym, czy zostaną uwzględnione również niedokończone (częściowe) wypełnienia.

order

Parametr decydujący o tym, czy wyniki pojawią się w kolejności od najnowszego do najstarszego, czy odwrotnie. Domyślnie parametr przyjmuje wartość desc a operacja wyświetla wyniki od najnowszego do najstarszego wypełnienia.

page

Parametr decydujący o tym, która strona zostanie wyświetlona.

limit

Parametr decydujący o tym ile rekordów zostanie wyświetlony w jednej odpowiedzi. maksymalna wartość parametru wynosi 200. Domyslna wartość wynosi 10..

Przykładowa odpowiedź

{
"data": {
"sheets": [
{
"meta": {
"id": 89595094,
"surveyId": 347232,
"startDate": "2021-05-26 11:01:01",
"endDate": "2021-05-26 11:07:14",
"lastRespondentInteractionDate": "2023-07-03 11:28:03",
"email": "[email protected]",
"respondentId": 7548,
"token": "84CFd0",
"finished": true,
"externalKey": "",
"ip": "213.222.209.195",
"referer": "https://www.webankieta.pl/ankieta/token/id/424938/demo-single-sheets.html"
"personalDataChecked": true,
"labels": [
{
"id": 1,
"name": "Zawód",
"value": "Programista"
},
{
"id": 2,
"name": "Wykształcenie",
"value": "Wyższe"
}
],
"tags": [
{
"id": 11452,
"sentiment": "positive",
"weight": 1
},
{
"id": 11454,
"sentiment": "none",
"weight": null
}
]
},
"time": {
"real": "00:06:13",
"total": "00:06:13",
"pages": [
{
"id": 1539098,
"time": 373
}
]
},
"questions": [
{
"id": 5255742,
"content": "Jednokrotne",
"answer": {
"id": 1,
"content": "a",
"additional": "własna odpowiedź"
}
},
{
"id": 5255744,
"content": "Wielokrotne",
"answers": [
{
"id": 1,
"content": "a",
"additional": "własna odpowiedź"
},
{
"id": 2,
"content": "b",
"additional": null
},
{
"id": 3,
"content": "c",
"additional": null
}
]
},
{
"id": 5255746,
"content": "Otwarte",
"answers": [
{
"value": "otwarte 1"
},
{
"value": "otwarte 2"
}
]
},
{
"id": 5255748,
"content": "NPS",
"answer": {
"id": 7,
"content": "6",
"additional": "Uzasadnienie"
}
},
{
"id": 5255750,
"content": "Ocena/Macierz ocen",
"answers": [
{
"id": 1,
"rating": 2,
"content": "a",
"additional": "Uzasadnienie",
"reason": null
},
{
"id": 2,
"rating": 3,
"content": "b",
"additional": null,
"reason": null
},
{
"id": 3,
"rating": 4,
"content": "c",
"additional": null,
"reason": null
}
]
},
{
"id": 5255752,
"content": "Macierzowe jednokrotne",
"answers": [
{
"id": 1,
"content": "wiersz 1",
"column": {
"id": 1,
"content": "kolumna 1"
},
"additional": "w1",
"reason": "w1k1"
},
{
"id": 2,
"content": "wiersz 2",
"column": {
"id": 2,
"content": "kolumna 2"
},
"additional": null,
"reason": null
},
{
"id": 3,
"content": "wiersz 3",
"column": {
"id": 3,
"content": "kolumna 3"
},
"additional": null,
"reason": null
}
]
},
{
"id": 5255754,
"content": "Macierzowe wielokrotne",
"answers": [
{
"id": 1,
"content": "w1",
"columns": [
{
"column": "1",
"content": "k1"
},
{
"column": "2",
"content": "k2"
}
],
"additional": "w1 uzasadnienie"
},
{
"id": 2,
"content": "w2",
"columns": [
{
"column": "2",
"content": "k2"
}
],
"additional": "w2 uzasadnienie"
},
{
"id": 3,
"content": "w3",
"columns": [
{
"column": "3",
"content": "k3"
}
],
"additional": null
}
]
},
{
"id": 5255758,
"content": "Macierzowe otwarte",
"answers": [
{
"id": 1,
"content": "w1",
"columns": [
{
"column": "1",
"content": "k1",
"answer": "w1k2"
},
{
"column": "2",
"content": "k2",
"answer": "w1k1"
}
]
},
{
"id": 2,
"content": "w2",
"columns": [
{
"column": "1",
"content": "k1",
"answer": "w2k1"
},
{
"column": "2",
"content": "k2",
"answer": "w2k2"
}
]
}
]
},
{
"id": 5255760,
"content": "Suwak",
"type": "slider",
"answers": [
{
"id": 21,
"leftPositionContent": "tekst po lewej",
"rightPositionContent": "tekst po prawej",
"rowId": 1
},
{
"id": 4,
"leftPositionContent": "tekst po lewej 2",
"rightPositionContent": "tekst po prawej 2",
"rowId": 2
},
{
"id": 18,
"leftPositionContent": "tekst po lewej 3",
"rightPositionContent": "tekst po prawej 3",
"rowId": 3
}
]
},
{
"id": 5255762,
"content": "Formularz",
"answers": [
{
"id": "1",
"content": "odpowiedz 1",
"value": "odp1"
},
{
"id": "2",
"content": "odpowiedz 2",
"value": "odp2"
}
]
},
{
"questionId": 5255764,
"content": "Lista rozwijana",
"answer": {
"id": 2,
"content": "b"
}
},
{
"id": 5255766,
"content": "przeciągnij i upuść",
"answers": [
{
"id": 1,
"content": "a",
"group": 1,
"groupContent": "samogłoski"
},
{
"id": 2,
"content": "b",
"group": 2,
"groupContent": "spółgłoski"
},
{
"id": 3,
"content": "c",
"group": 2,
"groupContent": "spółgłoski"
},
{
"id": 4,
"content": "d",
"group": 2,
"groupContent": "spółgłoski"
},
{
"id": 5,
"content": "f",
"group": 2,
"groupContent": "spółgłoski"
}
]
},
{
"id": 5255768,
"content": "Ranking",
"answers": [
{
"id": 1,
"content": "rzodkiewki",
"value": 3
},
{
"id": 2,
"content": "truskawki",
"value": 2
},
{
"id": 3,
"content": "banany",
"value": 1
}
]
},
{
"questionId": 5255770,
"answers": [
{
"id": 1,
"content": "a",
"value": 33
},
{
"id": 2,
"content": "b",
"value": 33
},
{
"id": 3,
"content": "c",
"value": 34
}
]
},
{
"id": 5255772,
"content": "Załącznik",
"answer": "816_przenoszenie.pdf"
},
{
"id": 5255774,
"content": "Liczba",
"answer": "165"
},
{
"id": 5255776,
"content": "Email",
"answer": "[email protected]"
},
{
"id": 5255778,
"content": "Data",
"answer": "2021-05-21 00:00:00"
}
]
}
}

Zwracane błędy

  • 400 Bad request – Nieprawidłowy format daty.

  • 401 Unauthorized – Jeżeli użytkownik odwołuje się do obcego zasobu.

  • 404 Not Found – Jeżeli nie znaleziono ankiety o podanym :id_survey.

  • 406 Not Acceptable – Jeżeli nie przekazano parametru :id_survey.

  • 409 Conflict – Przekazano jednocześnie parametry :id_response oraz :token.


Pojedyncze wypełnienia (v3)

Uwaga!:

Metoda w wersji v3 umożliwia pobieranie danych z informacją o tym, jak dużo rekordów znajduje się po wywołaniu tego żądania - dzięki temu można łatwo zarządzać podzieleniem odpowiedzi na strony.

URL

(GET) https://www.webankieta.pl/api/v3/results/single-sheets/:id_survey

Parametry opcjonalne (GET) (w tej operacji wyjątkowo GET)

Nazwa

Opis

responseId

ID wypełnienia wykorzystywane przy wypełnianiu. Nie można przekazać parametru jeżeli jednocześnie przekazano token

token

Token respondenta użyty do wypełnienia ankiety. Nie można przekazać parametru jeżeli jednocześnie przekazano id_response

externalKey

Zewnętrzny paramter śledzący respondenta nadawany przez system klienta

lowerResponseDate

Najstarsza możliwa data wypełnienia ankiety. Przy wykorzystaniu tego paramteru zostaną zwrócone tylko takie wypełnienia, które miały miejsce później niż przekazana data Data musi być przekazana w formacie YYYY-MM-DD (np. 2011-11-20).

upperResponseDate

Najmłodsza możliwa data wypełnienia ankiety. Przy wykorzystaniu tego paramteru zostaną zwrócone tylko takie wypełnienia, które miały miejsce wcześniej niż przekazana data Data musi być przekazana w formacie YYYY-MM-DD (np. 2011-11-20).

unfinished

Parametr decydujący o tym, czy zostaną uwzględnione również niedokończone (częściowe) wypełnienia.

order

Parametr decydujący o tym, czy wyniki pojawią się w kolejności od najnowszego do najstarszego, czy odwrotnie. Domyślnie parametr przyjmuje wartość desc a operacja wyświetla wyniki od najnowszego do najstarszego wypełnienia.

page

Parametr decydujący o tym, która strona zostanie wyświetlona.

limit

Parametr decydujący o tym ile rekordów zostanie wyświetlony w jednej odpowiedzi. maksymalna wartość parametru wynosi 200. Domyslna wartość wynosi 10..

Przykładowa odpowiedź

{
"data": {
"sheets": [
{
"meta": {
"id": 89595094,
"surveyId": 347232,
"startDate": "2021-05-26 11:01:01",
"endDate": "2021-05-26 11:07:14",
"lastRespondentInteractionDate": "2023-07-03 11:28:03",
"email": "[email protected]",
"respondentId": 7548,
"token": "84CFd0",
"finished": true,
"externalKey": "",
"ip": "213.222.209.195",
"referer": "https://www.webankieta.pl/ankieta/token/id/424938/demo-single-sheets.html"
"personalDataChecked": true,
"labels": [
{
"id": 1,
"name": "Zawód",
"value": "Programista"
},
{
"id": 2,
"name": "Wykształcenie",
"value": "Wyższe"
}
],
"tags": [
{
"id": 11452,
"sentiment": "positive",
"weight": 1
},
{
"id": 11454,
"sentiment": "none",
"weight": null
}
]
},
"time": {
"real": "00:06:13",
"total": "00:06:13",
"pages": [
{
"id": 1539098,
"time": 373
}
]
},
"questions": [
{
"id": 5255742,
"content": "Jednokrotne",
"answer": {
"id": 1,
"content": "a",
"additional": "własna odpowiedź"
}
},
{
"id": 5255744,
"content": "Wielokrotne",
"answers": [
{
"id": 1,
"content": "a",
"additional": "własna odpowiedź"
},
{
"id": 2,
"content": "b",
"additional": null
},
{
"id": 3,
"content": "c",
"additional": null
}
]
},
{
"id": 5255746,
"content": "Otwarte",
"answers": [
{
"value": "otwarte 1"
},
{
"value": "otwarte 2"
}
]
},
{
"id": 5255748,
"content": "NPS",
"answer": {
"id": 7,
"content": "6",
"additional": "Uzasadnienie"
}
},
{
"id": 5255750,
"content": "Ocena/Macierz ocen",
"answers": [
{
"id": 1,
"rating": 2,
"content": "a",
"additional": "Uzasadnienie",
"reason": null
},
{
"id": 2,
"rating": 3,
"content": "b",
"additional": null,
"reason": null
},
{
"id": 3,
"rating": 4,
"content": "c",
"additional": null,
"reason": null
}
]
},
{
"id": 5255752,
"content": "Macierzowe jednokrotne",
"answers": [
{
"id": 1,
"content": "wiersz 1",
"column": {
"id": 1,
"content": "kolumna 1"
},
"additional": "w1",
"reason": "w1k1"
},
{
"id": 2,
"content": "wiersz 2",
"column": {
"id": 2,
"content": "kolumna 2"
},
"additional": null,
"reason": null
},
{
"id": 3,
"content": "wiersz 3",
"column": {
"id": 3,
"content": "kolumna 3"
},
"additional": null,
"reason": null
}
]
},
{
"id": 5255754,
"content": "Macierzowe wielokrotne",
"answers": [
{
"id": 1,
"content": "w1",
"columns": [
{
"column": "1",
"content": "k1"
},
{
"column": "2",
"content": "k2"
}
],
"additional": "w1 uzasadnienie"
},
{
"id": 2,
"content": "w2",
"columns": [
{
"column": "2",
"content": "k2"
}
],
"additional": "w2 uzasadnienie"
},
{
"id": 3,
"content": "w3",
"columns": [
{
"column": "3",
"content": "k3"
}
],
"additional": null
}
]
},
{
"id": 5255758,
"content": "Macierzowe otwarte",
"answers": [
{
"id": 1,
"content": "w1",
"columns": [
{
"column": "1",
"content": "k1",
"answer": "w1k2"
},
{
"column": "2",
"content": "k2",
"answer": "w1k1"
}
]
},
{
"id": 2,
"content": "w2",
"columns": [
{
"column": "1",
"content": "k1",
"answer": "w2k1"
},
{
"column": "2",
"content": "k2",
"answer": "w2k2"
}
]
}
]
},
{
"id": 5255760,
"content": "Suwak",
"type": "slider",
"answers": [
{
"id": 21,
"leftPositionContent": "tekst po lewej",
"rightPositionContent": "tekst po prawej",
"rowId": 1
},
{
"id": 4,
"leftPositionContent": "tekst po lewej 2",
"rightPositionContent": "tekst po prawej 2",
"rowId": 2
},
{
"id": 18,
"leftPositionContent": "tekst po lewej 3",
"rightPositionContent": "tekst po prawej 3",
"rowId": 3
}
]
},
{
"id": 5255762,
"content": "Formularz",
"answers": [
{
"id": "1",
"content": "odpowiedz 1",
"value": "odp1"
},
{
"id": "2",
"content": "odpowiedz 2",
"value": "odp2"
}
]
},
{
"questionId": 5255764,
"content": "Lista rozwijana",
"answer": {
"id": 2,
"content": "b"
}
},
{
"id": 5255766,
"content": "przeciągnij i upuść",
"answers": [
{
"id": 1,
"content": "a",
"group": 1,
"groupContent": "samogłoski"
},
{
"id": 2,
"content": "b",
"group": 2,
"groupContent": "spółgłoski"
},
{
"id": 3,
"content": "c",
"group": 2,
"groupContent": "spółgłoski"
},
{
"id": 4,
"content": "d",
"group": 2,
"groupContent": "spółgłoski"
},
{
"id": 5,
"content": "f",
"group": 2,
"groupContent": "spółgłoski"
}
]
},
{
"id": 5255768,
"content": "Ranking",
"answers": [
{
"id": 1,
"content": "rzodkiewki",
"value": 3
},
{
"id": 2,
"content": "truskawki",
"value": 2
},
{
"id": 3,
"content": "banany",
"value": 1
}
]
},
{
"questionId": 5255770,
"answers": [
{
"id": 1,
"content": "a",
"value": 33
},
{
"id": 2,
"content": "b",
"value": 33
},
{
"id": 3,
"content": "c",
"value": 34
}
]
},
{
"id": 5255772,
"content": "Załącznik",
"answer": "816_przenoszenie.pdf"
},
{
"id": 5255774,
"content": "Liczba",
"answer": "165"
},
{
"id": 5255776,
"content": "Email",
"answer": "[email protected]"
},
{
"id": 5255778,
"content": "Data",
"answer": "2021-05-21 00:00:00"
}
]
}
],
"totalCount":1
}
}

Zwracane błędy

  • 400 Bad request – Nieprawidłowy format daty.

  • 401 Unauthorized – Jeżeli użytkownik odwołuje się do obcego zasobu.

  • 404 Not Found – Jeżeli nie znaleziono ankiety o podanym :id_survey.

  • 406 Not Acceptable – Jeżeli nie przekazano parametru :id_survey.

  • 409 Conflict – Przekazano jednocześnie parametry :id_response oraz :token.


Wyniki zbiorcze

URL

(GET) https://www.webankieta.pl/api/v2/results/aggregated/:id_survey

Parametry opcjonalne (POST)

Nazwa

Opis

id_response

ID wypełnienia wykorzystywane przy wypełnianiu. Nie można przekazać parametru jeżeli jednocześnie przekazano token

token

Token respondenta użyty do wypełnienia ankiety. Nie można przekazać parametru jeżeli jednocześnie przekazano id_response

external_key

Zewnętrzny paramter śledzący respondenta nadawany przez system klienta

sm_client_id

Identyfikator klienta z systemu Sales Manago. Umieszczany w wypełnieniu tylko wtedy kiedy konto i ankieta mają włączoną integrację z Sales Manago.

lower_response_date

Najstarsza możliwa data wypełnienia ankiety. Przy wykorzystaniu tego paramteru zostaną zwrócone tylko takie wypełnienia, które miały miejsce później niż przekazana data Data musi być przekazana w formacie YYYY-MM-DD (np. 2011-11-20).

upper_response_date

Najmłodsza możliwa data wypełnienia ankiety. Przy wykorzystaniu tego paramteru zostaną zwrócone tylko takie wypełnienia, które miały miejsce wcześniej niż przekazana data Data musi być przekazana w formacie YYYY-MM-DD (np. 2011-11-20).

Przykładowa odpowiedź

CSV goes here

Zwracane błędy

  • 400 Bad request – Nieprawidłowy format daty.

  • 401 Unauthorized – Użytkownik odwołuje się do obcego zasobu.

  • 404 Not Found – Nie znaleziono ankiety o podanym :id_survey.

  • 406 Not Acceptable – Nie przekazano parametru :id_survey.

  • 409 Conflict – Przekazano jednocześnie parametry :id_response oraz :token.


Meta dane na temat zebranych wyników (JSON)

URL

(GET) https://www.webankieta.pl/api/v2/results/meta/:id_survey

Parametry opcjonalne (POST)

Nazwa

Opis

id_response

ID wypełnienia wykorzystywane przy wypełnianiu. Nie można przekazać parametru jeżeli jednocześnie przekazano token

token

Token respondenta użyty do wypełnienia ankiety. Nie można przekazać parametru jeżeli jednocześnie przekazano id_response

external_key

Zewnętrzny paramter śledzący respondenta nadawany przez system klienta

lower_response_date

Najstarsza możliwa data wypełnienia ankiety. Przy wykorzystaniu tego paramteru zostaną zwrócone tylko takie wypełnienia, które miały miejsce później niż przekazana data Data musi być przekazana w formacie YYYY-MM-DD (np. 2011-11-20).

upper_response_date

Najmłodsza możliwa data wypełnienia ankiety. Przy wykorzystaniu tego paramteru zostaną zwrócone tylko takie wypełnienia, które miały miejsce wcześniej niż przekazana data Data musi być przekazana w formacie YYYY-MM-DD (np. 2011-11-20).

unfinished

Parametr decydujący o tym, czy zostaną uwzględnione również niedokończone (częściowe) wypełnienia.

Przykładowa odpowiedź

[
{
"meta": {
"id": 123456,
"ip": "127.0.0.1",
"referer": "http:\/\/facebook.com",
"date_start": "2014-02-01 12:00:00",
"date_response": "2014-02-02 12:00:00",
"finished": "1",
"external_key": "mailing",
"token": "12fh47",
"e-mail": "[email protected]",
"label1": "Jan",
"label2": "Kowalski",
//....
"label10": "Mr."
},
"time": {
"real": "9:05",
"total": "10:10"
}
},{
//next record
}
]

Zwracane błędy

  • 400 Bad request – Nieprawidłowy format daty.

  • 401 Unauthorized – Jeżeli użytkownik odwołuje się do obcego zasobu.

  • 404 Not Found – Jeżeli nie znaleziono ankiety o podanym :id_survey.

  • 406 Not Acceptable – Jeżeli nie przekazano parametru :id_survey.

  • 409 Conflict – Przekazano jednocześnie parametry :id_response oraz :token.


Czy to odpowiedziało na twoje pytanie?