GET /api/v1/buyer_conversions
List buyer conversions

Params

Param name
Description
auth_token
optional

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

  • Must be String

ids
required

Return records matching these ids.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]

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
  • created_at
  • updated_at
  • user_updated_at
  • owner_id
  • owner_type
  • sortable_order
  • conversion_type
  • type
  • offer_id
  • buyer_id
  • traffic_source_id
  • name
  • revenue
  • duration
  • duplicate_timeframe
  • business_range_id
  • revenue_min
  • revenue_max
  • revenue_increment
  • token_value_ids
  • attribution_token_value_ids
  • webhook_type
  • webhook_remote_url
  • webhook_read_timeout
  • webhook_remote_method
  • webhook_remote_body
  • webhook_remote_headers
  • token_value_map_ids
  • webhook_response_buyers_limit
  • webhook_response_buyers_order_by
  • webhook_response_buyers_order_dir
  • 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/buyer_conversions/new
Build a new buyer conversion

Params

Param name
Description
auth_token
optional

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

  • Must be String

owner_id
required

The ID for the record that owns this record.

  • Must be an Integer ID reference to an object on Trackdrive.

owner_type
required

The type of record that owns this record.

  • Must be String

name
optional

This name that will appear in call logs.

  • Must be String

conversion_type
optional

Configure static or dynamic revenue.

  • Must be one of: revenue, webhook.

revenue
optional

The number of dollars paid per call in increments of $0.01 for the current time frame.

  • Must be a decimal number.

revenue_min
optional

The minimum valid revenue for the current time frame.

  • Must be a decimal number.

revenue_max
optional

The maximum valid revenue for the current time frame.

  • Must be a decimal number.

revenue_increment
optional

Bids must be increased/decreased by this amount for the current time frame.

  • Must be a decimal number.

duration
optional

The number of seconds for a call to payout. If this is set to 0 the call will convert when this buyer is dialed for the current time frame.

  • Must be a decimal number.

duplicate_timeframe
optional

The period of time that must elapse before a buyer will pay for the same caller to be transferred.

  • Must be a decimal number.

token_value_ids
optional , nil allowed

The first conversion matching these filters will be used.

attribution_token_value_ids
optional , nil allowed

These extra tokens will be applied to calls that exit the schedule through this trigger.

webhook_type
optional

translation missing: en.api.buyer_conversions.webhook_type

  • Must be one of: elocal, marchex.

webhook_remote_url
optional

translation missing: en.api.buyer_conversions.webhook_remote_url

  • Must be String

webhook_remote_method
optional

translation missing: en.api.buyer_conversions.webhook_remote_method

  • Must be String

webhook_remote_body
optional

translation missing: en.api.buyer_conversions.webhook_remote_body

  • Must be String

webhook_remote_headers
optional

translation missing: en.api.buyer_conversions.webhook_remote_headers

  • Must be String

webhook_read_timeout
optional

How many seconds should Trackdrive wait before cancelling this request? Call routing pauses while waiting for PING/POST buyers to respond. Wait times longer then a few seconds may frustrate callers.

  • Must be a decimal number.

webhook_response_buyers_limit
optional

translation missing: en.api.buyer_conversions.webhook_response_buyers_limit

  • Must be a decimal number.

webhook_response_buyers_order_by
optional

translation missing: en.api.buyer_conversions.webhook_response_buyers_order_by

  • Must be one of: revenue, duration.

webhook_response_buyers_order_dir
optional

translation missing: en.api.buyer_conversions.webhook_response_buyers_order_dir

  • Must be one of: desc, asc.

sortable_order
optional , nil allowed

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

  • Must be a decimal number.


POST /api/v1/buyer_conversions
Create a buyer conversion

Params

Param name
Description
auth_token
optional

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

  • Must be String

owner_id
required

The ID for the record that owns this record.

  • Must be an Integer ID reference to an object on Trackdrive.

owner_type
required

The type of record that owns this record.

  • Must be String

name
optional

This name that will appear in call logs.

  • Must be String

conversion_type
optional

Configure static or dynamic revenue.

  • Must be one of: revenue, webhook.

revenue
optional

The number of dollars paid per call in increments of $0.01 for the current time frame.

  • Must be a decimal number.

revenue_min
optional

The minimum valid revenue for the current time frame.

  • Must be a decimal number.

revenue_max
optional

The maximum valid revenue for the current time frame.

  • Must be a decimal number.

revenue_increment
optional

Bids must be increased/decreased by this amount for the current time frame.

  • Must be a decimal number.

duration
optional

The number of seconds for a call to payout. If this is set to 0 the call will convert when this buyer is dialed for the current time frame.

  • Must be a decimal number.

