GET /api/v1/calls
Get pages of calls by criteria.

Supported Formats

json, csv

Examples

wget "https://[your-subdomain].trackdrive.net/api/v1/calls?page=1&in_progress=true&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

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.

  • Must be a number.

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.

  • Must be one of: Etc/UTC, UTC, SST, HST, AKST, PST, MST, CST, EST, COT, PET, AST, VET, BOT, CLST, NST, BRST, ART, UYT, GYT, WGT, GST, AZOT, CVT, GMT, WET, CET, EET, MSK, IST, CAT, SAST, EAT, IRST, AZT, GET, AMT, AFT, YEKT, PKT, UZT, NPT, BDT, NOVT, MMT, ICT, WIB, KRAT, HKT, XJT, MYT, SGT, AWST, IRKT, ULAT, KST, JST, YAKT, ACST, ACDT, AEDT, AEST, VLAT, ChST, PGT, MAGT, SBT, NCT, FJST, PETT, MHT, NZDT, TOT, TKT, CHADT, WSDT.

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:

  • uuid
  • recording_url
  • number_called
  • connected_to
  • caller_number
  • offer
  • traffic_source
  • buyer
  • obfuscated_caller_number
  • caller_city
  • caller_country
  • token_values
  • total_duration
  • hold_duration
  • ivr_duration
  • answered_duration
  • user_offer_id
  • user_traffic_source_id
  • user_buyer_id
  • sub_id
  • ring_pool_id
  • status
  • buyer_converted
  • buyer_repeat_caller
  • buyer_revenue
  • traffic_source_converted
  • traffic_source_repeat_caller
  • traffic_source_payout
  • trackdrive_cost
  • provider_cost
  • hangup_reason
  • call_sid
  • provider
  • outgoing_webhooks_count
  • created_at
  • ended_at
  • Must be String

offer_repeat_caller
optional

Match calls where the Traffic Source had a repeat caller.

  • Must be one of: true, false.

buyer_repeat_caller
optional

Match calls where the Buyer had a repeat caller.

  • Must be one of: true, false.

buyer_converted
optional

Whether this call's buyer has converted.

  • Must be one of: true, false.

offer_converted
optional

Match calls where the Traffic Source converted.

  • Must be one of: true, false.

in_progress
optional

Match calls that are on-going

  • Must be one of: true, false.

placed_on_hold
optional

translation missing: en.api.calls.placed_on_hold

  • Must be one of: true, false.

has_recording
optional

Match calls that have a recording.

  • Must be one of: true, false.

buyer_conversion_duplicated_call
optional

Match calls where the callerID was a duplicate against the Buyer's conversion settings.

  • Must be one of: true, false.

offer_conversion_duplicated_call
optional

Match calls where the callerID was a duplicate against the Traffic Source's conversion settings.

  • Must be one of: true, false.

no_buyer
optional

Match calls that didn't connect to a Buyer

  • Must be one of: true, false.

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.

  • Must be String

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.

  • Must be String

order
optional

Sort results by this field.

  • Must be one of: direction, number_id, offer_id, traffic_source_id, sub_id, buyer_id, caller_number, updated_at, total_duration, hold_duration, ivr_duration, cost, charge, answered_duration, status, sub_status, buyer_converted, revenue, offer_converted, payout, outgoing_webhooks_count, created_at, end_time, lead_id.

order_dir
optional

Sort results in ascending or descending order.

  • Must be one of: desc, asc.

number_id
optional

Refer to the number api for details

  • Must be a decimal number.

offer_id
optional

Refer to the offer api for details

  • Must be a decimal number.

traffic_source_id
optional

Refer to the traffic source api for details

  • Must be a decimal number.

buyer_id
optional

Refer to the buyer api for details

  • Must be a decimal number.

buyer_group_ids
optional

translation missing: en.api.buyer_group_ids

  • Must be a decimal number.

ring_pool_id
optional

Refer to the ring pool api for details

  • Must be a decimal number.

id
optional

An Integer number eg: 12345

  • Must be a decimal number.

provider_configuration_id
optional

Refer to the provider api for details

  • Must be a decimal number.

contact_id
optional

Match calls that were placed by this caller.

  • Must be a decimal number.

status
optional

Match results that have this status.

  • Must be one of: forwarded, finished, on-hold, no-answer, no-buyer, no-buyer-all-maxed-out, no-buyer-all-filtered, no-buyer-prevent-dupes, not-open, caller-hung-up, rejected, rejected-traffic-source-capped-hang-up, rejected-no-concurrency-cap-available, rejected-caller-concurrency-exceeded, rejected-average-hold-time-exceeded, blocked, failed, hold-queue-waited-too-long.

