All Versions

Version 1
Version 2


Page tree

Versions Compared

Key

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

Table of Contents

hidden

Table of Contents

true

maxLevel

Member data 

2
excludeTable of Contents

Overview

Data that we have collected or that you have provided for your members.

Table of Contents

Table of Contents
maxLevel2
excludeTable of Contents

Version 1.0

Data Model

NameTypeGETPOSTPUTRequiredDescription
_links#_links(tick)(error)(error)(error)Object containing links to related resources
_metadata#_metadata(tick)(error)(error)(error)Metadata describing this resource
memberId
integer(tick)(tick)(error)(tick)The ID provided by you for this member
memberStatus
enumeration(tick)(error)(error)(error)


NameDescription
activeThe member is considered active and is allowed to participate in our surveys.
temporary usage restrictionThe member has hit a limit on the number of surveys allowed and is temporarily restricted from taking surveys. Refer to temporaryRestrictionExpires in the _metadata to see when the restriction will be lifted.
temporary quality restrictionThe member has failed a minor quality check and is temporarily restricted from taking surveys. Refer to temporaryRestrictionExpires in the _metadata to see when the restriction will be lifted.
bannedThe member has failed a major quality check and is permanently banned from participating in our surveys.


emailstring(tick)(tick)(tick)(error)

Member's email address

languageenumeration(tick)(tick)(tick)(tick)

Member's primary language. Refer to the list of valid language codes.

firstNamestring(tick)(tick)(tick)(error)

Member's first name

lastNamestring(tick)(tick)(tick)(error)

Member's last name

birthDatedate(tick)(tick)(tick)(tick)Member's full birth date.
addressaddressAddress(tick)(tick)(tick)(tick)Object containing the member's address information.

Examples

UI Tabs


UI Tab
titleJSON


No Format
{
  "_links": {
    "self": {
      "href": "https://supplier.cmix.com/api/v2/members/ID0001",
      "class": "members",
      "identifier": "ID0001"
    },
    "demographics": {
      "href": "https://supplier.cmix.com/api/v2/members/ID0001/demos",
      "class": "demos"
    }
  },
  "_metadata": {
    "created": "2019-01-08T10:37:02Z",
    "lastModified": "2019-01-08T10:38:58Z"
  },
  "memberId": "ID0001",
  "memberStatus": "active",
  "email": "id0001@example.com",
  "language": "EN",
  "firstName": "Kevin",
  "lastName": "Lirot",
  "birthDate": "1971-01-28",
  "address": {
    "country": "US",
    "streetAddress": "8600 S Wilkinson Way, Suite D",
    "city": "Perrysburg",
    "state": "OH",
    "postalcode": "43551",
    "zipPlus4": "9331",
    "zipDeliveryPoint": "86"
  }
}

 



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

valuesLinkLink to the acceptable response values for this demographic

Examples

UI Tabs


UI Tab
titleJSON


No Format
"self": {
  "href": "https://qa-supplier.cmix.com/api/v2/demographics/16",
  "class": "demographics",
  "identifier": 16
},
"values": {
  "href": "https://qa-supplier.cmix.com/api/v2/demographics/16/values",
  "class": "values"
}




_metadata

NameTypeDescription
createddatetimeWhen this member was created
lastModifieddatetimeWhen the last modifications were made to this member
temporaryRestrictionExpiresdatetimeBased on the member status, the date/time when this member will again be eligible to participate in our surveys.

Examples

UI Tabs


UI Tab
titleJSON


No Format
{
  "created": "2018-08-21T10:34:16Z",
  "lastModified": "2018-08-22T13:39:13Z",
  "temporaryRestrictionExpires": "2019-01-09T00:00:00Z"
}




Address

Typically we only collect country and postal code, and country is the only information required for every member. Note that we may run a validation on postal codes submitted, and may reject data that we deem invalid. 

Info

You may only submit country, postal code, and street address through this API. Any other address information shown may be derived by Critical Mix based on other information collected. We reserve the right to run additional validations and collect additional information about a member's address as required for specific targets. In the event that a project requires additional PII, it will be clearly indicated in the targetPii data element of the targetCriteria.


NameTypeGETPOSTPUTRequiredDescription
country
enumerationThis is the only part of the address that is required for all members. See Countries for the list of acceptable country codes.
streetAddress
enumerationcross (x)

This should only contain data that is typically contained in address lines 1 and 2, such as street name and direction, building number, apartment, suite, etc. It should NOT contain personal or business names, city, state, province, region, or postal code.

cityenumerationcross (x)cross (x)cross (x)

City, as determined by Critical Mix based on Postal Code. You cannot submit or update city information via the API. This data will only be populated if

statestringcross (x)cross (x)cross (x)

Member's first name

postalcodestringcross (x)

Member's last name

zipPlus4datecross (x)cross (x)cross (x)Member's full birth date.
zipDeliveryPointaddresscross (x)cross (x)cross (x)Object containing the member's address information.

Examples

UI Tabs


UI Tab
titleJSON


No Format
{
  "_links": {
    "self": {
      "href": "https://supplier.cmix.com/api/v2/members/ID0001",
      "class": "members",
      "identifier": "ID0001"
    },
    "demographics": {
      "href": "https://supplier.cmix.com/api/v2/members/ID0001/demos",
      "class": "demos"
    }
  },
  "_metadata": {
    "created": "2019-01-08T10:37:02Z",
    "lastModified": "2019-01-08T10:38:58Z"
  },
  "memberId": "ID0001",
  "memberStatus": "active",
  "email": "id0001@example.com",
  "language": "EN",
  "firstName": "Kevin",
  "lastName": "Lirot",
  "birthDate": "1971-01-28",
  "address": {
    "country": "US",
    "streetAddress": "8600 S Wilkinson Way, Suite D",
    "city": "Perrysburg",
    "state": "OH",
    "postalcode": "43551",
    "zipPlus4": "9331",
    "zipDeliveryPoint": "86"
  }
}

 



 

Excerpt
hiddentrue

Member data