All Versions

Version 1
Version 2


Page tree

Supplier API v1

There is a newer version of this API!

Skip to end of metadata
Go to start of metadata


Returns a prioritized list of the top n surveys for the specified user.

Table of Contents

Request

Request Headers

NameValueDescription
Acceptapplication/jsonExpected MIME type of the response body

URI Identifiers

NameTypeDescription
user-idstringYour ID for the user, provided to us when you created the user

Request Parameters

NameTypeRequiredDefaultDescription
topintegeroptional5Number of surveys requested. Fewer may be returned if there are not enough surveys available to the user to fulfill the full number requested.
ipAddressstringrecommendednoneIf supplied, the IP address will be used to run de-duplication checks against the surveys. This decreases the likelihood of being rejected from the survey.

Request Examples

import requests
import json

uri = https://supplier-api.cmix.com/api/v1/users/example/surveys?top=2&ipAddress=127.0.0.1
headers = {
    "Accept": "application/json",
}
response = requests.get(uri, headers=headers, json=payload)

Successful Response

Successful Response HTTP Status Codes

A successful response will have one of the following HTTP Status Codes:

HTTP Status CodeUsage
200: OKThe requested resource was found and returned in the response body

Successful Response Headers

NameValueDescription
Content-Typeapplication/jsonMIME type of the response body

Successful Response Body

The Response is an array of Qualified Surveys. If no surveys are found for the user, an empty array will be returned.

NameTypeDescription
namestringName of the survey, suitable for display to your member
urlstringEntry URL for the survey, specific to the specified user
anticipatedLoiintegerExpected length of interview in minutes
cpinumberAmount Critical Mix will pay to you for a completed interview
statusstring
ValueDescription
QUALIFIEDThe user meets all of our qualifying criteria based on known demos
PRESCREENINGThe user is not disqualified based on known demos. But, additional pre-screening demos are needed to determine qualification.
idintegerCritical Mix's survey identifier (a.k.a. Audience ID)

 

Successful Response Examples

HTTP/1.1 200 OK
 
[
    {
        "name": "A New Survey for You!",
        "url": "http://s.oneopinion.com/atc/src/000000JJCO6NGUTXR72XLNKV/000000BGPPJWFKDEEVI776H5?pid=user-id",
        "anticipatedLOI": 10,
        "cpi": 2.1,
        "status": "QUALIFIED",
        "id": 108828
    },
    {
        "name": "A New Survey for You!",
        "url": "http://qa-s.oneopinion.com/atc/src/000000JJCO6NGUTXR72XLNKV/000000WEJ4U97RC2NH2MWFFR?pid=user-id",
        "anticipatedLOI": 20,
        "cpi": 4.5,
        "status": "PRESCREENING",
        "id": 108814
    }
]


Error Response

Refer to the Error Responses section on the Getting Started page for more information about error responses, including details about the Headers and Body.


Error Response HTTP Status Codes

The following HTTP status codes will be used specific to this endpoint:

HTTP Status CodeUsage
404: Not FoundThe requested user was not found. Try again after adding the user via POST to /users/{user-id}

Error Response Examples

HTTP/1.1 404 Not Found
 
{
	"message": "User not found",
	"code": 2
}

Change Log

Version Date Comment
Current Version (v. 2) Jan 14, 2019 21:43 Kevin Lirot
v. 1 Sep 20, 2018 17:28 Kevin Lirot

 

Write a comment…