Poradnik - Dokumentacja API

Wyniki

Lista operacji dla zasobu

Nazwa URL Opis
Wyniki zbiorcze /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
Wyniki surowe /results/raw/:id_survey Operacja zwraca wyniki ankiety w formacie CSV. Postać odpowiedzi jest identyczna z postacią pliku CSV z surowaymi wynikami eksportowanymi w interfejsie webankieta.pl. Przykładowy plik z surowaymi danymi można pobrać tutaj
Meta dane (JSON) /results/meta/:id_survey Operacja zwraca meta informacje o zebranych wynikach ankiety w formacie JSON. Format odpowiedzi jest opisany poniżej.
Wyniki surowe (JSON) /results/json/:id_survey Operacja zwraca wyniki ankiety (wraz z meta danymi) w formacie JSON. Format odpowiedzi jest opisany poniżej. Operacja zostanie wyłączona 31 grudnia 2018r. Zalecamy użycie operacji „Wyniki surowe (JSON) – paginacja”.
Wyniki surowe (JSON) – paginacja /results/paginated-json/:id_survey Operacja zwraca wyniki ankiety (wraz z meta danymi) w formacie JSON. Format odpowiedzi jest opisany poniżej. Wyniki są zwracane po 10 rekordów, najnowszy znajduje się na pierwszej pozycji.

Wyniki zbiorcze

URL

(GET) https://www.webankieta.pl/api/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.

Wyniki surowe

URL

(GET) https://www.webankieta.pl/api/results/raw/: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ź

CSV goes here

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.

Meta dane na temat zebranych wyników (JSON)

URL

(GET) https://www.webankieta.pl/api/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": "jan@kowalski.pl",
        "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.

Wyniki surowe (JSON)

Operacja zostanie wyłączona 31 grudnia 2018r. Zalecamy użycie operacji „Wyniki surowe (JSON) – paginacja”. Dokumentacja poniżej.

URL

