List of operations for a resource

Name

URL

Description

Single sheets (v2)

/results/single-sheets

An operation that returns results in a correct JSON-schema.

Single sheets (v3)

/results/single-sheets

Access point https://www.webankieta.pl/api/v3

New version of the operation Raw results (JSON), which returns results in a correct JSON-schema. We recommend using this operation instead of the old version –

additionally, information is returned on how many records satisfy the request

Aggregated results

/results/aggregated/:id_survey

The operation returns the survey results in CSV format. The form of the response is identical to the form of the CSV file with aggregated results exported in the startquestion.com interface. A sample file with aggregated results can be downloaded here

Raw results

(legacy endpoint - we recommend using single-sheets)

/results/raw/:id_survey

The operation returns survey results in CSV format. The form of the response is identical to the form of the CSV file with raw results exported in the startquestion.com interface. A sample file with raw results can be downloaded here

Meta data (JSON)

/results/meta/:id_survey

The operation returns meta information about the collected survey results in JSON format. The response format is described below.


Single sheets (v2)

URL

(GET) https://www.startquestion.com/api/v2/results/single-sheets/:id_survey

Optional parameters (GET) (GET is optional in this operation as an exception)

Name

Description

id_response

ID of filling out the survey used when filling it out. It is not possible to provide the parameter if a token was provided at the same time.

token

The respondent token used to fill out the survey. It is not possible to provide the parameter if id_response was provided at the same time.

externalKey

External parameter tracking the respondent, assigned by the customer's system.

lowerResponseDate

The oldest possible date for filling out the survey. When using this parameter, only those filled out surveys will be returned that took place later than the provided date. The date must be specified in the YYYY-MM-DD format (e.g. 2011-11-20).

upperResponseDate

The youngest possible date for filling out the survey. When using this parameter, only those filled out surveys will be returned that took place earlier than the provided date. The date must be specified in the YYYY-MM-DD format (e.g. 2011-11-20).

unfinished

A parameter that determines whether unfinished (partially filled-out surveys) will also be included.

order

A parameter that determines whether the results will appear from the newest to the oldest, or vice versa. By default, the parameter is set to desc and the operation displays the results from the newest to the oldest filled out survey.

page

A parameter deciding which page will be displayed.

limit

A parameter deciding how many records will be displayed in one response. The maximum value of the parameter is 200. The default value is 10.

Sample response

{
{
"meta": {
"id": 89595094,
"startDate": "2021-05-26 11:01:01",
"endDate": "2021-05-26 11:07:14",
"email": "j.kowalski@webankieta.pl",
"token": "84CFd0",
"finished": true,
"externalKey": "",
"ip": "213.222.209.195",
"referer": "https://www.webankieta.pl/ankieta/token/id/424938/demo-single-sheets.html"
},
"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",
"leftPositionContent": "tekst po lewej",
"rightPositionContent": "tekst po prawej",
"answers": [
{
"id": 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": "j.kowalski@webankieta.pl"
},
{
"id": 5255778,
"content": "Data",
"answer": "2021-05-21 00:00:00"
}
]
}
}

Returned errors

  • 400 Bad request – Incorrect date format.

  • 401 Unauthorized – If the user refers to a foreign resource.

  • 404 Not Found – If no survey with the specified :id_survey was found.

  • 406 Not Acceptable – If no :id_survey parameter was provided.

  • 409 Conflict – Parameters :id_response and :token were provided at the same time.


Single sheets (v3)

Note!

The method in version v3 makes it possible to retrieve data with information about how many records there are after initiating this request. This makes it possible to easily manage division of the response into pages.

URL

(GET) https://www.startquestion.com/api/v3/results/single-sheets/:id_survey

Optional parameters (GET) (GET is optional in this operation as an exception)

Name

Description

id_response

ID of filling out the survey used when filling it out. It is not possible to provide the parameter if a token was provided at the same time.

token

The respondent token used to fill out the survey. It is not possible to provide the parameter if id_response was provided at the same time.

externalKey

External parameter tracking the respondent, assigned by the customer's system.

lowerResponseDate

The oldest possible date for filling out the survey. When using this parameter, only those filled out surveys will be returned that took place later than the provided date. The date must be specified in the YYYY-MM-DD format (e.g. 2011-11-20).

upperResponseDate

The youngest possible date for filling out the survey. When using this parameter, only those filled out surveys will be returned that took place earlier than the provided date. The date must be specified in the YYYY-MM-DD format (e.g. 2011-11-20).

unfinished

A parameter that determines whether unfinished (partially filled-out surveys) will also be included.

order

A parameter that determines whether the results will appear from the newest to the oldest, or vice versa. By default, the parameter is set to desc and the operation displays the results from the newest to the oldest filled out survey.

page

A parameter deciding which page will be displayed.

limit

A parameter deciding how many records will be displayed in one response. The maximum value of the parameter is 200. The default value is 10.

Sample response

