API documentation

GET /offer_conversions

Authorization Required

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

List Traffic Source Payouts.

Lists the Traffic Source Payout rules (conversion-to-payout definitions) configured on offers, filterable by offer_id or business_range_id. Supports CSV export.

Supported Formats

json, csv

Params

Param name Description

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 Value Description
offer_conversion Default response format.
offer_conversion_grid Modern response format that returns various foreign keys for use with other API endpoints.

offer_id
Optional

The Offer this conversion rule belongs to.

Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

business_range_id
Optional

Scopes this conversion rule to calls during this Business Range, instead of the whole Offer.

Must be a valid foreign key reference to an Business Days & Hours. Refer to: /api/docs/1.0/

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
context_menu_name
payout
payout_type
revenue_percentage
duration
duplicate_timeframe
duplicate_timeframe_scope
name
token_values
sortable_order
offer_id
business_range_id
conversion_type
record_token_filter_id
record_token_filter_data_count
record_token_filter_data

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/offer_conversions/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "offer_conversions": [
    {
      "id": 10001,
      "type": "OfferConversion",
      "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,
      "context_menu_name": "TS Payout 10001 120s Connected",
      "payout": 38.0,
      "payout_type": "usd",
      "revenue_percentage": null,
      "duration": 120,
      "duplicate_timeframe": 86400,
      "duplicate_timeframe_scope": "offer",
      "name": "120s Connected",
      "token_values": [],
      "sortable_order": -2,
      "offer_id": 10002,
      "business_range_id": 10003,
      "conversion_type": "payout",
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    },
    {
      "id": 10004,
      "type": "OfferConversion",
      "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,
      "context_menu_name": "TS Payout 10004 120s Connected",
      "payout": 55.0,
      "payout_type": "usd",
      "revenue_percentage": null,
      "duration": 120,
      "duplicate_timeframe": 604800,
      "duplicate_timeframe_scope": "offer",
      "name": "120s Connected",
      "token_values": [],
      "sortable_order": -2,
      "offer_id": 10005,
      "business_range_id": 10006,
      "conversion_type": "payout",
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    }
  ],
  "metadata": {
    "root": "offer_conversions",
    "page": 1,
    "total_pages": 6,
    "per_page": 2,
    "total_count": 12,
    "next_cursor": 10007
  }
}

GET /offer_conversions/new

Authorization Required

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

Build Traffic Source Payout with defaults.

Returns a blank Traffic Source Payout record populated with default attribute values, without saving it.

Params

Param name Description

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 Value Description
offer_conversion Default response format.
offer_conversion_grid Modern response format that returns various foreign keys for use with other API endpoints.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "offer_conversion": {
    "id": null,
    "type": "OfferConversion",
    "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,
    "context_menu_name": "TS Payout  ",
    "payout": null,
    "payout_type": "usd",
    "revenue_percentage": null,
    "duration": null,
    "duplicate_timeframe": null,
    "duplicate_timeframe_scope": "offer",
    "name": null,
    "token_values": [],
    "sortable_order": null,
    "offer_id": null,
    "business_range_id": null,
    "conversion_type": "when_buyer_converted",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "offer_conversion"
  }
}

GET /offer_conversions/:id

Authorization Required

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

Get Traffic Source Payout by id.

Fetches a single Traffic Source Payout by id.

Params

Param name Description

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 Value Description
offer_conversion Default response format.
offer_conversion_grid Modern response format that returns various foreign keys for use with other API endpoints.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "offer_conversion": {
    "id": 10001,
    "type": "OfferConversion",
    "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,
    "context_menu_name": "TS Payout 10001 120s Connected",
    "payout": 38.0,
    "payout_type": "usd",
    "revenue_percentage": null,
    "duration": 120,
    "duplicate_timeframe": 86400,
    "duplicate_timeframe_scope": "offer",
    "name": "120s Connected",
    "token_values": [],
    "sortable_order": -2,
    "offer_id": 10002,
    "business_range_id": 10003,
    "conversion_type": "payout",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "offer_conversion"
  }
}

POST /offer_conversions

Authorization Required

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

Create Traffic Source Payout.

Creates a Traffic Source Payout rule that pays out once a call on the given offer reaches the specified duration, deduping repeat conversions from the same caller within duplicate_timeframe seconds. Set payout_type to usd with a fixed payout amount, or to buyer_conversion_percent with revenue_percentage instead; the matching field is required.

Params

Param name Description

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 Value Description
offer_conversion Default response format.
offer_conversion_grid Modern response format that returns various foreign keys for use with other API endpoints.

payout_type
Optional

Payout Type

Must be one of: usd, buyer_conversion_percent.

payout
Optional Blank value allowed

Payout

Must be a decimal number.

revenue_percentage
Optional Blank value allowed

Revenue Percentage

Must be a decimal number.

duration
Required

Duration

Must be a decimal number.

duplicate_timeframe
Required

Duplicate Timeframe

Must be a decimal number.

duplicate_timeframe_scope
Optional

Duplicate Timeframe Scope

Must be one of: offer, traffic_source, number.

name
Required

Name

Must be a String

offer_id
Required

The Offer this conversion rule belongs to.

Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

business_range_id
Optional Blank value allowed

Scopes this conversion rule to calls during this Business Range, instead of the whole Offer.

Must be a valid foreign key reference to an Business Days & Hours. Refer to: /api/docs/1.0/

conversion_type
Optional Blank value allowed

When the traffic source is paid: payout (after Duration seconds), postback (an external conversion postback), or when_buyer_converted (when a buyer converts the call).

Must be one of: payout, postback, when_buyer_converted.

traffic_source_id
Optional Blank value allowed

Scopes this conversion rule to calls from this Traffic Source, instead of the whole Offer.

Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources

