Sprievodca - API

Výsledky dotazníka

Zoznam operácií pre zdroj

NázovURLPopis
Agregované výsledky/results/aggregated/:id_surveyTáto operácia vracia výsledky dotazníka v CSV formáte. Podoba odpovede je rovnaká, ako je podoba CSV súboru obsahujúceho agregované výsledky, exportovaného z rozhrania Netquest.sk
Ukážkový súbor agregovaných výsledkov môžete stiahnuť tu.
Raw výsledky/results/raw/:id_surveyTáto operácia vracia výsledky dotazníka v CSV formáte. Podoba odpovede je rovnaká, ako je podoba CSV súboru obsahujúceho raw výsledky, exportovaného z rozhrania Netquest.sk
Ukážkový súbor agregovaných výsledkov môžete stiahnuť zde
Meta data (JSON)/results/meta/:id_surveyTáto operácia vracia meta informácie o výsledkoch dotazníka vo formáte JSON. Podoba odpovede je popísaná nižšie.
Raw výsledky (JSON)/results/json/:id_surveyTáto operácia vracia výsledky dotazníka vo formáte JSON. Podoba odpovede je popísaná nižšie. Operácia bude vypnutá 31. decembra 2018. Odporúčame použiť operáciu „Raw výsledky (JSON) – stránkovanie”.
Raw výsledky (JSON) – stránkování/results/paginated-json/:id_surveyTáto operácia vracia výsledky dotazníka vo formáte JSON. Podoba odpovede je popísaná nižšie. Výsledky sú vrátené po 10 záznamoch, najnovšie je na prvej pozícii.

Agregované výsledky

URL

(GET) https://www.netquest.sk/api/results/aggregated/:id_survey

Nepovinné parametre (POST)

NázovPopis
id_responseID vyplnenie použité počas vypĺňania dotazníka.
Parameter nemôže byť odovzdaný, pokiaľ je v rovnaký čas odovzdávaný token
tokenToken respondenta použitý počas vypĺňania dotazníka.
Parameter nemôže byť odovzdaný, pokiaľ je v rovnaký čas odovzdávaný id_response
external_keyMeranie externého parametra respondenta, dodaného systémom klienta
lower_response_dateNajvzdialenejšie možné dátum vyplnenia dotazníka. Ak je tento parameter použitý, budú vrátené iba tie vyplnenie, ktorá prebehla počas odovzdávaného dáta.
Dátum musí byť predstavené v podobe YYYY-MM-DD (napr. 2011-11-20).
upper_response_dateNajbližší možný dátum vyplnenia dotazníka. Ak je tento parameter použitý, budú vrátené iba tie vyplnenie, ktorá prebehla počas odovzdávaného dáta.
Dátum musí byť predstavené v podobe YYYY-MM-DD (napr. 2011-11-20).

Ukážka odpovede

Zde je CSV

Chybové hlášky

400 Zlá požiadavka – Nesprávny formát dátumu.
401 Neautorizovaný – Užívateľ odkazuje na zdroj, ktorý nevlastní.
404 Nenájdené – Nenašiel sa žiadny dotazník daného: id_survey.
406 Neprijateľné – Nebol odovzdaný žiadny parameter: id_survey.
409 Konflikt – Parametre: id_response a: token boli odovzdané súčasne.

Raw výsledky

URL

(GET) https://www.netquest.sk/api/results/search/:id_survey

Nepovinné parametry (POST)

NázovPopis
id_responseID vyplnenie použité počas vyplňovania dotazníka.
Parameter nemôže byť odovzdaný, pokiaľ je v rovnaký čas odovzdávaný token
tokenToken respondenta použitý počas vyplňovania dotazníka.
Parameter nemôže byť odovzdaný, pokiaľ je v rovnaký čas odovzdávaný id_response
external_keyMeranie externého parametra respondenta, dodaného systémom klienta
lower_response_dateNajvzdialenejší možný dátum vyplnenia dotazníka. Ak je tento parameter použitý, budú vrátené iba tie vyplnenie, ktorá prebehla počas odovzdávaného dáta.
Dátum musí byť predstavené v podobe YYYY-MM-DD (napr. 2011-11-20).
upper_response_dateNajbližší možný dátum vyplnenia dotazníka. Ak je tento parameter použitý, budú vrátené iba tie vyplnenie, ktorá prebehla počas odovzdávaného dáta.
Dátum musí byť predstavené v podobe YYYY-MM-DD (napr. 2011-11-20).
unfinishedParameter, ktorý určuje, či sú zahrnuté aj neúplné (čiastočná) vyplnenie.

