RateLimitError
codemessageDrilldownReportParams
timeStarttimeEnduseEntranceTimeshowFilteredTrafficincludeAssetsWithoutTrafficreturnUniqueVisitorsrestrictToMetricsIf 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
calculatedMetricsCan 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.
sortByAttributesstatusFilterFilters 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).
returnAssetURLWhen true, includes offerURL, offerPayout, and landerURL fields on applicable row attributes. Requires additional asset metadata lookups.
campaignIDsDEPRECATED
funnelIDsDEPRECATED
trafficSourceIDsDEPRECATED
pageIDsDEPRECATED
offerSourceIDsDEPRECATED
subCampaignsDEPRECATED
DrilldownReport
Root-level rows for journey tree reports. Only present for journey-mode reports. Contains the top-level funnel entries before tree expansion.
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.
Aggregate totals for journey tree reports. Only present for journey-mode reports. Omitted (absent from JSON) when not applicable, rather than null.
DrilldownReportColumns
attributesDrilldownReportCustomEventMetric
countrevenueDrilldownReportRow
visitorsvisitscostnodeViewsnodeViewsUniquelanderViewslanderViewsUniquelanderClickslanderClicksUniqueofferViewsofferViewsUniqueofferClicksofferClicksUniqueconversionsrevenuetotalRevenuepageViewspageViewsUniquepageClickspageClicksUniqueaverageTimeOnPageAverage 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.
bounceRateShare 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.
indexDrilldownReportRowAttribute
attributeidvaluestatusinfonodeIDJourney tree node identifier. Only present for journey-mode reports.
categoryIDofferSourceIDofferURLOffer destination URL. Only present when returnAssetURL is true in the request.
offerPayoutOffer default payout. Only present when returnAssetURL is true in the request.
landerURLLander destination URL. Only present when returnAssetURL is true in the request.
DrilldownReportRowCalculatedMetrics
lander_ctroffer_ctrunique_lander_ctrunique_offer_ctrconversion_per_lander_clickconversion_per_lander_viewconversion_per_offer_clickconversion_per_offer_viewconversion_per_unique_lander_clickconversion_per_unique_lander_viewconversion_per_unique_offer_clickconversion_per_unique_offer_viewconversion_per_unique_visitorconversion_per_visitcustom_event_1_per_visitcustom_event_2_per_visitcustom_event_3_per_visitcustom_event_4_per_visitcustom_event_5_per_visitcustom_event_6_per_visitcustom_event_7_per_visitcustom_event_8_per_visitcustom_event_9_per_visitcustom_event_10_per_visitcost_per_conversioncost_per_event_1cost_per_event_2cost_per_event_3cost_per_event_4cost_per_event_5cost_per_event_6cost_per_event_7cost_per_event_8cost_per_event_9cost_per_event_10cost_per_lander_clickcost_per_lander_viewcost_per_offer_clickcost_per_offer_viewcost_per_unique_lander_clickcost_per_unique_lander_viewcost_per_unique_offer_clickcost_per_unique_offer_viewcost_per_unique_visitorcost_per_visitcost_per_visitoruniquenessprofit_and_lossroirevenue_per_conversionrevenue_per_event_1revenue_per_event_2revenue_per_event_3revenue_per_event_4revenue_per_event_5revenue_per_event_6revenue_per_event_7revenue_per_event_8revenue_per_event_9revenue_per_event_10revenue_per_lander_clickrevenue_per_lander_viewrevenue_per_offer_clickrevenue_per_offer_viewrevenue_per_unique_lander_clickrevenue_per_unique_lander_viewrevenue_per_unique_offer_clickrevenue_per_unique_offer_viewrevenue_per_unique_visitorrevenue_per_visitrevenue_per_visitorlander_ctr_uniqueAlias for unique_lander_ctr
offer_ctr_uniqueAlias for unique_offer_ctr
ctrGeneral click-through rate
unique_ctrCombined unique click-through rate
revenue_per_page_viewrevenue_per_page_clickcost_per_page_viewcost_per_page_clickconversion_per_page_viewconversion_per_page_clickepvEarnings per visit
epcEarnings per click
rollup_visitorsJourney tree rollup - total visitors through this path
rollup_conversionsJourney tree rollup - total conversions through this path
rollup_revenueJourney tree rollup - total revenue through this path
AttributeData
attributewhitelistFiltersIf 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.
blacklistFiltersIf 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.
trackingFieldSlotFor URL Tracking Field: which column to group by (campaign, c1-c20). Replaces the legacy wildcard pattern.
PostbackLogAttributeData
attributewhitelistFiltersIf not empty, then only rows where at least one of the specified filters is true will be returned.
blacklistFiltersIf not empty, then only rows where all the specified filters are false will be returned.
Category
idnametypestatusOfferSource
idnamecategoryIDstatusAttribute
PostbackLogAttribute
HitReportParams
timeStarttimeEndpagingLengthincludeHitsincludeClicksincludeConversionsincludeCustomEventssortByColumn 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
sortDirectionSort direction - ascending or descending
sortDEPRECATED: Use sortDirection instead. Sort direction for results.
visitorIDFilter 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.
hitIDFilter 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).
pagingStartrestrictToMetricsIf 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
HitReportRow
eventTypeeventTimehitTimefunnelIDtrafficSourceIDexternalnodeIDhitIDvisitorIDvisitorIPclickIDconversionIDconversionTransactionrevenuecosttrackingDomainfunnelGroupIDofferSourceIDpageIDpageCategoryIDpageGroupIDcontinentcountryregioncityconnectionMobileCarrierconnectionTypeconnectionReferrerPathconnectionReferrerDomaindeviceTypedeviceBranddeviceModeldeviceModelNamedeviceOSdeviceOSVersiondeviceBrowserdeviceBrowserVersiondeviceMainLanguagedeviceUserAgentsubCampaigntotalRevenuetrackingField1trackingField2trackingField3trackingField4trackingField5trackingField6trackingField7trackingField8trackingField9trackingField10trackingField11trackingField12trackingField13trackingField14trackingField15trackingField16trackingField17trackingField18trackingField19trackingField20nodeTypenodeNameconnectionISPeventData1Custom event data field 1 for conversions and custom events
eventData2Custom event data field 2 for conversions and custom events
funnelNameResolved funnel name from asset JOIN
trafficSourceNameResolved traffic source name from asset JOIN
pageNameResolved page name from asset JOIN
pageGroupNameResolved page group (lander/offer group) name from asset JOIN
funnelGroupNameResolved funnel group (campaign) name from asset JOIN
offerSourceNameResolved offer source name from asset JOIN
categoryNameResolved page category name from asset JOIN
PostbackLogParams
timeStarttimeEndpagingLengthsortpagingStartrestrictToMetricsIf 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
PostbackLogReportRow
timeurlownerfunnelIDtrafficSourceIDhitIDconversionIDtransactionIDeventNumberpayouterrorresponseStatusCoderesponseBodytrylastTryisIntegrationintegrationIdqueryStringfunnelNametrafficSourceNamepageIDpageNamepageCategoryNameofferSourceNamehasPiiEmailWhether the conversion has a PII email address
hasPiiPhoneWhether the conversion has a PII phone number
hasPiiZipcodeWhether the conversion has a PII zipcode
hasDedupeEventIdWhether the conversion has a deduplication event ID
WebhookSummaryParams
timeStarttimeEndstatusFiltergroupByidWebhookConfigsidCategoriestargetTypesincludeAssetsWithoutTrafficWebhookSummaryReportRow
idWebhookConfigwebhookConfigNameidCategorycategoryNametargetTypestatusenabledexecutionCountsuccessCountfailureCountnodeExecutionCountonActionCountconversionTriggeredCountcustomEventTriggeredCountMiddlewareSummaryParams
timeStarttimeEndstatusFiltergroupByidMiddlewareConfigsidCategoriesdestinationTypesincludeAssetsWithoutTrafficMiddlewareSummaryReportRow
idMiddlewareConfigmiddlewareConfigNameidCategorycategoryNamedestinationTypestatusexecutionCountsuccessCountfailureCounttimeoutCountsuccessRatefailureRateaverageLatencyMsAverage middleware execution latency in milliseconds across rows with recorded latency.
IncomingPostbackLogParams
timeStarttimeEndpagingLengthsortpagingStartrestrictToMetricsOptional 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.
IncomingPostbackLogAttributeData
attributeOne of RequestID, Domain, Path, Method, PostbackType, Status, ErrorCode, ResponseStatusCode, ClientIP, UserAgent, HitID, EventNumber, TransactionID, HasPiiEmail, HasPiiPhone, HasPiiZipcode, HasDedupeEventId.
whitelistFiltersblacklistFiltersIncomingPostbackLogReportRow
timeownerrequestIDdomainpathmethodpostbackTypeconversion or custom_event.
statusvalid, invalid, or server_error.
errorCodeError taxonomy code, for example missing_hit, invalid_hit, invalid_custom_event_number, negative_revenue.
errorMessageresponseStatusCodeclientIPuserAgentrefererhitIDeventNumberCustom-event number; null for conversion postbacks.
revenuetransactionIDeventData1eventData2conversionTimerevSharedisablePostbacksforcePostbackshasPiiEmailhasPiiPhonehasPiiZipcodehasDedupeEventIdIntegrationLogParams
timeStarttimeEndpagingLengthsortpagingStartIntegrationLogAttributeData
attributewhitelistFiltersblacklistFiltersIntegrationLogReportRow
timeLog timestamp rendered in the request timezone offset derived from timeStart (format YYYY-MM-DD HH:MM:SS)
ownerintegrationIdtrafficSourceIdplatformintenteventTypeeventNumberhitIdconversionIdtransactionIddestinationEventrequestSummarystatusCoderesponseBodyerrorsuccesslatencyMsoutcomeDelivery outcome. queued, delivered, skipped, or failed on postbacks rows. unknown when the stored outcome is empty, including integrations-service connection_auth rows.
outcomeReasonReason 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
timeStartInclusive start. Required. Bounds updated_at in UTC.
timeEndInclusive end. Required and must be greater than or equal to timeStart.
pagingLengthPage size from 1 to 10000. The server fetches one extra row to set metadata.hasMore.
sortOrder of updated_at, integration_id, and conversion_id. Defaults to desc.
pagingStartIntegrationQueueLogAttributeData
attributeClosed allowlist. HoldReason values are integration_inactive, integration_misconfigured, and credentials_invalid. Status accepts pending, processing, held, completed, and failed.
whitelistFiltersblacklistFiltersIntegrationQueueLogReport
IntegrationQueueLogMetadata
rowsReturnedRows in this page, after the extra sentinel row is trimmed.
hasMoreTrue when another row exists beyond this page.
IntegrationQueueLogReportRow
activityTimeupdated_at rendered in the request timezone offset (YYYY-MM-DD HH:MM:SS).
queueIdintegrationIdintegrationNameCurrent asset_integrations.name. Empty when the asset join misses. Not replaced with the ID.
integrationTypeCurrent asset_integrations.type. Empty when the asset join misses.
platformWrite-time platform. No server-side platform label.
accountIdloginCustomerIdtrafficSourceIdtrafficSourceNameCurrent asset_traffic_sources.name. Empty when the asset join misses.
intenteventTypehitIdconversionIdtransactionIddestinationEventstatuspending, processing, held, completed, or failed. An expired row is failed with lastError exactly expired. There is no resolution field.
statusLabelScheduled, Retry scheduled, Queued, Processing, Held, Completed, or Failed. Completed is not Delivered. Held is status=held.
attemptsholdReasonintegration_inactive, integration_misconfigured, credentials_invalid, or empty when the row is not held.
lastErrorRedacted diagnostic. An expired held row stores exactly expired. A row held for a provider configuration error stores config_error
clickTimenextAttemptAtearliest_upload_at in the request timezone offset.
createdAtupdatedAteventNumbercompletedAtNull when the row has not completed.
ExplorerVisitorRequest
visitorIdVisitor ID to look up. Requires timeStart and timeEnd when used.
hitIdHit ID to find the visitor for. Alternative to visitorId.
timeStartStart of time range (RFC3339). Required when using visitorId.
timeEndEnd of time range (RFC3339). Required when using visitorId.
ExplorerHitRequest
hitIdThe hit ID to look up
timeStartOptional date hint for partition elimination when hit ID parsing fails
ExplorerVisitorResponse
Visitor session summary derived from the entrance hit
hasMoreTrue if there are more hits beyond the returned set
ExplorerHitResponse
All events for this hit ID — the original hit event, plus any conversion, customEvent1–10 events that reference it. Ordered by eventTime ASC.
VisitorInfo
visitorIdipcountryregioncityispconnectionTypemobileCarrierdeviceTypedeviceBranddeviceModeldeviceModelNamedeviceOSdeviceOSVersionbrowserbrowserVersionlanguageuserAgentfirstSeenTimestamp of earliest hit in the queried range
lastSeenTimestamp of latest hit in the queried range
totalHitsNumber of hits returned in this response (capped at 100). Use hasMore to detect truncation.
ExplorerHitRow
hitIdeventTypeeventTimefunnelIdfunnelNamenodeIdnodeNamenodeTypetrafficSourceIdtrafficSourceNamepageIdpageNamepageGroupIdpageGroupNamefunnelGroupIdfunnelGroupNameofferSourceIdofferSourceNamecategoryIdcategoryNamecostrevenuetotalRevenueclickIdconversionIdconversionTransactiontrackingDomainexternalIdsubCampaignt1t2t3t4t5t6t7t8t9t10t11t12t13t14t15t16t17t18t19t20eventData1eventData2ExplorerHitDetail
hitIdvisitorIdeventTypeeventTimehitTimefunnelIdfunnelNamenodeIdnodeNamenodeTypetrafficSourceIdtrafficSourceNamepageIdpageNamepageGroupIdpageGroupNamefunnelGroupIdfunnelGroupNameofferSourceIdofferSourceNamecategoryIdcategoryNameipipv6countrycontinentregioncityispconnectionTypemobileCarrierreferrerDomainreferrerPathdeviceTypedeviceBranddeviceModeldeviceModelNamedeviceOSdeviceOSVersionbrowserbrowserVersionlanguageuserAgentcostrevenuetotalRevenuetrackingDomainexternalIdclickIdconversionIdconversionTransactionsubCampaignt1t2t3t4t5t6t7t8t9t10t11t12t13t14t15t16t17t18t19t20eventData1eventData2ConvertedHit
idHit ID
transactionThe optional transaction id
revenueAn 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.
piiEmailAn optional email address
piiPhoneAn optional phone number
piiZipcodeAn optional zipcode passed through to postbacks
dedupeEventIdOptional external dedupe ID passed through to postbacks
conversionTimeThe 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.
timezoneOptional 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.
eventData1Optional conversion event data field 1
eventData2Optional conversion event data field 2
ConversionsUpdateParams
postbackCallsSet 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.
overridePayoutdisablePostbacksWhen 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.
forcePostbacksWhen 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'.
CustomEventUploadHit
idHit ID
eventNumberCustom event number, from 1 through 10
revenueOptional non-negative custom event revenue
piiEmailAn optional email address passed through to postbacks
piiPhoneAn optional phone number passed through to postbacks
piiZipcodeAn optional zipcode passed through to postbacks
dedupeEventIdOptional external dedupe ID passed through to postbacks
conversionTimeThe 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.
timezoneOptional 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.
eventData1Optional custom event data field 1
eventData2Optional custom event data field 2
CustomEventsUpdateParams
postbackCallsSet 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.
disablePostbacksWhen true, FunnelFlux records the custom events but sends nothing to traffic source postback URLs, webhooks, or integrations for this request.
CostSegment
costcostTyperestrictToDeviceTypeIf 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.
restrictToConnectionTypeIf 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.
restrictToBrowserIf set, then update cost of traffic that comes from this browser only
restrictToCountryCodeIf set, then update cost of traffic that comes from this country only
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
funnelIDstrafficSourceIDstimeStartRequired nonzero inclusive start, on or after 2020-01-01T00:00:00Z. UTC instants are compared; offsets are accepted. No future-date restriction.
timeEndRequired 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.
includeFilteredTrafficInclude filtered entrances when assigning cost. Defaults to false; excluded entrances are left out of the update and keep their existing cost.
includeProxyHostingTrafficInclude 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.
ResetUpdateParams
timeStartRequired nonzero inclusive start, on or after 2020-01-01T00:00:00Z. UTC instants are compared; offsets are accepted. No future-date restriction.
timeEndRequired 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.
restrictToCampaignIDsrestrictToFunnelIDsrestrictToTrafficSourceIDsrestrictToCountryCodesrestrictToVisitorIDsrestrictToIPsIf 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
timeStarttimeEndidFunneloffsetcountPostbackLog
totalPostbackLogEntry
timeurlidFunnelidTrafficSourceidHitidConversionidTransactionpayoutcan be empty string if revenue payout is not specified
errorresponseStatusCoderesponseBodytrylastTry