GET /api/v1/offer_conversions
List the Traffic Source Conversions in your Trackdrive Account.

Supported Formats

json, csv

Examples

wget "https://[your-subdomain].trackdrive.net/api/v1/offer_conversions?page=1&order=created_at&auth_token=[your-auth-token]"

Params

Param name
Description
auth_token
optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

offer_id
optional

The conversion will be added to this offer.

business_range_id
optional

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

page
optional

Return the next page of results.

  • Must be a number.

per_page
optional

How many results to return per page. The default is 25.

  • Must be a number.

created_at_to
optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String

created_at_from
optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String

fulltext
optional

Search for any record that matches this text

  • Must be String

time_zone
optional

Date ranges will be parsed using this time zone.

columns
optional
Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at

Must be any combination of:

  • id
  • payout
  • payout_type
  • revenue_percentage
  • duration
  • duplicate_timeframe
  • name
  • token_values
  • sortable_order
  • offer_id
  • business_range_id
  • Must be String

root
optional

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off


GET /api/v1/offer_conversions/:id
Get a Traffic Source Conversion by ID.

Supported Formats

json

Params

Param name
Description
auth_token
optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String


POST /api/v1/offer_conversions
Create a Traffic Source Conversion.

Supported Formats

json

Examples

curl -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.net/api/v1/offer_conversions?auth_token=[your-auth-token]

Params

Param name
Description
auth_token
optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

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

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

  • Must be a decimal number.

revenue_percentage
optional

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 String

offer_id
required

The conversion will be added to this offer.

business_range_id
optional , nil allowed

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

token_values
optional

Conversion will only occur if the call matches these filters.

  • 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.


PUT /api/v1/offer_conversions/:id
Update a Traffic Source Conversion by ID.

Supported Formats

json

Examples

curl -H "Content-Type: application/json" -X PUT -d '{"payout": 9, "duration": 120}' https://[your-subdomain].trackdrive.net/api/v1/offer_conversions/1008923?auth_token=[your-auth-token]

Params

Param name
Description
auth_token
optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

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

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

  • Must be a decimal number.

revenue_percentage
optional

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
optional

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
optional

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
optional

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

  • Must be String

token_values
optional

Conversion will only occur if the call matches these filters.

  • 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.


DELETE /api/v1/offer_conversions/:id
Delete a Traffic Source Conversion by ID.

Supported Formats

json

Examples

curl -H "Content-Type: application/json" -X DELETE "https://[your-subdomain].trackdrive.net/api/v1/offer_conversions/1008923?auth_token=[your-auth-token]"

Params

Param name
Description
auth_token
optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String