Ukážka odpovede

Tu je CSV

Chybové hlášky

400 Zlá požiadavka – Nesprávny formát dátumu.
401 Neautorizovaný – Užívateľ odkazuje na zdroj, ktorý nevlastní.
404 Nenájdené – Nenašiel sa žiadny dotazník daného: id_survey.
406 Neprijateľné – Nebol odovzdaný žiadny parameter: id_survey.
409 Konflikt – Parametre: id_response a: token boli odovzdané súčasne.

Meta dáta (JSON)

URL

(GET) https://www.netquest.sk/api/results/meta/:id_survey

Nepovinné parametre (POST)

NázovPopis
id_responseID vyplnenie použité počas vyplnenie.
Parameter nemôže byť odovzdaný, pokiaľ bol v rovnaký čas odovzdaný token
tokenToken respondenta použitý počas vyplnenie dotazníka.
Parameter nemôže byť odovzdaný, pokiaľ bol v rovnaký čas odovzdaný id_response
external_keyExterný parameter meriaci respondenta a prenášaného systémom klienta
lower_response_datePosledný možný dostupné dátum vyplnenia dotazníka. Ak je tento parameter použitý, budú vrátené iba tie vyplnenie, ktorá bola vykonaná po predvedenom dátume.
Dátum musí byť odovzdané v tvare RRRR-MM-DD (napr. 2011-11-20).
upper_response_dateNajbližšie dostupné dátum vyplnenia dotazníka. Ak je tento parameter použitý, budú vrátené iba tie vyplnenie, ktorá bola vykonaná pred odovzdanom dátume.
Dátum musí byť odovzdané v tvare RRRR-MM-DD (napr. 2011-11-20).
unfinishedParameter, ktorý určuje, či sú zahrnuté aj neúplné (čiastočná) vyplnenie.

Ukážka odpovede

[
  {
    "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": "Petr",
        "label2": "Novák",
        //....
        "label10": "Pán"
    },
    "time": {
        "real": "9:05",
        "total": "10:10"
    }
  },{
    //další záznam
  }
]

Chybové hlášky

400 Zlá požiadavka – Nesprávny formát dátumu.
401 Neautorizovaný – Užívateľ odkazuje na zdroj, ktorý nevlastní.
404 Nenájdené – Nenašiel sa žiadny dotazník daného: id_survey.
406 Neprijateľné – Nebol odovzdaný žiadny parameter: id_survey.
409 Konflikt – Parametre: id_response a: token boli odovzdané súčasne.

Raw výsledky (JSON)

Operácia bude vypnutá 31. decembra 2018. Odporúčame použiť operáciu „Raw výsledky (JSON) – stránkovanie”

URL

(GET) https://www.netquest.sk/api/results/json/:id_survey

Nepovinné parametre (POST)

NázovPopis
id_responseID vyplnenie použité počas vyplnenie.
Parameter nemôže byť odovzdaný, pokiaľ bol v rovnaký čas odovzdaný token
tokenToken respondenta použitý počas vyplnenie dotazníka.
Parameter nemôže byť odovzdaný, pokiaľ bol v rovnaký čas odovzdaný id_response
external_keyExterný parameter meriaci respondenta a prenášaného systémom klienta
lower_response_datePosledný možný dostupný dátum vyplnenia dotazníka. Ak je tento parameter použitý, budú vrátené iba tie vyplnenie, ktorá bola vykonaná po predvedenom dátume.
Dátum musí byť odovzdané v tvare RRRR-MM-DD (napr. 2011-11-20).
upper_response_dateNajbližší dostupný dátum vyplnenia dotazníka. Ak je tento parameter použitý, budú vrátené iba tie vyplnenie, ktorá bola vykonaná pred odovzdanom dátume.
Dátum musí byť odovzdané v tvare RRRR-MM-DD (napr. 2011-11-20).
unfinishedParameter, ktorý určuje, či sú zahrnuté aj neúplné (čiastočná) vyplnenie.

Ukážka odpovede

