1. Getting Started
Data Partner API
  • Data Partner API
    • Getting Started
      • Introduction to API
      • Become a Supplier
      • Authentication
      • Urls
      • Status Codes and Types
    • API Reference
      • Account
        • Get Supplier Details
        • Update redirect urls
        • Update S2S redirect urls
      • Surveys
        • Get Surveys
        • Get Survey Qualifications
        • Get Survey Quotas
        • Get Survey Stats
        • Get Survey Groups
        • Get ReContact Respondents
      • Collections
        • Languages
        • Industries
        • StudyTypes
        • SurveyStatuses
        • QualificationCategories
        • QualificationCategoryTypes
        • QualificationTypes
        • Qualifications
        • QualificationDetailById
    • Schemas
      • Survey
      • SupplierAccountResponse
      • SupplierSurveyResponse
      • Qualification
      • SurveyQualificationResponse
      • QuotaCondition
      • SurveyQuotaResponse
      • Quotas
      • SurveyStat
      • SurveyStatsResponse
      • SurveyGroup
      • SurveyGroupsResponse
      • ReContact Respondents
  1. Getting Started

Status Codes and Types

Respondent Status Codes#


High level respondent status codes which can be configured with the variable [%%status_id%%]
Respondent Status CodeDescription
1Complete
2Terminate
3Overquota
4Security Terminate

Industry Types#

The studies may belong to any of the following industries.
Industry IDIndustry
1Automotive
2Beauty/Cosmetics
3Beverages - Alcoholic
4Beverages - Non Alcoholic
5Education
6Electronics/Computer/Software
7Entertainment (Movies, Music, TV, etc)
8Fashion/Clothing
9Financial Services/Insurance
10Food/Snacks
11Gambling/Lottery
12Healthcare/Pharmaceuticals
13Home (Utilities, Appliances, ...)
14Home Entertainment
15Home Improvement/RealEstates/Construction
16IT (Servers, Databases, etc)
17Personal Care/Toiletries
18Pets
19Politics
20Publishing (Newspapers, magazines, Books)
21Restaurants
22Sports
23Telecommunications
24Tobacco
25Toys
26Transportation/Shipping
27Travel
28Video Games
29Websites/Internet/Ecommerce
30Other
31Sensitive Content
32Explicit Content
33Affluent
34BDM
35Builder
36Contractor (HVAC installer, General contractor, Electrician, Plumber)
37Developer
38Educator
39Financial DM
40Gamer
41Healthcare Admin
42HR
43Influencer / Content Creator
44Insurance
45ITDM
46Logistics / Supply Chain
47Physician
48Small Business Owner
49Law Firm / Lawyer

Study Types#

Each study can be categorised into the following types:
StudyTypeIDDescription
1Adhoc
2Consumer
3B2B
4Daily Tracker
5ReContact

ReContact Respondents Study#

Studies which require re contacting the respondnets which have already participated on the phase first phase of a study are refered to as ReContact respondents studies. The list of all the PIDs can be fetched for a specific Survey_ID. A dedicated endpoint Get ReContact Respondents returns the complete list of all the respondents to be re-contacted.
NOTE: Hitting the endpoint for the survey_id other than StudyTypeID: 5 will result in no records.

Encryption Types#

We support the following encryptions to ensure high security.
EncryptionTypeIDDescription
1HMACSHA256Hash
2HMACSHA256HashBASE64
3MACSHA1HashBASE64
4HMACSHA1Hash
Previous
Urls
Next
Account
Built with