Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In the Request of the API, you will specify the countrylocale, respondent demographics, session ID and member ID, and psid (if available). In the response, you will receive a list of full-match and/or partial-match surveys that for which the respondent qualifies for.

The surveys will include fully formed “Fusion Entry Links”, specifically tailored with the correct CPI and maxLOI to target these survey opportunities. If the respondent fails to qualify, they will be sent to other relevant opportunities.

...

The Fusion Match API is reserved for top performing publisher partners. To use the Fusion Match API, you will need to request an Access-Token from our Supply Team, and must qualify based on reputation and expected send.

...

HEADER Parameters

Parameter

Data

Type

Required

Description

Example

access-token

Header

string

yes

Yes

Token used to identify the authenticity of the

publisher requesting survey list

user.

"access-token": "$accessToken"

REQUEST Query String Parameters

Parameter

Data Type

Required

Description

Example

respondentId

Query

String

Parameter

yes

Unique

respondent

session ID

respondentId=

FusionTestSessionId

TestSessionId

memberId

Query

String

Parameter

no

yes

Persistent member ID

memberId=

FusionTestMemberId

TestMemberId

respondentLocalization

String

yes

respondent localization (reference)

en_US

profile data

Query

String

Parameter

no

The information stored in your system related to the respondent profile. See “Passing in Demographics”

211=111&212=111&229=90403

ipAddress

String

maxNumberOfSurveysReturned

Query String Parameter

no - defaults to 12

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=FusionTestMemberIdTestMemberId&respondentId=FusionTestSessionIdTestSessionId&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

...

Code Block
languagejson
{
"respondentId": "FusionTestSessionId",
"memberId":"FusionTestMemberRespondentId"
"surveys": [
    {
    "surveyId": 470381,
    "cpi": 1.35,
    "estimatedLoi": 1,
    "ir":47,
    "fullOrPartialMatch": "full",
    "entryLink":
    "https://fusion.spectrumsurveys.com//start-session/1US0135?maxLoi=4&sessiontok
    ensessiontoken=FusionTestSessionId&memberid=FusionTestMemberRespondentId&surveyId=470381"
    },
    {
    "surveyId": 450501,
    "cpi": 9.38,
    "estimatedLoi": 2,
    "ir": 33,
    "fullOrPartialMatch": "full",
    "entryLink":
    "https://fusion.spectrumsurveys.com//start-session/1US0938?maxLoi=5sessiontok
    en5sessiontoken=FusionTestSessionId&memberid=FusionTestMemberRespondentId&surveyId=450501"
    }
  ]
}
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

  1. Identify a user interested in taking a survey

  2. Hit the API endpoint with that specific user's information (their member ID, unique session ID, profile data, etc.) 

  3. 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.

memberId - Passing in a value for “memberId” in the Request Params is recommended as it allows us to retrieve the respondent profile if it exists in our system, and remove any attempted surveys from the response.

respondentId - Passing in a value for “respondentId” is a requirement so that we can properly generate an entry link to Fusion, however the value of this is determined on your end. If you would like to be able to track specific transactions on your end, you will want to ensure this value is unique before providing the entry link to the respondent.

One-time Entry Links - given the links in the API response are generated to provide a specific respondent an opportunity, they should be treated as a one-time use entry link.

Utilize S2S Postbacks - Given the payouts will likely be variable, it’s best to implement S2S postbacks to confirm the value of Completes as they occur in real time.

Passing in Profiling Demographics

...

- To maximize the quality of matches for a respondent, we recommend passing in as many demographic variables as possible. At a minimum, please refer to Fusion: Appending Qualifications InfoWe highly encourage passing in a memberId of the respondent in the Request Params. Doing so allows us to retrieve the respondent profile, and remove any attempted surveys from the response., we expect age, gender and zipcode. Please refer to Profiling - Appending Qualifications for further details.

Time Difference between API request and session start - The delay between the API request being made and the session beginning should be at a minimum (less than 5 seconds). The longer the delay between the API response providing the entry link and the respondent receiving the entry link to enter Fusion, the more likely the opportunity is to be no longer available for them.

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.

Info

In order to get started, you will need to get login credentials from the PureSpectrum team.

Portal Access

Once you have you credentials, you can begin setting up your account by logging into the portal.

https://fusionadmin.spectrumsurveys.com/dashboard/redirect-settings

Next Step

The rest of the documentation will take you through your account setup.

Userflow - Inbound and Outbound Parameters

Profiling - Appending Qualifications

Userflow - Respondent Redirects

Security - S2S Postbacks

Security - IP Whitelisting

Fusion Testing

Questions

If any questions come up during the account setup process, please reach out to globalsupply@purespectrum.com

...