[
  {
    "meta": {
        "id": 123456,
        "ip": "127.0.0.1",
        "referer": "http:\/\/facebook.com",
        "date_response": "2014-02-02 12:00:00",
        "external_key": "mailing",
        "token": "12fh47",
        "e-mail": "[email protected]",
        "label1": "Petr",
        "label2": "Novák",
        //....
        "label10": "Pán"
    },
    "time": {
        "total": "184",
        "page1": "20",
        "page2": "30",
        "page3": "40",
        //....
        "pageN": "10"
    },
    "questions":{
      //Otázka s jednou možností výběru
      "1457974":{ //ID otázky
        "number":1, //Číslo otázky
        "content":"Otázka s jednou možností výberu", //Obsah otázky
        "answers":{ //Poskytnuté odpovědi
          "3":"Ostatní", //Číslo odpovědi, obsah odpovědi
          "other3":"Má odpověď" //Uživatelská odpověď zadaná na třetím řádku
        }
      },
      //Otázka s více možnostmi výběru
      "1457975":{
        "number":2,
        "content":"Otázka s více možnostmi výběru",
        "answers":{
          "2":"Kafe", //Číslo odpovědi, obsah odpovědi
          "3":"Ostatní",
          "other3":"Čaj" //Uživatelská odpověď zadaná na třetím řádku
        }
      },
      //Maticová otázka s jednou možností výběru
      "1457976":{
        "number":3,
        "content":"Maticová otázka s jednou možností výběru",
        "answers":{
          "1":{ //Odpověď/číslo řádku
            "2":"Ne" //Číslo rozsahu (sloupec), obsah rozsahu
          },
          "2":{
            "3":"Nevím"
          },
          "3":{
            "2":"Ne"
          },
          "justif2":"Protože jsem tak řekl", //Zdůvodnění pro odpověď na 2. řádku
          "other3":"Má odpověď" //Odpověď respondenta na 3. řádku
        }
      },
      //Maticová otázka s více možnostmi výběru
      "1457977":{
        "number":4,
        "content":"Maticová otázka s více možnostmi výběru",
        "answers":{
          "1":{ //Odpověď/číslo řádku
            "1":"Ano", //Číslo rozsahu (sloupec), obsah rozsahu
            "2":"Ne"
          },
          "2":{
            "2":"Ne",
            "3":"Nevím"
          },
          "3":{
            "1":"Ano",
            "2":"Ne"
          },
          "other3":"Má odpověď" //Odpověď respondenta na 3. řádku
        }
      },
      //Otevřená otázka
      "1457978":{
        "number":5,
        "content":"Otevřená otázka",
        "answers":[ //Následující odpovědi
          "Otevřená odpověď"
        ]
      },
      //Rankingová otázka
      "1457979":{
        "number":6,
        "content":"Rankingová otázka",
        "answers":{
          "1":3, //Číslo odpovědi, pozice
          "2":2,
          "3":1
        }
      },
      //Roletka
      "1457980":{
        "number":7,
        "content":"Roletka",
        "answers":{
          "2":"2. prvek" //Číslo odpovědi, obsah odpovědi
        }
      },
      //Formulář
      "1457981":{
        "number":8,
        "content":"Formulář",
        "answers":{
          "1":"Petr", //Číslo odpovědi, odpověď respondenta
          "2":"Novák"
        }
      },
      //Posuvníková otázka
      "1457982":{
        "number":9,
        "content":"Posuvníková otázka",
        "answers":{
          "1":10 //Odpověď/číslo řádku, pozice posuvníku
        }
      },
      //Numerická otázka
      "1457983":{
        "number":10,
        "content":"Numerická otázka",
        "answers":[ //Následující odpovědi
          "124"
        ]
      },
      //E-mailová otázka
      "1457984":{
        "number":11,
        "content":"Prosím zadejte svoji e-mailovou adresu",
        "answers":[ //Následující odpovědi
          "[email protected]"
        ]
      },
      //Datumová otázka
      "1457985":{
        "number":12,
        "content":"Prosím zadejte datum svého narození",
        "answers":[ //Následující odpovědi
          "23/05/2014"
        ]
      },
  //NPS otázka       
      "1457974":{ //ID otázky         
       "number":14, //číslo otázky         
       "content":"Na základě vašich zkušeností s námi, jaká je pravděpodobnost, že byste nás doporučil/a svým známým?", //Obsah otázky
        "answers":{ //udělené odpovědi           "10":"9", //číslo odpovědi, obsah odpovědi           
         "other4":"Protože jste skvělí!" // vlastní odpověď, zadáná do třetího řádku         
      }       
     }, 
  //Otázka s pevným počtem odpovědí
      "1457986":{
        "number":13,
        "content":"Pevný počet odpovědí",
        "answers":{
          "1":80, //Číslo odpovědi, odpověď poskytnutá respondentem
          "2":20
        }
      }
    },
    "points": { //Nepovinná sekce, dostupná pouze pro Testy / Hodnocení
        "max": 100, //Maximální počet bodů k nasbírání
        "total": 80, //Počet nasbíraných bodů
        "percentage_result": "80%", //Procentuální výsledek
        "feature1": { //Výsledek pro vlastnost číslo 1
            "sum": 40,
            "avg": "4.5"
        },
        "feature2": {
            "sum": 30,
            "avg": "3.5"
        }
    },
    "feedback": "Toto je zpětná vazba pro respondenta v testu" // Zpětná vazba
  },{
    //Další záznam
  }
]

