FunnelFlux Pro API DocumentsFunnelFlux Pro API Documents
  • Changelog
  • Status
  • Dashboard
  • Documentation
  • Authentication
  • Domains
  • Assets
  • Reporting
Information
Reporting
    List available attributesgetCreate a drilldown reportpostCreate a raw event reportpost
Updates
    Submit a conversion updateputSubmit a custom event updateputSubmit a cost updateputValidate a data resetpostPerform a data resetdelete
Logs
    Get postback logpostGet webhook asset summarypostGet middleware asset summarypostGet incoming postback logspostGet integration logspostGet integration queue rowspostGet postback logpost
Explorer
    Look up a visitorpostLook up a single hitpost
Schemas
FunnelFlux Reporting API
FunnelFlux Reporting API

Schemas

Download schema

RateLimitError

The API gateway returns this error when the account's per-minute API rate limit is exhausted.
code
​string · enum · required
Enum values:
API_RATE_LIMITED
message
​string · required

DrilldownReportParams

timeStart
​string · date-time · required
timeEnd
​string · date-time · required
​AttributeData[] · required
useEntranceTime
​boolean
Default: false
​AttributeData[]
showFilteredTraffic
​boolean
Default: false
includeAssetsWithoutTraffic
​boolean
Default: false
returnUniqueVisitors
​boolean
Default: false
restrictToMetrics
​string[]

If empty (and calculatedMetrics is empty), returns the default metric set: every metric below except CustomEvent1-10, AverageTimeOnPage and BounceRate, which are opt-in and only returned when named explicitly here. Unsupported names are ignored; a request naming only unsupported metrics returns rows with no metrics, never all metrics. Names match regardless of case, surrounding whitespace, and underscores, spaces, hyphens or colons (average_time_on_page names AverageTimeOnPage). Can restrict the response to any combination of the following metrics:

  • Visits
  • Visitors
  • Cost
  • NodeViews
  • NodeViewsUnique
  • LanderViews
  • LanderViewsUnique
  • LanderClicks
  • LanderClicksUnique
  • OfferViews
  • OfferViewsUnique
  • OfferClicks
  • OfferClicksUnique
  • Conversions
  • Revenue
  • TotalRevenue
  • CustomEvent1
  • CustomEvent2
  • CustomEvent3
  • CustomEvent4
  • CustomEvent5
  • CustomEvent6
  • CustomEvent7
  • CustomEvent8
  • CustomEvent9
  • CustomEvent10
  • PageViews
  • PageViewsUnique
  • PageClicks
  • PageClicksUnique
  • AverageTimeOnPage
  • BounceRate
calculatedMetrics
​string[]

Can get the following calculated metrics:

  • lander_ctr
  • offer_ctr
  • unique_lander_ctr
  • unique_offer_ctr
  • lander_ctr_unique (alias for unique_lander_ctr)
  • offer_ctr_unique (alias for unique_offer_ctr)
  • ctr (general click-through rate)
  • unique_ctr (unique combined CTR)
  • conversion_per_lander_click
  • conversion_per_lander_view
  • conversion_per_offer_click
  • conversion_per_offer_view
  • conversion_per_unique_lander_click
  • conversion_per_unique_lander_view
  • conversion_per_unique_offer_click
  • conversion_per_unique_offer_view
  • conversion_per_unique_visitor
  • conversion_per_visit
  • custom_event_x_per_visit
  • cost_per_conversion
  • cost_per_event_x
  • cost_per_lander_click
  • cost_per_lander_view
  • cost_per_offer_click
  • cost_per_offer_view
  • cost_per_unique_lander_click
  • cost_per_unique_lander_view
  • cost_per_unique_offer_click
  • cost_per_unique_offer_view
  • cost_per_unique_visitor
  • cost_per_visit
  • cost_per_visitor
  • uniqueness
  • profit_and_loss
  • roi
  • epv (earnings per visit)
  • epc (earnings per click)
  • revenue_per_conversion
  • revenue_per_event_x
  • revenue_per_lander_click
  • revenue_per_lander_view
  • revenue_per_offer_click
  • revenue_per_offer_view
  • revenue_per_unique_lander_click
  • revenue_per_unique_lander_view
  • revenue_per_unique_offer_click
  • revenue_per_unique_offer_view
  • revenue_per_unique_visitor
  • revenue_per_visit
  • revenue_per_visitor
  • revenue_per_page_view
  • revenue_per_page_click
  • cost_per_page_view
  • cost_per_page_click
  • conversion_per_page_view
  • conversion_per_page_click
  • rollup_visitors (journey tree internal)
  • rollup_conversions (journey tree internal)
  • rollup_revenue (journey tree internal)

Any other name, including a base, duration or custom-event metric, is ignored and adds no metric to the rows; name those in restrictToMetrics. An ignored name still counts as naming metrics, so the default metric set does not apply.

sortByAttributes
​string[]
Default: []
statusFilter
​string · enum

Filters zero-traffic assets by status when includeAssetsWithoutTraffic is true. Only effective with includeAssetsWithoutTraffic=true; ignored otherwise. Values: "active" (only active assets), "archived" (only archived assets), "not-deleted" or empty (all non-deleted assets, the default).

Enum values:
active
archived
not-deleted
returnAssetURL
​boolean

When true, includes offerURL, offerPayout, and landerURL fields on applicable row attributes. Requires additional asset metadata lookups.

Default: false
campaignIDs
​string[]

DEPRECATED

Default: []
funnelIDs
​string[]

DEPRECATED

Default: []
trafficSourceIDs
​string[]

DEPRECATED

Default: []
pageIDs
​string[]

DEPRECATED

Default: []
offerSourceIDs
​string[]

DEPRECATED

Default: []
subCampaigns
​string[]

DEPRECATED

Default: []

DrilldownReport

​DrilldownReportColumns · required
​DrilldownReportRow[] · required
​DrilldownReportRow[]

Root-level rows for journey tree reports. Only present for journey-mode reports. Contains the top-level funnel entries before tree expansion.

​DrilldownReportEntities

DEPRECATED in V2. Category and offer source metadata is now embedded directly on each row attribute via categoryID and offerSourceID fields. This field is omitted from V2 responses.

