Supported Formats

json, csv

Examples

wget "https://[your-subdomain].trackdrive.net/api/v1/buyers?page=1&order=created_at&auth_token=[your-auth-token]"

Response Example

{
  "status" : 200,
  "success" : true,
  "buyers" : [
    {
      "id" : 10056640,
      "type" : "Buyer",
      "created_at" : "2020-02-08T17:21:41.129+00:00",
      "updated_at" : "2020-05-24T18:11:21.036+00:00",
      "user_updated_at" : "2020-04-24T23:16:28.875+00:00",
      "routes_show_path" : "\/buyers\/10056640",
      "routes_edit_path" : "\/buyers\/10056640\/edit",
      "name" : "DEF Lending",
      "number" : "+17195220377",
      "paused" : false,
      "time_zone" : "Eastern Time (US & Canada)",
      "user_buyer_id" : "123876",
      "bid_price" : 30.0,
      "route_by_type" : "epc",
      "buyer_type" : "buyer",
      "buyer_group_ids" : [],
      "buyer_group_names" : [],
      "token_values" : [],
      "context_menu_name" : "123876 - DEF Lending - +17195220377",
      "last_call_at" : "2020-05-21T20:52:33.943+00:00",
      "weight" : 1,
      "tier" : -25.0,
      "timeout_seconds" : 15,
      "dtmf_tones" : "WWw1ww[caller_zip]",
      "concurrency_cap_limit" : 50,
      "concurrency_cap_used" : 0,
      "maxed_out_by" : "f",
      "current_conversion_revenue_max" : 40.0,
      "current_conversion_revenue_min" : 30.0,
      "current_conversion_revenue_increment" : "0.25",
      "current_conversion_revenue" : 30.0,
      "current_conversion_duration" : 60,
      "current_conversion_duplicate_timeframe" : 2592000,
      "current_conversion_name" : "Traffic Sources for higher pay",
      "current_conversion_token_value_ids" : [
        546606192,
        546606326
      ],
      "current_conversion_attribution_token_value_ids" : [],
      "buyer_suppression_ids" : [],
      "attempt_daily_used" : 0,
      "attempt_hourly_used" : 0,
      "attempt_monthly_used" : 0,
      "attempt_total_used" : 4,
      "buyer_conversion_daily_used" : 0,
      "buyer_conversion_hourly_used" : 0,
      "buyer_conversion_monthly_used" : 0,
      "buyer_conversion_total_used" : 0,
      "connection_daily_used" : 0,
      "connection_hourly_used" : 0,
      "connection_monthly_used" : 0,
      "connection_total_used" : 1,
      "earned_revenue_daily_used" : "0.0",
      "earned_revenue_hourly_used" : "0.0",
      "earned_revenue_monthly_used" : "0.0",
      "earned_revenue_total_used" : "0.0",
      "revenue_daily_used" : 0.0,
      "revenue_hourly_used" : 0.0,
      "revenue_monthly_used" : 0.0,
      "revenue_total_used" : 0.0,
      "attempt_daily_limit" : null,
      "attempt_hourly_limit" : null,
      "attempt_monthly_limit" : null,
      "attempt_total_limit" : null,
      "buyer_conversion_daily_limit" : 100,
      "buyer_conversion_hourly_limit" : null,
      "buyer_conversion_monthly_limit" : null,
      "buyer_conversion_total_limit" : null,
      "connection_daily_limit" : null,
      "connection_hourly_limit" : null,
      "connection_monthly_limit" : null,
      "connection_total_limit" : null,
      "earned_revenue_daily_limit" : null,
      "earned_revenue_hourly_limit" : null,
      "earned_revenue_monthly_limit" : null,
      "earned_revenue_total_limit" : null,
      "revenue_daily_limit" : null,
      "revenue_hourly_limit" : null,
      "revenue_monthly_limit" : null,
      "revenue_total_limit" : 5000.0,
      "business_hours_schedule" : [
        {
          "attempt_hourly_limit" : null,
          "connection_hourly_limit" : null,
          "buyer_conversion_hourly_limit" : null,
          "revenue_hourly_limit" : null,
          "concurrency_limit" : 10,
          "schedule" : [
            {
              "day" : 1,
              "times" : [
                "17:00..20:59"
              ]
            },
            {
              "day" : 2,
              "times" : [
                "17:00..20:59"
              ]
            },
            {
              "day" : 3,
              "times" : [
                "17:00..20:59"
              ]
            },
            {
              "day" : 4,
              "times" : [
                "17:00..20:59"
              ]
            },
            {
              "day" : 5,
              "times" : [
                "17:00..20:59"
              ]
            }
          ]
        },
        {
          "attempt_hourly_limit" : null,
          "connection_hourly_limit" : null,
          "buyer_conversion_hourly_limit" : null,
          "revenue_hourly_limit" : null,
          "concurrency_limit" : 25,
          "schedule" : [
            {
              "day" : 1,
              "times" : [
                "12:00..13:59"
              ]
            },
            {
              "day" : 2,
              "times" : [
                "12:00..13:59"
              ]
            },
            {
              "day" : 3,
              "times" : [
                "12:00..13:59"
              ]
            },
            {
              "day" : 4,
              "times" : [
                "12:00..13:59"
              ]
            },
            {
              "day" : 5,
              "times" : [
                "12:00..13:59"
              ]
            }
          ]
        },
        {
          "attempt_hourly_limit" : null,
          "connection_hourly_limit" : null,
          "buyer_conversion_hourly_limit" : null,
          "revenue_hourly_limit" : null,
          "concurrency_limit" : 50,
          "schedule" : [
            {
              "day" : 1,
              "times" : [
                "08:00..11:59",
                "14:00..16:59"
              ]
            },
            {
              "day" : 2,
              "times" : [
                "08:00..11:59",
                "14:00..16:59"
              ]
            },
            {
              "day" : 3,
              "times" : [
                "08:00..11:59",
                "14:00..16:59"
              ]
            },
            {
              "day" : 4,
              "times" : [
                "08:00..11:59",
                "14:00..16:59"
              ]
            },
            {
              "day" : 5,
              "times" : [
                "08:00..11:59",
                "14:00..16:59"
              ]
            },
            {
              "day" : 6,
              "times" : [
                "08:00..11:59"
              ]
            }
          ]
        }
      ],
      "buyer_conversions_schedule" : [
        {
          "buyer_conversions_attributes" : [
            {
              "name" : "Traffic Sources for higher pay",
              "duration" : 60,
              "revenue" : 30.0,
              "duplicate_timeframe" : 2592000,
              "revenue_min" : 30.0,
              "revenue_max" : 40.0,
              "revenue_increment" : "0.25"
            },
            {
              "name" : "Default Revenue",
              "duration" : 60,
              "revenue" : 25.0,
              "duplicate_timeframe" : 2592000,
              "revenue_min" : 25.0,
              "revenue_max" : 35.0,
              "revenue_increment" : "0.25"
            }
          ],
          "schedule" : [
            {
              "day" : 0,
              "times" : [
                "00:00..23:59"
              ]
            },
            {
              "day" : 1,
              "times" : [
                "00:00..23:59"
              ]
            },
            {
              "day" : 2,
              "times" : [
                "00:00..23:59"
              ]
            },
            {
              "day" : 3,
              "times" : [
                "00:00..23:59"
              ]
            },
            {
              "day" : 4,
              "times" : [
                "00:00..23:59"
              ]
            },
            {
              "day" : 5,
              "times" : [
                "00:00..23:59"
              ]
            },
            {
              "day" : 6,
              "times" : [
                "00:00..23:59"
              ]
            }
          ]
        }
      ]
    },
    {
      "id" : 10054663,
      "type" : "Buyer",
      "created_at" : "2019-12-18T17:19:04.038+00:00",
      "updated_at" : "2020-05-24T18:11:11.952+00:00",
      "user_updated_at" : "2020-04-24T23:17:11.968+00:00",
      "routes_show_path" : "\/buyers\/10054663",
      "routes_edit_path" : "\/buyers\/10054663\/edit",
      "name" : "Blake Cell for testing",
      "number" : "+17194451505",
      "paused" : true,
      "time_zone" : "Eastern Time (US & Canada)",
      "user_buyer_id" : "blakecell",
      "bid_price" : 10.0,
      "route_by_type" : "tier",
      "buyer_type" : "buyer",
      "buyer_group_ids" : [],
      "buyer_group_names" : [],
      "token_values" : [
        "is_verified:yes"
      ],
      "context_menu_name" : "blakecell - Blake Cell for testing - +17194451505",
      "last_call_at" : "2019-12-18T17:27:15.871+00:00",
      "weight" : 1,
      "tier" : -10.0,
      "timeout_seconds" : 30,
      "dtmf_tones" : null,
      "concurrency_cap_limit" : 50,
      "concurrency_cap_used" : 0,
      "maxed_out_by" : "f",
      "current_conversion_revenue_max" : null,
      "current_conversion_revenue_min" : null,
      "current_conversion_revenue_increment" : "0.01",
      "current_conversion_revenue" : 10.0,
      "current_conversion_duration" : 60,
      "current_conversion_duplicate_timeframe" : 86400,
      "current_conversion_name" : "10 \/ 60 sec \/ 1 day",
      "current_conversion_token_value_ids" : null,
      "current_conversion_attribution_token_value_ids" : null,
      "buyer_suppression_ids" : [],
      "attempt_daily_used" : 0,
      "attempt_hourly_used" : 0,
      "attempt_monthly_used" : 0,
      "attempt_total_used" : 1,
      "buyer_conversion_daily_used" : 0,
      "buyer_conversion_hourly_used" : 0,
      "buyer_conversion_monthly_used" : 0,
      "buyer_conversion_total_used" : 1,
      "connection_daily_used" : 0,
      "connection_hourly_used" : 0,
      "connection_monthly_used" : 0,
      "connection_total_used" : 1,
      "earned_revenue_daily_used" : "0.0",
      "earned_revenue_hourly_used" : "0.0",
      "earned_revenue_monthly_used" : "0.0",
      "earned_revenue_total_used" : "10.0",
      "revenue_daily_used" : 0.0,
      "revenue_hourly_used" : 0.0,
      "revenue_monthly_used" : 0.0,
      "revenue_total_used" : 10.0,
      "attempt_daily_limit" : null,
      "attempt_hourly_limit" : null,
      "attempt_monthly_limit" : null,
      "attempt_total_limit" : null,
      "buyer_conversion_daily_limit" : null,
      "buyer_conversion_hourly_limit" : null,
      "buyer_conversion_monthly_limit" : null,
      "buyer_conversion_total_limit" : null,
      "connection_daily_limit" : null,
      "connection_hourly_limit" : null,
      "connection_monthly_limit" : null,
      "connection_total_limit" : null,
      "earned_revenue_daily_limit" : null,
      "earned_revenue_hourly_limit" : null,
      "earned_revenue_monthly_limit" : null,
      "earned_revenue_total_limit" : null,
      "revenue_daily_limit" : null,
      "revenue_hourly_limit" : null,
      "revenue_monthly_limit" : null,
      "revenue_total_limit" : null,
      "business_hours_schedule" : [
        {
          "attempt_hourly_limit" : null,
          "connection_hourly_limit" : null,
          "buyer_conversion_hourly_limit" : null,
          "revenue_hourly_limit" : null,
          "concurrency_limit" : 10,
          "schedule" : [
            {
              "day" : 1,
              "times" : [
                "17:00..20:59"
              ]
            },
            {
              "day" : 2,
              "times" : [
                "17:00..20:59"
              ]
            },
            {
              "day" : 3,
              "times" : [
                "17:00..20:59"
              ]
            },
            {
              "day" : 4,
              "times" : [
                "17:00..20:59"
              ]
            },
            {
              "day" : 5,
              "times" : [
                "17:00..20:59"
              ]
            }
          ]
        },
        {
          "attempt_hourly_limit" : null,
          "connection_hourly_limit" : null,
          "buyer_conversion_hourly_limit" : null,
          "revenue_hourly_limit" : null,
          "concurrency_limit" : 25,
          "schedule" : [
            {
              "day" : 1,
              "times" : [
                "12:00..13:59"
              ]
            },
            {
              "day" : 2,
              "times" : [
                "12:00..13:59"
              ]
            },
            {
              "day" : 3,
              "times" : [
                "12:00..13:59"
              ]
            },
            {
              "day" : 4,
              "times" : [
                "12:00..13:59"
              ]
            },
            {
              "day" : 5,
              "times" : [
                "12:00..13:59"
              ]
            }
          ]
        },
        {
          "attempt_hourly_limit" : null,
          "connection_hourly_limit" : null,
          "buyer_conversion_hourly_limit" : null,
          "revenue_hourly_limit" : null,
          "concurrency_limit" : 50,
          "schedule" : [
            {
              "day" : 1,
              "times" : [
                "08:00..11:59",
                "14:00..16:59"
              ]
            },
            {
              "day" : 2,
              "times" : [
                "08:00..11:59",
                "14:00..16:59"
              ]
            },
            {
              "day" : 3,
              "times" : [
                "08:00..11:59",
                "14:00..16:59"
              ]
            },
            {
              "day" : 4,
              "times" : [
                "08:00..11:59",
                "14:00..16:59"
              ]
            },
            {
              "day" : 5,
              "times" : [
                "08:00..11:59",
                "14:00..16:59"
              ]
            },
            {
              "day" : 6,
              "times" : [
                "08:00..11:59"
              ]
            }
          ]
        }
      ],
      "buyer_conversions_schedule" : [
        {
          "buyer_conversions_attributes" : [
            {
              "name" : "10 \/ 60 sec \/ 1 day",
              "duration" : 60,
              "revenue" : 10.0,
              "duplicate_timeframe" : 86400,
              "revenue_min" : null,
              "revenue_max" : null,
              "revenue_increment" : "0.01"
            }
          ],
          "schedule" : [
            {
              "day" : 0,
              "times" : [
                "00:00..23:59"
              ]
            },
            {
              "day" : 1,
              "times" : [
                "00:00..23:59"
              ]
            },
            {
              "day" : 2,
              "times" : [
                "00:00..23:59"
              ]
            },
            {
              "day" : 3,
              "times" : [
                "00:00..23:59"
              ]
            },
            {
              "day" : 4,
              "times" : [
                "00:00..23:59"
              ]
            },
            {
              "day" : 5,
              "times" : [
                "00:00..23:59"
              ]
            },
            {
              "day" : 6,
              "times" : [
                "00:00..23:59"
              ]
            }
          ]
        }
      ]
    }
  ],
  "metadata" : {
    "root" : "buyers",
    "page" : 1,
    "total_pages" : 6,
    "per_page" : 2,
    "total_count" : 11,
    "next_cursor" : 10054663
  }
}

