Name

URL

Description

Information about the user

/user

Detailed information about the logged in user identified by the parameters token and token_secret

Information about filled out surveys on the user account

/user/responses

The operation returns information about the last week's filled out surveys in all surveys on the user's account.

Description of response parameters

Name/path

Description

Possible values

id

User ID

email

Email address of the user

login_key

Md5 key used for logging in. The structure of the login link to the user panel is:https://www.webankieta.pl/logowanie/link/:login_key/:id,
where: login_key is the value of login_key parameters and id is the user ID.

registration_date

Date of account registration on the website

activation_date

Date of account activation on the website (registration confirmation)

expiration_date

Account validity date - for business and enterprise accounts

RRRR-MM-DD for business and enterprise accounts

type

Account type

biznes – business account
enterprise – enterprise account

company

Company name

street

Address

postal_code

Postal code

city

City

nip

VAT No.

surveys_count

Number of surveys in the account

id_response

Fill ID used for filling out multi-page questionnaires. Used in conjunction with the respondent_key

id_survey

Survey ID

token

A unique token that identifies the respondent. Used for one-time survey completion by the respondent. The parameter is active only with the highest level of survey security.

date_survey_open

Date and time when the survey was first opened. The parameter is active only with the highest level of survey security.

null – Survey was not opened by the respondent
2012-12-06 12:00:00 – Date and time when the survey was opened.

date_survey_answer

Date and time when the survey was filled out. The parameter is active only with the highest level of survey security.

null – Survey was not filled out by the respondent
2012-12-06 12:00:00 – Date and time when the survey was opened.

Information about the user

URL

(GET) https://www.startquestion.com/api/v2/user

Parameters

none

Sample response

{  
"email":"jan@kowalski.pl", "md5_password":"663964500831381fc657ce86690fb0c0", "login_key":"657ce86690fb0c0663964500831381fc", "registration_date":"2010-01-01 00:00:00",
"activation_date":"2010-01-01 01:00:00",
"expiration_date":"2012-01-01 00:00:00",
"type":"biznes",
"company":"Moja firma",
"street":"Ulica 99",
"postal-code":"00-00",
"city":
"Warszawa",
"nip":"000-000-00-00",
"surveys_count":"11"
}

Returned errors

None

Information about filled out surveys on the user account

URL

(GET) https://www.startquestion.com/api/v2/user/responses

Optional parameters (POST)

Name

Description

title

Survey title

date_survey_open

The minimum start date for completing the survey. The date must be provided in the YYYY-MM-DD format (e.g. 2011-11-20). After the parameter is provided, filled out surveys from that date and later days will be returned.

date_survey_open_upper

The maximum start date for completing the survey. The date must be provided in the YYYY-MM-DD format (e.g. 2011-11-20). After the parameter is provided, filled out surveys from that date and earlier days will be returned.

external_key

Value provided to the survey as the external_key parameter. This makes it possible to list all filled out surveys from a given source. More information regarding external_ey can be found here

sm_client_id

Value transferred to the survey if the integration with Sales Manago is enabled. Thanks to this, you can list all the filled out surveys for a given profile.

limit

Limit per number of records

offset

Offset for records

Sample response

[   
{
"id_response":123,
"id_survey":123,
"token":"2a5089",
"user_token":"ola1983",
"date_survey_open":"2012-12-06 12:00:00", "date_survey_answer":"2012-12-06 12:00:00"
}
]

Returned errors

None

Did this answer your question?