GET /api/v1/buyers
List the buyers in your Trackdrive account.

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

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
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • name
  • context_menu_name
  • number
  • paused
  • time_zone
  • user_buyer_id
  • bid_price
  • route_by_type
  • buyer_type
  • buyer_group_ids
  • buyer_group_names
  • token_values
  • token_values_hash
  • attribution_token_values
  • attribution_token_values_hash
  • 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
  • record_token_filter_id
  • record_token_filter_data_count
  • record_token_filter_data
  • record_token_additional_id
  • record_token_additional_data_count
  • record_token_additional_data
  • 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, revenue_hourly_used, revenue_daily_used, revenue_monthly_used, revenue_total_used, earned_revenue_hourly_used, earned_revenue_daily_used, earned_revenue_monthly_used, earned_revenue_total_used, buyer_conversion_hourly_used, buyer_conversion_daily_used, buyer_conversion_monthly_used, buyer_conversion_total_used, connection_hourly_used, connection_daily_used, connection_monthly_used, connection_total_used, attempt_hourly_used, attempt_daily_used, attempt_monthly_used, attempt_total_used.

order_dir
Optional

Sort results in ascending or descending order.

  • Must be one of: desc, asc.


GET /api/v1/buyers/:id
Get a buyer record by Trackdrive's internal ID.

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

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.

GET /api/v1/buyers/:user_buyer_id/by_user_buyer_id
Get a buyer record by your own external ID for the buyer.

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

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.

PUT /api/v1/buyers/:id
Update a buyer with Trackdrive's internal ID.

Supported Formats

json

Examples

curl -H "Content-Type: application/json" -X PUT -d '{"tier":"-10","name":"new name"}' https://[your-subdomain].trackdrive.net/api/v1/buyers/:id?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

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.
reset_total_caps
Optional
  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

user_buyer_id
Optional

User Buyer

  • Must be String

number
Optional

Number

  • Must be String

name
Optional

Name

  • Must be String

timeout_seconds
Optional

Timeout Seconds

  • Must be a decimal number.

dtmf_tones
Optional Blank Value Allowed

Dtmf Tones

  • Must be String

time_zone
Optional

Date ranges will be parsed using this time zone.

buyer_suppression_ids
Optional Blank Value Allowed

The list of internal suppression id's that will be assigned to this buyer.

paused
Optional

Paused

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

record_calls
Optional

Record Calls

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

press_one_to_accept
Optional Blank Value Allowed

Press One To Accept

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

generate_team
Optional

Grant access to edit this Buyer, and view calls that it paid for.

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

team_users_emails
Optional Blank Value Allowed

The selected users will recieve an email invitation to collaborate on your company.

  • Must be an array of emails. EG: ["john-smith@gmail.com", "example@domain.com"]

team_offer_ids
Optional Blank Value Allowed

Team members can view calls made to these Offers that were paid for by their Buyer.

  • Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

token_values
Optional Blank Value Allowed

Callers will be routed to Buyers with matching tokens.

  • Must be a valid list of filters. Example filters:
    ["interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"]
attribution_token_values
Optional Blank Value Allowed

When this Buyer is connected to a Caller, the Call will be tagged with these tokens.

  • Must be a valid list of tokens. Example tokens:
    ["buyer_interest:loan","another_token:value"]
route_by_type
Optional

Route By Type

  • Must be one of: tier, revenue, epc.

tier
Optional Blank Value Allowed

Tier

  • Must be a decimal number.

epc_timeframe
Optional Blank Value Allowed

Epc Timeframe

  • Must be a decimal number.

epc_assumed_amount
Optional Blank Value Allowed

Epc Assumed Amount

  • Must be a decimal number.

epc_assumed_calls_count
Optional Blank Value Allowed

Epc Assumed Calls Count

  • Must be a decimal number.

weight
Optional Blank Value Allowed

Weight

  • Must be a decimal number.

display_caller_id_type
Optional

Display Caller Id Type

  • Must be one of: display_caller_id, display_fake_caller_id, display_trackdrive_number_id.

display_trackdrive_number_id
Optional Blank Value Allowed

Display Trackdrive Number

concurrency_cap_limit
Optional Blank Value Allowed

Choose the number of concurrent calls that can be forwarded to this buyer simultaneously.

  • Must be a decimal number.

attempt_total_limit
Optional Blank Value Allowed

Attempt caps limit the number of times a buyer can be attempted in a given interval.

  • Must be a decimal number.

attempt_monthly_limit
Optional Blank Value Allowed

Monthly Attempt Cap

  • Must be a decimal number.

attempt_daily_limit
Optional Blank Value Allowed

Daily Attempt Cap

  • Must be a decimal number.

connection_total_limit
Optional Blank Value Allowed

Connection caps limit the number of times a buyer can be connected in a given interval.

  • Must be a decimal number.

connection_monthly_limit
Optional Blank Value Allowed

Monthly Connection Cap

  • Must be a decimal number.

