List traffic sources
List all traffic sources
query Parameters
statusStatus of resource
idCategoryOptional category ID to filter by
List traffic sources › Responses
List of traffic sources
idTrafficSourceID of the traffic source
trafficSourceNameTraffic source's name.
statusidCategoryID of the parent category
categoryNameName of the parent category
Find traffic source by ID
Retrieve a traffic source by its id
query Parameters
idTrafficSourceThe ID of the traffic source
Find traffic source by ID › Responses
The requested traffic source
idTrafficSourceID of the traffic source
trafficSourceNameTraffic source's name.
costTypedefaultCostDEPRECATED
Allowed keys are campaign, external and c1 to c20 - see example
statusidCategoryCategory ID. Empty if uncategorized
Free form object for storing custom scenario data (deprecated)
Free form object for storing conversion tracking settings (UI usage only)
Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.
incomingCostModifierIncoming cost modifier in percent. This value is used to adjust the incoming cost of a traffic source. For example, if the incoming cost is $1 and the incoming cost modifier is 50, the incoming cost will be adjusted to $0.5. This number should be between 0 and 500.
outgoingRevenueModifierOutgoing revenue modifier in percent. This value is used to adjust the outgoing revenue of a traffic source. For example, if the outgoing revenue is $1 and the outgoing revenue modifier is 50, the outgoing revenue sent in postbacks will be $0.5. This number should be between 0 and 500.
outgoingPostbackProbabilityOutgoing postback probability in percent. This value is used to determine the probability of sending a postback to the traffic source. For example, if the outgoing postback probability is 50, then there is a 50% chance that a postback will be sent to the traffic source. This number should be between 0 and 100.
disableZeroRevenuePostbacksIf true, then zero revenue postbacks will not be sent for this traffic source. This is useful for filtering events of zero revenue which may not be desirable to send to the traffic source.
conversionWebhookConfigIDsWebhook configs to dispatch for conversion events attributed to this traffic source
Map of custom event identifiers to webhook config IDs to dispatch for that event
Find traffic sources by ID list
Retrieve all traffic sources with the specified ids
query Parameters
idTrafficSourcesThe list of traffic source IDs to retrieve
Find traffic sources by ID list › Responses
List of traffic sources with the specified ids
idTrafficSourceID of the traffic source
trafficSourceNameTraffic source's name.
costTypedefaultCostDEPRECATED
Allowed keys are campaign, external and c1 to c20 - see example
statusidCategoryCategory ID. Empty if uncategorized
Free form object for storing custom scenario data (deprecated)
Free form object for storing conversion tracking settings (UI usage only)
Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.
incomingCostModifierIncoming cost modifier in percent. This value is used to adjust the incoming cost of a traffic source. For example, if the incoming cost is $1 and the incoming cost modifier is 50, the incoming cost will be adjusted to $0.5. This number should be between 0 and 500.
outgoingRevenueModifierOutgoing revenue modifier in percent. This value is used to adjust the outgoing revenue of a traffic source. For example, if the outgoing revenue is $1 and the outgoing revenue modifier is 50, the outgoing revenue sent in postbacks will be $0.5. This number should be between 0 and 500.
outgoingPostbackProbabilityOutgoing postback probability in percent. This value is used to determine the probability of sending a postback to the traffic source. For example, if the outgoing postback probability is 50, then there is a 50% chance that a postback will be sent to the traffic source. This number should be between 0 and 100.
disableZeroRevenuePostbacksIf true, then zero revenue postbacks will not be sent for this traffic source. This is useful for filtering events of zero revenue which may not be desirable to send to the traffic source.
conversionWebhookConfigIDsWebhook configs to dispatch for conversion events attributed to this traffic source
Map of custom event identifiers to webhook config IDs to dispatch for that event
Find traffic sources by status
Retrieve all traffic sources with the specified status. Returns slim projection (same as list endpoint). Use find/byId for full objects.
query Parameters
statusStatus of resource
Find traffic sources by status › Responses
List of traffic sources with the specified status
idTrafficSourceID of the traffic source
trafficSourceNameTraffic source's name.
statusidCategoryID of the parent category
categoryNameName of the parent category
Find traffic sources by category
Retrieve all traffic sources under the specified category
query Parameters
idCategoryParent category of resource
Find traffic sources by category › Responses
List of traffic sources
idTrafficSourceID of the traffic source
trafficSourceNameTraffic source's name.
costTypedefaultCostDEPRECATED
Allowed keys are campaign, external and c1 to c20 - see example
statusidCategoryCategory ID. Empty if uncategorized
Free form object for storing custom scenario data (deprecated)
Free form object for storing conversion tracking settings (UI usage only)
Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.
incomingCostModifierIncoming cost modifier in percent. This value is used to adjust the incoming cost of a traffic source. For example, if the incoming cost is $1 and the incoming cost modifier is 50, the incoming cost will be adjusted to $0.5. This number should be between 0 and 500.
outgoingRevenueModifierOutgoing revenue modifier in percent. This value is used to adjust the outgoing revenue of a traffic source. For example, if the outgoing revenue is $1 and the outgoing revenue modifier is 50, the outgoing revenue sent in postbacks will be $0.5. This number should be between 0 and 500.
outgoingPostbackProbabilityOutgoing postback probability in percent. This value is used to determine the probability of sending a postback to the traffic source. For example, if the outgoing postback probability is 50, then there is a 50% chance that a postback will be sent to the traffic source. This number should be between 0 and 100.
disableZeroRevenuePostbacksIf true, then zero revenue postbacks will not be sent for this traffic source. This is useful for filtering events of zero revenue which may not be desirable to send to the traffic source.
conversionWebhookConfigIDsWebhook configs to dispatch for conversion events attributed to this traffic source
Map of custom event identifiers to webhook config IDs to dispatch for that event
Save traffic source
Update an existing traffic source. The id cannot be changed.
Save traffic source › Request Body
idTrafficSourceID of the traffic source
trafficSourceNameTraffic source's name.
costTypedefaultCostDEPRECATED
Allowed keys are campaign, external and c1 to c20 - see example
statusidCategoryCategory ID. Empty if uncategorized
Free form object for storing custom scenario data (deprecated)
Free form object for storing conversion tracking settings (UI usage only)
Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.
incomingCostModifierIncoming cost modifier in percent. This value is used to adjust the incoming cost of a traffic source. For example, if the incoming cost is $1 and the incoming cost modifier is 50, the incoming cost will be adjusted to $0.5. This number should be between 0 and 500.
outgoingRevenueModifierOutgoing revenue modifier in percent. This value is used to adjust the outgoing revenue of a traffic source. For example, if the outgoing revenue is $1 and the outgoing revenue modifier is 50, the outgoing revenue sent in postbacks will be $0.5. This number should be between 0 and 500.
outgoingPostbackProbabilityOutgoing postback probability in percent. This value is used to determine the probability of sending a postback to the traffic source. For example, if the outgoing postback probability is 50, then there is a 50% chance that a postback will be sent to the traffic source. This number should be between 0 and 100.
disableZeroRevenuePostbacksIf true, then zero revenue postbacks will not be sent for this traffic source. This is useful for filtering events of zero revenue which may not be desirable to send to the traffic source.
conversionWebhookConfigIDsWebhook configs to dispatch for conversion events attributed to this traffic source
Map of custom event identifiers to webhook config IDs to dispatch for that event
Save traffic source › Responses
Traffic source updated successfully
Create traffic source
Create a new traffic source
Create traffic source › Request Body
idTrafficSourceID of the traffic source
trafficSourceNameTraffic source's name.
costTypedefaultCostDEPRECATED
Allowed keys are campaign, external and c1 to c20 - see example
statusidCategoryCategory ID. Empty if uncategorized
Free form object for storing custom scenario data (deprecated)
Free form object for storing conversion tracking settings (UI usage only)
Reserved for the FunnelFlux user interface (UI state and edit version/conflict tracking). For internal UI use only; do not store your own data here via the API, as the UI may overwrite it.
incomingCostModifierIncoming cost modifier in percent. This value is used to adjust the incoming cost of a traffic source. For example, if the incoming cost is $1 and the incoming cost modifier is 50, the incoming cost will be adjusted to $0.5. This number should be between 0 and 500.
outgoingRevenueModifierOutgoing revenue modifier in percent. This value is used to adjust the outgoing revenue of a traffic source. For example, if the outgoing revenue is $1 and the outgoing revenue modifier is 50, the outgoing revenue sent in postbacks will be $0.5. This number should be between 0 and 500.
outgoingPostbackProbabilityOutgoing postback probability in percent. This value is used to determine the probability of sending a postback to the traffic source. For example, if the outgoing postback probability is 50, then there is a 50% chance that a postback will be sent to the traffic source. This number should be between 0 and 100.
disableZeroRevenuePostbacksIf true, then zero revenue postbacks will not be sent for this traffic source. This is useful for filtering events of zero revenue which may not be desirable to send to the traffic source.
conversionWebhookConfigIDsWebhook configs to dispatch for conversion events attributed to this traffic source
Map of custom event identifiers to webhook config IDs to dispatch for that event
Create traffic source › Responses
Traffic source created successfully
Duplicate traffic source
Create duplicate of existing traffic source.
query Parameters
idTrafficSourceID of the traffic source to duplicate.
Duplicate traffic source › Request Body
nameName for the new asset
parentIdOptional parent/category ID for the new asset
Optional field overrides to merge into the duplicated asset. Keys are JSON field names (e.g. baseURL, trackingFieldSlots). Protected fields (ID, owner, status) cannot be changed via this field — they are always set by the server after the merge.
Duplicate traffic source › Responses
The newly created traffic source
idID of the newly created asset
Move traffic sources to a category
Move the specified traffic sources to a category
Move traffic sources to a category › Request Body
entriesList of asset IDs to move
idCategoryTarget category ID (empty string to remove from category)
Move traffic sources to a category › Responses
Traffic sources moved successfully