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.3.1.Create Project

Create Project
Description Submit a new project for the Prodege Panel
Request URL Prodege Base URL + /project-create
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
project_id String The ID that uniquely identifies this project in your system. Yes
reference_id String Your PO Number. No
project_type_id Numeric The type that classifies this project (e.g. Adhoc, Recontact). See Project Types for details. Yes
project_name String The descriptive name for this project. No
sample_size Numeric The total number of completes requested for this project. No
loi Numeric The expected length of interview for this project. Yes
expected_ir Numeric Expected incidence rate %. Yes
country_id Numeric The id that uniquely identifies the projects’ country (see Lookup All Supported Countries). Yes 
project_url String The survey entry link for panelists. A %transid% placeholder is required in your survey link for appropriate tracking and redirection from your survey. Only when project type is Adhoc
estimated_start String (ff format: MM/DD/YYYY) The estimated date that the project will start fielding. Note: this is just for informational purposes and will not automatically start/stop sampling.  No
estimated_end String (ff format: MM/DD/YYYY) The estimated date that the project will end fielding. Note: this is just for informational purposes and will not automatically start/stop sampling.  No
cpi Numeric  Cost per completed interview. No (Required if Real Time Pricing is not enabled)
mobile_optimized String Whether or not the project is optimized for mobile devices. Either “true” or “false”, true by default. No
allow_multi_entries String Allow multiple entries for the same panelist until a status (e.g. Success, DQ, OQ) is reached. Either “true” or “false”, false by default. No
buyer_name String The name of the buyer purchasing survey completes. No
max_cpi Numeric The maximum allowable price per complete for the project (for use only when Real Time Pricing is enabled). No
notes String Optional notes about the project. No
Response Parameters
Parameter Name Parameter Type Description
return_status String The return status for this api call
prodege_project_id Numeric The id that uniquely identifies this project
cpi Numeric The current price per complete for the project
« Project CallsUpdate Project »
Help Guide Powered by Documentor
Suggest Edit