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.3.6.Get Project Settings

Get Project Info
Description Get detailed information of an existing project
Request URL Prodege Base URL + /project-settings-get
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 (*Currently only for failed requests)
project_settings String JSON string that holds the current settings for the project
projects String JSON array that holds the current past participation inclusions or exclusions, if any are configured.

project_settings Model

Property Name Property Type Description
enable_max_clicks Boolean Whether or not max click logic is enforced
enable_max_clicks_cap Numeric If max click logic is enforced, the user-specified number of clicks allowed before pausing project traffic
enable_max_clicks_allowed_clicks Numeric If max click logic is enforced, the current remaining number of clicks before pausing project traffic
enable_max_clicks_max_click_rate_id Numeric If max click logic is enforced, the refill rate id for clicks (1: every 30 min, 2: every 1 hour, 3: every 24 hours, 0: one-time setting)
enable_quality_screener Boolean Whether or not quality screener is enforced
require_rvid Boolean Whether or not relevant id checking is enforced
limit_panelists JSON Panelist-specific filter settings

projects Model

Property Name Property Type Description
participation_status Numeric The types of transactions for the included/excluded prodege_project_ids that are included in the inclusion/exclusion.

Possible values are 1 for click, 2 for complete, 4 for DQ, 8 for OQ (bit values are added together).
surveys Array The list of projects being included or excluded.
participation_filter_type Numeric The filter type, either inclusion or exclusion. 1 for inclusion or 2 for exclusion.
« Project Settings - UpdateUpdate CPI »
Help Guide Powered by Documentor
Suggest Edit