​DrilldownReportRow

Aggregate totals for journey tree reports. Only present for journey-mode reports. Omitted (absent from JSON) when not applicable, rather than null.

DrilldownReportColumns

attributes
​Attribute[] · required
Enum values:
URL Tracking Field
Tracking Field List
Tracking Field Values
Element: Campaign
Element: Funnel Group
Element: Funnel
Element: Lander
Element: Lander Group

DrilldownReportCustomEventMetric

count
​number · int64 · min: 0 · required
revenue
​Decimal · required

DrilldownReportRow

​DrilldownReportRowAttribute[] · required
visitors
​number · int64 · min: 0 · required
visits
​number · int64 · min: 0 · required
cost
​Decimal · required
nodeViews
​number · int64 · min: 0 · required
nodeViewsUnique
​number · int64 · min: 0 · required
landerViews
​number · int64 · min: 0 · required
landerViewsUnique
​number · int64 · min: 0 · required
landerClicks
​number · int64 · min: 0 · required
landerClicksUnique
​number · int64 · min: 0 · required
offerViews
​number · int64 · min: 0 · required
offerViewsUnique
​number · int64 · min: 0 · required
offerClicks
​number · int64 · min: 0 · required
offerClicksUnique
​number · int64 · min: 0 · required
conversions
​number · int64 · min: 0 · required
revenue
​Decimal · required
totalRevenue
​Decimal · required
pageViews
​number · int64 · min: 0
pageViewsUnique
​number · int64 · min: 0
pageClicks
​number · int64 · min: 0
pageClicksUnique
​number · int64 · min: 0
averageTimeOnPage
​number · double · min: 0

Average visible time on page, in seconds, carrying decimals. Derived from EventType 6 beacon rows, which store the duration as milliseconds quantised to a 100ms grid. Opt-in: this metric is NOT part of the default metric set, so it is returned only when "averageTimeOnPage" is listed explicitly in restrictToMetrics. Omitted whenever nothing was measured: the metric was not requested, the row is a node type that cannot hold a page duration (rotator, condition, external URL, action row, funnel root), or the row is an eligible page that received no beacons at all. A returned value is always a real measurement — a returned 0 means beacons landed and averaged to zero, which is a different claim from "no data". Render the absent case as "no data", never as 0.

bounceRate
​number · double · min: 0 · max: 100

Share of measured page views, as a percentage from 0 to 100, that ended in under 3000 ms. The threshold is fixed and not configurable, so the metric is comparable across owners and across time. The denominator is MEASURED page views (EventType 6 beacon rows), not all page views. A page view with no beacon appears in neither the numerator nor the denominator, so bounceRate only describes JS-tracked traffic. Beacons whose duration rounds to zero on the 100ms quantisation grid are discarded at the edge, so the metric slightly under-reports the very fastest exits. Opt-in: this metric is NOT part of the default metric set, so it is returned only when "bounceRate" is listed explicitly in restrictToMetrics; either duration metric can be requested alone. It shares averageTimeOnPage's denominator and eligibility rule, so when both are requested they appear and disappear together, and a request naming only one never receives the other. A returned 0 means beacons landed and none of them bounced.

​DrilldownReportRowCalculatedMetrics
​object
​object
​object
​object
​object
​object
​object
​object
​object
​object
​object
index
​number · int64 · min: 1

DrilldownReportEntities

​Category[]
​OfferSource[]

DrilldownReportRowAttribute

attribute
​string · required
id
​string · required
value
​string · required
status
​Status · enum · required
Enum values:
active
archived
deleted
Default: active
info
​string
nodeID
​string

Journey tree node identifier. Only present for journey-mode reports.

categoryID
​string
offerSourceID
​string
offerURL
​string

Offer destination URL. Only present when returnAssetURL is true in the request.

offerPayout
​string

Offer default payout. Only present when returnAssetURL is true in the request.

landerURL
​string

Lander destination URL. Only present when returnAssetURL is true in the request.

DrilldownReportRowCalculatedMetrics

lander_ctr
​number · float64
offer_ctr
​number · float64
unique_lander_ctr
​number · float64
unique_offer_ctr
​number · float64
conversion_per_lander_click
​number · float64
conversion_per_lander_view
​number · float64
conversion_per_offer_click
​number · float64
conversion_per_offer_view
​number · float64
conversion_per_unique_lander_click
​number · float64
conversion_per_unique_lander_view
​number · float64
conversion_per_unique_offer_click
​number · float64
conversion_per_unique_offer_view
​number · float64
conversion_per_unique_visitor
​number · float64
conversion_per_visit
​number · float64
custom_event_1_per_visit
​number · float64
custom_event_2_per_visit
​number · float64
custom_event_3_per_visit
​number · float64
custom_event_4_per_visit
​number · float64
custom_event_5_per_visit
​number · float64
custom_event_6_per_visit
​number · float64
custom_event_7_per_visit
​number · float64
custom_event_8_per_visit
​number · float64
custom_event_9_per_visit
​number · float64
custom_event_10_per_visit
​number · float64
cost_per_conversion
​number · float64
cost_per_event_1
​number · float64
cost_per_event_2
​number · float64
cost_per_event_3
​number · float64
cost_per_event_4
​number · float64
cost_per_event_5
​number · float64
cost_per_event_6
​number · float64
cost_per_event_7
​number · float64
cost_per_event_8
​number · float64
cost_per_event_9
​number · float64
cost_per_event_10
​number · float64
cost_per_lander_click
​number · float64
cost_per_lander_view
​number · float64
cost_per_offer_click
​number · float64
cost_per_offer_view
​number · float64
cost_per_unique_lander_click
​number · float64
cost_per_unique_lander_view
​number · float64
cost_per_unique_offer_click
​number · float64
cost_per_unique_offer_view
​number · float64
cost_per_unique_visitor
​number · float64
cost_per_visit
​number · float64
cost_per_visitor
​number · float64
uniqueness
​number · float64
profit_and_loss
​number · float64
roi
​number · float64
revenue_per_conversion
​number · float64
revenue_per_event_1
​number · float64
revenue_per_event_2
​number · float64
revenue_per_event_3
​number · float64
revenue_per_event_4
​number · float64
revenue_per_event_5
​number · float64
revenue_per_event_6
​number · float64
revenue_per_event_7
​number · float64
revenue_per_event_8
​number · float64
revenue_per_event_9
​number · float64
revenue_per_event_10
​number · float64
revenue_per_lander_click
​number · float64
revenue_per_lander_view
​number · float64
revenue_per_offer_click
​number · float64
revenue_per_offer_view
​number · float64
revenue_per_unique_lander_click
​number · float64
revenue_per_unique_lander_view
​number · float64
revenue_per_unique_offer_click
​number · float64
revenue_per_unique_offer_view
​number · float64
revenue_per_unique_visitor
​number · float64
revenue_per_visit
​number · float64
revenue_per_visitor
​number · float64
lander_ctr_unique
​number · float64

