Seznam operací pro zdroj
Název | URL | Popis |
---|---|---|
Agregované výsledky | /results/aggregated/:id_survey | Tato operace vrací výsledky dotazníku v CSV formátu. Podoba odpovědi je stejná, jako je podoba CSV souboru obsahujícího agregované výsledky, exportovaného z rozhraní Netquest.cz Ukázkový soubor agregovaných výsledků můžete stáhnout zde. |
Raw výsledky | /results/raw/:id_survey | Tato operace vrací výsledky dotazníku v CSV formátu. Podoba odpovědi je stejná, jako je podoba CSV souboru obsahujícího raw výsledky, exportovaného z rozhraní Netquest.cz Ukázkový soubor agregovaných výsledků můžete stáhnout zde |
Meta data (JSON) | /results/meta/:id_survey | Tato operace vrací meta informace o výsledkcích dotazníku ve formátu JSON. Podoba odpovědi je popsána níže. |
Raw výsledky (JSON) | /results/json/:id_survey | Tato operace vrací výsledky dotazníku ve formátu JSON. Podoba odpovědi je popsána níže. Operace bude vypnuta 31. prosince 2018. Doporučujeme použít operaci „Raw výsledky (JSON) – stránkování“. |
Raw výsledky (JSON) – stránkování | /results/paginated-json/:id_survey | Tato operace vrací výsledky dotazníku ve formátu JSON. Podoba odpovědi je popsána níže. Výsledky jsou vráceny po 10 záznamech, nejnovější je na první pozici. |
Agregované výsledky
URL
(GET) https://www.netquest.cz/api/results/aggregated/:id_survey
Nepovinné parametry (POST)
Název | Popis |
---|---|
id_response | ID vyplnění použité během vyplňování dotazníku. Parametr nemůže být předán, pokud je ve stejný čas předáván token |
token | Token respondenta použitý během vyplňování dotazníku. Parametr nemůže být předán, pokud je ve stejný čas předáván id_response |
external_key | Měření externího parametru respondenta, dodaného systémem klienta |
lower_response_date | Nejvzdálenější možné datum vyplnění dotazníku. Je-li tento parametr použit, budou vrácena pouze ta vyplnění, která proběhla během předávaného data. Datum musí být předáno v podobě YYYY-MM-DD (např. 2011-11-20). |
upper_response_date | Nejbližší možné datum vyplnění dotazníku. Je-li tento parametr použit, budou vrácena pouze ta vyplnění, která proběhla během předávaného data. Datum musí být předáno v podobě YYYY-MM-DD (např. 2011-11-20). |
Ukázka odpovědi
Zde je CSV
Chybové hlášky
400 Špatný požadavek
– Nesprávný formát datumu.401 Neautorizováno
– Uživatel odkazuje na zdroj, který nevlastní.404 Nenalezeno
– Nebyl nalezen žádný dotazník daného:id_survey
.406 Nepřijatelné
– Nebyl předán žádný parametr:id_survey
.409 Konflikt
– Parametry:id_response
a:token
byly předány současně.
Raw výsledky
URL
(GET) https://www.netquest.cz/api/results/search/:id_survey
Nepovinné parametry (POST)
Název | Popis |
---|---|
id_response | ID vyplnění použité během vyplňování dotazníku. Parametr nemůže být předán, pokud je ve stejný čas předáván token |
token | Token respondenta použitý během vyplňování dotazníku. Parametr nemůže být předán, pokud je ve stejný čas předáván id_response |
external_key | Měření externího parametru respondenta, dodaného systémem klienta |
lower_response_date | Nejvzdálenější možné datum vyplnění dotazníku. Je-li tento parametr použit, budou vrácena pouze ta vyplnění, která proběhla během předávaného data. Datum musí být předáno v podobě YYYY-MM-DD (např. 2011-11-20). |
upper_response_date | Nejbližší možné datum vyplnění dotazníku. Je-li tento parametr použit, budou vrácena pouze ta vyplnění, která proběhla během předávaného data. Datum musí být předáno v podobě YYYY-MM-DD (např. 2011-11-20). |
unfinished | Parametr, který určuje, zda jsou zahrnuty i neúplná (částečná) vyplnění. |
Ukázka odpovědi
Zde je CSV
Chybové hlášky
400 Špatný požadavek
– Nesprávný formát datumu.401 Neautorizováno
– Uživatel odkazuje na zdroj, který nevlastní.404 Nenalezeno
– Nebyl nalezen žádný dotazník daného:id_survey
.406 Nepřijatelné
– Nebyl předán žádný parametr:id_survey
.409 Konflikt
– Parametry:id_response
a:token
byly předány současně.
Meta data (JSON)
URL
(GET) https://www.netquest.cz/api/results/meta/:id_survey
Nepovinné parametry (POST)
Název | Popis |
---|---|
id_response | ID vyplnění použité během vyplnění. Parametr nemůže být předán, pokud byl ve stejný čas předán token |
token | Token respondenta použitý během vyplnění dotazníku. Parametr nemůže být předán, pokud byl ve stejný čas předán id_response |
external_key | Externí parametr měřící respondenta a předaný systémem klienta |
lower_response_date | Nejzazší dostupné datum vyplnění dotazníku. Je-li tento parametr použitý, budou vrácena pouze ta vyplnění, která byla provedena po předaném datu. Datum musí být předáno ve tvaru RRRR-MM-DD (např. 2011-11-20). |
upper_response_date | Nejbližší dostupné datum vyplnění dotazníku. Je-li tento parametr použitý, budou vrácena pouze ta vyplnění, která byla provedena před předaném datu. Datum musí být předáno ve tvaru RRRR-MM-DD (např. 2011-11-20). |
unfinished | Parametr, který určuje, zda jsou zahrnuty i neúplná (částečná) vyplnění. |
Ukázka odpovědi
[ { "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 Špatný požadavek
– Nesprávný formát datumu.401 Neautorizováno
– Uživatel odkazuje na zdroj, který nevlastní.404 Nenalezeno
– Nebyl nalezen žádný dotazník daného:id_survey
.406 Nepřijatelné
– Nebyl předán žádný parametr:id_survey
.409 Konflikt
– Parametry:id_response
a:token
byly předány současně.
Raw výsledky (JSON)
Operace bude vypnuta 31. prosince 2018. Doporučujeme použít operaci „Raw výsledky (JSON) – stránkování“
URL
(GET) https://www.netquest.cz/api/results/json/:id_survey
Nepovinné parametry (POST)
Název | Popis |
---|---|
id_response | ID vyplnění použité během vyplnění. Parametr nemůže být předán, pokud byl ve stejný čas předán token |
token | Token respondenta použitý během vyplnění dotazníku. Parametr nemůže být předán, pokud byl ve stejný čas předán id_response |
external_key | Externí parametr měřící respondenta a předaný systémem klienta |
lower_response_date | Nejzazší dostupné datum vyplnění dotazníku. Je-li tento parametr použitý, budou vrácena pouze ta vyplnění, která byla provedena po předaném datu. Datum musí být předáno ve tvaru RRRR-MM-DD (např. 2011-11-20). |
upper_response_date | Nejbližší dostupné datum vyplnění dotazníku. Je-li tento parametr použitý, budou vrácena pouze ta vyplnění, která byla provedena před předaném datu. Datum musí být předáno ve tvaru RRRR-MM-DD (např. 2011-11-20). |
unfinished | Parametr, který určuje, zda jsou zahrnuty i neúplná (částečná) vyplnění. |
Ukázka odpovědi
[ { "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 Špatný požadavek
– Nesprávný formát datumu.401 Neautorizováno
– Uživatel odkazuje na zdroj, který nevlastní.404 Nenalezeno
– Nebyl nalezen žádný dotazník daného:id_survey
.406 Nepřijatelné
– Nebyl předán žádný parametr:id_survey
.409 Konflikt
– Parametry:id_response
a:token
byly předány současně.
Raw výsledky (JSON) – stránkování
URL
(GET) https://www.netquest.cz/api/results/paginated-json/:id_survey
Nepovinné parametry (POST)
Název | Popis |
---|---|
id_response | ID vyplnění použité během vyplnění. Parametr nemůže být předán, pokud byl ve stejný čas předán token |
token | Token respondenta použitý během vyplnění dotazníku. Parametr nemůže být předán, pokud byl ve stejný čas předán id_response |
external_key | Externí parametr měřící respondenta a předaný systémem klienta |
lower_response_date | Nejzazší dostupné datum vyplnění dotazníku. Je-li tento parametr použitý, budou vrácena pouze ta vyplnění, která byla provedena po předaném datu. Datum musí být předáno ve tvaru RRRR-MM-DD (např. 2011-11-20). |
upper_response_date | Nejbližší dostupné datum vyplnění dotazníku. Je-li tento parametr použitý, budou vrácena pouze ta vyplnění, která byla provedena před předaném datu. Datum musí být předáno ve tvaru RRRR-MM-DD (např. 2011-11-20). |
unfinished | Parametr, který určuje, zda jsou zahrnuty i neúplná (částečná) vyplnění. |
page | Parametr, který určuje, která stránka se zobrazí. |
Ukázka odpovědi
[ { "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 Špatný požadavek
– Nesprávný formát datumu.401 Neautorizováno
– Uživatel odkazuje na zdroj, který nevlastní.404 Nenalezeno
– Nebyl nalezen žádný dotazník daného:id_survey
.406 Nepřijatelné
– Nebyl předán žádný parametr:id_survey
.409 Konflikt
– Parametry:id_response
a:token
byly předány současně.