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

Supported Formats

json, csv

Examples

curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" "https://[your-subdomain].trackdrive.com/api/v1/calls/reports?category=buyer_id&"

Params

Param name
Description
Validations
category
Required

Validations:

  • Must be a String
page
Optional

Return the next page of results.

Validations:

  • Must be a number.
per_page
Optional

How many results to return per page. The default is 25.

Validations:

  • Must be a number.
created_at_to
Optional

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

Validations:

  • Must be a String
created_at_from
Optional

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

Validations:

  • Must be a String
fulltext
Optional

Search for any record that matches this text

Validations:

  • Must be a String
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:

  • id
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • external_record_id
  • name
  • recording_url
  • category
  • number_called
  • number_id
  • connected_to
  • caller_number
  • offer
  • user_offer_id
  • offer_id
  • quality_assurance_user_id
  • quality_assurance_name
  • quality_assurance_id
  • agent_id
  • traffic_source
  • user_traffic_source_id
  • traffic_source_id
  • buyer
  • user_buyer_id
  • buyer_id
  • obfuscated_caller_number
  • caller_city
  • caller_country
  • token_values
  • total_duration
  • hold_duration
  • ivr_duration
  • attempted_duration
  • answered_duration
  • agent_duration
  • sub_id
  • schedule_id
  • schedule_name
  • ring_pool_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
  • ended_at
  • contact_field_type
  • disposition_id
  • disposition_key
  • disposition_name
  • disposition_notes
  • hangup_cause

Validations:

  • 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: {}}

Validations:

  • 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.

Validations:

  • 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.

Validations:

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

Did the buyer convert?

Validations:

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

Did the traffic source convert?

Validations:

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

Match calls that are on-going

Validations:

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

Was the call placed on hold?

Validations:

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

Match calls that have a recording.

Validations:

  • 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.

Validations:

  • 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.

Validations:

  • 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.

Validations:

  • 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

Validations:

  • 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.

Validations:

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

Validations:

  • Must be a String
order
Optional

Sort results by this field.

Validations:

  • Must be one of: direction, updated_at, start_app_duration, number_id, offer_id, traffic_source_id, sub_id, buyer_id, caller_number, updated_at, total_duration, hold_duration, ivr_duration, third_party_cost, charge_total, answered_duration, agent_duration, 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.

Validations:

  • Must be one of: desc, asc.
number_id
Optional

Refer to the number api for details

Validations:

  • Must be a decimal number.
offer_id
Optional

Refer to the offer api for details

Validations:

  • Must be a decimal number.
schedule_id
Optional

Schedule internal id.

Validations:

  • Must be a decimal number.
traffic_source_id
Optional

Refer to the traffic source api for details

Validations:

  • Must be a decimal number.
buyer_id
Optional

Refer to the buyer api for details

Validations:

  • Must be a decimal number.
buyer_group_ids
Optional

Buyer Group Internal ids.

Validations:

  • Must be a decimal number.
ring_pool_id
Optional

Refer to the Number Pool api for details

Validations:

  • Must be a decimal number.
id
Optional

An Integer number eg: 12345

Validations:

  • Must be a decimal number.
provider_configuration_id
Optional

Refer to the provider api for details

Validations:

  • Must be a decimal number.
contact_id
Optional

Match calls that were placed by this caller.

Validations:

  • Must be a decimal number.
status
Optional

Match results that have this status.

Validations:

  • Must be a String
ended_at_to
Optional

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

Validations:

  • Must be a String
ended_at_from
Optional

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

Validations:

  • Must be a String