Alias for unique_lander_ctr

offer_ctr_unique
​number · float64

Alias for unique_offer_ctr

ctr
​number · float64

General click-through rate

unique_ctr
​number · float64

Combined unique click-through rate

revenue_per_page_view
​number · float64
revenue_per_page_click
​number · float64
cost_per_page_view
​number · float64
cost_per_page_click
​number · float64
conversion_per_page_view
​number · float64
conversion_per_page_click
​number · float64
epv
​number · float64

Earnings per visit

epc
​number · float64

Earnings per click

rollup_visitors
​number · float64

Journey tree rollup - total visitors through this path

rollup_conversions
​number · float64

Journey tree rollup - total conversions through this path

rollup_revenue
​number · float64

Journey tree rollup - total revenue through this path

AttributeData

attribute
​Attribute · enum
Enum values:
URL Tracking Field
Tracking Field List
Tracking Field Values
Element: Campaign
Element: Funnel Group
Element: Funnel
Element: Lander
Element: Lander Group
whitelistFilters
​string[]

If not empty, then only rows where at least one of the specified filters is true will be returned. For asset-related groupings like 'traffic source', 'campaign', 'lander' etc, a filter must be the asset's id. For Connection: Connection Type, Device: Device Type, and Filtered Status, a filter accepts a display label (case-insensitive) or the numeric id string returned by drilldown rows. Connection Type: the empty id "" and the Connection data not available label (case-insensitive) select NULL rows only; "0" selects id 0 only. Device Type: the empty id "" and the Unknown label select id 0 and NULL rows; "0" selects id 0 only. Filtered Status: the empty id "" and Not Filtered select id 0; there is no NULL selector. An unknown label or id, or any value containing '', returns HTTP 400 on these three groupings. Other groupings accept case-insensitive strings such as 'Malaysia'; filters containing '' use wildcard matching there.

blacklistFilters
​string[]

If not empty, then only rows where all the specified filters are false will be returned. For asset-related groupings like 'traffic source', 'campaign', 'lander' etc, a filter must be the asset's id. For Connection: Connection Type, Device: Device Type, and Filtered Status, a filter accepts a display label (case-insensitive) or the numeric id string returned by drilldown rows. Connection Type: the empty id "" and the Connection data not available label (case-insensitive) exclude NULL rows only; "0" excludes id 0 only. Device Type: the empty id "" and the Unknown label exclude id 0 and NULL rows; "0" excludes id 0 only. Filtered Status: the empty id "" and Not Filtered exclude id 0; there is no NULL selector. Blacklists retain NULL rows unless a value that selects NULL is blacklisted. An unknown label or id, or any value containing '', returns HTTP 400 on these three groupings. Other groupings accept case-insensitive strings such as 'Malaysia'; filters containing '' use wildcard matching there.

trackingFieldSlot
​string

For URL Tracking Field: which column to group by (campaign, c1-c20). Replaces the legacy wildcard pattern.

PostbackLogAttributeData

attribute
​PostbackLogAttribute · enum
Enum values:
Time
URL
Owner
FunnelID
TrafficSourceID
HitID
ConversionID
TransactionID
whitelistFilters
​string[]

If not empty, then only rows where at least one of the specified filters is true will be returned.

blacklistFilters
​string[]

If not empty, then only rows where all the specified filters are false will be returned.

Category

id
​string · required
name
​string · required
type
​string · enum · required
Enum values:
offer
lander
offersources
trafficsources
condition
status
​Status · enum · required
Enum values:
active
archived
deleted
Default: active

OfferSource

id
​string · required
name
​string · required
categoryID
​string · required
status
​Status · enum · required
Enum values:
active
archived
deleted
Default: active

Attribute

string · enum
Enum values:
URL Tracking Field
Tracking Field List
Tracking Field Values
Element: Campaign
Element: Funnel Group
Element: Funnel
Element: Lander
Element: Lander Group

PostbackLogAttribute

string · enum
Enum values:
Time
URL
Owner
FunnelID
TrafficSourceID
HitID
ConversionID
TransactionID

HitReportParams

timeStart
​string · date-time · required
timeEnd
​string · date-time · required
pagingLength
​integer · int32 · min: 1 · max: 10000 · required
​AttributeData[]
includeHits
​boolean
Default: true
includeClicks
​boolean
Default: true
includeConversions
​boolean
Default: true
includeCustomEvents
​string[]
sortBy
​string · enum

Column to sort results by. Defaults to 'eventTime' if not specified. Available sort columns:

  • eventTime - Time when the event occurred (default)
  • hitTime - Time when the original hit/entrance occurred
  • hitID - The unique hit identifier
  • visitorID - The visitor identifier
Enum values:
eventTime
hitTime
hitID
visitorID
Default: eventTime
sortDirection
​string · enum

Sort direction - ascending or descending

Enum values:
asc
desc
Default: desc
sort
​string · enum

DEPRECATED: Use sortDirection instead. Sort direction for results.

Enum values:
asc
desc
Default: desc
visitorID
​string

Filter results to a specific visitor ID. When provided, only events for this visitor will be returned. This is useful for investigating a specific user's journey through funnels.

Default:
hitID
​string

Filter results to a specific hit ID. When provided, only events for this hit will be returned. This is useful for investigating a specific tracking hit and all its associated events (clicks, conversions, custom events).

Default:
pagingStart
​integer · int32 · min: 0
Default: 0
restrictToMetrics
​string[]

