Supported Formats

json, csv

Examples

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

Response Example

{
  "status" : 200,
  "buyer_groups" : [
    {
      "id" : 10001704,
      "created_at" : "2019-01-23T13:20:25.719+00:00",
      "updated_at" : "2019-09-11T17:00:47.206+00:00",
      "user_updated_at" : "2019-01-23T13:20:25.720+00:00",
      "concurrency_cap_limit" : null,
      "concurrency_cap_used" : 0,
      "buyer_ids" : [
        10033187,
        10033325,
        10033326,
        10033327,
        10033328
      ],
      "type" : "BuyerGroup",
      "name" : "All Agents",
      "paused" : false,
      "weight" : null,
      "tier" : null,
      "last_call_at" : null,
      "dial_buyers_type" : "sequentially",
      "attempt_daily_used" : 0,
      "attempt_hourly_used" : 0,
      "attempt_monthly_used" : 0,
      "attempt_total_used" : 126,
      "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" : 29,
      "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" : 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
    },
    {
      "id" : 10001496,
      "created_at" : "2018-04-27T14:28:55.008+00:00",
      "updated_at" : "2019-08-15T05:43:06.200+00:00",
      "user_updated_at" : "2018-04-27T14:28:55.009+00:00",
      "concurrency_cap_limit" : null,
      "concurrency_cap_used" : 0,
      "buyer_ids" : [
        10029770,
        10029771,
        10029772,
        10029774,
        10029773
      ],
      "type" : "BuyerGroup",
      "name" : "Healthcare Reseller Buyer Group",
      "paused" : false,
      "weight" : null,
      "tier" : null,
      "last_call_at" : null,
      "dial_buyers_type" : "sequentially",
      "attempt_daily_used" : 0,
      "attempt_hourly_used" : 0,
      "attempt_monthly_used" : 0,
      "attempt_total_used" : 5,
      "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" : 3,
      "earned_revenue_daily_used" : "0.0",
      "earned_revenue_hourly_used" : "0.0",
      "earned_revenue_monthly_used" : "0.0",
      "earned_revenue_total_used" : "18.0",
      "revenue_daily_used" : 0.0,
      "revenue_hourly_used" : 0.0,
      "revenue_monthly_used" : 0.0,
      "revenue_total_used" : 18.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
    }
  ],
  "metadata" : {
    "root" : "buyer_groups",
    "page" : 1,
    "total_pages" : 0,
    "per_page" : 0,
    "total_count" : 0,
    "next_cursor" : 10001496
  }
}

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 any combination of:

  • id
  • created_at
  • updated_at
  • user_updated_at
  • concurrency_cap_limit
  • concurrency_cap_used
  • buyer_ids
  • type
  • name
  • paused
  • weight
  • tier
  • last_call_at
  • dial_buyers_type
  • 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
  • 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: name, paused, created_at, tier, weight, 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.