connection_daily_limit
Optional Blank Value Allowed

Daily Connection Cap

  • Must be a decimal number.

buyer_conversion_total_limit
Optional Blank Value Allowed

Conversion caps limit the number of times a buyer can convert in a given interval.

  • Must be a decimal number.

buyer_conversion_monthly_limit
Optional Blank Value Allowed

Monthly Conversion Cap

  • Must be a decimal number.

buyer_conversion_daily_limit
Optional Blank Value Allowed

Daily Conversion Cap

  • Must be a decimal number.

revenue_total_limit
Optional Blank Value Allowed

Revenue caps limit the dollar amount that can be paid by a buyer in a given interval.

  • Must be a decimal number.

revenue_monthly_limit
Optional Blank Value Allowed

Monthly $ Revenue Cap

  • Must be a decimal number.

revenue_daily_limit
Optional Blank Value Allowed

Daily $ Revenue Cap

  • Must be a decimal number.

business_hours_schedule
Optional

[

{
    attempt_hourly_limit: 10,
    connection_hourly_limit: 10,
    buyer_conversion_hourly_limit: 10,
    revenue_hourly_limit: 10,
    schedule: [
        {
            day: 0,
            times: ["11:00..13:09", "14:00..15:09"]
        },
        {
            day: 1,
            times: ["11:10..18:39", "19:10..23:39"]
        }
    ]
}

]

  • Must be an array of any type

buyer_conversions_schedule
Optional

[

{
    buyer_conversions_attributes: [
        {
            name: '10$ conversion at 1 minute, deduped every 2 hours',
            duration: 60,
            revenue: 10,
            duplicate_timeframe: 7200
        }
    ],
    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"]}]
}

]

  • Must be an array of any type

current_conversion_revenue_max
Optional

The maximum valid revenue for the current time frame.

  • Must be a decimal number.

current_conversion_revenue_min
Optional

The minimum valid revenue for the current time frame.

  • Must be a decimal number.

current_conversion_revenue_increment
Optional

Bids must be increased/decreased by this amount for the current time frame.

  • Must be a decimal number.

current_conversion_revenue
Optional

The number of dollars paid per call in increments of $0.01 for the current time frame.

  • Must be a decimal number.

current_conversion_duration
Optional

The number of seconds for a call to payout. If this is set to 0 the call will convert when this buyer is dialed for the current time frame.

  • Must be a decimal number.

current_conversion_duplicate_timeframe
Optional

The period of time that must elapse before a buyer will pay for the same caller to be transferred.

  • Must be a decimal number.

current_conversion_name
Optional

This name that will appear in call logs.

  • Must be String

current_conversion_token_values
Optional Blank Value Allowed

Conversion will only occur if the caller matches these filters.

  • Must be a valid list of filters. Example filters:
    ["interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"]
current_conversion_attribution_token_values
Optional Blank Value Allowed

If the call converts, these tokens will be applied to the call.

  • Must be a valid list of tokens. Example tokens:
    ["buyer_interest:loan","another_token:value"]

GET /api/v1/buyers/new
Build buyer with defaults.

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.

POST /api/v1/buyers
Create a buyer.

Supported Formats

json

Examples

curl -H "Content-Type: application/json" -X POST -d '{"name":"Call Centre 1", number: "+18004457682"}' https://[your-subdomain].trackdrive.net/api/v1/buyers?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

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.
copy_another_buyer
Optional

Copy another buyer?

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

user_buyer_id
Optional

User Buyer

  • Must be String

number
Optional

Number

  • Must be String

name
Optional

Name

  • Must be String

timeout_seconds
Optional

Timeout Seconds

  • Must be a decimal number.

dtmf_tones
Optional Blank Value Allowed

Dtmf Tones

  • Must be String

time_zone
Optional

Date ranges will be parsed using this time zone.

buyer_suppression_ids
Optional Blank Value Allowed

The list of internal suppression id's that will be assigned to this buyer.

paused
Optional

Paused

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

record_calls
Optional

Record Calls

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

press_one_to_accept
Optional Blank Value Allowed

Press One To Accept

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

generate_team
Optional

Grant access to edit this Buyer, and view calls that it paid for.

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

team_users_emails
Optional Blank Value Allowed

The selected users will recieve an email invitation to collaborate on your company.

  • Must be an array of emails. EG: ["john-smith@gmail.com", "example@domain.com"]

team_offer_ids
Optional Blank Value Allowed

Team members can view calls made to these Offers that were paid for by their Buyer.

  • Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

token_values
Optional Blank Value Allowed

Callers will be routed to Buyers with matching tokens.

  • Must be a valid list of filters. Example filters:
    ["interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"]
attribution_token_values
Optional Blank Value Allowed

When this Buyer is connected to a Caller, the Call will be tagged with these tokens.

  • Must be a valid list of tokens. Example tokens:
    ["buyer_interest:loan","another_token:value"]
route_by_type
Optional

