API documentation

GET /api/v1/token_matchers
List records.

Params

Param name	Description Validations
offer_id Optional	Translation missing: en.api.token_matchers.offer_id Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
ids Optional	Return records matching these ids. Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Validations: Must be a number.
per_page Optional	How many results to return per page. The default is 25. Validations: Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
fulltext Optional	Search for any record that matches this text Validations: Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Validations: 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 url_param_key owner_id owner_type Validations: 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: {}}` Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /api/v1/token_matchers/new
Build record with defaults.

Params

Param name	Description Validations
offer_id Optional	Assign the record to this Offer. Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
token_key Optional	The internal token name where values are stored. Validations: Must be a String
url_param_key Optional	This URL key will be assigned to a Trackdrive Token. Validations: 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. Validations: Must be a decimal number.

POST /api/v1/token_matchers
Create record.

Params

Param name	Description Validations
offer_id Required	Assign the record to this Offer. Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
token_key Required	The internal token name where values are stored. Validations: Must be a String
url_param_key Required	This URL key will be assigned to a Trackdrive Token. Validations: 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. Validations: Must be a decimal number.

GET /api/v1/token_matchers/:id
Get record by id.

PUT /api/v1/token_matchers/:id
Update record by id.

Params

Param name	Description Validations
token_key Optional	The internal token name where values are stored. Validations: Must be a String
url_param_key Optional	This URL key will be assigned to a Trackdrive Token. Validations: 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. Validations: Must be a decimal number.

DELETE /api/v1/token_matchers/:id
Destroy record by id.