GET /api/v1/buyer_conversions
List buyer conversions

Params

Param name
Description
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 a String

created_at_from
Optional

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

  • Must be a String

fulltext
Optional

Search for any record that matches this text

  • Must be a 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
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • external_record_id
  • owner_id
  • owner_type
  • sortable_order
  • conversion_type
  • offer_id
  • buyer_id
  • traffic_source_id
  • context_menu_name
  • name
  • revenue
  • duration
  • duplicate_timeframe
  • cache_result_for_seconds
  • business_range_id
  • revenue_min
  • revenue_max
  • revenue_increment
  • revenue_type
  • webhook_response_success_codes
  • webhook_body_success_path
  • webhook_body_success_match
  • webhook_path_number
  • webhook_path_duration
  • webhook_path_name
  • webhook_path_revenue
  • webhook_type
  • webhook_remote_url
  • webhook_read_timeout
  • webhook_remote_method
  • webhook_remote_body
  • webhook_remote_headers
  • token_value_map_ids
  • webhook_path_external_id
  • webhook_contains_many_buyers
  • webhook_path_buyers
  • webhook_response_buyers_limit
  • webhook_response_buyers_order_by
  • webhook_response_buyers_order_dir
  • oauth_connection_id
  • cache_success_for_seconds
  • webhook_manual_fire_ids
  • response_parser_ids
  • webhook_response_buyers_max_duration_fallback
  • webhook_response_buyers_max_duration
  • token_value_map_group_ids
  • webhook_conversion_type
  • record_token_filter_id
  • record_token_filter_data_count
  • record_token_filter_data
  • record_token_additional_id
  • record_token_additional_data_count
  • record_token_additional_data
  • webhook_params_count
  • buyer_ping_parser_ids
  • Must be a 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
owner_id
Required

The ID for the record that owns this record.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21

owner_type
Required

The type of record that owns this record.

  • Must be a String

name
Optional

This name that will appear in call logs.

  • Must be a String

conversion_type
Optional

Configure static or dynamic revenue.

  • Must be one of: revenue, webhook, postback.

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 Blank Value Allowed

The minimum valid revenue for the current time frame.

  • Must be a decimal number.

revenue_max
Optional Blank Value Allowed

The maximum valid revenue for the current time frame.

  • Must be a decimal number.

revenue_increment
Optional Blank Value Allowed

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.

webhook_type
Optional

Translation missing: en.api.buyer_conversions.webhook_type

  • Must be one of: elocal, media_alpha, marchex, marchex_v2, jornaya_tcpa_guardian, custom.

webhook_remote_url
Optional

Translation missing: en.api.buyer_conversions.webhook_remote_url

  • Must be a String

webhook_remote_method
Optional

Translation missing: en.api.buyer_conversions.webhook_remote_method

  • Must be a String

webhook_remote_body
Optional

Translation missing: en.api.buyer_conversions.webhook_remote_body

  • Must be a String

webhook_remote_headers
Optional

Translation missing: en.api.buyer_conversions.webhook_remote_headers

  • Must be a 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 Blank Value 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
owner_id
Required

The ID for the record that owns this record.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21

owner_type
Required

The type of record that owns this record.

  • Must be a String

name
Optional

This name that will appear in call logs.

  • Must be a String

conversion_type
Optional

Configure static or dynamic revenue.

  • Must be one of: revenue, webhook, postback.

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 Blank Value Allowed

The minimum valid revenue for the current time frame.

  • Must be a decimal number.

revenue_max
Optional Blank Value Allowed

The maximum valid revenue for the current time frame.

  • Must be a decimal number.

revenue_increment
Optional Blank Value Allowed

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.

webhook_type
Optional

Translation missing: en.api.buyer_conversions.webhook_type

  • Must be one of: elocal, media_alpha, marchex, marchex_v2, jornaya_tcpa_guardian, custom.

webhook_remote_url
Optional

Translation missing: en.api.buyer_conversions.webhook_remote_url

  • Must be a String

webhook_remote_method
Optional

Translation missing: en.api.buyer_conversions.webhook_remote_method

  • Must be a String

webhook_remote_body
Optional

Translation missing: en.api.buyer_conversions.webhook_remote_body

  • Must be a String

webhook_remote_headers
Optional

Translation missing: en.api.buyer_conversions.webhook_remote_headers

  • Must be a 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 Blank Value 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


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

Params

Param name
Description
name
Optional

This name that will appear in call logs.

  • Must be a String

conversion_type
Optional

Configure static or dynamic revenue.

  • Must be one of: revenue, webhook, postback.

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 Blank Value Allowed

The minimum valid revenue for the current time frame.

  • Must be a decimal number.

revenue_max
Optional Blank Value Allowed

The maximum valid revenue for the current time frame.

  • Must be a decimal number.

revenue_increment
Optional Blank Value Allowed

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.

webhook_type
Optional

Translation missing: en.api.buyer_conversions.webhook_type

  • Must be one of: elocal, media_alpha, marchex, marchex_v2, jornaya_tcpa_guardian, custom.

webhook_remote_url
Optional

Translation missing: en.api.buyer_conversions.webhook_remote_url

  • Must be a String

webhook_remote_method
Optional

Translation missing: en.api.buyer_conversions.webhook_remote_method

  • Must be a String

webhook_remote_body
Optional

Translation missing: en.api.buyer_conversions.webhook_remote_body

  • Must be a String

webhook_remote_headers
Optional

Translation missing: en.api.buyer_conversions.webhook_remote_headers

  • Must be a 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 Blank Value 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