Supported Formats

json

Examples

curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -H "Content-Type: application/json" -X POST -d '{"payout": 10, "duration": 60, duplicate_timeframe: 3600, name: "Pay $10 after 1 minute, deduped by 1 hour.", offer_id: 10001234}' https://[your-subdomain].trackdrive.com/api/v1/offer_conversions

Params

Param name
Description
serializer
Optional Blank Value Allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    offer_conversionDefault response format.
    offer_conversion_gridModern response format that returns various foreign keys for use with other API endpoints.
payout_type
Optional

How should the payout be calculated?
buyer_conversion_percent: Calculate the payout as a percentage of the revenue paid to the buyer.
usd: Pay the Traffic Source this amount.

  • Must be one of: usd, buyer_conversion_percent.

payout
Optional Blank Value Allowed

The Traffic Source will be paid this amount when payout_type is set to usd

  • Must be a decimal number.

revenue_percentage
Optional Blank Value Allowed

Calculate the payout as a percentage of the revenue paid to the buyer when payout_type is set to buyer_conversion_percent. A value of 60 would pay 60% of the revenue to the Traffic Source. If the buyer revenue is $15 and the percent is 60, the calculated payout would be $9

  • Must be a decimal number.

duration
Required

The number of seconds after the buyer answers the call before the traffic source gets paid. 0 seconds means the call will convert for the traffic source even if a buyer doesn't answer.

  • Must be a decimal number.

duplicate_timeframe
Required

The period of time that must elapse before a traffic source will be paid again when transferring the same CallerID.

  • Must be a decimal number.

name
Required

This name that will appear in your call logs when the call converts.

  • Must be a String

offer_id
Required

The conversion will be added to this offer.

business_range_id
Optional Blank Value Allowed

The conversion will be added to these business hours. Leave this blank to automatically assign the currently open business hours.

record_token_filter_list
Optional Blank Value Allowed

Assign filters to the object by passing an array of key:value pairs

  • Must be a valid list of filters. Example filters:
    "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"
sortable_order
Optional

The order in which Traffic Source Conversions will be checked for a matching conversion. Values are sorted in ascending order; smaller values are checked first.

  • Must be a decimal number.