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.10.Get Stats By Project

Get Stats By Project
Description Get the current stats (number of clicks, completes, fails, etc) of an existing project
Request URL Prodege Base URL + /project-stats-by-id
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 String 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
prodege_project_id Numeric The id that uniquely identifies this project
project_name String The name of the project
status String The current status of the project
project_url String The redirect URL of the project
loi Numeric The given length of interview for the project
cpi Numeric Only when automated pricing is enabled
lifetime_stats String  JSON container for lifetime stats
daily_stats String JSON container for daily stats 

 

lifetime_stats Model
Property Name Property Type Description
survey_entries Numeric The number of clicks this project has received
completes Numeric The number of completes this project has received
billable_completes Numeric The number of billable completes (including reconciliations) this project has received 
fails Numeric The number of terminates this project has received
overquotas Numeric  The number of overquotas this project has received
current_ir Numeric The calculated incidence rate of this project
median_loi Numeric The calculated median length of interview (completes) of this project 

 

last_24hr_stats, last_12hr_stats, last_6hr_stats, last_1hr_stats Models
Property Name Property Type Description
entries Numeric The number of clicks this project has received in the last 24 hours
completes Numeric The number of completes this project has received in the last 24 hours
dqs Numeric The number of terminates this project has received in the last 24 hours
oqs Numeric  The number of overquotas this project has received in the last 24 hours
ir Numeric The calculated incidence rate of this project in the last 24 hours
loi Numeric The calculated median length of interview (completes) of this project in the last 24 hours 

 

« Get Project InfoGet Quotas By Project »
Help Guide Powered by Documentor
Suggest Edit