Data Partner API
  1. API Reference
Data Partner API
  • Data Partner API
    • Getting Started
      • Introduction to API
      • Become a Supplier
      • Authentication
      • Urls
    • 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
      • Collections
        • Languages
        • Industries
        • StudyTypes
        • SurveyStatuses
        • QualificationCategories
        • QualificationCategoryTypes
        • QualificationTypes
        • Qualifications
        • QualificationDetailById
    • Schemas
      • Survey
      • SupplierAccountResponse
      • SupplierSurveyResponse
      • Qualification
      • SurveyQualificationResponse
      • QuotaCondition
      • SurveyQuotaResponse
      • Quotas
      • SurveyStat
      • SurveyStatsResponse
      • SurveyGroup
      • SurveyGroupsResponse
  1. API Reference

Surveys

Surveys#

Overview#

Allocated Surveys endpoint allows buyers to allocate specific portions of studies to suppliers. This resource provides you with information about the allocation you have been given for a study, based on your supplier code(Api Key). Refer to the Get Surveys endpoint to fetch the allocated surveys in real time.
⚠️ Deprecation Notice – Pricing & Survey Metrics
To improve data consistency and enable accurate calculations, the following properties have been deprecated and replaced with new standardized fields:
Deprecated PropertyType (Old)Replacement PropertyType (New)Notes
CPIstringRevenuenumber (float)Use Revenue for all pricing calculations
IRstringIncidentRatenumberRepresents incidence rate as a numeric value
LOIstringLengthOfInterviewnumberLength of interview in minutes
🔹 Important Notes
Deprecated fields are still returned for backward compatibility.
New fields use proper numeric types (number / float) and should be used for all new integrations.
Deprecated fields will be removed in a future API version.

Survey Qualifications#

Survey Qualifications are the targetting needed to qualify the survey participation criteria. Refer to the Get Survey Qualifications endpoint to fetch the survey qualifications in real time.

Survey Quotas#

Survey Quotas refers to the total number of samples from different set of qualifications on a survey. Refer to the Get Survey Quotas endpoint to fetch the survey quotas in real time.

Survey Stats#

Survey Stats refers to real time survey metrics. Survey metrics such as conversion, epc, dropout rate etc. Refer to the Get Survey Stats endpoint to fetch the survey stats in real time.
Previous
Update S2S redirect urls
Next
Get Surveys
Built with