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
    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. Project Transaction Calls
      1. Transaction Completion
      2. Transaction Reconciliation
      3. Create Project Transaction
      4. Lookup Transaction Status
      5. Lookup Multiple Transaction Statuses
  5. Test Project URL
  6. Webhooks
    1. Real Time Pricing
  7. Appendix
    1. JSON Examples
    2. Collecting User Data
    3. Real Time Pricing Overview
    4. Project Types
    5. Error Codes
    6. FAQ

4.2.1.Run Feasibility

Run Feasibility
Description Run a feasibility query on the Prodege panel
Request URL Prodege Base URL + /feasibility-run
Request Method POST

 

 

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
targeting_criteria  array JSON array of targeting criteria (see JSON Examples). Yes
country_id  Numeric The id that uniquely identifies the projects’ country (see Lookup All Supported Countries). Yes
expected_incidence_rate Numeric   Expected incidence rate %.  No
loi Numeric   The expected length of interview.  No
prodege_project_id Numeric  The ID that uniquely identifies the project in the Prodege system. This is an optional parameter that can be used in order to receive feasibility for a specific project.  No
Response Parameters
Parameter Name Parameter Type Description
return_status String The return status for this api call
completes_estimate Numeric Count of available respondents based on provided criteria
cpi Numeric The cost per complete determined from the provided incidence and loi (returned if loi and expected_incidence_rate are provided)

 

targeting_criteria Element Model    (see JSON Examples section for sample data)
Property Name Property Type Description
question_id Numeric Targeting Criterion identifier (based on the Questions Library)
operator String Possible values: OR, NOT, BETWEEN
 precodes array of option_id’s List of Targeting Criterion question options

 

« Feasibility CallsRun Feasibility by Project »
Help Guide Powered by Documentor
Suggest Edit