Create Link API

This API is used to create a supplier-specific link into a project. Note, that there is no routing with our Live Alert API. You can use this link for all users, just append all the mandatory parameters mentioned in the docs and any other information you have about each user, relevant to this project.

Command

"livealert/createLink/1"

Recommended Frequency

You will only need to do this once per survey.The entry link will never change for a survey.


Link Parameters

When you redirect a respondent to the link, you must append the following mandatory http parameters:

Name Value
rid Unique respondent ID, used to link datapoints from multiple sessions together.
country 2 character ISO country
postalCode

Australia, South Africa: 4 digits

US, Egypt, France, Germany, Indonesia, Italy, Malaysia, Mexico, Saudi Arabia, Spain, Thailand, Turkey: 5 digits

China, South Korea, Russia, Singapore, Vietnam: 6 digits

Brazil: 8 digits

Canada: AnAnAn

Argentina: AnnnnAAA

UK: AAnAnAA, AnAnAA, AnnAA, AnnnAA, AAnnAA, AAnnnA

Other: anything
gender

Male : "m", "M", or "1"

Female: "f", "F", or "2"
birthday Format: "yyyy-MM-dd"

Please also provide as many responses to the project's profile and screener questions as you have, in the format property=#, where # is the index of the selected answer. For multiple-selection, separate answers with commas. e.g. #,#,#

Do not include any responses for datapoints with type 13, these are derived from the postal code of the panelist.

Other responses that we calculate automatically are computerCheck, flashEnabled and javaEnabled. It is not necessary that you include those responses either.

You may also append your tracking ids. All parameters (excluding the above datapoints) will be echoed back to you in the redirect following the survey (see Section Additional Info for other parameters that you may receive). None of your tracking ids should be named "sesskey", "start", "end", "result" or "loi"; if it does, it will be ignored and it will not be echoed back to you.

If you use a link that you obtained when a project was active, but that project has now been paused or closed, the respondent will be termed and in the return URL we will add a status parameter whose value can be paused or closed (depending on the project status) so you can update your information.


Inputs

The following values are expected in the JSON body:

Name Type Required Description
command String

Must be "livealert/createLink/1"
rfg_id String

The identifier of the project.

Outputs

Name Type Description
link String

HTTP URL of direct link into project.

You will have to use the link to redirect respondents to a survey.
rfg_id String

The identifier of the survey.

Example Command

{
    "command": "livealert/createLink/1",  
    "rfg_id": "RFG605150-001"
}

Example Response

"response" : {"link" : "http://survey.saysoforgood.com/live/survey/539abc392146el17b0fd5d09?init=ydf1hiRPPiS135o1yBeyf8SuYcU%7B%22tropSource%22%3A%22539abc392146el17b0fd5d09%22%2C%22project%22%3A%2253e6y936e4b03db314rtg16e492%22%7D"}

Example url to use to redirect a respondent (taken from the link value received in the previous example). Note that the profile information is appended to the link:

http://survey.saysoforgood.com/live/survey/539abc393896el17b0fd5d09?init=ydf1hiRPPiS135o1yBeyf8SuYcU%7B%22tropSource%22%3A%22539abc392146el17b0fd5d09%22%2C%22project%22%3A%2253e6y936e4b03db314rtg16e492%22%7D&gender=M&country=US&postalCode=12345&birthday=1970-01-01&HH_Finance_DMs=1