If empty, returns default metrics. Can restrict the response to any combination of the following metrics (note a limit of 20 total metrics is imposed):

  • EventType
  • EventTime
  • HitTime
  • FunnelID
  • TrafficSourceID
  • External
  • NodeID
  • NodeType
  • NodeName
  • HitID
  • VisitorID
  • VisitorIP
  • ClickID
  • ConversionID
  • ConversionTransaction
  • Revenue
  • TotalRevenue
  • Cost
  • TrackingDomain
  • FunnelGroupID
  • OfferSourceID
  • PageID
  • PageCategoryID
  • PageGroupID
  • LocationContinent
  • LocationCountry
  • LocationRegion
  • LocationCity
  • ConnectionISP
  • ConnectionMobileCarrier
  • ConnectionType
  • ConnectionReferrerPath
  • ConnectionReferrerDomain
  • DeviceType
  • DeviceBrand
  • DeviceModel
  • DeviceModelName
  • DeviceOS
  • DeviceOSVersion
  • DeviceBrowser
  • DeviceBrowserVersion
  • DeviceMainLanguage
  • DeviceUserAgent
  • SubCampaign
  • TrackingField1
  • TrackingField2
  • TrackingField3
  • TrackingField4
  • TrackingField5
  • TrackingField6
  • TrackingField7
  • TrackingField8
  • TrackingField9
  • TrackingField10
  • TrackingField11
  • TrackingField12
  • TrackingField13
  • TrackingField14
  • TrackingField15
  • TrackingField16
  • TrackingField17
  • TrackingField18
  • TrackingField19
  • TrackingField20
  • CustomEvent1
  • CustomEvent2
  • CustomEvent3
  • CustomEvent4
  • CustomEvent5
  • CustomEvent6
  • CustomEvent7
  • CustomEvent8
  • CustomEvent9
  • CustomEvent10
  • EventData1
  • EventData2
  • FunnelName
  • TrafficSourceName
  • PageName
  • PageGroupName
  • FunnelGroupName
  • OfferSourceName
  • CategoryName

HitReport

​HitReportRow[]

HitReportRow

eventType
​string · enum
Enum values:
hit
click
conversion
customEvent1
customEvent2
customEvent3
customEvent4
customEvent5
eventTime
​string
hitTime
​string
funnelID
​string
trafficSourceID
​string
external
​string
nodeID
​string
hitID
​string
visitorID
​string
visitorIP
​string
clickID
​string
conversionID
​string
conversionTransaction
​string
revenue
​string
cost
​string
trackingDomain
​string
funnelGroupID
​string
offerSourceID
​string
pageID
​string
pageCategoryID
​string
pageGroupID
​string
continent
​string
country
​string
region
​string
city
​string
connectionMobileCarrier
​string
connectionType
​string
connectionReferrerPath
​string
connectionReferrerDomain
​string
deviceType
​string
deviceBrand
​string
deviceModel
​string
deviceModelName
​string
deviceOS
​string
deviceOSVersion
​string
deviceBrowser
​string
deviceBrowserVersion
​string
deviceMainLanguage
​string
deviceUserAgent
​string
subCampaign
​string
totalRevenue
​string
trackingField1
​string
trackingField2
​string
trackingField3
​string
trackingField4
​string
trackingField5
​string
trackingField6
​string
trackingField7
​string
trackingField8
​string
trackingField9
​string
trackingField10
​string
trackingField11
​string
trackingField12
​string
trackingField13
​string
trackingField14
​string
trackingField15
​string
trackingField16
​string
trackingField17
​string
trackingField18
​string
trackingField19
​string
trackingField20
​string
nodeType
​string · enum
Enum values:
rotator
lander
offer
landerGroup
offerGroup
externalURL
condition
visitorTag
nodeName
​string
connectionISP
​string
eventData1
​string

Custom event data field 1 for conversions and custom events

eventData2
​string

Custom event data field 2 for conversions and custom events

funnelName
​string

Resolved funnel name from asset JOIN

trafficSourceName
​string

Resolved traffic source name from asset JOIN

pageName
​string

Resolved page name from asset JOIN

pageGroupName
​string

Resolved page group (lander/offer group) name from asset JOIN

funnelGroupName
​string

Resolved funnel group (campaign) name from asset JOIN

offerSourceName
​string

Resolved offer source name from asset JOIN

categoryName
​string

Resolved page category name from asset JOIN

PostbackLogParams

timeStart
​string · date-time · required
timeEnd
​string · date-time · required
pagingLength
​integer · int32 · min: 1 · max: 10000 · required
​PostbackLogAttributeData[]
sort
​string · enum
Enum values:
asc
desc
Default: desc
pagingStart
​integer · int32 · min: 0
Default: 0
restrictToMetrics
​string[]

If empty, returns default metrics. Can restrict the response to any combination of the following metrics:

  • Time
  • URL
  • Owner
  • FunnelID
  • TrafficSourceID
  • HitID
  • ConversionID
  • TransactionID
  • EventNumber
  • Payout
  • Error
  • ResponseStatusCode
  • ResponseBody
  • Try
  • LastTry
  • IsIntegration
  • IntegrationId
  • QueryString
  • FunnelName
  • TrafficSourceName
  • PageID
  • PageName
  • PageCategoryName
  • OfferSourceName
  • HasPiiEmail
  • HasPiiPhone
  • HasPiiZipcode
  • HasDedupeEventId

PostbackLogReport

​PostbackLogReportRow[]

PostbackLogReportRow

time
​string · date-time
url
​string
owner
​string
funnelID
​string
trafficSourceID
​string
hitID
​string
conversionID
​string
transactionID
​string
eventNumber
​number · int64
payout
​number · float64
error
​string
responseStatusCode
​number · int32
responseBody
​string
try
​number · int64
lastTry
​number · int64
isIntegration
​string
integrationId
​string
queryString
​string
funnelName
​string
trafficSourceName
​string
pageID
​string
pageName
​string
pageCategoryName
​string
offerSourceName
​string
hasPiiEmail
​boolean

Whether the conversion has a PII email address

hasPiiPhone
​boolean

Whether the conversion has a PII phone number

