REST API

SurveyLab umożliwia dostęp do Twoich ankiet i danych za pomocą REST API. Dostęp do API odbywa się za pomocą szyfrowanego połączenia (SSL / HTTPS) oraz tokenu. Dane są udostępniane w formacie JSON. Autoryzacja użytkownika odbywa się za pomocą JWT.

Lista dostępnych zapytań

Pobierz token
Pobierz listę ankiet
Pobierz ankietę
Pobierz pytania
Pobierz odpowiedzi (100)
Pobierz odpowiedź
Pobierz metadane

Kody statusów

Statusy są zwracane za pomocą standardowych kodów błędów HTTPS.

Kod	Opis
200	Zapytania zostało wykonane pomyślnie.
400	Zapytanie nie powiodło się. Błędny token.
401	Unauthorized. Prubujesz zautoryzować się za pomocą błędnego loginu lub klucza API.
404	Not Found. Zasób nie istnieje.
500	Internal Server Error. Spróbuj ponownie lub skontaktuj się z naszym wsparciem.

Pobierz token

Pobranie tokena do bezpiecznej komunikacji. Token jest ważny przez 30 dni.

POST https://api.surveylab.com/oauth/token/

cURL
curl -i -X POST https://api.surveylab.com/oauth/token/ -d "clientSecret=YOUR_CLIENT_SECRET &clientId=YOUR_CLIENT_ID"

Przykład wyniku zapytania

Token

UWAGI. Aby skorzystać z API będziesz potrzebować clientId oraz clientSecret. Te informacje są udostępniane na żądanie. Skontaktuj się z nami, aby je uzyskać.

Pobierz listę ankiet

Pobranie listy ankiet. Otrzymasz listę wszystkich ankiet znajdujących się na Twoim koncie.

GET https://api.surveylab.com/api/v2/surveys/

cURL
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/

Przykład wyniku zapytania

{
        "surveyId": 22789,
        "userId": 127,
        "surveyThemeId": 90,
        "name": "eNPS",
        "questionNumbering": "survey",
        "headerPageTitleShow": null,
        "headerPageNumberShow": null,
        "pageRotation": 0,
        "logoPlacement": null,
        "layoutHideProgressBar": null,
        "created": 1540556695,
        "modified": "2019-01-03 15:14:45",
        "footerVisible": null,
        "headerShowTitle": null,
        "answerOneClick": null,
        "logoVisibility": null,
        "logoVisibilityEmbedded": null,
        "logoURL": null,
        "blockRotation": 0,
        "defaultName": "eNPS",
        "languageId": 2,
        "impressions": 2,
        "responses": 1,
        "correct": 1,
        "unpaidResponses": 0,
        "opened": 1,
        "campaignCount": 1
    }

Pobierz ankietę

Pobranie pojedynczej ankiety. Otrzymasz całą ankietę, w tym informację o stronach, blokach, ... Aby wykonać zapytanie będziesz potrzebował numer id ankiety. Możesz go znaleźć na stronie podglądu lub stronie projektu ankiety.

GET https://api.surveylab.com/api/v2/surveys/:id/

cURL
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/

Przykład
GET https://api.surveylab.com/api/v2/surveys/21045/

Przykład wyniku zapytania

{
"surveyId": 21045,
"userId": 127,
"modified": "2019-01-08 16:44:12",
"surveyThemeId": 90,
"languageId": null,
"name": "Was this article helpful",
"title": "Was this article helpful",
"questionNumbering": "survey",
"textDirection": "ltr",
"pageRotation": 0,
"blockRotation": 0,
"answerOneClick": false,
"blocksById": {
"25480": {
"blockId": 25480,
"surveyId": 21045,
"blockIsRotated": 0,
"blockNumber": 1,
"blockIdBySurvey": 1,
"blockName": "Block name",
"pagesOrder": {
"1": 85533
}
}
},
"pagesById": {
"85533": {
"surveyId": 21045,
"pageId": 85533,
"number": 1,
"pageIdBySurvey": 1,
"welcomePage": 0,
"title": "Untitled Page",
"description": null,
"titleVisible": 1,
"blockId": 25480,
"questionOffset": 0,
"questionsOrder": [
194238
],
"pageIsRotated": 0,
"questionsRotation": 0,
"randomQuestion": null
}
},
"questionsById": {
"194238": {
"questionId": 194238,
"pageId": 85533,
"type": "simple",
"params": {
"question": "Was this article helpful?",
"description": "",
"required": 0,
"comments": 0,
"exclusionQuestion": false,
"questionImgURL": "",
"maxNumberOfAnswers": 0,
"minNumberOfAnswers": 0,
"answers": [
"Yes",
"No"
],
"imageAnswer": [],
"open": "",
"multiple": 0,
"noneAbove": "",
"hideLableText": 0,
"points": 0,
"columnElements": 0,
"scoreArray": {
"0": "1",
"1": "-1",
"max": "1"
},
"presentationTiled": 1,
"presentation": "tiles-horizontal",
"random": 0,
"randomizeOptions": true
},
"questionIsRotated": 0,
"isRandomQuestion": 1,
"numbering": true,
"number": 1,
"questionIdBySurvey": 1,
"addedToBank": false,
"templateFile": "questions/simple.tpl",
"points": 0,
"opentext": "",
"open": 0
}
},
"public": 1,
"defaultTranslation": 1,
"blocksOrder": {
"1": 25480
}
}

