All Versions

Version 1
Version 2


Page tree

Supplier API v2

Skip to end of metadata
Go to start of metadata

List of respondents invited to take a specific survey.

Table of Contents

Version 1.0

Data Model

NameTypeDescription
_links_linksObject containing links to related resources
_metadata_metadataMetadata describing this resource
invitationListIdintegerID of this invitation list
indirectInvitationsarray of IndirectInvitationsArray of source targets whose participants are invited to participate in the survey to which this list is assigned. An empty array will be included if there are no indirect invitations.
directInvitationsarray of DirectInvitationsList of member IDs who have been explicitly invited. An empty array will be included if there are no direct invitations.

While technically possible, it is highly unlikely that an invitation list will contain both direct and indirect invitations.

Examples

This is an example of an invitation list with indirect invitations.

{
  "_links": {
    "self": {
      "href": "https://supplier.cmix.com/api/v2/invitations/102735",
      "class": "invitations",
      "identifier": 102735
    }
  },
  "_metadata": {
    "created": "2018-08-21T10:34:16Z",
    "lastModified": "2018-08-22T13:39:13Z",
  },
  "indirectInvitations": [
    {
      "sourceTargetId": 165437,
      "surveyStatuses" : "completes"
    },
    {
      "sourceTargetId": 165437,
      "surveyStatuses" : "all exposures"
    }
  ],
  "directInvitations": [ ]
}

 

This is an example with direct invitations.

{
  "_links": {
    "self": {
      "href": "https://supplier.cmix.com/api/v2/exclusions/104937",
      "class": "invitations",
      "identifier": 104937
    }
  },
  "_metadata": {
    "created": "2018-08-21T10:34:16Z",
    "lastModified": "2018-08-22T13:39:13Z",
  },
  "indirectInvitations": [ ]
  "directInvitations": [ 
    { "memberId": "dhw873ww2q9wweh" },
    { "memberId": "4754yrrdfhgde7e" },
    { "memberId": "dgegud2374h47ed" },
  ]
}

Links to related resources. Links are provided only in cases where the linked resource exists in the context of this target. 

NameTypeDescription
selfLink

Self-referencing link to the current object

Examples

{
  "self": {
    "href": "https://supplier.cmix.com/api/v2/invitations/102735",
    "class": "invitations",
    "identifier": 102735
  }
}

_metadata

NameTypeDescription
createddatetimeWhen this list was created
lastModifieddatetimeWhen the last modifications were made to this list

Examples

{
  "created": "2018-08-21T10:34:16Z",
  "lastModified": "2018-08-22T13:39:13Z",
}

IndirectInvitations

Indirect invitations are defined by the members who participated in other targets and had specific survey outcomes in those targets. The member list may be dynamic because the targets specified may still be in field. 

The statuses refer to the status within the survey. Anyone who disqualified during the pre-screening process is not a part of the invitation list.

NameTypeDescription
sourceTargetIdintegerThe ID of a source target whose participants are invited to participate in destination targets which subscribe to this list.
surveyStatusesenumeration
ValueDescription
completesOnly those who successfully completed the survey are invited to participate.
terms and over quotasOnly those who were terminated from the survey or were marked as over quota are invited.
all exposuresAnyone who was forwarded to the survey regardless of status, including drop-off, is invited.

Examples

{
  "sourceTargetId": 165437,
  "surveyStatuses" : "completes"
}

DirectInvitations

Direct invitations are a list of specific member ids who are explicitly excluded from this target.

Some of our surveys which use direct invitations have time sensitive subject matters. An example would be an ad effectiveness study which needs to be completed within two days of exposure to the ad. As such, the invitation may have an expiration date assigned. Once the expiration date has passed, the member will no longer be able to participate. However, sometimes the expiration date will be renewed, such as after an subsequent re-exposure to the advertisement.

NameTypeDescription
memberIdstringThe id of the invited member

Examples

{
  "memberId": "1002376"
}

 

  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.