Inbound

Inbound

The Inbound is the entry URL used to send a respondent into an opportunity. It must include all required query-parameters.

Security

The entry URL must be signed using the Dynata signing algorithm.

Query Parameters

Required

parameter	description
ctx	A Respondent Gateway context identifier.
respondent_id	A unique identifier for the respondent. typically the partner’s own internal identifier for the respondent.
language	Two character language ISO code, lowercase.
expiration	RFC3339 timestamp indicating request expiration.
access_key	Dynata assigned access key.
signature	String created using the Dynata signing methodology.

Optional

parameter	description
gender	Accepts a value of either male or female.
postal_code	Accepts any postal code value. if omitted, the respondent will not qualify for any studies having geo-based targeting.
birth_date	A formatted date string representing the respondent’s date of birth - format: YYYY-MM-DD.
attributes	A URL encoded JSON string of the same attributes structure used in the /put-respondent input payload - example: attributes=[{"id":115,"answers":[45364]}].
source	A sub-source identifier. mainly used by supplier aggregators/marketplaces.

Useful Tip

Any extraneous query parameters (i.e., parameters not listed above as required or optional) passed in the inbound URL will be preserved and included in the callback parameters object, as well as appended onto the redirect URL when the respondent is sent back to the partner. This is useful when the partner wishes to supply a unique identifier or tracking token for the respondent session.

Be Aware

The gateway does not support repeated query parameters of the same name within a URL.

Prescreening & Refinement

If birth_date, gender, or postal_code were not previously passed for the respondent, Dynata will prescreen for these properties.

Dynata will also prescreen for certain attributes when an opportunity requires it for targeting.