Supported Formats

json

Response Example

{
  "status" : 200,
  "leads" : [
    {
      "id" : 11063364,
      "created_at" : "2019-08-11T21:48:07.305+00:00",
      "updated_at" : "2019-08-11T21:50:25.826+00:00",
      "user_updated_at" : null,
      "caller_id" : "+15703280300",
      "email" : "{example_email}",
      "full_name" : "{EXAMPLE_FIRST_NAME} {EXAMPLE_LAST_NAME}",
      "contact_field_type" : "level1",
      "expires_in" : null,
      "country" : "US",
      "state_province" : "PA",
      "zip_postal_code" : "",
      "time_zone" : "America\/New_York",
      "sub_id" : "none",
      "offer_id" : 10007440,
      "schedule_id" : 231,
      "status" : "waiting_to_dial",
      "human_status" : "Waiting To Be Called",
      "css_status" : "warning",
      "has_next_action" : true,
      "opt_out" : null,
      "revenue" : null,
      "payout" : null,
      "offer_converted" : null,
      "buyer_converted" : null,
      "traffic_source_id" : null,
      "buyer_id" : null,
      "lead_import_id" : null,
      "attempted_call_id" : null,
      "connected_call_id" : null,
      "scheduled_callback_id" : null,
      "call_buyer_conversion_id" : null,
      "call_offer_conversion_id" : null,
      "sms_number_id" : 14812357,
      "dial_number_id" : 14812357,
      "dial_tier" : 0,
      "last_action_at" : "2019-08-11T21:48:31.550+00:00",
      "first_action_at" : "2019-08-11T21:48:19.885+00:00",
      "first_queued_at" : "2019-08-11T21:48:19.885+00:00",
      "schedule_ended_at" : null,
      "next_action_at" : "2019-09-05T18:04:41.916+00:00",
      "last_call_at" : null,
      "is_live" : true,
      "schedule_trigger_type" : null,
      "blocked" : false,
      "type" : "Lead",
      "data" : {
        "checkbox" : "on",
        "name" : "carmine Falletta",
        "ip" : "207.237.186.4",
        "landing" : "TrackDrive Scehduler",
        "phone" : "570-328-0300",
        "text" : "mobinity",
        "select" : "Agent 1",
        "city" : "{EXAMPLE_CITY}",
        "first_name" : "{EXAMPLE_FIRST_NAME}",
        "last_name" : "{EXAMPLE_LAST_NAME}",
        "zip" : "{EXAMPLE_ZIP}",
        "primary_phone" : "{EXAMPLE_PRIMARY_PHONE}",
        "slc_attending_school" : "{EXAMPLE_SLC_ATTENDING_SCHOOL}",
        "slc_employed" : "{EXAMPLE_SLC_EMPLOYED}",
        "state" : "{EXAMPLE_STATE}",
        "slc_type_of_debt" : "{EXAMPLE_SLC_TYPE_OF_DEBT}",
        "slc_payment_status" : "{EXAMPLE_SLC_PAYMENT_STATUS}",
        "address" : "{EXAMPLE_ADDRESS}",
        "is_verified" : "{EXAMPLE_IS_VERIFIED}",
        "slc_federal_debt_amount" : "{EXAMPLE_SLC_FEDERAL_DEBT_AMOUNT}"
      },
      "worker_processed_at" : "2019-10-14T21:57:12.618+00:00",
      "checkbox" : "on",
      "name" : "carmine Falletta",
      "ip" : "207.237.186.4",
      "landing" : "TrackDrive Scehduler",
      "phone" : "570-328-0300",
      "text" : "mobinity",
      "select" : "Agent 1",
      "city" : "{EXAMPLE_CITY}",
      "first_name" : "{EXAMPLE_FIRST_NAME}",
      "last_name" : "{EXAMPLE_LAST_NAME}",
      "zip" : "{EXAMPLE_ZIP}",
      "primary_phone" : "{EXAMPLE_PRIMARY_PHONE}",
      "slc_attending_school" : "{EXAMPLE_SLC_ATTENDING_SCHOOL}",
      "slc_employed" : "{EXAMPLE_SLC_EMPLOYED}",
      "state" : "{EXAMPLE_STATE}",
      "slc_type_of_debt" : "{EXAMPLE_SLC_TYPE_OF_DEBT}",
      "slc_payment_status" : "{EXAMPLE_SLC_PAYMENT_STATUS}",
      "address" : "{EXAMPLE_ADDRESS}",
      "is_verified" : "{EXAMPLE_IS_VERIFIED}",
      "slc_federal_debt_amount" : "{EXAMPLE_SLC_FEDERAL_DEBT_AMOUNT}"
    },
    {
      "id" : 11063362,
      "created_at" : "2019-08-11T21:46:09.200+00:00",
      "updated_at" : "2019-08-11T21:48:18.415+00:00",
      "user_updated_at" : null,
      "caller_id" : "+13039852700",
      "email" : "{example_email}",
      "full_name" : "{EXAMPLE_FIRST_NAME} {EXAMPLE_LAST_NAME}",
      "contact_field_type" : "level1",
      "expires_in" : null,
      "country" : "US",
      "state_province" : "CO",
      "zip_postal_code" : "",
      "time_zone" : "America\/Denver",
      "sub_id" : "none",
      "offer_id" : 10007440,
      "schedule_id" : 231,
      "status" : "waiting_to_dial",
      "human_status" : "Waiting To Be Called",
      "css_status" : "warning",
      "has_next_action" : true,
      "opt_out" : null,
      "revenue" : null,
      "payout" : null,
      "offer_converted" : null,
      "buyer_converted" : null,
      "traffic_source_id" : null,
      "buyer_id" : null,
      "lead_import_id" : null,
      "attempted_call_id" : null,
      "connected_call_id" : null,
      "scheduled_callback_id" : null,
      "call_buyer_conversion_id" : null,
      "call_offer_conversion_id" : null,
      "sms_number_id" : 14812357,
      "dial_number_id" : 14812357,
      "dial_tier" : 0,
      "last_action_at" : "2019-08-11T21:46:26.977+00:00",
      "first_action_at" : "2019-08-11T21:46:17.567+00:00",
      "first_queued_at" : "2019-08-11T21:46:17.567+00:00",
      "schedule_ended_at" : null,
      "next_action_at" : "2019-09-05T18:06:26.249+00:00",
      "last_call_at" : null,
      "is_live" : true,
      "schedule_trigger_type" : null,
      "blocked" : false,
      "type" : "Lead",
      "data" : {
        "checkbox" : "on",
        "name" : "Dakota Neel",
        "ip" : "207.237.186.4",
        "landing" : "TrackDrive Scehduler",
        "phone" : "303-985-2700",
        "text" : "adperio",
        "select" : "Agent 1",
        "city" : "{EXAMPLE_CITY}",
        "first_name" : "{EXAMPLE_FIRST_NAME}",
        "last_name" : "{EXAMPLE_LAST_NAME}",
        "zip" : "{EXAMPLE_ZIP}",
        "primary_phone" : "{EXAMPLE_PRIMARY_PHONE}",
        "slc_attending_school" : "{EXAMPLE_SLC_ATTENDING_SCHOOL}",
        "slc_employed" : "{EXAMPLE_SLC_EMPLOYED}",
        "state" : "{EXAMPLE_STATE}",
        "slc_type_of_debt" : "{EXAMPLE_SLC_TYPE_OF_DEBT}",
        "slc_payment_status" : "{EXAMPLE_SLC_PAYMENT_STATUS}",
        "address" : "{EXAMPLE_ADDRESS}",
        "is_verified" : "{EXAMPLE_IS_VERIFIED}",
        "slc_federal_debt_amount" : "{EXAMPLE_SLC_FEDERAL_DEBT_AMOUNT}"
      },
      "worker_processed_at" : "2019-10-14T21:57:14.532+00:00",
      "checkbox" : "on",
      "name" : "Dakota Neel",
      "ip" : "207.237.186.4",
      "landing" : "TrackDrive Scehduler",
      "phone" : "303-985-2700",
      "text" : "adperio",
      "select" : "Agent 1",
      "city" : "{EXAMPLE_CITY}",
      "first_name" : "{EXAMPLE_FIRST_NAME}",
      "last_name" : "{EXAMPLE_LAST_NAME}",
      "zip" : "{EXAMPLE_ZIP}",
      "primary_phone" : "{EXAMPLE_PRIMARY_PHONE}",
      "slc_attending_school" : "{EXAMPLE_SLC_ATTENDING_SCHOOL}",
      "slc_employed" : "{EXAMPLE_SLC_EMPLOYED}",
      "state" : "{EXAMPLE_STATE}",
      "slc_type_of_debt" : "{EXAMPLE_SLC_TYPE_OF_DEBT}",
      "slc_payment_status" : "{EXAMPLE_SLC_PAYMENT_STATUS}",
      "address" : "{EXAMPLE_ADDRESS}",
      "is_verified" : "{EXAMPLE_IS_VERIFIED}",
      "slc_federal_debt_amount" : "{EXAMPLE_SLC_FEDERAL_DEBT_AMOUNT}"
    }
  ],
  "totals" : {
    "full_name" : 213,
    "revenue" : 20.0,
    "payout" : 0.0,
    "is_live" : 192,
    "buyer_converted" : 2,
    "offer_converted" : 2
  },
  "metadata" : {
    "root" : "leads",
    "page" : 1,
    "total_pages" : 107,
    "per_page" : 2,
    "total_count" : 213,
    "next_cursor" : 11063362
  }
}

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.

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

created_at_label
optional , nil allowed

translation missing: en.api.created_at_label

  • Must be one of: Last 5 Min, Last 15 Min, Last 30 Min, Last Hour, Last 4 Hours, Last 6 Hours, Last 12 Hours, Last Day, Last 2 Days, Today, Yesterday, This Week, Last Week, This Month, Last Month, This Quarter, Last Quarter, Last 6 Months, This Year, Last Year, Custom Range.

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 String

status_wait
optional

Filter for leads that are waiting before performing an action.

  • Must be String

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