duplicate_timeframe
optional

The period of time that must elapse before a buyer will pay for the same caller to be transferred.

  • Must be a decimal number.

token_value_ids
optional , nil allowed

The first conversion matching these filters will be used.

attribution_token_value_ids
optional , nil allowed

These extra tokens will be applied to calls that exit the schedule through this trigger.

webhook_type
optional

translation missing: en.api.buyer_conversions.webhook_type

  • Must be one of: elocal, marchex.

webhook_remote_url
optional

translation missing: en.api.buyer_conversions.webhook_remote_url

  • Must be String

webhook_remote_method
optional

translation missing: en.api.buyer_conversions.webhook_remote_method

  • Must be String

webhook_remote_body
optional

translation missing: en.api.buyer_conversions.webhook_remote_body

  • Must be String

webhook_remote_headers
optional

translation missing: en.api.buyer_conversions.webhook_remote_headers

  • Must be String

webhook_read_timeout
optional

How many seconds should Trackdrive wait before cancelling this request? Call routing pauses while waiting for PING/POST buyers to respond. Wait times longer then a few seconds may frustrate callers.

  • Must be a decimal number.

webhook_response_buyers_limit
optional

translation missing: en.api.buyer_conversions.webhook_response_buyers_limit

  • Must be a decimal number.

webhook_response_buyers_order_by
optional

translation missing: en.api.buyer_conversions.webhook_response_buyers_order_by

  • Must be one of: revenue, duration.

webhook_response_buyers_order_dir
optional

translation missing: en.api.buyer_conversions.webhook_response_buyers_order_dir

  • Must be one of: desc, asc.

sortable_order
optional , nil allowed

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

  • Must be a decimal number.


GET /api/v1/buyer_conversions/:id
Show the details of a buyer conversion

Params

Param name
Description
auth_token
optional

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

  • Must be String


PUT /api/v1/buyer_conversions/:id
Update a buyer conversion

Params

Param name
Description
auth_token
optional

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

  • Must be String

name
optional

This name that will appear in call logs.

  • Must be String

conversion_type
optional

Configure static or dynamic revenue.

  • Must be one of: revenue, webhook.

revenue
optional

The number of dollars paid per call in increments of $0.01 for the current time frame.

  • Must be a decimal number.

revenue_min
optional

The minimum valid revenue for the current time frame.

  • Must be a decimal number.

revenue_max
optional

The maximum valid revenue for the current time frame.

  • Must be a decimal number.

revenue_increment
optional

Bids must be increased/decreased by this amount for the current time frame.

  • Must be a decimal number.

duration
optional

The number of seconds for a call to payout. If this is set to 0 the call will convert when this buyer is dialed for the current time frame.

  • Must be a decimal number.

duplicate_timeframe
optional

The period of time that must elapse before a buyer will pay for the same caller to be transferred.

  • Must be a decimal number.

token_value_ids
optional , nil allowed

The first conversion matching these filters will be used.

attribution_token_value_ids
optional , nil allowed

These extra tokens will be applied to calls that exit the schedule through this trigger.

webhook_type
optional

translation missing: en.api.buyer_conversions.webhook_type

  • Must be one of: elocal, marchex.

webhook_remote_url
optional

translation missing: en.api.buyer_conversions.webhook_remote_url

  • Must be String

webhook_remote_method
optional

translation missing: en.api.buyer_conversions.webhook_remote_method

  • Must be String

webhook_remote_body
optional

translation missing: en.api.buyer_conversions.webhook_remote_body

  • Must be String

webhook_remote_headers
optional

translation missing: en.api.buyer_conversions.webhook_remote_headers

  • Must be String

webhook_read_timeout
optional

How many seconds should Trackdrive wait before cancelling this request? Call routing pauses while waiting for PING/POST buyers to respond. Wait times longer then a few seconds may frustrate callers.

  • Must be a decimal number.

webhook_response_buyers_limit
optional

translation missing: en.api.buyer_conversions.webhook_response_buyers_limit

  • Must be a decimal number.

webhook_response_buyers_order_by
optional

translation missing: en.api.buyer_conversions.webhook_response_buyers_order_by

  • Must be one of: revenue, duration.

webhook_response_buyers_order_dir
optional

translation missing: en.api.buyer_conversions.webhook_response_buyers_order_dir

  • Must be one of: desc, asc.

sortable_order
optional , nil allowed

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

  • Must be a decimal number.


DELETE /api/v1/buyer_conversions/:id
Delete a buyer conversion

Params

Param name
Description
auth_token
optional

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

  • Must be String