DrilldownReportParams
timeStarttimeEnduseEntranceTimeshowFilteredTrafficincludeAssetsWithoutTrafficreturnUniqueVisitorsrestrictToMetricsIf empty, returns all metrics. 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
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)
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
visitorsvisitscostnodeViewsnodeViewsUniquelanderViewslanderViewsUniquelanderClickslanderClicksUniqueofferViewsofferViewsUniqueofferClicksofferClicksUniqueconversionsrevenuetotalRevenuepageViewspageViewsUniquepageClickspageClicksUniqueindexDrilldownReportRowAttribute
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. Otherwise, for groupings like 'country', 'device type' etc, a filter is a case-insensitive string representing the data, like 'Malaysia', 'Smartphone' etc... Filters can contain wildcards '*'.
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. Otherwise, for groupings like 'country', 'device type' etc, a filter is a case-insensitive string representing the data, like 'Malaysia', 'Smartphone' etc... Filters can contain wildcards '*'.
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
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
conversionTimeThe time when the conversion occurred
ConversionsUpdateParams
postbackCallsCall the traffic source postbacks of the sources that generated theses conversions. If set to 'none', then the postbacks are not called for any of the specified hits. If set to 'onlyOnce', then the postbacks are only called for the hits that never called them before. If set to 'all', the postbacks are called for all the specified hits, even if they were already called in the past for some/all hits.
overridePayoutdisablePostbacksforcePostbacksCostSegment
costcostTyperestrictToDeviceTypeIf set, then update cost of traffic that comes from this device type only
restrictToConnectionTypeIf set, then update cost of traffic that comes from this connection type only
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.
CostUpdateParams
funnelIDstrafficSourceIDstimeStarttimeEndResetUpdateParams
timeStarttimeEndrestrictToCampaignIDsrestrictToFunnelIDsrestrictToTrafficSourceIDsrestrictToCountryCodesrestrictToVisitorIDsrestrictToIPsPostbackLogCriteria
timeStarttimeEndidFunneloffsetcountPostbackLog
totalPostbackLogEntry
timeurlidFunnelidTrafficSourceidHitidConversionidTransactionpayoutcan be empty string if revenue payout is not specified
errorresponseStatusCoderesponseBodytrylastTryRateLimitError
codeRate limit error code (REPORTING_RATE_LIMITED or EXPLORER_RATE_LIMITED)
message