(GET) https://www.webankieta.pl/api/results/json/: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": "jan@kowalski.pl",
        "label1": "Jan",
        "label2": "Kowalski",
        //....
        "label10": "Mr."
    },
    "time": {
       "real": "9:05",
        "total": "10:10",
        "page1": "20",
        "page2": "30",
        "page3": "40",
        //....
        "pageN": "10"
    },
    "questions":{
      //Pytanie jednokrotnego wyboru
      "1457974":{ //ID pytania
        "number":1, //numer pytania
        "content":"Pytanie jednokrotnego wyboru", //Treść pytania
        "answers":{ //udzielone odpowiedzi
          "3":"inne, jakie?", //numer odpowiedzi, treść dopowiedzi
          "other3":"moja odpowiedź" // własna odpowiedź wpisana w trzecim   wierszu
        }
      },
      //Pytanie wielokrotnego wyboru
      "1457975":{
        "number":2,
        "content":"Pytanie wielokrotnego wyboru",
        "answers":{
          "2":"kawa", //numer odpowiedzi, treść dopowiedzi
          "3":"inne jakie",
          "other3":"herbata" // własna odpowiedź wpisana przez resp. w wierszu trzecim
        }
      },
      //Pytanie macierzowe jednokrotne
      "1457976":{
        "number":3,
        "content":"Pytanie macierzowe jednokrotne",
        "answers":{
          "1":{ //numer odpowiedzi/wiersza
            "2":"nie" //numer zakresu (kolumny), treść zakresu
          },
          "2":{
            "3":"nie wiem"
          },
          "3":{
            "2":"nie"
          },
          "justif2":"bo tak uważam", //usazadnienie dla odpowiedzi w wierszu numer 2
          "other3":"moja odpowiedz" //odpowiedz respondenta w wierszu 3
        }
      },
      //Pytanie macierzowe wielokrotne
      "1457977":{
        "number":4,
        "content":"Pytanie macierzowe wielokrotne",
        "answers":{
          "1":{ //numer odpowiedzi/wiersza
            "1":"tak", //numer zakresu (kolumny), treść zakresu
            "2":"nie"
          },
          "2":{
            "2":"nie",
            "3":"nie wiem"
          },
          "3":{
            "1":"tak",
            "2":"nie"
          },
          "other3":"my answer" //odpowiedz respondenta w wierszu 3
        }
      },
      //Pytanie macierzowe otwarte
      "1898235":{
        "number":1,
        "content":"Pytanie macierzowe otwarte",
        "answers":{
          "1":{ //numer odpowiedzi
            "1":"a", //odpowiedź wpisana w odpowiedzi nr 1 w kolumnie nr 1
            "2":"b",
            "3":"c"
          },
          "2":{
            "1":"d",
            "2":"e",
            "3":"f"
          },
          "3":{
            "1":"g",
            "2":"h",
            "3":"i"
          },
          "4":{
            "1":"j",
            "2":"k",
            "3":"l"
          }
        }
      }
      //Pytanie otwarte
      "1457978":{
        "number":5,
        "content":"Pytanie otwarte",
        "answers":[ //kolejne odpowiedzi
          "Open answer"
        ]
      },
      //Pytanie rankingowe
      "1457979":{
        "number":6,
        "content":"Pytanie rankingowe",
        "answers":{
          "1":3, // numer odpowiedzi, pozycja
          "2":2,
          "3":1
        }
      },
      //Lista rozwijalna
      "1457980":{
        "number":7,
        "content":"Lista rozwijalna",
        "answers":{
          "2":"Element 2" //numer odpowiedzi, treść odpowiedzi
        }
      },
      //Pytanie formularz
      "1457981":{
        "number":8,
        "content":"Pytanie formularz",
        "answers":{
          "1":"Jan", //numer odpowiedzi, odpowiedź respondenta
          "2":"Kowalski"
        }
      },
      //Pytanie suwakowe
      "1457982":{
        "number":9,
        "content":"Pytanie suwakowe",
        "answers":{
          "1":10 //Numer odpowiedzi/wiersza, pozycja suwaka
        }
      },
      //Pytanie o liczbę
      "1457983":{
        "number":10,
        "content":"Pytanie o liczb\u0119",
        "answers":[ //kolejne odpowiedzi
          "124"
        ]
      },
      //Pytanie o e-mail
      "1457984":{
        "number":11,
        "content":"Podaj sw\u00f3j e-mail",
        "answers":[ //kolejne odpowiedzi
          "jan@kowalski.pl"
        ]
      },
      //Pytanie o datę
      "1457985":{
        "number":12,
        "content":"Podaj dat\u0119 urodzin",
        "answers":[ //Kolejne odpowiedzi
          "23/05/2014"
        ]
      },
      //Pytanie o ustalonej sumie odpowiedzi
      "1457986":{
        "number":13,
        "content":"Ustalona suma odpowiedzi",
        "answers":{
          "1":80, //numer odpowiedzi, odpowiedź wpisana przez respondenta
          "2":20
        }
      }
      //Pytanie NPS
      "1457974":{ //ID pytania
        "number":14, //numer pytania
        "content":"Na ile by\u0142by\u015b w stanie poleci\u0107 nasze us\u0142ugi swoim znajomym?", //Treść pytania
        "answers":{ //udzielone odpowiedzi
          "10":"9", //numer odpowiedzi, treść dopowiedzi
          "other4":"Bo jesteście świetni!" // własna odpowiedź wpisana w trzecim   wierszu
        }
      },
     //Pytanie przeciągnij i upuść
      "1457976":{
        "number":3,
        "content":"Pytanie przeciagnij i upuść",
        "answers":{
          "1":{ //numer odpowiedzi/wiersza
            "2":"wiosna" //numer grupy, treść grupy
          },
          "2":{
            "3":"lato"
          },
          "3":{
            "2":"jesień"
          }
        }
      },
    },
    "points": { //Sekcja opcjonlana, obecna tylko dla ankiet typu Test
        "max": 100, //maksymalna liczba punktów do zdobycia
        "total": 80, //liczba zdobytych punktów
        "percentage_result": "80%", //wynik procentowy
        "feature1": { //wyniki dla cechy numer 1
            "sum": 40,
            "avg": "4.5"
        },
        "feature2": {
            "sum": 30,
            "avg": "3.5"
        }
    },


    "feedback": "This is the feedback for respondent in a test" // Informacja zwrotna
  },{
    //next record
  }
]

Wyniki surowe (JSON) – paginacja

URL

