Param name |
Description
Validations
|
---|---|
ids Required |
Return records matching these ids.
|
page Optional |
Return the next page of results.
|
per_page Optional |
How many results to return per page. The default is 25.
|
created_at_to Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
created_at_from Optional |
Date formatted like 2016-01-01 12:25:15 -0500
|
fulltext Optional |
Search for any record that matches this text
|
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:
|
root Optional |
Pass
|
Param name |
Description
Validations
|
---|---|
owner_id Required |
The ID for the record that owns this record.
|
owner_type Required |
The type of record that owns this record.
|
name Optional |
This name that will appear in call logs.
|
conversion_type Optional |
Configure static or dynamic revenue.
|
revenue Optional |
The number of dollars paid per call in increments of $0.01 for the current time frame.
|
revenue_min Optional Blank Value Allowed |
The minimum valid revenue for the current time frame.
|
revenue_max Optional Blank Value Allowed |
The maximum valid revenue for the current time frame.
|
revenue_increment Optional Blank Value Allowed |
Bids must be increased/decreased by this amount for the current time frame.
|
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.
|
duplicate_timeframe Optional |
The period of time that must elapse before a buyer will pay for the same caller to be transferred.
|
webhook_type Optional |
Translation missing: en.api.buyer_conversions.webhook_type
|
webhook_remote_url Optional |
Translation missing: en.api.buyer_conversions.webhook_remote_url
|
webhook_remote_method Optional |
Translation missing: en.api.buyer_conversions.webhook_remote_method
|
webhook_remote_body Optional |
Translation missing: en.api.buyer_conversions.webhook_remote_body
|
webhook_remote_headers Optional |
Translation missing: en.api.buyer_conversions.webhook_remote_headers
|
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.
|
webhook_response_buyers_limit Optional |
Translation missing: en.api.buyer_conversions.webhook_response_buyers_limit
|
webhook_response_buyers_order_by Optional |
Translation missing: en.api.buyer_conversions.webhook_response_buyers_order_by
|
webhook_response_buyers_order_dir Optional |
Translation missing: en.api.buyer_conversions.webhook_response_buyers_order_dir
|
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.
|
Param name |
Description
Validations
|
---|---|
owner_id Required |
The ID for the record that owns this record.
|
owner_type Required |
The type of record that owns this record.
|
name Optional |
This name that will appear in call logs.
|
conversion_type Optional |
Configure static or dynamic revenue.
|
revenue Optional |
The number of dollars paid per call in increments of $0.01 for the current time frame.
|
revenue_min Optional Blank Value Allowed |
The minimum valid revenue for the current time frame.
|
revenue_max Optional Blank Value Allowed |
The maximum valid revenue for the current time frame.
|
revenue_increment Optional Blank Value Allowed |
Bids must be increased/decreased by this amount for the current time frame.
|
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.
|
duplicate_timeframe Optional |
The period of time that must elapse before a buyer will pay for the same caller to be transferred.
|
webhook_type Optional |
Translation missing: en.api.buyer_conversions.webhook_type
|
webhook_remote_url Optional |
Translation missing: en.api.buyer_conversions.webhook_remote_url
|
webhook_remote_method Optional |
Translation missing: en.api.buyer_conversions.webhook_remote_method
|
webhook_remote_body Optional |
Translation missing: en.api.buyer_conversions.webhook_remote_body
|
webhook_remote_headers Optional |
Translation missing: en.api.buyer_conversions.webhook_remote_headers
|
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.
|
webhook_response_buyers_limit Optional |
Translation missing: en.api.buyer_conversions.webhook_response_buyers_limit
|
webhook_response_buyers_order_by Optional |
Translation missing: en.api.buyer_conversions.webhook_response_buyers_order_by
|
webhook_response_buyers_order_dir Optional |
Translation missing: en.api.buyer_conversions.webhook_response_buyers_order_dir
|
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.
|
Param name |
Description
Validations
|
---|---|
name Optional |
This name that will appear in call logs.
|
conversion_type Optional |
Configure static or dynamic revenue.
|
revenue Optional |
The number of dollars paid per call in increments of $0.01 for the current time frame.
|
revenue_min Optional Blank Value Allowed |
The minimum valid revenue for the current time frame.
|
revenue_max Optional Blank Value Allowed |
The maximum valid revenue for the current time frame.
|
revenue_increment Optional Blank Value Allowed |
Bids must be increased/decreased by this amount for the current time frame.
|
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.
|
duplicate_timeframe Optional |
The period of time that must elapse before a buyer will pay for the same caller to be transferred.
|
webhook_type Optional |
Translation missing: en.api.buyer_conversions.webhook_type
|
webhook_remote_url Optional |
Translation missing: en.api.buyer_conversions.webhook_remote_url
|
webhook_remote_method Optional |
Translation missing: en.api.buyer_conversions.webhook_remote_method
|
webhook_remote_body Optional |
Translation missing: en.api.buyer_conversions.webhook_remote_body
|
webhook_remote_headers Optional |
Translation missing: en.api.buyer_conversions.webhook_remote_headers
|
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.
|
webhook_response_buyers_limit Optional |
Translation missing: en.api.buyer_conversions.webhook_response_buyers_limit
|
webhook_response_buyers_order_by Optional |
Translation missing: en.api.buyer_conversions.webhook_response_buyers_order_by
|
webhook_response_buyers_order_dir Optional |
Translation missing: en.api.buyer_conversions.webhook_response_buyers_order_dir
|
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.
|