curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" "https://[your-subdomain].trackdrive.com/api/v1/calls?page=1&in_progress=true&order=created_at"
| Param name |
Description
Validations
|
||||||
|---|---|---|---|---|---|---|---|
|
serializer Optional Blank Value Allowed |
This endpoint supports multiple response formats. Pass Validations:
|
||||||
|
page Optional |
Return the next page of results. A per_page request parameter > 10 is not allowed, cursor must be used instead. Validations:
|
||||||
|
cursor Optional |
The API provides a technique called ‘cursoring' to paginate large result sets. Cursoring separates results into pages (the size of which are defined by the per_page request parameter) and provides a means to move backwards and forwards through these pages. To retrieve cursored results, you initially pass a cursor with a value of -1 to the endpoint. By default, an API endpoint that supports cursoring will assume -1 was passed as cursor if you do not provide one. The response to a cursored request will contain metadata.next_cursor. The next_cursor is the cursor that you should send to the endpoint to receive the next batch of responses. You will know that you have requested the last available page of results when the API responds with a next_cursor = 0. Validations:
|
||||||
|
per_page Optional |
How many results to return per page. The default is 25. Validations:
|
||||||
|
created_at_to Optional |
Date formatted like 2016-01-01 12:25:15 -0500 Validations:
|
||||||
|
created_at_from Optional |
Date formatted like 2016-01-01 12:25:15 -0500 Validations:
|
||||||
|
fulltext Optional |
Search for any record that matches this text Validations:
|
||||||
|
time_zone Optional |
Date ranges will be parsed using this time zone. Validations:
|
||||||
|
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:
Validations:
|
||||||
|
root Optional |
Pass Validations:
|
||||||
|
created_at_label Optional Blank Value Allowed |
Dynamic Date String such as “Today” or “This Year” Validations:
|
||||||
|
offer_repeat_caller Optional |
Match calls where the Traffic Source had a repeat caller. Validations:
|
||||||
|
buyer_repeat_caller Optional |
Match calls where the Buyer had a repeat caller. Validations:
|
||||||
|
buyer_converted Optional |
Did the buyer convert? Validations:
|
||||||
|
offer_converted Optional |
Did the traffic source convert? Validations:
|
||||||
|
in_progress Optional |
Match calls that are on-going Validations:
|
||||||
|
placed_on_hold Optional |
Was the call placed on hold? Validations:
|
||||||
|
has_recording Optional |
Match calls that have a recording. Validations:
|
||||||
|
either_converted Optional |
Whether this call's buyer or traffic source has converted. Validations:
|
||||||
|
buyer_conversion_duplicated_call Optional |
Match calls where the callerID was a duplicate against the Buyer's conversion settings. Validations:
|
||||||
|
offer_conversion_duplicated_call Optional |
Match calls where the callerID was a duplicate against the Traffic Source's conversion settings. Validations:
|
||||||
|
no_buyer Optional |
Match calls that didn't connect to a Buyer Validations:
|
||||||
|
token_key Optional |
Calls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token. Validations:
|
||||||
|
token_value Optional |
Will match calls that are tagged with a token:value. EG: token_key=buyer_id:12345 will return all calls that have a buyer_id token with the value set to 12345. Validations:
|
||||||
|
order Optional |
Sort results by this field. Validations:
|
||||||
|
order_dir Optional |
Sort results in ascending or descending order. Validations:
|
||||||
|
number_id Optional |
Refer to the number api for details Validations:
|
||||||
|
offer_id Optional |
Refer to the offer api for details Validations:
|
||||||
|
schedule_id Optional |
Schedule internal id. Validations:
|
||||||
|
traffic_source_id Optional |
Refer to the traffic source api for details Validations:
|
||||||
|
buyer_id Optional |
Refer to the buyer api for details Validations:
|
||||||
|
buyer_group_ids Optional |
Buyer Group Internal ids. Validations:
|
||||||
|
ring_pool_id Optional |
Refer to the Number Pool api for details Validations:
|
||||||
|
id Optional |
An Integer number eg: 12345 Validations:
|
||||||
|
provider_configuration_id Optional |
Refer to the provider api for details Validations:
|
||||||
|
contact_id Optional |
Match calls that were placed by this caller. Validations:
|
||||||
|
status Optional |
Match results that have this status. Validations:
|
||||||
|
ended_at_to Optional |
Date formatted like 2016-01-01 12:00:15 -0500 Validations:
|
||||||
|
ended_at_from Optional |
Date formatted like 2016-01-01 12:00:15 -0500 Validations:
|
curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" "https://[your-subdomain].trackdrive.com/api/v1/calls/17191231234/by_caller_number"
| Param name |
Description
Validations
|
||||||
|---|---|---|---|---|---|---|---|
|
serializer Optional Blank Value Allowed |
This endpoint supports multiple response formats. Pass Validations:
|
||||||
|
caller_number Required |
The caller number. EG: +17191112222 Validations:
|
||||||
|
per_page Optional |
How many results to return per page. The default is 25. Validations:
|
curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" "https://[your-subdomain].trackdrive.com/api/v1/calls/live_calls"
| Param name |
Description
Validations
|
||||||
|---|---|---|---|---|---|---|---|
|
serializer Optional Blank Value Allowed |
This endpoint supports multiple response formats. Pass Validations:
|
curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" "https://[your-subdomain].trackdrive.com/api/v1/calls/reports?category=buyer_id&"
| Param name |
Description
Validations
|
|---|---|
|
category Required |
Validations:
|
|
page Optional |
Return the next page of results. Validations:
|
|
per_page Optional |
How many results to return per page. The default is 25. Validations:
|
|
created_at_to Optional |
Date formatted like 2016-01-01 12:25:15 -0500 Validations:
|
|
created_at_from Optional |
Date formatted like 2016-01-01 12:25:15 -0500 Validations:
|
|
fulltext Optional |
Search for any record that matches this text Validations:
|
|
time_zone Optional |
Date ranges will be parsed using this time zone. Validations:
|
|
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:
Validations:
|
|
root Optional |
Pass Validations:
|
|
offer_repeat_caller Optional |
Match calls where the Traffic Source had a repeat caller. Validations:
|
|
buyer_repeat_caller Optional |
Match calls where the Buyer had a repeat caller. Validations:
|
|
buyer_converted Optional |
Did the buyer convert? Validations:
|
|
offer_converted Optional |
Did the traffic source convert? Validations:
|
|
in_progress Optional |
Match calls that are on-going Validations:
|
|
placed_on_hold Optional |
Was the call placed on hold? Validations:
|
|
has_recording Optional |
Match calls that have a recording. Validations:
|
|
either_converted Optional |
Whether this call's buyer or traffic source has converted. Validations:
|
|
buyer_conversion_duplicated_call Optional |
Match calls where the callerID was a duplicate against the Buyer's conversion settings. Validations:
|
|
offer_conversion_duplicated_call Optional |
Match calls where the callerID was a duplicate against the Traffic Source's conversion settings. Validations:
|
|
no_buyer Optional |
Match calls that didn't connect to a Buyer Validations:
|
|
token_key Optional |
Calls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token. Validations:
|
|
token_value Optional |
Will match calls that are tagged with a token:value. EG: token_key=buyer_id:12345 will return all calls that have a buyer_id token with the value set to 12345. Validations:
|
|
order Optional |
Sort results by this field. Validations:
|
|
order_dir Optional |
Sort results in ascending or descending order. Validations:
|
|
number_id Optional |
Refer to the number api for details Validations:
|
|
offer_id Optional |
Refer to the offer api for details Validations:
|
|
schedule_id Optional |
Schedule internal id. Validations:
|
|
traffic_source_id Optional |
Refer to the traffic source api for details Validations:
|
|
buyer_id Optional |
Refer to the buyer api for details Validations:
|
|
buyer_group_ids Optional |
Buyer Group Internal ids. Validations:
|
|
ring_pool_id Optional |
Refer to the Number Pool api for details Validations:
|
|
id Optional |
An Integer number eg: 12345 Validations:
|
|
provider_configuration_id Optional |
Refer to the provider api for details Validations:
|
|
contact_id Optional |
Match calls that were placed by this caller. Validations:
|
|
status Optional |
Match results that have this status. Validations:
|
|
ended_at_to Optional |
Date formatted like 2016-01-01 12:00:15 -0500 Validations:
|
|
ended_at_from Optional |
Date formatted like 2016-01-01 12:00:15 -0500 Validations:
|
curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" "https://[your-subdomain].trackdrive.com/api/v1/calls/stats/?group_by=status&created_at_from=2025-11-03 01:28:22 UTC&created_at_to=2025-11-03 13:28:22 +0000&stat=count"
| Param name |
Description
Validations
|
|---|---|
|
group_by Required |
Group calls by one of these attributes. Validations:
|
|
stat Required |
Return statistics on the grouped calls by one of these numeric columns. Validations:
|
|
created_at_to Required |
Date formatted like 2016-01-01 12:25:15 -0500 Validations:
|
|
created_at_from Required |
Date formatted like 2016-01-01 12:25:15 -0500 Validations:
|
|
page Optional |
Return the next page of results. Validations:
|
|
offer_repeat_caller Optional |
Match calls where the Traffic Source had a repeat caller. Validations:
|
|
buyer_repeat_caller Optional |
Match calls where the Buyer had a repeat caller. Validations:
|
|
buyer_converted Optional |
Did the buyer convert? Validations:
|
|
offer_converted Optional |
Did the traffic source convert? Validations:
|
|
in_progress Optional |
Match calls that are on-going Validations:
|
|
placed_on_hold Optional |
Was the call placed on hold? Validations:
|
|
has_recording Optional |
Match calls that have a recording. Validations:
|
|
either_converted Optional |
Whether this call's buyer or traffic source has converted. Validations:
|
|
buyer_conversion_duplicated_call Optional |
Match calls where the callerID was a duplicate against the Buyer's conversion settings. Validations:
|
|
offer_conversion_duplicated_call Optional |
Match calls where the callerID was a duplicate against the Traffic Source's conversion settings. Validations:
|
|
no_buyer Optional |
Match calls that didn't connect to a Buyer Validations:
|
|
token_key Optional |
Calls that are tagged with this token will be matched. EG: token_key=buyer_id will return all calls that have a buyer_id token. Validations:
|
|
token_value Optional |
Will match calls that are tagged with a token:value. EG: token_key=buyer_id:12345 will return all calls that have a buyer_id token with the value set to 12345. Validations:
|
|
order Optional |
Sort results by this field. Validations:
|
|
order_dir Optional |
Sort results in ascending or descending order. Validations:
|
|
number_id Optional |
Refer to the number api for details Validations:
|
|
offer_id Optional |
Refer to the offer api for details Validations:
|
|
schedule_id Optional |
Schedule internal id. Validations:
|
|
traffic_source_id Optional |
Refer to the traffic source api for details Validations:
|
|
buyer_id Optional |
Refer to the buyer api for details Validations:
|
|
buyer_group_ids Optional |
Buyer Group Internal ids. Validations:
|
|
ring_pool_id Optional |
Refer to the Number Pool api for details Validations:
|
|
id Optional |
An Integer number eg: 12345 Validations:
|
|
provider_configuration_id Optional |
Refer to the provider api for details Validations:
|
|
contact_id Optional |
Match calls that were placed by this caller. Validations:
|
|
status Optional |
Match results that have this status. Validations:
|
|
ended_at_to Optional |
Date formatted like 2016-01-01 12:00:15 -0500 Validations:
|
|
ended_at_from Optional |
Date formatted like 2016-01-01 12:00:15 -0500 Validations:
|
| Param name |
Description
Validations
|
||||||
|---|---|---|---|---|---|---|---|
|
serializer Optional Blank Value Allowed |
This endpoint supports multiple response formats. Pass Validations:
|
||||||
|
from Required |
The call will originate from this address (+E.164 formatted phone number.) Example: +18665550001 Validations:
|
||||||
|
to Required |
The call will be placed to this receiving address (+E.164 formatted phone number.) Example: +18665550001 Validations:
|
||||||
|
lead_id Optional |
Optional. Associate this call with this lead. Validations:
|
||||||
|
schedule_id Optional |
Optional. If a lead exists on this schedule, this call will be associated with it. If no lead currently exists, one will be created, and it will be added to this schedule. Validations:
|
||||||
|
offer_id Optional |
Optional. Associate this call with a matching lead on this offer. If no lead currently exists, one will be created on this offer. Validations:
|
curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" "https://[your-subdomain].trackdrive.com/api/v1/calls/5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1"
| Param name |
Description
Validations
|
||||||
|---|---|---|---|---|---|---|---|
|
serializer Optional Blank Value Allowed |
This endpoint supports multiple response formats. Pass Validations:
|
||||||
|
id Optional |
Find the call by Validations:
|
curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" "https://[your-subdomain].trackdrive.com/api/v1/calls/5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1/events"
Call ID or Call UUID with contact fields, revenue, payout, and more.
curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -H "Content-Type: application/json" -X POST -d '{"post_call_tokens": {"good_lead":"yes","loan_amount":"500"}}' https://[your-subdomain].trackdrive.com/api/v1/calls/:id
| Param name |
Description
Validations
|
||||||
|---|---|---|---|---|---|---|---|
|
serializer Optional Blank Value Allowed |
This endpoint supports multiple response formats. Pass Validations:
|
||||||
|
id Optional |
Find the call by Validations:
|
||||||
|
post_call_tokens Optional |
Custom contact fields defined on the offer. Validations:
|
||||||
|
revenue Optional |
The revenue paid out for the call. Validations:
|
||||||
|
add_revenue Optional |
Add this amount to the call's current revenue. For example pass 2.5 to add 2.5 to the current call revenue. If the call revenue is currently 10.50, the revenue would become 13 (10.50 + 2.50) Validations:
|
||||||
|
add_payout Optional |
Add this amount to the call's current payout. Validations:
|
||||||
|
buyer_converted Optional |
Did the buyer convert? Validations:
|
||||||
|
trackdrive_buyer_id Optional |
Update the winning Buyer that is assigned to this call. Validations:
|
||||||
|
payout Optional |
The amount paid to the traffic source. Validations:
|
||||||
|
offer_converted Optional |
Did the traffic source convert? Validations:
|
||||||
|
trackdrive_traffic_source_id Optional |
Update the Traffic Source that is assigned to this call. Validations:
|
||||||
|
contact_field_type Optional |
Pass an ID belonging to an Validations:
|
||||||
|
fire_outgoing_webhook_ids Optional |
Manually refire the listed outgoing webhook ids against this call. Validations:
|
||||||
|
manual_transcribe Optional |
Manually transcribe this call using the default transcription group. Validations:
|
||||||
|
call_disposition_id Optional Blank Value Allowed |
Call Disposition Validations:
|
||||||
|
agent_call_disposition_notes Optional Blank Value Allowed |
Notes Validations:
|
caller_id and offer_token
curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -H "Content-Type: application/json" -X POST -d '{"add_revenue": 2.50, "buyer_converted": "true"}' https://[your-subdomain].trackdrive.com/api/v1/calls/update_by_caller_id/:caller_id
curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -X POST "https://my-company.trackdrive.com/api/v1/calls/update_by_caller_id/17194448888?offer_token=the-offer-token&add_revenue=5"
| Param name |
Description
Validations
|
|---|---|
|
caller_id Required |
The caller ID for the call that will be updated. Validations:
|
|
offer_token Required |
The Validations:
|
|
call_timeframe Optional |
Pass this optional parameter to restrict the call update to calls made in the last Validations:
|
|
revenue Optional |
Set the call's revenue to this amount. For example pass 10.50 to set the revenue to 10.50 Validations:
|
|
add_revenue Optional |
Add this amount to the call's current revenue. For example pass 2.5 to add 2.5 to the current call revenue. If the call revenue is currently 10.50, the revenue would become 13 (10.50 + 2.50) Validations:
|
|
add_payout Optional |
Add this amount to the call's current payout. Validations:
|
|
call_disposition_id Optional Blank Value Allowed |
Call Disposition Validations:
|
|
agent_call_disposition_notes Optional Blank Value Allowed |
Notes Validations:
|
|
buyer_converted Optional |
Did the buyer convert? Validations:
|
curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -H "Content-Type: application/json" -X POST -d '{"id": "fbd28553-04fc-4c6b-9af8-46c17d5925bf", "digits": "5", "data": {"first_name": "John"}}' "https://[your-subdomain].trackdrive.com/api/v1/calls/send_key_press"
| Param name |
Description
Validations
|
|---|---|
|
id Required |
Find the call by Validations:
|
|
digits Required |
DTMF digit Validations:
|
|
data Optional Blank Value Allowed |
Update the call with this data. Validations:
|
curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -i -X DELETE "https://[your-subdomain].trackdrive.com/api/v1/calls/77777777-dbe3-49ee-b28f-115ec80dcef9"
| Param name |
Description
Validations
|
||||||
|---|---|---|---|---|---|---|---|
|
serializer Optional Blank Value Allowed |
This endpoint supports multiple response formats. Pass Validations:
|
||||||
|
id Optional |
Find the call by Validations:
|