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

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

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