Survey Exclusion Group

In order to not allow respondents who participated in a previous survey to access a new survey, you can create a survey group and then apply that group to the new survey.

Create a survey group

Use the Create exclusion group endpoint to create a survey group.

Second Step

Once a survey group has been created, it can be added to a survey either at survey creation time using the Create survey endpoint or after using the Update survey or Update survey attributes / properties endpoints.

The payload for the above endpoints needs to contain a new key buyer_surveygroup_ref and its value is the created survey group ID.

Example:

{
  "survey_title": "Sample Survey with survey groups",
  "survey_category_code": 231,
  "survey_localization": "en_US",
  "completes_required": 1000,
  "expected_ir": 60,
  "expected_loi": 60,
  "offer_price": 4.5,
  "live_url": "https://my.survey.com?survey_id=1234",
  "test_url": "https://my.survey.com?survey_id=1234&test=1",
  "field_time": 10,

  // If you need use only one survey group
  "buyer_surveygroup_ref": "cosmetics_project_123"
}

Once the survey has been created with the above exclusion group it will also be automatically added to the exclusion group list.

Example: You create a survey group with survey A and survey B. And you create a new survey C using buyer_surveygroup_ref including survey A and B. If you create another survey D using the same buyer_surveygroup_ref, then survey C will be also included on the buyer_surveygroup_ref.

The available endpoints for survey grouping can be found here: Survey group exclusions

We recommend that the exclusion group is added at survey creation.
You can't group a survey that had been created with incl_excl=1 (a recontact survey).

Apply multiple survey groups to a survey

To apply multiple survey groups to a single survey buyer_surveygroup_refs can be used to pass an array of survey groups IDs.

Example:

{
  "survey_title": "Sample Survey with survey groups",
  "survey_category_code": 231,
  "survey_localization": "en_US",
  "completes_required": 1000,
  "expected_ir": 60,
  "expected_loi": 60,
  "offer_price": 4.5,
  "live_url": "https://my.survey.com?survey_id=1234",
  "test_url": "https://my.survey.com?survey_id=1234&test=1",
  "field_time": 10,
  
  // If you need use more than one survey groups
  "buyer_surveygroup_refs": ["cosmetics_project_123", "cosmetics_project_1234"]
}

Remove one or more exclusion groups from survey

To remove one or more exclusion groups from a survey, follow the same steps as above and keep the values for buyer_surveygroup_ref and buyer_surveygroup_refs empty.

{
  "buyer_surveygroup_ref": "",
  "buyer_surveygroup_refs": []
}

For more information on exclusions, access the Advanced Filters - Exclusion & Feasibility page.

Respondents exclusions considerations

Survey Referencing Behavior

If survey B has on buyer_surveygroup_refs survey A, the user will be terminated on survey A on access even if A doesn't have any buyer_surveygroup_refs. If survey B does not have on buyer_surveygroup_refs surveys A but has survey C and D, user will not be terminated when answering the survey A.

Exclusion Period Hierarchy

If a survey is included in an exclusion group that has an exclusion period of 10 days, as an example, and in another that has 15 days than the higher period will be considered when our internal checks are run.

Apply multiple survey groups to a survey#

Remove one or more exclusion groups from survey#

Respondents exclusions considerations#

Survey Referencing Behavior#

Exclusion Period Hierarchy#

Apply multiple survey groups to a survey

Remove one or more exclusion groups from survey

Respondents exclusions considerations

Survey Referencing Behavior

Exclusion Period Hierarchy