{
"data":
{
"sheets": [
{
"meta": {
"id": 89595094,
"startDate": "2021-05-26 11:01:01",
"endDate": "2021-05-26 11:07:14",
"email": "j.kowalski@webankieta.pl",
"token": "84CFd0",
"finished": true,
"externalKey": "",
"ip": "213.222.209.195",
"referer": "https://www.webankieta.pl/ankieta/token/id/424938/demo-single-sheets.html"
},
"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",
"leftPositionContent": "tekst po lewej",
"rightPositionContent": "tekst po prawej",
"answers": [
{
"id": 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": "j.kowalski@webankieta.pl"
},
{
"id": 5255778,
"content": "Data",
"answer": "2021-05-21 00:00:00"
}
]
}
],
"totalCount": 1
}
}

Returned errors

  • 400 Bad request – Incorrect date format.

  • 401 Unauthorized – If the user refers to a foreign resource.

  • 404 Not Found – If no survey with the specified :id_survey was found.

  • 406 Not Acceptable – If no :id_survey parameter was provided.

  • 409 Conflict – Parameters :id_response and :token were provided at the same time.


Aggregated results

URL

(GET) https://www.statquestion.com/api/v2/results/aggregated/:id_survey

Optional parameters (POST)

Name

Description

id_response

ID of filling out the survey used when filling it out. It is not possible to provide the parameter if a token was provided at the same time.

token

The respondent token used to fill out the survey. It is not possible to provide the parameter if id_response was provided at the same time.

external_key

External parameter tracking the respondent, assigned by the customer's system.

sm_client_id

Customer identified from Sales Manago. Included in the filled out survey only when the account and the survey have integration with Sales Manago enabled.

lower_response_date

The oldest possible date for filling out the survey. When using this parameter, only those filled out surveys will be returned that took place later than the provided date. The date must be specified in the YYYY-MM-DD format (e.g. 2011-11-20).

upper_response_date

The youngest possible date for filling out the survey. When using this parameter, only those filled out surveys will be returned that took place earlier than the provided date. The date must be specified in the YYYY-MM-DD format (e.g. 2011-11-20).

Sample response

CSV goes here

Returned errors

  • 400 Bad request – Incorrect date format.

  • 401 Unauthorized – If the user refers to a foreign resource.

  • 404 Not Found – If no survey with the specified :id_survey was found.

  • 406 Not Acceptable – If no :id_survey parameter was provided.

  • 409 Conflict – Parameters :id_response and :token were provided at the same time.


Raw results

URL

(GET) https://www.startquestion.com/api/v2/results/raw/:id_survey

Optional parameters (POST)

Name

Description

id_response

ID of filling out the survey used when filling it out. It is not possible to provide the parameter if a token was provided at the same time.

token

The respondent token used to fill out the survey. It is not possible to provide the parameter if id_response was provided at the same time.

external_key

External parameter tracking the respondent, assigned by the customer's system.

lower_response_date

The oldest possible date for filling out the survey. When using this parameter, only those filled out surveys will be returned that took place later than the proviedd date. The date must be specified in the YYYY-MM-DD format (e.g. 2011-11-20).

upper_response_date

The youngest possible date for filling out the survey. When using this parameter, only those filled out surveys will be returned that took place earlier than the parovide date. The date must be specified in the YYYY-MM-DD format (e.g. 2011-11-20).

unfinished

A parameter that determines whether unfinished (partially filled-out surveys) will also be included.

Sample response

CSV goes here

Returned errors

  • 400 Bad request – Incorrect date format.

  • 401 Unauthorized – If the user refers to a foreign resource.

  • 404 Not Found – If no survey with the specified :id_survey was found.

  • 406 Not Acceptable – If no :id_survey parameter was provided.

  • 409 Conflict – Parameters :id_response and :token were provided at the same time.


Meta data regarding the collected results (JSON)

URL

(GET) https://www.startquestion.com/api/v2/results/meta/:id_survey

Optional parameters (POST)

Name

Description

id_response

ID of filling out the survey used when filling it out. It is not possible to provide the parameter if a token was provided at the same time.

token

The respondent token used to fill out the survey. It is not possible to provide the parameter if id_response was provided at the same time.

external_key

External parameter tracking the respondent, assigned by the customer's system.

lower_response_date

The oldest possible date for filling out the survey. When using this parameter, only those filled out surveys will be returned that took place later than the provided date. The date must be specified in the YYYY-MM-DD format (e.g. 2011-11-20).

upper_response_date

The youngest possible date for filling out the survey. When using this parameter, only those filled out surveys will be returned that took place earlier than the provided date. The date must be specified in the YYYY-MM-DD format (e.g. 2011-11-20).

unfinished

A parameter that determines whether unfinished (partially filled-out surveys) will also be included.

Sample response

[
{
"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
}
]

Returned errors

  • 400 Bad request – Incorrect date format.

  • 401 Unauthorized – If the user refers to a foreign resource.

  • 404 Not Found – If no survey with the specified :id_survey was found.

  • 406 Not Acceptable – If no :id_survey parameter was provided.

  • 409 Conflict – Parameters :id_response and :token were provided at the same time.

Did this answer your question?