Params

Param name
Description
auth_token
Optional

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

  • Must be String

serializer
Optional Blank Value Allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    buyerDefault response format.
    buyer_gridModern response format that returns various foreign keys for use with other API endpoints.
number
Optional

Filter buyers for a telephone number.

  • Must be String

paused
Optional

Filter buyers that are either paused or unpaused.

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

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:

  • id
  • type
  • created_at
  • updated_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • name
  • number
  • paused
  • time_zone
  • user_buyer_id
  • bid_price
  • route_by_type
  • buyer_type
  • buyer_group_ids
  • buyer_group_names
  • token_values
  • context_menu_name
  • last_call_at
  • weight
  • tier
  • timeout_seconds
  • dtmf_tones
  • concurrency_cap_limit
  • concurrency_cap_used
  • maxed_out_by
  • current_conversion_revenue_max
  • current_conversion_revenue_min
  • current_conversion_revenue_increment
  • current_conversion_revenue
  • current_conversion_duration
  • current_conversion_duplicate_timeframe
  • current_conversion_name
  • current_conversion_token_value_ids
  • current_conversion_attribution_token_value_ids
  • buyer_suppression_ids
  • attempt_daily_used
  • attempt_hourly_used
  • attempt_monthly_used
  • attempt_total_used
  • buyer_conversion_daily_used
  • buyer_conversion_hourly_used
  • buyer_conversion_monthly_used
  • buyer_conversion_total_used
  • connection_daily_used
  • connection_hourly_used
  • connection_monthly_used
  • connection_total_used
  • earned_revenue_daily_used
  • earned_revenue_hourly_used
  • earned_revenue_monthly_used
  • earned_revenue_total_used
  • revenue_daily_used
  • revenue_hourly_used
  • revenue_monthly_used
  • revenue_total_used
  • attempt_daily_limit
  • attempt_hourly_limit
  • attempt_monthly_limit
  • attempt_total_limit
  • buyer_conversion_daily_limit
  • buyer_conversion_hourly_limit
  • buyer_conversion_monthly_limit
  • buyer_conversion_total_limit
  • connection_daily_limit
  • connection_hourly_limit
  • connection_monthly_limit
  • connection_total_limit
  • earned_revenue_daily_limit
  • earned_revenue_hourly_limit
  • earned_revenue_monthly_limit
  • earned_revenue_total_limit
  • revenue_daily_limit
  • revenue_hourly_limit
  • revenue_monthly_limit
  • revenue_total_limit
  • business_hours_schedule
  • buyer_conversions_schedule
  • 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

order
Optional

Sort results by this field.

  • Must be one of: id, name, calls_count, recent_calls_count, paused, number, created_at, last_call_at, tier, weight, time_zone, user_buyer_id, call_limits.in_progress_count, call_limits.in_progress_used, call_limits.revenue_hourly_used, call_limits.revenue_daily_used, call_limits.revenue_monthly_used, call_limits.revenue_total_used, call_limits.earned_revenue_hourly_used, call_limits.earned_revenue_daily_used, call_limits.earned_revenue_monthly_used, call_limits.earned_revenue_total_used, call_limits.buyer_conversion_hourly_used, call_limits.buyer_conversion_daily_used, call_limits.buyer_conversion_monthly_used, call_limits.buyer_conversion_total_used, call_limits.connection_hourly_used, call_limits.connection_daily_used, call_limits.connection_monthly_used, call_limits.connection_total_used, call_limits.attempt_hourly_used, call_limits.attempt_daily_used, call_limits.attempt_monthly_used, call_limits.attempt_total_used.

order_dir
Optional

Sort results in ascending or descending order.

  • Must be one of: desc, asc.