Route By Type

  • Must be one of: tier, revenue, epc.

tier
Optional Blank Value Allowed

Tier

  • Must be a decimal number.

epc_timeframe
Optional Blank Value Allowed

Epc Timeframe

  • Must be a decimal number.

epc_assumed_amount
Optional Blank Value Allowed

Epc Assumed Amount

  • Must be a decimal number.

epc_assumed_calls_count
Optional Blank Value Allowed

Epc Assumed Calls Count

  • Must be a decimal number.

weight
Optional Blank Value Allowed

Weight

  • Must be a decimal number.

display_caller_id_type
Optional

Display Caller Id Type

  • Must be one of: display_caller_id, display_fake_caller_id, display_trackdrive_number_id.

display_trackdrive_number_id
Optional Blank Value Allowed

Display Trackdrive Number

concurrency_cap_limit
Optional Blank Value Allowed

Choose the number of concurrent calls that can be forwarded to this buyer simultaneously.

  • Must be a decimal number.

attempt_total_limit
Optional Blank Value Allowed

Attempt caps limit the number of times a buyer can be attempted in a given interval.

  • Must be a decimal number.

attempt_monthly_limit
Optional Blank Value Allowed

Monthly Attempt Cap

  • Must be a decimal number.

attempt_daily_limit
Optional Blank Value Allowed

Daily Attempt Cap

  • Must be a decimal number.

connection_total_limit
Optional Blank Value Allowed

Connection caps limit the number of times a buyer can be connected in a given interval.

  • Must be a decimal number.

connection_monthly_limit
Optional Blank Value Allowed

Monthly Connection Cap

  • Must be a decimal number.

connection_daily_limit
Optional Blank Value Allowed

Daily Connection Cap

  • Must be a decimal number.

buyer_conversion_total_limit
Optional Blank Value Allowed

Conversion caps limit the number of times a buyer can convert in a given interval.

  • Must be a decimal number.

buyer_conversion_monthly_limit
Optional Blank Value Allowed

Monthly Conversion Cap

  • Must be a decimal number.

buyer_conversion_daily_limit
Optional Blank Value Allowed

Daily Conversion Cap

  • Must be a decimal number.

revenue_total_limit
Optional Blank Value Allowed

Revenue caps limit the dollar amount that can be paid by a buyer in a given interval.

  • Must be a decimal number.

revenue_monthly_limit
Optional Blank Value Allowed

Monthly $ Revenue Cap

  • Must be a decimal number.

revenue_daily_limit
Optional Blank Value Allowed

Daily $ Revenue Cap

  • Must be a decimal number.

business_hours_schedule
Optional

[

{
    attempt_hourly_limit: 10,
    connection_hourly_limit: 10,
    buyer_conversion_hourly_limit: 10,
    revenue_hourly_limit: 10,
    schedule: [
        {
            day: 0,
            times: ["11:00..13:09", "14:00..15:09"]
        },
        {
            day: 1,
            times: ["11:10..18:39", "19:10..23:39"]
        }
    ]
}

]

  • Must be an array of any type

buyer_conversions_schedule
Optional

[

{
    buyer_conversions_attributes: [
        {
            name: '10$ conversion at 1 minute, deduped every 2 hours',
            duration: 60,
            revenue: 10,
            duplicate_timeframe: 7200
        }
    ],
    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"]}]
}

]

  • Must be an array of any type

current_conversion_revenue_max
Optional

The maximum valid revenue for the current time frame.

  • Must be a decimal number.

current_conversion_revenue_min
Optional

The minimum valid revenue for the current time frame.

  • Must be a decimal number.

current_conversion_revenue_increment
Optional

Bids must be increased/decreased by this amount for the current time frame.

  • Must be a decimal number.

current_conversion_revenue
Optional

The number of dollars paid per call in increments of $0.01 for the current time frame.

  • Must be a decimal number.

current_conversion_duration
Optional

The number of seconds for a call to payout. If this is set to 0 the call will convert when this buyer is dialed for the current time frame.

  • Must be a decimal number.

current_conversion_duplicate_timeframe
Optional

The period of time that must elapse before a buyer will pay for the same caller to be transferred.

  • Must be a decimal number.

current_conversion_name
Optional

This name that will appear in call logs.

  • Must be String

current_conversion_token_values
Optional Blank Value Allowed

Conversion will only occur if the caller matches these filters.

  • Must be a valid list of filters. Example filters:
    ["interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"]
current_conversion_attribution_token_values
Optional Blank Value Allowed

If the call converts, these tokens will be applied to the call.

  • Must be a valid list of tokens. Example tokens:
    ["buyer_interest:loan","another_token:value"]

DELETE /api/v1/buyers/:id
Delete a buyer with Trackdrive's internal ID.

Supported Formats

json

Examples

curl -H "Content-Type: application/json" -X DELETE "https://[your-subdomain].trackdrive.net/api/v1/buyers/:id?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

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.