Supported Formats

json, csv

Examples

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

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.

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
  • name
  • number
  • paused
  • time_zone
  • user_buyer_id
  • bid_price
  • route_by_type
  • buyer_group_ids
  • token_values
  • last_call_at
  • weight
  • tier
  • timeout_seconds
  • dtmf_tones
  • concurrency_cap_limit
  • concurrency_cap_used
  • 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

order
optional

Sort results by this field.

  • Must be one of: name, 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.