Create Survey User Profile

Market Research API Parameters

API parameters pubID, profileID, and api_key can be found on the Integration page. The link is located next to your profile at Your Market Research Profiles.

If you would like us to notify you whenever an offer is completed (lead generated), set up a server postback.

Create Survey User Profile

Allows you to create a user profile which can then be used to pull qualified surveys for a user.

  • Request must be made securely over SSL (HTTPS).
  • You must set the Content-Type header to 'application/json'.
  • The parameters below must be passed in the request body as a JSON string

Client vs. Server-side Usage

When the Create Survey User Profile call is made by the end-user's client, such as with javascript, the values for the ip, platform_type, and browser_family parameters will be determined automatically by our server which detects the user's IP address and determines the other values from the end-user's user-agent string. If instead you make this call from your server on behalf of a user then you must pass in the user's IP, platform_type, and browser family. Otherwise, your users' profiles will appear to have the same IP address & user-agent (your server's) which would result in them getting flagged for fraud.

Response Codes

Response 400 when validation failed.

Response 409 when user profile already exists for the provided pubId profileId subId1 or provided email is already associated with existing user profile.

POST:

https://adscendmedia.com/market-research/api/publisher/{pubId}/profile/{profileId}/user/{subid1}.json

Example JSON Body Request:

{
  "api_key" : "API_KEY_HERE",
  "first_name": "MyName",
  "last_name": "LastName",
  "address1": "123 Oak St",
  "address2": "Apt 22",
  "email": "myemail@example.com",
  "gender": "m",
  "dob": "1990-08-27",
  "city": "Austin",
  "state": "TX",
  "country": "US",
  "zip": "78701-0233", // Or 78701
  "target_system_selected": [51, 52],
  "answers": {
    "1": [1],
    "2": [11],
    "3": [19],
    "4": [31],
    "5": [32],
    "6": [61],
    "7": [88],
    "8": [89, 90],
    "9": [109],
    "11": [112]
  }
}
Parameters   Description Type
api_key Required Your Market Research Profile's API Key. It can be found on the integration page of Your Market Research Profile String
pubId Required Your publisher ID Number
profileId Required Your Market Research profile ID Number
subid1 Required Your user's primary unique identifier. Maximum length of 60. String
email Required Email of user. Maximum length of 80. It should be valid email address. Example: test@example.com String
first_name Required First Name of user. Maximum length of 40. String
last_name Required Last Name of user. Maximum length of 40. String
gender Required Possible values "m" or "f" String
target_system_selected Required Array of ID's of selected target devices. 51 = iPhone, 52 = iPad, 40 = Android Phone or Tablet, None of the Above Example: [40, 52] Array
dob Required Date of birth. Format: YYYY-MM-DD Example: 2015-07-22 String
address1 Required Address line 1. Maximum length of 70. String
address2 Optional Address line 2. Maximum length of 70. String
city Required Name of city. Maximum length of 50. String
state Required Name of state. Maximum length of 50. String
country Required Name of country. Use 2 letter country code; see options: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 Example: US String
zip Required The field may have alpha-numeric characters, as well as dashes and underscores. Maximum length of 10. String
answers Required The parameter contains an object of question ids and their answers option ids. Refer following table for question and answer id references. Example: answers: {1: "4", 2: "9", 3: "17", 4: "30", 5: "32", 6: "44", 7: "87", 8: ["89"], 9: "99", 11: "112"} Object
ip Optional The IP address of the user.   Required when making the call server-side String
platform_type Optional You can also filter the items by sending the parameter platform_type. This parameter can have one value out of - 'android_phone', 'android_tablet', 'android_kindle', 'ios_phone', 'ios_ipod', 'ios_tablet' and 'desktop'.   Required when making the call server-side String
browser_family Optional This parameter filters the items by allowed browsers. It can have one value out of - 'safari', 'chrome', 'firefox', 'ie', 'opera'.   Required when making the call server-side String
Questions(ID/question)   Answers(ID/answer) Question Type
1 What is your Marital Status? Required Possible values for answer(ID/ text):
1/ Single
2/ Married
3/ Divorced
4/ Widowed
5/ Engaged
Example: If answer is "single" then answers object: {1: "1"}
Radio
2 What is the highest level of education you have completed? Required Possible values for answer(ID/ text):
6/ 8th Grade or below
7/ 9th Grade to 11th Grade
8/ High School Graduate
9/ Some College
10/ Associate's Degree
11/ Bachelor's Degree
12/ Some postgraduate study
13/ Masters Degree
14/ Doctorate / PhD
15/ Trade School
16/ None of the above
Example: If answer is "Some College" then answers object: {2: "9"}
Select
3 What classification best describes your total pre-tax household income? Required Possible values for answer(ID/ text):
17/ Under $10,000
18/ $20,000 - $29,999
19/ $20,000 - $29,999
20/ $30,000 - $39,999
21/ $40,000 - $49,999
22/ $50,000 - $74,999
23/ $75,000 - $99,999
24/ $100,000 - $124,999
25/ $125,000 - $149,999
26/ $150,000 - $174,999
27/ $175,000 - $199,999
28/ More than $200,000
29/ Prefer not to state
Example: If answer is "Under $10,000" then answers object: {3: "17"}
Select
4 Do you own or rent your place of residence? Required Possible values for answer(ID/ text):
30/ Own
31/ Rent
Example: If answer is "Own" then answers object: {4: "30"}
Radio
5 What is your current employment status? Required Possible values for answer(ID/ text):
32/ Employed full-time
33/ Employed part-time
34/ Self employed
35/ Temporarily unemployed
36/ Student
37/ Homemaker
38/ Retired
39/ Disabled or Permanently Unemployed
Example: If answer is "Employed full-time" then answers object: {5: "32"}
Select
6 Which of the following best describes your primary occupation? Required Possible values for answer(ID/ text):
40/ Hair Stylists
41/ Photographers
42/ Property/Facilities Managers
43/ Bartenders/Servers
44/ Chefs/Cooks
45/ Event Planners
46/ Accountant/CPA/Bookkeeper
47/ Administrator/Clerical
48/ Advertising
49/ Attorney
50/ Civil Servant/Government/Military
51/ Consultant/Adviser/Analyst
52/ Customer Support
53/ Designer/Artist
54/ Doctor / Physician
55/ Engineer (Electrical, Mechanical or Aerospace)
56/ Entertainer (musician, actor, performer, model, DJ)
57/ Financial Professional (Broker, Analyst, Planner)
58/ Human Resources
59/ Information Systems Manager (MIS)
60/ Insurance Agent
61/ Janitor
62/ Marketing
63/ Mechanic (Automobile, Motorcycle, Airplane, Marine, Heavy Equipment)
64/ Programmer/Software Developer
65/ Public Relations
66/ Registered Nurse
67/ Retail (Sales & Management)
68/ Sales/Business Development
69/ Skilled Labor - Plumber
70/ Skilled Labor - Electrician
71/ Skilled Labor - Carpenter
72/ Skilled labor - HVAC
73/ Skilled labor - General
74/ Teacher/educator - Grades K-8
75/ Teacher/educator - High School Level
76/ Teacher/educator - University Level
77/ Technician (home appliance, electronics)
78/ Top Management (CEO, CFO, partner, etc.)
79/ Veterinarian
80/ Warehouse/Logistics
81/ Web Developer
82/ Writer/Reporter/Editor
83/ Other
84/ Disabled
85/ Retired
86/ Does Not Apply
Example: If answer is "Hair Stylists" then answers object: {4: "40"}
Select
7 Do you consider yourself Hispanic/Latino or of Hispanic/Latino descent? Required Possible values for answer(ID/ text):
87/ Yes
88/ No
Example: If answer is "Yes" then answers object: {7: "87"}
Radio
8 What kind of pets do you own? Select multiple options Optional Possible values for answer(ID/ text):
89/ Dog
90/ Cat
91/ Reptile
92/ Rodent
93/ Bird
94/ Fish (fresh water)
95/ Fish (salt water)
96/ Other
96/ None
Example: If answer is "Dog" and "Cat" then answers object: {8: ["89", "90"]}
Multiple choice
9 How many children 18 years old or younger live in your home? Required Possible values for answer(ID/ text):
109/ None
98/ 1
99/ 2
100/ 3
101/ 4
102/ 5
103/ 6
104/ 7
105/ 8
106/ 9
107/ 10
108/ 10+
Example: If answer is "3" then answers object: {9: "100"}
Select
11 Which of the following best describes your ethnic background? Required Possible values for answer(ID/ text):
112/ White
113/ Black or African American
114/ Hispanic, Latino, or Spanish origin
115/ American Indian or Alaska Native
116/ Asian Indian
117/ Chinese
118/ Filipino
119/ Japanese
120/ Korean
121/ Vietnamese
122/ Pacific Islander
123/ Middle Eastern
124/ Other Asian
125/ Other
126/ Prefer not to answer
Example: If answer is "White" then answers object: {11: "112"}
Select

Response 201

Content-Type: application/json

{"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.ayJzdWIiOjI2MTIzNzgsImVtYWlsIjoiemVjaKhfMV8yXzU2QG5vLmNvbSIsInJhbmRvbVN0cmluZyI6IlNJSnhIIn0.QoK9WBotun6DCWHkjZZdoI3AeFZfS5_yAzKjIW8ofh4"}