API documentation

GET /visitor_token_matchers

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/visitor_token_matchers

List records.

List the Dynamic Number Insertion visitor token matchers defined for your offers, optionally filtered by offer_id.

Params

Param name	Description
offer_id Optional	Filter for records that belong to this Offer. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
ids Optional	Return records matching these ids. Must be an array of decimal values. EG: `[0, 1, 2, 3]`
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 a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
fulltext Optional	Search for any record that matches this text Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Must be a valid time zone. See the list of valid time zones.
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 external_record_id offer_id token key Must be a 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

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/visitor_token_matchers/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "visitor_token_matchers": [
    {
      "id": 10001,
      "type": "VisitorTokenMatcher",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": null,
      "routes_edit_path": null,
      "external_record_id": null,
      "offer_id": 10002,
      "token": "1e563464b25366fb087a2eb291663a65",
      "key": "utm_source"
    },
    {
      "id": 10003,
      "type": "VisitorTokenMatcher",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": null,
      "routes_edit_path": null,
      "external_record_id": null,
      "offer_id": 10002,
      "token": "1e563464b25366fb087a2eb291663a65",
      "key": "utm_campaign"
    }
  ],
  "metadata": {
    "root": "visitor_token_matchers",
    "page": 1,
    "total_pages": 1,
    "per_page": 2,
    "total_count": 2,
    "next_cursor": 10004
  }
}

GET /visitor_token_matchers/new

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/visitor_token_matchers/new

Build record with defaults.

Return a new, unsaved visitor token matcher pre-filled with defaults for the given offer.

Params

Param name	Description
offer_id Optional	Assign the record to this Offer. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
token Optional	The internal token name where values are stored. Must be a String
key Optional	This URL key will be assigned to a Trackdrive Token. Must be a String
sortable_order Optional Blank value allowed	The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first. Must be a decimal number.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/visitor_token_matchers/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "visitor_token_matcher": {
    "id": null,
    "type": "VisitorTokenMatcher",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "offer_id": null,
    "token": null,
    "key": null
  },
  "metadata": {
    "root": "visitor_token_matcher"
  }
}

POST /visitor_token_matchers

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/visitor_token_matchers

Create record.

Create a matcher that maps a URL query parameter (key) to an internal Trackdrive token (token), used with Dynamic Number Insertion to capture values such as ad-click IDs when a visitor lands on a tracked page.

Params

Param name	Description
offer_id Required	Assign the record to this Offer. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
token Required	The internal token name where values are stored. Must be a String
key Required	This URL key will be assigned to a Trackdrive Token. Must be a String
sortable_order Optional Blank value allowed	The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first. Must be a decimal number.

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/visitor_token_matchers/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "offer_id": 10001,
  "key": "example_visitor_key",
  "token": "1e563464b25366fb087a2eb291663a65"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "visitor_token_matcher": {
    "id": 10002,
    "type": "VisitorTokenMatcher",
    "uuid": null,
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "offer_id": 10001,
    "token": "1e563464b25366fb087a2eb291663a65",
    "key": "example_visitor_key"
  },
  "metadata": {
    "root": "visitor_token_matcher"
  }
}

GET /visitor_token_matchers/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/visitor_token_matchers/:id

Get record by id.

Retrieve a single visitor token matcher by id.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/visitor_token_matchers/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "visitor_token_matcher": {
    "id": 10001,
    "type": "VisitorTokenMatcher",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "offer_id": 10002,
    "token": "1e563464b25366fb087a2eb291663a65",
    "key": "utm_source"
  },
  "metadata": {
    "root": "visitor_token_matcher"
  }
}

PUT /visitor_token_matchers/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/visitor_token_matchers/:id

Update record by id.

Change the URL key or the internal token name on an existing visitor token matcher.

Params

Param name	Description
offer_id Optional Blank value allowed	Assign the record to this Offer. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
token Optional	The internal token name where values are stored. Must be a String
key Optional	This URL key will be assigned to a Trackdrive Token. Must be a String
sortable_order Optional Blank value allowed	The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first. Must be a decimal number.

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/visitor_token_matchers/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "token": "1e563464b25366fb087a2eb291663a65"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "visitor_token_matcher": {
    "id": 10001,
    "type": "VisitorTokenMatcher",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "offer_id": 10002,
    "token": "1e563464b25366fb087a2eb291663a65",
    "key": "example_visitor_key"
  },
  "metadata": {
    "root": "visitor_token_matcher"
  }
}

DELETE /visitor_token_matchers/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/visitor_token_matchers/:id

Destroy record by id.

Permanently remove a visitor token matcher.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/visitor_token_matchers/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 204

Params

Must be any combination of:

Params

Params

Params