ended_at_to
optional

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

  • Must be String

ended_at_from
optional

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

  • Must be String


GET /api/v1/calls/reports
Get statistics on calls by category.

Supported Formats

json, csv

Examples

wget "https://[your-subdomain].trackdrive.net/api/v1/calls/reports?category=buyer_id&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

category
required
  • Must be one of: buyer_id, offer_id, traffic_source_id, number_id, status, direction, sub_status, provider_configuration_id, contact_id, placed_on_hold, ring_pool_id, contact_state, contact_country, buyer_converted, offer_converted, in_progress.

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.

  • Must be one of: Etc/UTC, UTC, SST, HST, AKST, PST, MST, CST, EST, COT, PET, AST, VET, BOT, CLST, NST, BRST, ART, UYT, GYT, WGT, GST, AZOT, CVT, GMT, WET, CET, EET, MSK, IST, CAT, SAST, EAT, IRST, AZT, GET, AMT, AFT, YEKT, PKT, UZT, NPT, BDT, NOVT, MMT, ICT, WIB, KRAT, HKT, XJT, MYT, SGT, AWST, IRKT, ULAT, KST, JST, YAKT, ACST, ACDT, AEDT, AEST, VLAT, ChST, PGT, MAGT, SBT, NCT, FJST, PETT, MHT, NZDT, TOT, TKT, CHADT, WSDT.

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:

  • uuid
  • recording_url
  • number_called
  • connected_to
  • caller_number
  • offer
  • traffic_source
  • buyer
  • obfuscated_caller_number
  • caller_city
  • caller_country
  • token_values
  • total_duration
  • hold_duration
  • ivr_duration
  • answered_duration
  • user_offer_id
  • user_traffic_source_id
  • user_buyer_id
  • sub_id
  • ring_pool_id
  • status
  • buyer_converted
  • buyer_repeat_caller
  • buyer_revenue
  • traffic_source_converted
  • traffic_source_repeat_caller
  • traffic_source_payout
  • trackdrive_cost
  • provider_cost
  • hangup_reason
  • call_sid
  • provider
  • outgoing_webhooks_count
  • created_at
  • ended_at
  • Must be String

offer_repeat_caller
optional

Match calls where the Traffic Source had a repeat caller.

  • Must be one of: true, false.

buyer_repeat_caller
optional

Match calls where the Buyer had a repeat caller.

  • Must be one of: true, false.

buyer_converted
optional

Whether this call's buyer has converted.

  • Must be one of: true, false.

offer_converted
optional

Match calls where the Traffic Source converted.

  • Must be one of: true, false.

in_progress
optional

Match calls that are on-going

  • Must be one of: true, false.

placed_on_hold
optional

translation missing: en.api.calls.placed_on_hold

  • Must be one of: true, false.

has_recording
optional

Match calls that have a recording.

  • Must be one of: true, false.

buyer_conversion_duplicated_call
optional

Match calls where the callerID was a duplicate against the Buyer's conversion settings.

  • Must be one of: true, false.

offer_conversion_duplicated_call
optional

Match calls where the callerID was a duplicate against the Traffic Source's conversion settings.

  • Must be one of: true, false.

no_buyer
optional

Match calls that didn't connect to a Buyer

  • Must be one of: true, false.

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.

  • Must be String

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.

  • Must be String

order
optional

Sort results by this field.

  • Must be one of: direction, number_id, offer_id, traffic_source_id, sub_id, buyer_id, caller_number, updated_at, total_duration, hold_duration, ivr_duration, cost, charge, answered_duration, status, sub_status, buyer_converted, revenue, offer_converted, payout, outgoing_webhooks_count, created_at, end_time, lead_id.

order_dir
optional

Sort results in ascending or descending order.

  • Must be one of: desc, asc.

number_id
optional

Refer to the number api for details

  • Must be a decimal number.

offer_id
optional

Refer to the offer api for details

  • Must be a decimal number.

traffic_source_id
optional

Refer to the traffic source api for details

  • Must be a decimal number.

buyer_id
optional

Refer to the buyer api for details

  • Must be a decimal number.

buyer_group_ids
optional

translation missing: en.api.buyer_group_ids

  • Must be a decimal number.

ring_pool_id
optional

Refer to the ring pool api for details

  • Must be a decimal number.

id
optional

An Integer number eg: 12345

  • Must be a decimal number.

provider_configuration_id
optional

Refer to the provider api for details

  • Must be a decimal number.

contact_id
optional

Match calls that were placed by this caller.

  • Must be a decimal number.

status
optional

