Offers: Traffic Source Payouts API resource for managing Traffic Source Payouts.

GET /api/v1/offer_conversions
List Traffic Source Payouts.

Supported Formats

json, csv

Examples

curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" "https://[your-subdomain].trackdrive.com/api/v1/offer_conversions?page=1&order=created_at"

Params

Param name
Description
Validations
serializer
Optional Blank Value Allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

Validations:

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    offer_conversionDefault response format.
    offer_conversion_gridModern response format that returns various foreign keys for use with other API endpoints.
offer_id
Optional

Offer

Validations:
business_range_id
Optional

Business Range

Validations:
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:
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
  • 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

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/offer_conversions/new
Build Traffic Source Payout with defaults.

Params

Param name
Description
Validations
serializer
Optional Blank Value Allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

Validations:

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    offer_conversionDefault response format.
    offer_conversion_gridModern response format that returns various foreign keys for use with other API endpoints.

GET /api/v1/offer_conversions/:id
Get Traffic Source Payout by id.

Params

Param name
Description
Validations
serializer
Optional Blank Value Allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

Validations:

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    offer_conversionDefault response format.
    offer_conversion_gridModern response format that returns various foreign keys for use with other API endpoints.

POST /api/v1/offer_conversions
Create Traffic Source Payout.

Examples

curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -H "Content-Type: application/json" -X POST -d '{"payout": 10, "duration": 60, duplicate_timeframe: 3600, name: "Pay $10 after 1 minute, deduped by 1 hour.", offer_id: 10001234}' https://[your-subdomain].trackdrive.com/api/v1/offer_conversions

Params

Param name
Description
Validations
serializer
Optional Blank Value Allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

Validations:

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    offer_conversionDefault response format.
    offer_conversion_gridModern response format that returns various foreign keys for use with other API endpoints.
payout_type
Optional

Payout Type

Validations:

  • Must be one of: usd, buyer_conversion_percent.
payout
Optional Blank Value Allowed

Payout

Validations:

  • Must be a decimal number.
revenue_percentage
Optional Blank Value Allowed

Revenue Percentage

Validations:

  • Must be a decimal number.
duration
Required

Duration

Validations:

  • Must be a decimal number.
duplicate_timeframe
Required

Duplicate Timeframe

Validations:

  • Must be a decimal number.
name
Required

Name

Validations:

  • Must be a String
offer_id
Required

Offer

Validations:
business_range_id
Optional Blank Value Allowed

Business Range

Validations:
record_token_filter_list
Optional Blank Value Allowed

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

Validations:

  • 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

Validations:

  • Must be a decimal number.

PUT /api/v1/offer_conversions/:id
Update Traffic Source Payout by id.

Examples

curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -H "Content-Type: application/json" -X PUT -d '{"payout": 9, "duration": 120}' https://[your-subdomain].trackdrive.com/api/v1/offer_conversions/1008923

Params

Param name
Description
Validations
serializer
Optional Blank Value Allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

Validations:

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    offer_conversionDefault response format.
    offer_conversion_gridModern response format that returns various foreign keys for use with other API endpoints.
payout_type
Optional

Payout Type

Validations:

  • Must be one of: usd, buyer_conversion_percent.
payout
Optional Blank Value Allowed

Payout

Validations:

  • Must be a decimal number.
revenue_percentage
Optional Blank Value Allowed

Revenue Percentage

Validations:

  • Must be a decimal number.
duration
Optional

Duration

Validations:

  • Must be a decimal number.
duplicate_timeframe
Optional

Duplicate Timeframe

Validations:

  • Must be a decimal number.
name
Optional

Name

Validations:

  • Must be a String
record_token_filter_list
Optional Blank Value Allowed

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

Validations:

  • 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

Validations:

  • Must be a decimal number.

DELETE /api/v1/offer_conversions/:id
Destroy Traffic Source Payout by id.

Examples

curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -H "Content-Type: application/json" -X DELETE "https://[your-subdomain].trackdrive.com/api/v1/offer_conversions/1008923"

Params

Param name
Description
Validations
serializer
Optional Blank Value Allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

Validations:

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    offer_conversionDefault response format.
    offer_conversion_gridModern response format that returns various foreign keys for use with other API endpoints.