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.9.Get Project Info

Get Project Info
Description Get detailed information of an existing project
Request URL Prodege Base URL + /project-get-info
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
prodege_project_id Numeric The ID that uniquely identifies the project in the Prodege system. Yes
Response Parameters
Parameter Name Parameter Type Description
return_status String The return status for this api call
project_info String JSON string that holds the project details

project_info Model

 

Property Name Property Type Description
prodege_project_id Numeric The id that uniquely identifies this project
project_id String Partner-provided identification for this project
project_name String The name of the project
project_type_id Numeric Project Type (Adhoc, Recontact, etc)
expected_ir Numeric Expected incidence rate %
loi Numeric Expected length of interview
cpi Numeric Cost per interview
current_avg_cpi Numeric The current average cost per interview
mobile_optimized Boolean Whether or not the survey is mobile compatible 
status String The current status of the project
project_url String The survey entry link for panelists
country_id Numeric The id that uniquely identifies the projects’ country
max_cpi Numeric The maximum allowable price per complete for the project (for use only when Real Time Pricing is enabled)
disabled_by_cpi_reality_check Boolean Appears only when project is paused due to CPI reaching max_cpi (Real Time Pricing) and when it appears, its value will be true
ir_based_cpi Numeric The CPI (greater than the max_cpi) that is required in order to resume sampling. Appears only when project is paused due to CPI reaching max_cpi (Real Time Pricing)
disabled_by_max_clicks Boolean Whether or not project is set to Paused due to reaching the specified max clicks.
disabled_by_sample_size Boolean Whether or not project is set to Paused due to reaching the specified project sample size.
auto_transition_paused Boolean Whether or not project is set to Paused due to inactivity.
auto_transition_complete Boolean Whether or not project is set to Complete due to inactivity.
drop_off_paused Boolean Whether or not project is set to Paused due to high drop off rate (> 60%).

 

« Project Multi-LinksGet Stats By Project »
Help Guide Powered by Documentor
Suggest Edit