(GET) https://www.webankieta.pl/api/results/paginated-json/: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.
page Parametr decydujący o tym, która strona zostanie wyświetlona.

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": "jan@kowalski.pl",
        "label1": "Jan",
        "label2": "Kowalski",
        //....
        "label10": "Mr."
    },
    "time": {
       "real": "9:05",
        "total": "10:10",
        "page1": "20",
        "page2": "30",
        "page3": "40",
        //....
        "pageN": "10"
    },
    "questions":{
      //Pytanie jednokrotnego wyboru
      "1457974":{ //ID pytania
        "number":1, //numer pytania
        "content":"Pytanie jednokrotnego wyboru", //Treść pytania
        "answers":{ //udzielone odpowiedzi
          "3":"inne, jakie?", //numer odpowiedzi, treść dopowiedzi
          "other3":"moja odpowiedź" // własna odpowiedź wpisana w trzecim   wierszu
        }
      },
      //Pytanie wielokrotnego wyboru
      "1457975":{
        "number":2,
        "content":"Pytanie wielokrotnego wyboru",
        "answers":{
          "2":"kawa", //numer odpowiedzi, treść dopowiedzi
          "3":"inne jakie",
          "other3":"herbata" // własna odpowiedź wpisana przez resp. w wierszu trzecim
        }
      },
      //Pytanie macierzowe jednokrotne
      "1457976":{
        "number":3,
        "content":"Pytanie macierzowe jednokrotne",
        "answers":{
          "1":{ //numer odpowiedzi/wiersza
            "2":"nie" //numer zakresu (kolumny), treść zakresu
          },
          "2":{
            "3":"nie wiem"
          },
          "3":{
            "2":"nie"
          },
          "justif2":"bo tak uważam", //usazadnienie dla odpowiedzi w wierszu numer 2
          "other3":"moja odpowiedz" //odpowiedz respondenta w wierszu 3
        }
      },
      //Pytanie macierzowe wielokrotne
      "1457977":{
        "number":4,
        "content":"Pytanie macierzowe wielokrotne",
        "answers":{
          "1":{ //numer odpowiedzi/wiersza
            "1":"tak", //numer zakresu (kolumny), treść zakresu
            "2":"nie"
          },
          "2":{
            "2":"nie",
            "3":"nie wiem"
          },
          "3":{
            "1":"tak",
            "2":"nie"
          },
          "other3":"my answer" //odpowiedz respondenta w wierszu 3
        }
      },
      //Pytanie macierzowe otwarte
      "1898235":{
        "number":1,
        "content":"Pytanie macierzowe otwarte",
        "answers":{
          "1":{ //numer odpowiedzi
            "1":"a", //odpowiedź wpisana w odpowiedzi nr 1 w kolumnie nr 1
            "2":"b",
            "3":"c"
          },
          "2":{
            "1":"d",
            "2":"e",
            "3":"f"
          },
          "3":{
            "1":"g",
            "2":"h",
            "3":"i"
          },
          "4":{
            "1":"j",
            "2":"k",
            "3":"l"
          }
        }
      }
      //Pytanie otwarte
      "1457978":{
        "number":5,
        "content":"Pytanie otwarte",
        "answers":[ //kolejne odpowiedzi
          "Open answer"
        ]
      },
      //Pytanie rankingowe
      "1457979":{
        "number":6,
        "content":"Pytanie rankingowe",
        "answers":{
          "1":3, // numer odpowiedzi, pozycja
          "2":2,
          "3":1
        }
      },
      //Lista rozwijalna
      "1457980":{
        "number":7,
        "content":"Lista rozwijalna",
        "answers":{
          "2":"Element 2" //numer odpowiedzi, treść odpowiedzi
        }
      },
      //Pytanie formularz
      "1457981":{
        "number":8,
        "content":"Pytanie formularz",
        "answers":{
          "1":"Jan", //numer odpowiedzi, odpowiedź respondenta
          "2":"Kowalski"
        }
      },
      //Pytanie suwakowe
      "1457982":{
        "number":9,
        "content":"Pytanie suwakowe",
        "answers":{
          "1":10 //Numer odpowiedzi/wiersza, pozycja suwaka
        }
      },
      //Pytanie o liczbę
      "1457983":{
        "number":10,
        "content":"Pytanie o liczb\u0119",
        "answers":[ //kolejne odpowiedzi
          "124"
        ]
      },
      //Pytanie o e-mail
      "1457984":{
        "number":11,
        "content":"Podaj sw\u00f3j e-mail",
        "answers":[ //kolejne odpowiedzi
          "jan@kowalski.pl"
        ]
      },
      //Pytanie o datę
      "1457985":{
        "number":12,
        "content":"Podaj dat\u0119 urodzin",
        "answers":[ //Kolejne odpowiedzi
          "23/05/2014"
        ]
      },
      //Pytanie o ustalonej sumie odpowiedzi
      "1457986":{
        "number":13,
        "content":"Ustalona suma odpowiedzi",
        "answers":{
          "1":80, //numer odpowiedzi, odpowiedź wpisana przez respondenta
          "2":20
        }
      }
      //Pytanie NPS
      "1457974":{ //ID pytania
        "number":14, //numer pytania
        "content":"Na ile by\u0142by\u015b w stanie poleci\u0107 nasze us\u0142ugi swoim znajomym?", //Treść pytania
        "answers":{ //udzielone odpowiedzi
          "10":"9", //numer odpowiedzi, treść dopowiedzi
          "other4":"Bo jesteście świetni!" // własna odpowiedź wpisana w trzecim   wierszu
        }
      },
     //Pytanie przeciągnij i upuść
      "1457976":{
        "number":3,
        "content":"Pytanie przeciagnij i upuść",
        "answers":{
          "1":{ //numer odpowiedzi/wiersza
            "2":"wiosna" //numer grupy, treść grupy
          },
          "2":{
            "3":"lato"
          },
          "3":{
            "2":"jesień"
          }
        }
      },
    },
    "points": { //Sekcja opcjonlana, obecna tylko dla ankiet typu Test
        "max": 100, //maksymalna liczba punktów do zdobycia
        "total": 80, //liczba zdobytych punktów
        "percentage_result": "80%", //wynik procentowy
        "feature1": { //wyniki dla cechy numer 1
            "sum": 40,
            "avg": "4.5"
        },
        "feature2": {
            "sum": 30,
            "avg": "3.5"
        }
    },


    "feedback": "This is the feedback for respondent in a test" // Informacja zwrotna
  },{
    //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 ten artykuł był pomocny?

Dziękujemy za udzielenie odpowiedzi