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.5.2.Recontact by Transaction

Recontact by Transaction
Description Create (or update) the panel list of an existing recontact project using previously acquired panelist ids
Request URL Prodege Base URL + /recontact-by-transaction
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
prodege_project_id Numeric The ID that uniquely identifies this project in the Prodege system. Yes
transaction_recontacts array JSON array of transaction recontact entries for this project. 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
invalid_transaction_ids array List of transaction ids that were not successfully processed by the API

 

transaction_recontacts Elements Model         (see JSON Examples section for sample data)
Property Name Property Type Description
transaction_id Numeric The id that uniquely identifies a respondent on Prodege
survey_url String The entry link for this survey for the given panelist that is associated with the transaction_id. (url must have “%transid%” and “%panelistid%” placeholders in it)
invite_expiration DateTime The expiration date for this survey (in Unix UTC Timestamp, in milliseconds)

 

« Recontact by PanelistGet Recontact List »
Help Guide Powered by Documentor
Suggest Edit