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

6.1.Real Time Pricing

Partners may provide Prodege with a webhook URL that can be called when a project is Paused by Real Time Time pricing since the max CPI is reached or when a project is set back Live since the required CPI is now lower than the max CPI. The webhook will be called in as close to real time as possible.

 

Real Time Pricing Webhook Parameters – POST
Parameter Name Parameter Type Description
data Array Details related to the Real Time Pricing event. See data elements model and example below.
signature String The signature of your request (see Authentication).
data Model
Property Name Property Type Description
event_id String The id that uniquely identifies the event.
event_time String The timestamp of the event (Pacific Time).
max_cpi String The current Max CPI saved to the project.
current_cpi String The current CPI of the project.
avg_cpi String The average CPI of all existing completes.
required_cpi String The required (actual IR/LOI based) CPI of the project that must be accepted in order to resume the project.
project_id Numeric The id that uniquely identifies this project.
bid_ir Numeric The bid IR saved for the project.
actual_ir Numeric The lifetime actual IR for the project (so far).
bid_loi Numeric The bid LOI saved for the project.
actual_median_loi Numeric The lifetime median LOI for the project of all existing completes (so far).
project_status String The status of the project (e.g. LIVE, PAUSED).

data example:

{
"event_id":"63e174296722563b9cc28d96",
"event_time":"2023-02-06 13:42:01",
"max_cpi":"36",
"current_cpi":"30",
"avg_cpi":"1",
"required_cpi":"90",
"project_id":27293192,
"bid_ir":50,
"actual_ir":5,
"bid_loi":1,
"actual_median_loi":1,
"project_status":"PAUSED"
}

Expected Response

For this webhook, returning a success response (200) will indicate that the webhook has been received successfully. Returning a failure response (e.g. 500) will indicate that the webhook was not successfully received and the webhook will be tried again 3 more times: after 2 seconds, then 4 seconds, then 8 seconds.

« WebhooksAppendix »
Help Guide Powered by Documentor
Suggest Edit