number_id
Optional Blank value allowed

Scopes this conversion rule to calls to this Number, instead of the whole Offer.

Must be a valid foreign key reference to an Number. Refer to: /api/docs/1.0/phone_numbers

owner_id
Optional Blank value allowed

The id of the record given in owner_type that this conversion rule is scoped to, instead of the whole Offer.

Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21

owner_type
Optional Blank value allowed

What this conversion rule is scoped to instead of the whole Offer: TrafficSource, Number, or BusinessRange, used together with owner_id.

Must be a String

token_value_ids
Optional Blank value allowed

Only pays out for calls matching these token values.

Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values

record_token_filter_list
Optional Blank value allowed

Assign filters to the object by passing an array of key:value pairs

Must be a valid list of filters. Example filters:
"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"

sortable_order
Optional

Sortable Order

Must be a decimal number.

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/offer_conversions/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "payout_type": "usd",
  "payout": 10.0,
  "duration": 60,
  "duplicate_timeframe": 3600,
  "duplicate_timeframe_scope": "offer",
  "name": "Example Conversion",
  "offer_id": 10001
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "offer_conversion": {
    "id": 10002,
    "type": "OfferConversion",
    "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,
    "context_menu_name": "TS Payout 10002 Example Conversion",
    "payout": 10.0,
    "payout_type": "usd",
    "revenue_percentage": null,
    "duration": 60,
    "duplicate_timeframe": 3600,
    "duplicate_timeframe_scope": "offer",
    "name": "Example Conversion",
    "token_values": [],
    "sortable_order": -1,
    "offer_id": 10001,
    "business_range_id": null,
    "conversion_type": "payout",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "offer_conversion"
  }
}

PUT /offer_conversions/:id

Authorization Required

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

Update Traffic Source Payout by id.

Updates a Traffic Source Payout rule's duration, payout amount, or dedupe settings. If payout_type is changed, the corresponding payout or revenue_percentage requirement is re-validated.

Params

Param name Description

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 Value Description
offer_conversion Default response format.
offer_conversion_grid Modern response format that returns various foreign keys for use with other API endpoints.

payout_type
Optional

Payout Type

Must be one of: usd, buyer_conversion_percent.

payout
Optional Blank value allowed

Payout

Must be a decimal number.

revenue_percentage
Optional Blank value allowed

Revenue Percentage

Must be a decimal number.

duration
Optional

Duration

Must be a decimal number.

duplicate_timeframe
Optional

Duplicate Timeframe

Must be a decimal number.

duplicate_timeframe_scope
Optional

Duplicate Timeframe Scope

Must be one of: offer, traffic_source, number.

name
Optional

Name

Must be a String

offer_id
Optional Blank value allowed

The Offer this conversion rule belongs to.

Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

business_range_id
Optional Blank value allowed

Scopes this conversion rule to calls during this Business Range, instead of the whole Offer.

Must be a valid foreign key reference to an Business Days & Hours. Refer to: /api/docs/1.0/

conversion_type
Optional Blank value allowed

When the traffic source is paid: payout (after Duration seconds), postback (an external conversion postback), or when_buyer_converted (when a buyer converts the call).

Must be one of: payout, postback, when_buyer_converted.

traffic_source_id
Optional Blank value allowed

Scopes this conversion rule to calls from this Traffic Source, instead of the whole Offer.

Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources

number_id
Optional Blank value allowed

Scopes this conversion rule to calls to this Number, instead of the whole Offer.

Must be a valid foreign key reference to an Number. Refer to: /api/docs/1.0/phone_numbers

owner_id
Optional Blank value allowed

The id of the record given in owner_type that this conversion rule is scoped to, instead of the whole Offer.

Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21

owner_type
Optional Blank value allowed

What this conversion rule is scoped to instead of the whole Offer: TrafficSource, Number, or BusinessRange, used together with owner_id.

Must be a String

token_value_ids
Optional Blank value allowed

Only pays out for calls matching these token values.

Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values

record_token_filter_list
Optional Blank value allowed

Assign filters to the object by passing an array of key:value pairs

Must be a valid list of filters. Example filters:
"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"

sortable_order
Optional Blank value allowed

Sortable Order

Must be a decimal number.

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/offer_conversions/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Conversion (renamed)"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "offer_conversion": {
    "id": 10001,
    "type": "OfferConversion",
    "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,
    "context_menu_name": "TS Payout 10001 Example Conversion (renamed)",
    "payout": 10.0,
    "payout_type": "usd",
    "revenue_percentage": null,
    "duration": 60,
    "duplicate_timeframe": 3600,
    "duplicate_timeframe_scope": "offer",
    "name": "Example Conversion (renamed)",
    "token_values": [],
    "sortable_order": -2,
    "offer_id": 10002,
    "business_range_id": null,
    "conversion_type": "payout",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "offer_conversion"
  }
}

DELETE /offer_conversions/:id

Authorization Required

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

Destroy Traffic Source Payout by id.

Deletes a Traffic Source Payout rule by id.

Params

Param name Description

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 Value Description
offer_conversion Default response format.
offer_conversion_grid Modern response format that returns various foreign keys for use with other API endpoints.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "offer_conversion": {
    "id": 10001,
    "type": "OfferConversion",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": "2026-01-15T15:30:00.000Z",
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "context_menu_name": "TS Payout 10001 Example Conversion",
    "payout": 10.0,
    "payout_type": "usd",
    "revenue_percentage": null,
    "duration": 60,
    "duplicate_timeframe": 3600,
    "duplicate_timeframe_scope": "offer",
    "name": "Example Conversion",
    "token_values": [],
    "sortable_order": -2,
    "offer_id": 10002,
    "business_range_id": null,
    "conversion_type": "payout",
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "offer_conversion"
  }
}