hasPiiZipcode
​boolean

Whether the conversion has a PII zipcode

hasDedupeEventId
​boolean

Whether the conversion has a deduplication event ID

WebhookSummaryParams

timeStart
​string · date-time · required
timeEnd
​string · date-time · required
statusFilter
​string · enum
Enum values:
active
archived
deleted
not-deleted
all
Default: not-deleted
groupBy
​string[]
Enum values:
webhookConfig
category
targetType
idWebhookConfigs
​string[]
idCategories
​string[]
targetTypes
​string[]
Enum values:
custom
zapier
make
pipedream
pipedrive
n8n
tray_io
ifttt
includeAssetsWithoutTraffic
​boolean
Default: false

WebhookSummaryReport

​WebhookSummaryReportRow[]

WebhookSummaryReportRow

idWebhookConfig
​string
webhookConfigName
​string
idCategory
​string
categoryName
​string
targetType
​string · enum
Enum values:
custom
zapier
make
pipedream
pipedrive
n8n
tray_io
ifttt
status
​string · enum
Enum values:
active
archived
deleted
enabled
​boolean
executionCount
​integer · int64
successCount
​integer · int64
failureCount
​integer · int64
nodeExecutionCount
​integer · int64
onActionCount
​integer · int64
conversionTriggeredCount
​integer · int64
customEventTriggeredCount
​integer · int64

MiddlewareSummaryParams

timeStart
​string · date-time · required
timeEnd
​string · date-time · required
statusFilter
​string · enum
Enum values:
active
archived
disabled
deleted
not-deleted
all
Default: not-deleted
groupBy
​string[]
Enum values:
middlewareConfig
category
destinationType
idMiddlewareConfigs
​string[]
idCategories
​string[]
destinationTypes
​string[]
Enum values:
custom
zapier
make
pipedream
pipedrive
n8n
tray_io
ifttt
includeAssetsWithoutTraffic
​boolean
Default: false

MiddlewareSummaryReport

​MiddlewareSummaryReportRow[]

MiddlewareSummaryReportRow

idMiddlewareConfig
​string
middlewareConfigName
​string
idCategory
​string
categoryName
​string
destinationType
​string · enum
Enum values:
custom
zapier
make
pipedream
pipedrive
n8n
tray_io
ifttt
status
​string · enum
Enum values:
active
archived
disabled
deleted
executionCount
​integer · int64
successCount
​integer · int64
failureCount
​integer · int64
timeoutCount
​integer · int64
successRate
​number · double
failureRate
​number · double
averageLatencyMs
​number · double

Average middleware execution latency in milliseconds across rows with recorded latency.

IncomingPostbackLogParams

timeStart
​string · date-time · required
timeEnd
​string · date-time · required
pagingLength
​integer · int32 · min: 1 · max: 10000 · required
​IncomingPostbackLogAttributeData[]
sort
​string · enum
Enum values:
asc
desc
Default: desc
pagingStart
​integer · int32 · min: 0
Default: 0
restrictToMetrics
​string[]

Optional requested row fields. When set, the response and SQL projection contain only these fields. Valid values are Time, Owner, RequestID, Domain, Path, Method, PostbackType, Status, ErrorCode, ErrorMessage, ResponseStatusCode, ClientIP, UserAgent, Referer, HitID, EventNumber, Revenue, TransactionID, EventData1, EventData2, ConversionTime, RevShare, DisablePostbacks, ForcePostbacks, HasPiiEmail, HasPiiPhone, HasPiiZipcode, HasDedupeEventId.

Enum values:
Time
Owner
RequestID
Domain
Path
Method
PostbackType
Status

IncomingPostbackLogAttributeData

attribute
​string

One of RequestID, Domain, Path, Method, PostbackType, Status, ErrorCode, ResponseStatusCode, ClientIP, UserAgent, HitID, EventNumber, TransactionID, HasPiiEmail, HasPiiPhone, HasPiiZipcode, HasDedupeEventId.

whitelistFilters
​string[]
blacklistFilters
​string[]

IncomingPostbackLogReport

​IncomingPostbackLogReportRow[]

IncomingPostbackLogReportRow

time
​string
owner
​string
requestID
​string
domain
​string
path
​string
method
​string
postbackType
​string

conversion or custom_event.

status
​string

valid, invalid, or server_error.

errorCode
​string

Error taxonomy code, for example missing_hit, invalid_hit, invalid_custom_event_number, negative_revenue.

errorMessage
​string
responseStatusCode
​integer · int32
clientIP
​string
userAgent
​string
referer
​string
hitID
​string
eventNumber
​integer · int32

Custom-event number; null for conversion postbacks.

revenue
​string
transactionID
​string
eventData1
​string
eventData2
​string
conversionTime
​string
revShare
​string
disablePostbacks
​string
forcePostbacks
​string
hasPiiEmail
​boolean
hasPiiPhone
​boolean
hasPiiZipcode
​boolean
hasDedupeEventId
​boolean

IntegrationLogParams

timeStart
​string · date-time · required
timeEnd
​string · date-time · required
pagingLength
​integer · int32 · min: 1 · max: 10000 · required
​IntegrationLogAttributeData[]
sort
​string · enum
Enum values:
asc
desc
Default: desc
pagingStart
​integer · int32 · min: 0
Default: 0

IntegrationLogAttributeData

attribute
​string · enum
Enum values:
IntegrationID
TrafficSourceID
Platform
Intent
EventType
EventNumber
HitID
ConversionID
whitelistFilters
​string[]
blacklistFilters
​string[]

IntegrationLogReport

​IntegrationLogReportRow[]

IntegrationLogReportRow

time
​string · required

Log timestamp rendered in the request timezone offset derived from timeStart (format YYYY-MM-DD HH:MM:SS)

owner
​string · required
integrationId
​string · required
trafficSourceId
​string · required
platform
​string · required
intent
​string · required
eventType
​string · required
eventNumber
​integer · int64 · required
hitId
​string · required
conversionId
​string · required
transactionId
​string · required
destinationEvent
​string · required
requestSummary
​string · required
statusCode
​integer · int32 · required
responseBody
​string · required
error
​string · required
success
​boolean · required
latencyMs
​integer · int64 · required
outcome
​string · enum · required

