Versions Compared

Key

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

...

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

...