Chybové hlášky

400 Zlá požiadavka – Nesprávny formát dátumu.
401 Neautorizovaný – Užívateľ odkazuje na zdroj, ktorý nevlastní.
404 Nenájdené – Nenašiel sa žiadny dotazník daného: id_survey.
406 Neprijateľné – Nebol odovzdaný žiadny parameter: id_survey.
409 Konflikt – Parametre: id_response a: token boli odovzdané súčasne.

Raw výsledky (JSON) – stránkovanie

URL

(GET) https://www.netquest.sk/api/results/paginated-json/:id_survey

Nepovinné parametre (POST)

NázovPopis
id_responseID vyplnenie použité počas vyplnenia.
Parameter nemôže byť odovzdaný, pokiaľ bol v rovnaký čas odovzdaný token
tokenToken respondenta použitý počas vyplnenia dotazníka.
Parameter nemôže byť odovzdaný, pokiaľ bol v rovnaký čas odovzdaný id_response
external_keyExterný parameter meracie respondenta a prenášaného systémom klienta
lower_response_datePosledný možný dostupné dátum vyplnenia dotazníka. Ak je tento parameter použitý, budú vrátené iba tie vyplnenie, ktorá bola vykonaná po predvedenom dátume.
Dátum musí byť odovzdané v tvare RRRR-MM-DD (napr. 2011-11-20).
upper_response_dateNajbližší dostupný dátum vyplnenia dotazníka. Ak je tento parameter použitý, budú vrátené iba tie vyplnenie, ktorá bola vykonaná pred odovzdanom dátume.
Dátum musí byť odovzdané v tvare RRRR-MM-DD (napr. 2011-11-20).
unfinishedParameter, ktorý určuje, či sú zahrnuté aj neúplné (čiastočná) vyplnenie.
pageParameter, ktorý určuje, ktorá stránka sa zobrazí.

Ukážka odpovede