Delivery outcome. queued, delivered, skipped, or failed on postbacks rows. unknown when the stored outcome is empty, including integrations-service connection_auth rows.

Enum values:
queued
delivered
skipped
failed
unknown
outcomeReason
​string · required

Reason paired with outcome. Empty on legacy rows that stored no reason. queued uses inserted, coalesced, or released (a held row the sweep put back to pending). delivered uses accepted or duplicate. skipped uses dropped_stale, noop_completed, cancelled_pending, adjustment_unsupported, delivery_disabled, integration_removed (integration or traffic source missing, deleted, or unlinked), not_mapped, integration_inactive, integration_misconfigured, or credentials_invalid. failed uses queue_unavailable, expired, unsupported_platform, or the adapter error class.

IntegrationQueueLogParams

timeStart
​string · date-time · required

Inclusive start. Required. Bounds updated_at in UTC.

timeEnd
​string · date-time · required

Inclusive end. Required and must be greater than or equal to timeStart.

pagingLength
​integer · int32 · required

Page size from 1 to 10000. The server fetches one extra row to set metadata.hasMore.

​IntegrationQueueLogAttributeData[]
sort
​string · enum

Order of updated_at, integration_id, and conversion_id. Defaults to desc.

Enum values:
asc
desc
pagingStart
​integer · int32

IntegrationQueueLogAttributeData

attribute
​string · enum

Closed allowlist. HoldReason values are integration_inactive, integration_misconfigured, and credentials_invalid. Status accepts pending, processing, held, completed, and failed.

Enum values:
IntegrationID
TrafficSourceID
Platform
Intent
EventType
EventNumber
HitID
ConversionID
whitelistFilters
​string[]
blacklistFilters
​string[]

IntegrationQueueLogReport

​IntegrationQueueLogReportRow[] · required
​IntegrationQueueLogMetadata · required

IntegrationQueueLogMetadata

rowsReturned
​integer · int32 · required

Rows in this page, after the extra sentinel row is trimmed.

hasMore
​boolean · required

True when another row exists beyond this page.

IntegrationQueueLogReportRow

activityTime
​string · required

updated_at rendered in the request timezone offset (YYYY-MM-DD HH:MM:SS).

queueId
​string · required
integrationId
​string · required
integrationName
​string · required

Current asset_integrations.name. Empty when the asset join misses. Not replaced with the ID.

integrationType
​string · required

Current asset_integrations.type. Empty when the asset join misses.

platform
​string · required

Write-time platform. No server-side platform label.

accountId
​string · required
loginCustomerId
​string · required
trafficSourceId
​string · required
trafficSourceName
​string · required

Current asset_traffic_sources.name. Empty when the asset join misses.

intent
​string · required
eventType
​string · required
hitId
​string · required
conversionId
​string · required
transactionId
​string · required
destinationEvent
​string · required
status
​string · enum · required

pending, processing, held, completed, or failed. An expired row is failed with lastError exactly expired. There is no resolution field.

Enum values:
pending
processing
held
completed
failed
statusLabel
​string · required

Scheduled, Retry scheduled, Queued, Processing, Held, Completed, or Failed. Completed is not Delivered. Held is status=held.

attempts
​integer · int64 · required
holdReason
​string · required

integration_inactive, integration_misconfigured, credentials_invalid, or empty when the row is not held.

lastError
​string · required

Redacted diagnostic. An expired held row stores exactly expired. A row held for a provider configuration error stores config_error ; it is re-sent hourly and fails with the same lastError once attempts reach the budget. completed rows are normally empty because completion clears the stored error.

clickTime
​string · required
nextAttemptAt
​string · required

earliest_upload_at in the request timezone offset.

createdAt
​string · required
updatedAt
​string · required
eventNumber
​integer · int64
completedAt
​string

Null when the row has not completed.

ExplorerVisitorRequest

visitorId
​string

Visitor ID to look up. Requires timeStart and timeEnd when used.

hitId
​string

Hit ID to find the visitor for. Alternative to visitorId.

timeStart
​string · date-time

Start of time range (RFC3339). Required when using visitorId.

timeEnd
​string · date-time

End of time range (RFC3339). Required when using visitorId.

ExplorerHitRequest

hitId
​string · required

The hit ID to look up

timeStart
​string · date-time

Optional date hint for partition elimination when hit ID parsing fails

ExplorerVisitorResponse

​VisitorInfo

Visitor session summary derived from the entrance hit

​ExplorerHitRow[]
hasMore
​boolean

True if there are more hits beyond the returned set

ExplorerHitResponse

​ExplorerHitDetail[]

All events for this hit ID — the original hit event, plus any conversion, customEvent1–10 events that reference it. Ordered by eventTime ASC.

VisitorInfo

Visitor session summary derived from the entrance hit
visitorId
​string
ip
​string
country
​string
region
​string
city
​string
isp
​string
connectionType
​string
mobileCarrier
​string
deviceType
​string
deviceBrand
​string
deviceModel
​string
deviceModelName
​string
deviceOS
​string
deviceOSVersion
​string
browser
​string
browserVersion
​string
language
​string
userAgent
​string
firstSeen
​string

Timestamp of earliest hit in the queried range

lastSeen
​string

Timestamp of latest hit in the queried range

totalHits
​number · int64

Number of hits returned in this response (capped at 100). Use hasMore to detect truncation.

ExplorerHitRow

Compact hit row returned in visitor hit lists
hitId
​string
eventType
​string
eventTime
​string
funnelId
​string
funnelName
​string
nodeId
​string
nodeName
​string
nodeType
​string
trafficSourceId
​string
trafficSourceName
​string
pageId
​string
pageName
​string
pageGroupId
​string
pageGroupName
​string
funnelGroupId
​string
funnelGroupName
​string
offerSourceId
​string
offerSourceName
​string
categoryId
​string
categoryName
​string
cost
​number · float64
revenue
​number · float64
totalRevenue
​number · float64
clickId
​string
conversionId
​string
conversionTransaction
​string
trackingDomain
​string
externalId
​string
subCampaign
​string
t1
​string
t2
​string
t3
​string
t4
​string
t5
​string
t6
​string
t7
​string
t8
​string
t9
​string
t10
​string
t11
​string
t12
​string
t13
​string
t14
​string
t15
​string
t16
​string
t17
​string
t18
​string
t19
​string
t20
​string
eventData1
​string
eventData2
​string

