...
Parameter | Data Type | Required | Description | Example |
|---|---|---|---|---|
respondentId | String | yes | Unique session ID | respondentId=TestSessionId |
memberId | String | yes | Persistent member ID | memberId=TestMemberId |
respondentLocalization | String | yes | respondent localization (reference) | en_US |
profile data | String | no | The information stored in your system related to the respondent profile. See “Passing in Demographics” | 211=111&212=111&229=90403 |
ipAddress | String | no | respondent IP address | ipAddress=187.112.108.180 |
userAgent | String | no | respondent user agent | userAgent=Mozilla%2F5.0%20(X11%3B%20Linux%20x86_64)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F126.0.0.0%20Safari%2F537.36 |
maxNumberOfSurveysReturned | Integer | no | Set the max number of surveys to return in the response, sorted by internal score (defaults to 12) | maxNumberOfSurveysReturned=10 |
hashed_id | String | no | Provide a hashed email ID to further deduplication efforts | hashed_id=f20f15cd0d600687ec66007f69adeb5ce4fa0d5a4335209d8ba6b5df01de379f |
| Code Block |
|---|
GET
https://fusionapi.spectrumsurveys.com/surveys/fusionMatch?memberId=TestMemberId&respondentId=TestSessionId&respondentLocalization=en_US&211=111&212=28&215=114&maxNumberOfSurveysReturned=10&ipAddress=187.112.108.180&userAgent=Mozilla%2F5.0%20(X11%3B%20Linux%20x86_64)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F126.0.0.0%20Safari%2F537.36&hashed_id=f20f15cd0d600687ec66007f69adeb5ce4fa0d5a4335209d8ba6b5df01de379f
Host: fusionapi.spectrumsurveys.com
access-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
...
| Info |
|---|
We will return a value “ir” which is the PureSpectrum after targeting Incidence (Conversion) Rate. This is either a measured statistic, or based off of a buyer’s prior performance in a country. |
...
Basic Workflow
Identify a user interested in taking a survey
Hit the API endpoint with that specific user's information (their member ID, unique session ID, profile data, etc.)
The URLs returned in the API response are specific to that user, therefore you can choose to send that user to one of the options
If the respondent enters our system via any one of the entry links returned, that API response should no longer be used and a new response should be generated should that respondent want to take another survey.
...
Best Practices
API Request Frequency - The expected frequency of API requests should correlate to the available respondents you have at a given time e.g. if there are 20 respondents interested in taking a survey, 20 requests (one for each respondent) should occur. Most partners average around 30 per minute. Note: our system allows a maximum of 300 requests per minute.
...
ipAddress and userAgent fields - To improve the identification of respondents' Research Defender (RD) device IDs, especially for new participants who have not previously been routed into Fusion, it is recommended to pass these values for all respondents. Providing these values, we can enhance the accuracy of deduplication and perform standard Research Defender checks more effectively. Note: in order for us to make this check, both fields are required to be passed in.
...
Self Service Setup
Setting up a Fusion account can be done in a matter of minutes if you have all of the required information. This section outlines what is needed to set up an account.
...