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, off_hook_buyer_id, qa_buyer_id, offer_id, traffic_source_id, number_id, schedule_id, status, direction, sub_status, provider_configuration_id, contact_id, placed_on_hold, keys_pressed, ring_pool_id, contact_state, contact_country, buyer_converted, offer_converted, contact_field_type.

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:

  • name
  • 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
  • attempted_duration
  • answered_duration
  • user_offer_id
  • user_traffic_source_id
  • user_buyer_id
  • sub_id
  • offer_id
  • schedule_id
  • schedule_name
  • ring_pool_id
  • buyer_id
  • traffic_source_id
  • number_id
  • agent_id
  • status
  • buyer_converted
  • buyer_repeat_caller
  • buyer_revenue
  • revenue
  • traffic_source_converted
  • traffic_source_repeat_caller
  • traffic_source_payout
  • payout
  • trackdrive_cost
  • provider_cost
  • call_sid
  • provider
  • outgoing_webhooks_count
  • created_at
  • ended_at
  • contact_field_type
  • hangup_cause
  • 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

offer_repeat_caller
optional

Match calls where the Traffic Source had a repeat caller.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

buyer_repeat_caller
optional

Match calls where the Buyer had a repeat caller.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

buyer_converted
optional

Did the buyer convert?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

offer_converted
optional

Did the traffic source convert?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

in_progress
optional

Match calls that are on-going

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

placed_on_hold
optional

Was the call placed on hold?

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

has_recording
optional

Match calls that have a recording.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

either_converted
optional

Whether this call's buyer or traffic source has converted.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

buyer_conversion_duplicated_call
optional

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

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

offer_conversion_duplicated_call
optional

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

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

no_buyer
optional

Match calls that didn't connect to a Buyer

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

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, start_app_duration, 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.

schedule_id
optional

Schedule internal id.

  • 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

Buyer Group Internal ids.

  • Must be a decimal number.

ring_pool_id
optional

Refer to the Number 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: added-to-schedule, blocked, busy, caller-hung-up, caller-hung-up-while-ringing-buyer, calling-leads, cancelled, established, failed, finished, forwarded, hold-queue-no-buyer, hold-queue-waited-too-long, initiated, invalid-number, ivr-hung-up, ivr-no-keypress, left-voicemail, no-answer, no-answer-convert-on-attempt, no-buyer, no-buyer-all-filtered, no-route-to-destination, not-open, opt-out, rejected, rejected-caller-concurrency-exceeded, rejected-ivr-hang-up, rejected-no-concurrency-cap-available, rejected-traffic-source-capped-hang-up, voicemail, voicemail-detected.

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