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. 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.6.2.Register Completion (S2S)

Register Completion
Description When called, it notifies Prodege that a panelist has finished a project, either successfully (Complete) or unsuccessfully (DQ or OQ). This synchronous server-to-server call confirms the final recorded completion status and provides the final redirect URL for the panelist.

The endpoint’s response is idempotent: only the first call will record the completion, while subsequent calls will return the transaction details without altering the recorded data.

This endpoint serves as a server-to-server alternative to the Transaction Completion client-side redirect for recording completions.
Request URL Prodege Base URL + /prodegemr/register-completion
Request Method POST
Request Parameters
Parameter Name Parameter Type Description Required?
apik String Your API Key. Yes
signature String The signature of your request (see Authentication). Yes
request_date Numeric Timestamp in milliseconds (see Authentication). Yes
transaction_id Numeric Transaction ID Yes
completion_type Numeric The status of the transaction. Set to 1 for Success, 2 for Overquota, 3 for Disqualification, 7 for Quality Termination. Yes
Response Parameters
Parameter Name Parameter Type Description
return_status String The return status for this api call
redirect_url String The final redirect where the panelist should be redirected.
data Array A JSON representation of the completion confirmation details.

For example:

"data": 
{
"transaction_id":2147760117,
"project_id":39175444,
"completion_type":1,
"cpi":"0.00",
"audience_names":[
"Audience 1"
],
"quota_ids":[
223346738
]
}
}
data Element Model
Property Name Property Type Description
transaction_id Numeric The id that uniquely identifies this project transaction on Prodege.
project_id Numeric The ID that uniquely identifies the project in the Prodege system.
completion_type  Numeric The new (or confirmed) status for this transaction.
Expected completion_type values: 1 for Success, 2 for Overquota, 3 for Disqualification, 7 for Quality Termination.
cpi  Numeric  The cpi of the complete. This should only be greater than 0 if the completion_type is 1 (Success).

Register Completion Redirect

Register Completion Redirect
Description Static redirect endpoint for redirecting a survey participant to their final destination. This may only be used after registering a completion with the /prodegemr/register-completion api. 
It is intended for cases when the caller of register-completion is unable to redirect the user to the redirect_url provided in the register-completion response.Notes

  • There are no status changes associated with this redirect.  The completion status that was previously recorded during completion registration is to be preserved in all cases.
  • In the case this redirect is called for a transaction that has not been previously registered, the redirect will return a HTTP 400 bad request error. 
  • There should be nothing to prevent a user from traversing this redirect multiple times.
Request URL Prod:

https://www.swagbucks.com/prodegemr/registered-completion-redirect 

Staging:

https://prodegemr.sbxdv.com/prodegemr/registered-completion-redirect 

Important Note for Redirects: 

When redirecting users to this endpoint, as well as when making calls to any other endpoint, please be sure to utilize the secure HTTPS protocol. Using HTTP may lead to compatibility issues, especially on mobile devices, and is not recommended for a seamless experience.
Request Method GET (Redirect)
Request Parameters
Parameter Name Parameter Type Description Required?
apik String Your API Key. Yes
signature String The signature of your request (see Authentication). Yes
transaction_id String Transaction ID Yes

 

When successful, returns client-side redirect to the redirect_url associated with this transaction.  When unsuccessful, responds with an HTTP 400 (bad request) error.

« Transaction Completion (Redirect)Project Transaction Calls »
Help Guide Powered by Documentor
Suggest Edit