ExplorerHitDetail

Complete hit dump for single-hit lookup. Superset of ExplorerHitRow — adds device, geo, connection, referrer fields.
hitId
​string
visitorId
​string
eventType
​string
eventTime
​string
hitTime
​string
funnelId
​string
funnelName
​string
nodeId
​string
nodeName
​string
nodeType
​string
trafficSourceId
​string
trafficSourceName
​string
pageId
​string
pageName
​string
pageGroupId
​string
pageGroupName
​string
funnelGroupId
​string
funnelGroupName
​string
offerSourceId
​string
offerSourceName
​string
categoryId
​string
categoryName
​string
ip
​string
ipv6
​string
country
​string
continent
​string
region
​string
city
​string
isp
​string
connectionType
​string
mobileCarrier
​string
referrerDomain
​string
referrerPath
​string
deviceType
​string
deviceBrand
​string
deviceModel
​string
deviceModelName
​string
deviceOS
​string
deviceOSVersion
​string
browser
​string
browserVersion
​string
language
​string
userAgent
​string
cost
​number · float64
revenue
​number · float64
totalRevenue
​number · float64
trackingDomain
​string
externalId
​string
clickId
​string
conversionId
​string
conversionTransaction
​string
subCampaign
​string
t1
​string
t2
​string
t3
​string
t4
​string
t5
​string
t6
​string
t7
​string
t8
​string
t9
​string
t10
​string
t11
​string
t12
​string
t13
​string
t14
​string
t15
​string
t16
​string
t17
​string
t18
​string
t19
​string
t20
​string
eventData1
​string
eventData2
​string

ConvertedHit

id
​string · required

Hit ID

transaction
​string

The optional transaction id

Default:
revenue
​NullableDecimal

An optional revenue amount. When not specified, the default revenue from the converted offer is used. If set to -1, then this hit is set as non-converted.

Default: null
piiEmail
​string

An optional email address

Default:
piiPhone
​string

An optional phone number

Default:
piiZipcode
​string

An optional zipcode passed through to postbacks

Default:
dedupeEventId
​string

Optional external dedupe ID passed through to postbacks

Default:
conversionTime
​string

The time when the conversion occurred. Accepts Unix timestamps, timezone-aware RFC formats, and the Raw Events display format YYYY-MM-DD HH:mm:ss. Raw Events values use timezone when supplied, otherwise UTC.

Default:
timezone
​string

Optional UTC offset for conversionTime in the zone-less Raw Events format, written as UTC or UTC+/-HH[:MM]. Ignored when conversionTime is a Unix timestamp or contains an intrinsic timezone.

Default:
eventData1
​string

Optional conversion event data field 1

Default:
eventData2
​string

Optional conversion event data field 2

Default:

ConversionsUpdateParams

​ConvertedHit[] · required
postbackCalls
​string · enum

Set to 'none' to stop all outbound delivery for this request, the same as disablePostbacks: true. When omitted, delivery is not stopped: postbacks follow disablePostbacks, forcePostbacks and the re-upload rules in the endpoint description. 'onlyOnce' and 'all' are accepted for compatibility but behave the same as an omitted value. In particular, 'onlyOnce' does not stop a re-upload from being delivered again; use 'none' or disablePostbacks to prevent it.

Enum values:
none
onlyOnce
all
overridePayout
​NullableDecimal
Default: null
disablePostbacks
​boolean

When true, FunnelFlux records the conversions but sends nothing to traffic source postback URLs, webhooks, or integrations for this request. Takes precedence over forcePostbacks. Use it for corrections that the traffic source must not receive again.

Default: false
forcePostbacks
​boolean

When true, postback URLs and webhooks are also called for revenue corrections inside the correction window described for the endpoint, and for negative-revenue deletions at any time; neither is sent there otherwise. It does not resend an upload ignored as a duplicate and does not change what integrations receive. Ignored when disablePostbacks is true or postbackCalls is 'none'.

Default: false

CustomEventUploadHit

id
​string · required

Hit ID

eventNumber
​integer · min: 1 · max: 10 · required

Custom event number, from 1 through 10

revenue
​NullableDecimal

Optional non-negative custom event revenue

Default: null
piiEmail
​string

An optional email address passed through to postbacks

Default:
piiPhone
​string

An optional phone number passed through to postbacks

Default:
piiZipcode
​string

An optional zipcode passed through to postbacks

Default:
dedupeEventId
​string

Optional external dedupe ID passed through to postbacks

Default:
conversionTime
​string

The time when the custom event occurred. Accepts Unix timestamps, timezone-aware RFC formats, and the Raw Events display format YYYY-MM-DD HH:mm:ss. Raw Events values use timezone when supplied, otherwise UTC.

Default:
timezone
​string

Optional UTC offset for conversionTime in the zone-less Raw Events format, written as UTC or UTC+/-HH[:MM]. Ignored when conversionTime is a Unix timestamp or contains an intrinsic timezone.

Default:
eventData1
​string

Optional custom event data field 1

Default:
eventData2
​string

Optional custom event data field 2

Default:

CustomEventsUpdateParams

​CustomEventUploadHit[] · minItems: 1 · maxItems: 10 · required
postbackCalls
​string · enum

Set to 'none' to stop all outbound delivery for this request, the same as disablePostbacks: true. When omitted, delivery is not stopped and follows disablePostbacks. Other values behave the same as an omitted value; custom events have no force option.

Enum values:
none
onlyOnce
all
disablePostbacks
​boolean

When true, FunnelFlux records the custom events but sends nothing to traffic source postback URLs, webhooks, or integrations for this request.

Default: false

CostSegment

cost
​Decimal
costType
​string · enum
Enum values:
wholeSegment
perEntrance
Default: wholeSegment
restrictToDeviceType
​string · enum

If set, then update cost of traffic that comes from this device type only. Unknown also matches entrances with no device data, as the drilldown report does. Accepts the label or its numeric id.

