API Documentation

  1. Overview
  2. Getting Started
  3. Authentication
    1. Request Expiration
    2. Request Signing
    3. IP Whitelisting
    4. Link Signing
  4. API Reference
    1. Lookup Calls
      1. Lookup Request Time Offset
      2. Lookup All Supported Countries
      3. Lookup Questions By CountryID
      4. Lookup Postal Code Questions By CountryID
      5. Lookup Languages
    2. Feasibility Calls
      1. Run Feasibility
      2. Run Feasibility by Project
    3. Project Calls
      1. Create Project
      2. Update Project
      3. Delete Project
      4. Duplicate Project
      5. Project Settings - Update
      6. Get Project Settings
      7. Update CPI
      8. Project Multi-Links
      9. Get Project Info
      10. Get Stats By Project
      11. Get Quotas By Project
      12. Get Project List
      13. Update Aggregate Stats by Project
    4. Quota Calls
      1. Create Quota
      2. Update Quota
      3. Delete Quota
    5. Recontact Calls
      1. Recontact by Panelist
      2. Recontact by Transaction
      3. Get Recontact List
      4. Remove Recontact Entries
    6. Completion Calls
      1. Transaction Completion (Redirect)
      2. Register Completion (S2S)
    7. Project Transaction Calls
      1. Transaction Reconciliation
      2. Create Project Transaction
      3. Lookup Transaction Status
      4. Lookup Multiple Transaction Statuses
  5. Test Project URL
  6. Webhooks
    1. Real Time Pricing
    2. Project Status Update
  7. Appendix
    1. JSON Examples
    2. Collecting User Data
    3. Real Time Pricing Overview
    4. Project Types
    5. Error Codes
    6. FAQ

4.1.3.Lookup Questions By CountryID

Lookup All Supported Countries
Description Fetch a list of Prodege qualification questions available for a specific supported country
Request URL Prodege Base URL + /lookup-question-by-country
Request Method GET

 

 

Request Parameters
Parameter Name Parameter Type Description Required?
apik String Your API Key. Yes
request_date Numeric Timestamp in milliseconds (see Authentication). Yes
signature String The signature of your request (see Authentication). Yes
country_id Numeric The id that uniquely identifies the projects’ country (see Lookup All Supported Countries). Yes
group_by_category Boolean Questions are grouped into categories when set to true. Default is false. No
prodege_project_id Numeric If included, project-specific custom criteria will also be returned. No
Response Parameters
Parameter Name Parameter Type Description
return_status String The return status for this api call
questions array An array of Question model instances described below

 

questions Element Model
Property Name Property Type Description
question_id Numeric The id that uniquely identifies this question
question_type String The type this question belongs to (e.g. Single-Punch, Open-Ended Numeric, etc.)
question_name  String  A descriptive name for this question (e.g. GENDER, ETHNICITY, etc.) 
question_text  String  The text that is associated with this question (e.g. What is your gender?)
supports_time_period  Boolean  Whether or not a question supports time period targeting
 options  array List of possible options associated with this question 

 

options Element Model
Property Name Property Type Description
option_id Numeric The id that uniquely identifies this option
option_text String The text that is associated with this option (e.g. Male, Female)

 

« Lookup All Supported CountriesLookup Postal Code Questions By CountryID »
Help Guide Powered by Documentor
Suggest Edit