Pobierz pytania

Pobranie listy pytań dla wybranej ankiety. Otrzymasz tylko pytania.

GET https://api.surveylab.com/api/v2/surveys/:id/questions/

cURL
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/questions/

Przykład wyniku zapytania

{
"questionId": 194238,
"number": 1,
"questionIdBySurvey": 1,
"type": "simple",
"questionParams": {
"question": "Was this article helpful?",
"description": "",
"translatable": {
"question": "Was this article helpful?",
"description": "",
"open": "",
"noneAbove": "",
"answers": [
"Yes",
"No"
]
},
"required": 0,
"comments": 0,
"exclusionQuestion": 0,
"questionImgURL": "",
"maxNumberOfAnswers": 0,
"minNumberOfAnswers": 0,
"answers": [
"Tak",
"Nie"
],
"imageAnswer": [],
"open": "",
"multiple": 0,
"noneAbove": "",
"hideLableText": 0,
"points": 0,
"columnElements": 0,
"scoreArray": {
"0": "1",
"1": "-1",
"max": "1"
},
"presentationTiled": 1,
"presentation": "tiles-horizontal",
"random": 0,
"randomizeOptions": true
}
}

Pobierz odpowiedzi

Pobranie listy odpowiedzi, pierwsze 100 wpisów.

GET https://api.surveylab.com/api/v2/surveys/:id/responses

cURL
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/responses

Przykład
GET https://api.surveylab.com/api/v2/surveys/21045/responses

Przykład wyniku zapytania

{
"responseId": 6923205,
"surveyId": 21045,
"iso3166": "PL",
"crk": null,
"promoCode": null,
"completed": 1,
"dateStart": "2019-01-03 13:26:34",
"dateCompleted": "2019-01-03 13:26:39",
"questionId": 194238,
"answer": [
0
],
"comment": "",
"score": null,
"matrixScore": null
},
{
"responseId": 6923207,
"surveyId": 21045,
"iso3166": "PL",
"crk": null,
"promoCode": null,
"completed": 1,
"dateStart": "2019-01-03 13:27:05",
"dateCompleted": "2019-01-03 13:27:08",
"questionId": 194238,
"answer": [
1
],
"comment": "",
"score": null,
"matrixScore": null
}

Pobierz odpowiedzi (100)

Pobranie listy odpowiedzi, kolejne 100 wpisów. Zmień numer strony (np. /page/3/), aby pobrać koejne 100 rekordów.

GET https://api.surveylab.com/api/v2/surveys/:id/page/2/responses

cURL
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/page/2/responses

Example
GET https://api.surveylab.com/api/v2/surveys/21045/page/2/responses

Result example

{
"responseId": 6923209,
"surveyId": 21045,
"iso3166": "PL",
"crk": null,
"promoCode": null,
"completed": 1,
"dateStart": "2019-01-03 13:27:11",
"dateCompleted": "2019-01-03 13:27:13",
"questionId": 194238,
"answer": [
0
],
"comment": "",
"score": null,
"matrixScore": null
},
{
"responseId": 6923229,
"surveyId": 21045,
"iso3166": "PL",
"crk": null,
"promoCode": null,
"completed": 1,
"dateStart": "2019-01-03 13:32:29",
"dateCompleted": "2019-01-03 13:32:31",
"questionId": 194238,
"answer": [
0
],
"comment": "",
"score": 1,
"matrixScore": null
}

Pobierz odpowiedź

Pobranie pojedynczej odpowiedzi dla wybranej ankiety. Możesz użyć zamiennie response-id lub crk.

GET https://api.surveylab.com/api/v2/surveys/:id/responses/:response-id

GET https://api.surveylab.com/api/v2/surveys/:id/crk/:crk

cURL
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/responses/:response-id

curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/crk/:crk

Example
GET http://api.surveylab.com/api/v2/surveys/27162/responses/7423534

GET http://api.surveylab.com/api/v2/surveys/27162/crk/AGVIDd43

Pobierz metadata

Pobieranie metadanych, takich jak system operacyjny, przeglądarka, język czy rodzaj urządzenia.

cURL
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/responses/:responseId/metadata/

Example
GET https://api.surveylab.com/api/v2/surveys/27162/responses/7423534/metadata/

Przykład wyniku zapytania

{
"responseId":8610691,
"ip":"127.0.0.1",
"referrer":null,
"iso3166":"PL",
"languageId":null,
"languageName":null,
"languageSymbol":null,
"deviceType":"desktop",
"deviceTypeName":"Desktop",
"os":"Ubuntu",
"browser":"Firefox 77.0"
}

Skontaktuj się z nami

Stale udoskonalamy nasze oprogramowanie oraz API. Jeśli masz pytania lub potrzeby dotyczące API skontaktuj się z nami.

UWAGI. REST oznacza REpresentational State Transfer. API oznacza Application Programming Interface. JSON oznacza JavaScript Object Notation. JWT oznacza JSON Web Token.

Funkcjonalność dostępna jest dla kont Enterprise.

Powiązane strony