[
  {
    "meta": {
        "id": 123456,
        "ip": "127.0.0.1",
        "referer": "http:\/\/facebook.com",
        "date_response": "2014-02-02 12:00:00",
        "external_key": "mailing",
        "token": "12fh47",
        "e-mail": "[email protected]",
        "label1": "Petr",
        "label2": "Novák",
        //....
        "label10": "Pán"
    },
    "time": {
        "total": "184",
        "page1": "20",
        "page2": "30",
        "page3": "40",
        //....
        "pageN": "10"
    },
    "questions":{
      //Otázka s jednou možností výběru
      "1457974":{ //ID otázky
        "number":1, //Číslo otázky
        "content":"Otázka s jednou možností výberu", //Obsah otázky
        "answers":{ //Poskytnuté odpovědi
          "3":"Ostatní", //Číslo odpovědi, obsah odpovědi
          "other3":"Má odpověď" //Uživatelská odpověď zadaná na třetím řádku
        }
      },
      //Otázka s více možnostmi výběru
      "1457975":{
        "number":2,
        "content":"Otázka s více možnostmi výběru",
        "answers":{
          "2":"Kafe", //Číslo odpovědi, obsah odpovědi
          "3":"Ostatní",
          "other3":"Čaj" //Uživatelská odpověď zadaná na třetím řádku
        }
      },
      //Maticová otázka s jednou možností výběru
      "1457976":{
        "number":3,
        "content":"Maticová otázka s jednou možností výběru",
        "answers":{
          "1":{ //Odpověď/číslo řádku
            "2":"Ne" //Číslo rozsahu (sloupec), obsah rozsahu
          },
          "2":{
            "3":"Nevím"
          },
          "3":{
            "2":"Ne"
          },
          "justif2":"Protože jsem tak řekl", //Zdůvodnění pro odpověď na 2. řádku
          "other3":"Má odpověď" //Odpověď respondenta na 3. řádku
        }
      },
      //Maticová otázka s více možnostmi výběru
      "1457977":{
        "number":4,
        "content":"Maticová otázka s více možnostmi výběru",
        "answers":{
          "1":{ //Odpověď/číslo řádku
            "1":"Ano", //Číslo rozsahu (sloupec), obsah rozsahu
            "2":"Ne"
          },
          "2":{
            "2":"Ne",
            "3":"Nevím"
          },
          "3":{
            "1":"Ano",
            "2":"Ne"
          },
          "other3":"Má odpověď" //Odpověď respondenta na 3. řádku
        }
      },
      //Otevřená otázka
      "1457978":{
        "number":5,
        "content":"Otevřená otázka",
        "answers":[ //Následující odpovědi
          "Otevřená odpověď"
        ]
      },
      //Rankingová otázka
      "1457979":{
        "number":6,
        "content":"Rankingová otázka",
        "answers":{
          "1":3, //Číslo odpovědi, pozice
          "2":2,
          "3":1
        }
      },
      //Roletka
      "1457980":{
        "number":7,
        "content":"Roletka",
        "answers":{
          "2":"2. prvek" //Číslo odpovědi, obsah odpovědi
        }
      },
      //Formulář
      "1457981":{
        "number":8,
        "content":"Formulář",
        "answers":{
          "1":"Petr", //Číslo odpovědi, odpověď respondenta
          "2":"Novák"
        }
      },
      //Posuvníková otázka
      "1457982":{
        "number":9,
        "content":"Posuvníková otázka",
        "answers":{
          "1":10 //Odpověď/číslo řádku, pozice posuvníku
        }
      },
      //Numerická otázka
      "1457983":{
        "number":10,
        "content":"Numerická otázka",
        "answers":[ //Následující odpovědi
          "124"
        ]
      },
      //E-mailová otázka
      "1457984":{
        "number":11,
        "content":"Prosím zadejte svoji e-mailovou adresu",
        "answers":[ //Následující odpovědi
          "[email protected]"
        ]
      },
      //Datumová otázka
      "1457985":{
        "number":12,
        "content":"Prosím zadejte datum svého narození",
        "answers":[ //Následující odpovědi
          "23/05/2014"
        ]
      },
   //NPS otázka       
      "1457974":{ //ID otázky         
       "number":14, //číslo otázky         
       "content":"Na základě vašich zkušeností s námi, jaká je pravděpodobnost, že byste nás doporučil/a svým známým?", //Obsah otázky
        "answers":{ //udělené odpovědi           "10":"9", //číslo odpovědi, obsah odpovědi           
         "other4":"Protože jste skvělí!" // vlastní odpověď, zadáná do třetího řádku         
      }       
     },  
      //Otázka s pevným počtem odpovědí
      "1457986":{
        "number":13,
        "content":"Pevný počet odpovědí",
        "answers":{
          "1":80, //Číslo odpovědi, odpověď poskytnutá respondentem
          "2":20
        }
      }
    },
    "points": { //Nepovinná sekce, dostupná pouze pro Testy / Hodnocení
        "max": 100, //Maximální počet bodů k nasbírání
        "total": 80, //Počet nasbíraných bodů
        "percentage_result": "80%", //Procentuální výsledek
        "feature1": { //Výsledek pro vlastnost číslo 1
            "sum": 40,
            "avg": "4.5"
        },
        "feature2": {
            "sum": 30,
            "avg": "3.5"
        }
    },
    "feedback": "toto je zpětná vazba na respondenta v testu" // Zpětná vazba
  },{
    //Další záznam
  }
]

Chybové hlášky

400 Zlá požiadavka – Nesprávny formát dátumu.
401 Neautorizovaný – Užívateľ odkazuje na zdroj, ktorý nevlastní.
404 Nenájdené – Nenašiel sa žiadny dotazník daného: id_survey.
406 Neprijateľné – Nebol odovzdaný žiadny parameter: id_survey.
409 Konflikt – Parametre: id_response a: token boli odovzdané súčasne.

Pomohol Vám tento článok?

Ďakujeme za odpoveď