Enum values:
Unknown
Console
Desktop
EReader
MediaHub
Mobile
SmallScreen
SmartPhone
restrictToConnectionType
​string · enum

If set, then update cost of traffic that comes from this connection type only. Known Proxy and Hosting Provider require includeProxyHostingTraffic=true; otherwise the request is rejected with 400. Accepts the label or its numeric id.

Enum values:
Unknown
Mobile
Wired
Known Proxy
Hosting Provider
restrictToBrowser
​string

If set, then update cost of traffic that comes from this browser only

Default:
restrictToCountryCode
​string

If set, then update cost of traffic that comes from this country only

Default:
​object

If set, then update cost of traffic that have these tracking fields' keys/values only. Keys are case-insensitive and must be campaign, external, or a tracking field slot 1-20 written as cN, tN, trackingfieldN, or tracking_field_N; any other key is rejected with 400. A key with an empty value list or only blank values is rejected with 400; omit the key to leave tracking fields unrestricted.

CostUpdateParams

funnelIDs
​string[] · required
Default: []
trafficSourceIDs
​string[] · required
Default: []
timeStart
​string · date-time · required

Required nonzero inclusive start, on or after 2020-01-01T00:00:00Z. UTC instants are compared; offsets are accepted. No future-date restriction.

timeEnd
​string · date-time · required

Required nonzero inclusive end, strictly after timeStart and no later than timeStart.UTC().AddDate(0, 12, 0). This is 12 calendar months (1-year data period), not 365 days; February 29 normalizes to March 1 in a non-leap year. Exact anniversary is accepted.

​CostSegment[] · required
includeFilteredTraffic
​boolean

Include filtered entrances when assigning cost. Defaults to false; excluded entrances are left out of the update and keep their existing cost.

Default: false
includeProxyHostingTraffic
​boolean

Include Known Proxy and Hosting Provider entrances when assigning cost. Defaults to false; excluded entrances are left out of the update and keep their existing cost.

Default: false

ResetUpdateParams

Estimate or execute a reset with at least one non-blank restriction beyond its bounded time window. Scope validation precedes time-window validation; execute inherits the same checks as estimate.
timeStart
​string · date-time · required

Required nonzero inclusive start, on or after 2020-01-01T00:00:00Z. UTC instants are compared; offsets are accepted. No future-date restriction.

timeEnd
​string · date-time · required

Required nonzero inclusive end, strictly after timeStart and no later than timeStart.UTC().AddDate(0, 12, 0). This is 12 calendar months (1-year data period), not 365 days; February 29 normalizes to March 1 in a non-leap year. Exact anniversary is accepted.

restrictToCampaignIDs
​string[]
Default: []
restrictToFunnelIDs
​string[]
Default: []
restrictToTrafficSourceIDs
​string[]
Default: []
restrictToCountryCodes
​string[]
Default: []
restrictToVisitorIDs
​string[]
Default: []
restrictToIPs
​string[]
Default: []
​object

If set, then reset only traffic that has these tracking fields' keys/values. Keys are case-insensitive and must be campaign, external, or a tracking field slot 1-20 written as cN, tN, trackingfieldN, or tracking_field_N; any other key is rejected with 400. A key with an empty value list or only blank values is rejected with 400; omit the key to leave tracking fields unrestricted.

PostbackLogCriteria

timeStart
​string · date-time · required
timeEnd
​string · date-time · required
idFunnel
​string
Default:
offset
​integer · int32
Default: 0
count
​integer · int32
Default: 100

PostbackLog

total
​integer · int32 · required
​PostbackLogEntry[] · required

PostbackLogEntry

time
​string · date-time · required
url
​string · required
idFunnel
​string · required
idTrafficSource
​string · required
idHit
​string · required
idConversion
​string · required
idTransaction
​string · required
payout
​string · required

can be empty string if revenue payout is not specified

error
​string · required
responseStatusCode
​integer · int32 · min: 0 · required
responseBody
​string · required
try
​integer · int32 · min: 1 · required
lastTry
​boolean · required

IntegerValue

value
​integer · int64 · required

Error

code
​integer · int32 · required
message
​string · required

Decimal

string

NullableDecimal

string

Status

string · enum
Enum values:
active
archived
deleted
Default: active
On this page
  • RateLimitError
  • DrilldownReportParams
  • DrilldownReport
  • DrilldownReportColumns
  • DrilldownReportCustomEventMetric
  • DrilldownReportRow
  • DrilldownReportEntities
  • DrilldownReportRowAttribute
  • DrilldownReportRowCalculatedMetrics
  • AttributeData
  • PostbackLogAttributeData
  • Category
  • OfferSource
  • Attribute
  • PostbackLogAttribute
  • HitReportParams
  • HitReport
  • HitReportRow
  • PostbackLogParams
  • PostbackLogReport
  • PostbackLogReportRow
  • WebhookSummaryParams
  • WebhookSummaryReport
  • WebhookSummaryReportRow
  • MiddlewareSummaryParams
  • MiddlewareSummaryReport
  • MiddlewareSummaryReportRow
  • IncomingPostbackLogParams
  • IncomingPostbackLogAttributeData
  • IncomingPostbackLogReport
  • IncomingPostbackLogReportRow
  • IntegrationLogParams
  • IntegrationLogAttributeData
  • IntegrationLogReport
  • IntegrationLogReportRow
  • IntegrationQueueLogParams
  • IntegrationQueueLogAttributeData
  • IntegrationQueueLogReport
  • IntegrationQueueLogMetadata
  • IntegrationQueueLogReportRow
  • ExplorerVisitorRequest
  • ExplorerHitRequest
  • ExplorerVisitorResponse
  • ExplorerHitResponse
  • VisitorInfo
  • ExplorerHitRow
  • ExplorerHitDetail
  • ConvertedHit
  • ConversionsUpdateParams
  • CustomEventUploadHit
  • CustomEventsUpdateParams
  • CostSegment
  • CostUpdateParams
  • ResetUpdateParams
  • PostbackLogCriteria
  • PostbackLog
  • PostbackLogEntry
  • IntegerValue
  • Error
  • Decimal
  • NullableDecimal
  • Status