Attributes
Attributes
Dynata uses attributes as the building blocks for a respondent’s profile. Clients use these same attributes to target respondents for their studies. Partners leverage filter, quota, and cell definitions in the Opportunity Registry to match their respondents to an opportunity.
Attributes are the core of matching respondents to the client studies. Conversion is dependent on the completeness of a respondent’s profile and accuracy of the opportunity targeting. This can be achieved via 3 steps – mapping, profiling, and targeting.
Mapping
To map Dynata attributes
to a partner’s system, use the Respondent Gateway list-attributes and get-attribute-info endpoints.
Best Practices
The list-attributes endpoint returns the top 500
attributes
sorted by client usage.
- Map
attributes
using the list-attributes and get-attribute-info endpoints. First, focus onattributes
that correlate with the partner’s system. - Partners must use the list-attributes endpoint in the production environment to complete the
attributes
mapping. The results in the sandbox environment are sorted arbitrarily and may contain discrepancies. - Continuously map frequently occurring targeting
attributes
using the get-attribute-info endpoint.
Profiling
After mapping the Dynata attributes
, respondents can be created and updated using the Respondent Gateway put-respondent and put-respondent-answers endpoints. Learn more about respondent profiling here.
Inbound
Respondents can be created and updated upon entry through the Inbound URL.
Targeting
Targeting involves matching respondents to qualifying opportunities from the Opportunity Registry.
Using the attribute mapping to interpret cells and create the opportunity targeting criteria. Then matching respondents with opportunities and sending them in through the Respondent Gateway using the survey flow.
Learn more about Opportunity Targeting.
Attribute Properties
The basic properties for attributes are name, description, question, and answers.
property | description |
---|---|
name | Dynata attribute name. |
description | Describes the attribute. |
display mode | Question input type and rendering. |
parent dependencies | Prerequisite questions and answers. |
expiration duration | Length of time before the attribute will need to be asked again. |
is active | Designate if the attribute is in use. |
countries | Supported countries. |
question | Question info and translations. |
answers | Answer info and translations. |
Restricted Attributes
Some
attributes
returned from the list-attributes endpoint are restricted. Restrictedattributes
definitions are not exposed to partners. It’s possible for afilter or quota cell
to use a restricted attribute. Partners can choose to ignoreopportunities
that contain a restricted attribute.
Display Mode
The attribute display mode
represents how a question should be rendered if presented to a respondent.
display mode | description |
---|---|
single_select , single_select_searchable | Accepts only one answer per question. Single selection input (radio buttons). |
multi_select , multi_select_searchable | Accepts one or more answers per question. Multiple selection input (checkboxes). |
single_select_grid | Accepts only one answer per question, radio buttons in a row; rating scale |
multi_select_grid | Accepts one or more answers per question. Checkboxes in a row; multiple_choice_matrix. |
none , geo , zip | Derived attribute; not rendered to respondents. |
Important
Do not use put-respondent or put-respondent-answers with attributes that have a
display_mode
ofnone
,geo
, orzip
. These attributes are auto generated based on a respondent’s attributes.
Parent Dependencies
The parent_dependencies
are the prerequisite questions and answers required to update an attribute. The dependency can be for attribute as a whole, and can depend on certain attribute answers. It’s possible for an attribute to have multiple parent dependencies requirements.
Missing Dependencies
If the respondent is missing the
parent_dependencies
, updating theattribute
will fail.
Countries
The countries
property lists all countries where the attribute
is supported. Each country can support a different set of attribute questions and answers.
Recommended
Partners should map attributes individually by country in order to account for potential differences.
Question & Answers
The question
and answers
contain the translations for each supported country and language.
The answers
contains the id
, supported countries
, and translations
for each individual answer.