Match results that have this status.

  • Must be one of: forwarded, finished, on-hold, no-answer, no-buyer, no-buyer-all-maxed-out, no-buyer-all-filtered, no-buyer-prevent-dupes, not-open, caller-hung-up, rejected, rejected-traffic-source-capped-hang-up, rejected-no-concurrency-cap-available, rejected-caller-concurrency-exceeded, rejected-average-hold-time-exceeded, blocked, failed, hold-queue-waited-too-long.

ended_at_to
optional

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

  • Must be String

ended_at_from
optional

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

  • Must be String


GET /api/v1/calls/stats
Get statistics on calls by category and interval.

Supported Formats

json

Examples

wget "https://[your-subdomain].trackdrive.net/api/v1/calls/stats/?group_by=status&created_at_from=2017-08-17 07:58:10 UTC&created_at_to=2017-08-17 19:58:10 +0000&stat=count&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

group_by
required

Group calls by one of these attributes.

  • Must be one of: buyer_converted, offer_converted, status.

stat
required

Return statistics on the grouped calls by one of these numeric columns.

  • Must be one of: count, revenue, profit, cost.

created_at_to
required

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

  • Must be String

created_at_from
required

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

  • Must be String

page
optional

Return the next page of results.

  • Must be a number.

offer_repeat_caller
optional

Match calls where the Traffic Source had a repeat caller.

  • Must be one of: true, false.

buyer_repeat_caller
optional

Match calls where the Buyer had a repeat caller.

  • Must be one of: true, false.

buyer_converted
optional

Whether this call's buyer has converted.

  • Must be one of: true, false.

offer_converted
optional

Match calls where the Traffic Source converted.

  • Must be one of: true, false.

in_progress
optional

Match calls that are on-going

  • Must be one of: true, false.

placed_on_hold
optional

translation missing: en.api.calls.placed_on_hold

  • Must be one of: true, false.

has_recording
optional

Match calls that have a recording.

  • Must be one of: true, false.

buyer_conversion_duplicated_call
optional

Match calls where the callerID was a duplicate against the Buyer's conversion settings.

  • Must be one of: true, false.

offer_conversion_duplicated_call
optional

Match calls where the callerID was a duplicate against the Traffic Source's conversion settings.

  • Must be one of: true, false.

no_buyer
optional

Match calls that didn't connect to a Buyer

  • Must be one of: true, false.

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.

  • Must be String

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.

  • Must be String

order
optional

Sort results by this field.

  • Must be one of: direction, number_id, offer_id, traffic_source_id, sub_id, buyer_id, caller_number, updated_at, total_duration, hold_duration, ivr_duration, cost, charge, answered_duration, status, sub_status, buyer_converted, revenue, offer_converted, payout, outgoing_webhooks_count, created_at, end_time, lead_id.

order_dir
optional

Sort results in ascending or descending order.

  • Must be one of: desc, asc.

number_id
optional

Refer to the number api for details

  • Must be a decimal number.

offer_id
optional

Refer to the offer api for details

  • Must be a decimal number.

traffic_source_id
optional

Refer to the traffic source api for details

  • Must be a decimal number.

buyer_id
optional

Refer to the buyer api for details

  • Must be a decimal number.

buyer_group_ids
optional

translation missing: en.api.buyer_group_ids

  • Must be a decimal number.

ring_pool_id
optional

Refer to the ring pool api for details

  • Must be a decimal number.

id
optional

An Integer number eg: 12345

  • Must be a decimal number.

provider_configuration_id
optional

Refer to the provider api for details

  • Must be a decimal number.

contact_id
optional

Match calls that were placed by this caller.

  • Must be a decimal number.

status
optional

Match results that have this status.

  • Must be one of: forwarded, finished, on-hold, no-answer, no-buyer, no-buyer-all-maxed-out, no-buyer-all-filtered, no-buyer-prevent-dupes, not-open, caller-hung-up, rejected, rejected-traffic-source-capped-hang-up, rejected-no-concurrency-cap-available, rejected-caller-concurrency-exceeded, rejected-average-hold-time-exceeded, blocked, failed, hold-queue-waited-too-long.

ended_at_to
optional

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

  • Must be String

ended_at_from
optional

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

  • Must be String


GET /api/v1/calls/:uuid
Get a call by id or uuid.

Examples

wget "https://[your-subdomain].trackdrive.net/api/v1/calls/5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1?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

uuid
optional

A unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1

  • Must be String


DELETE /api/v1/calls/:uuid
Hang up an ongoing call.

Examples

curl -i -X DELETE "https://[your-subdomain].trackdrive.net/api/v1/calls/77777777-dbe3-49ee-b28f-115ec80dcef9?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

uuid
optional

A unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1

  • Must be String