Supported Formats

json

Params

Param name
Description
auth_token
optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

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, International Date Line West, Midway Island, American Samoa, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Mountain Time (US & Canada), Arizona, Chihuahua, Mazatlan, Central Time (US & Canada), Saskatchewan, Guadalajara, Mexico City, Monterrey, Central America, Eastern Time (US & Canada), Indiana (East), Bogota, Lima, Quito, Atlantic Time (Canada), Caracas, La Paz, Santiago, Newfoundland, Brasilia, Buenos Aires, Montevideo, Georgetown, Greenland, Mid-Atlantic, Azores, Cape Verde Is., Dublin, Edinburgh, Lisbon, London, Casablanca, Monrovia, UTC, Belgrade, Bratislava, Budapest, Ljubljana, Prague, Sarajevo, Skopje, Warsaw, Zagreb, Brussels, Copenhagen, Madrid, Paris, Amsterdam, Berlin, Bern, Zurich, Rome, Stockholm, Vienna, West Central Africa, Bucharest, Cairo, Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, Athens, Istanbul, Minsk, Jerusalem, Harare, Pretoria, Kaliningrad, Moscow, St. Petersburg, Volgograd, Samara, Kuwait, Riyadh, Nairobi, Baghdad, Tehran, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Kathmandu, Astana, Dhaka, Sri Jayawardenepura, Almaty, Novosibirsk, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Beijing, Chongqing, Hong Kong, Urumqi, Kuala Lumpur, Singapore, Taipei, Perth, Irkutsk, Ulaanbaatar, Seoul, Osaka, Sapporo, Tokyo, Yakutsk, Darwin, Adelaide, Canberra, Melbourne, Sydney, Brisbane, Hobart, Vladivostok, Guam, Port Moresby, Magadan, Srednekolymsk, Solomon Is., New Caledonia, Fiji, Kamchatka, Marshall Is., Auckland, Wellington, Nuku'alofa, Tokelau Is., Chatham Is., Samoa.

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

next_action_at_to
optional

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

  • Must be String

next_action_at_from
optional

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

  • Must be String

offer_id
optional

Refer to the offer api for details

schedule_id
optional

Schedule internal id.

contact_id
optional

Match calls that were placed by this caller.

traffic_source_id
optional

Refer to the traffic source api for details

buyer_id
optional

Refer to the buyer api for details

status
optional

Match results that have this status.

  • Must be one of: scheduled, waiting, waiting_for_schedule_to_open, running, queue, success, completed, completed_attempted, completed_connected, completed_converted, completed_with_one_call, completed_with_many_calls, exceeded_max_calls, exceeded_short_calls, dnc, failure, disabled, blocked, opt_out.

status_wait
optional

Filter for leads that are waiting before performing an action.

  • Must be one of: calls_on_hold_available, active_cc_available, no_schedule_number, ongoing_call, when_buyer_available, when_buyer_would_convert, off_hook_no_buyer_available, off_hook_not_enough_leads_queued, off_hook_no_seats_available.

number
optional

Filter for leads matching this callerid.

  • Must be String

email
optional

The email address for the lead. The lead's email is required for sending emails from schedules to leads.

  • Must be String

has_next_action
optional

Filter for leads that have more actions to perform.

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

buyer_converted
optional

Select leads that have converted.

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

offer_converted
optional

Select leads where a traffic source converted.

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

either_converted
optional

Select leads where either a buyer or traffic source converted.

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

opt_out
optional

Select leads that have opted-out.

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