Schemas

If 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

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)

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).

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

DEPRECATED

DEPRECATED

DEPRECATED

DEPRECATED

DEPRECATED

DEPRECATED

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.

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

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

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

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

Alias for unique_lander_ctr

Alias for unique_offer_ctr

General click-through rate

Combined unique click-through rate

Earnings per visit

Earnings per click

Journey tree rollup - total visitors through this path

Journey tree rollup - total conversions through this path

Journey tree rollup - total revenue through this path

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. 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 '*'.

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. 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 '*'.

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

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

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

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

Sort direction - ascending or descending

DEPRECATED: Use sortDirection instead. Sort direction for results.

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.

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).

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

Custom event data field 1 for conversions and custom events

Custom event data field 2 for conversions and custom events

Resolved funnel name from asset JOIN

Resolved traffic source name from asset JOIN

Resolved page name from asset JOIN

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

Resolved funnel group (campaign) name from asset JOIN

Resolved offer source name from asset JOIN

Resolved page category name from asset JOIN

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

Whether the conversion has a PII email address

Whether the conversion has a PII phone number

Whether the conversion has a PII zipcode

Whether the conversion has a deduplication event ID

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

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

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

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

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

The hit ID to look up

Optional date hint for partition elimination when hit ID parsing fails

Visitor session summary derived from the entrance hit

True if there are more hits beyond the returned set

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

Timestamp of earliest hit in the queried range

Timestamp of latest hit in the queried range

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

Hit ID

The optional transaction id

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.

An optional email address

An optional phone number

An optional zipcode passed through to postbacks

Optional external dedupe ID passed through to postbacks

The time when the conversion occurred

Optional conversion event data field 1

Optional conversion event data field 2

Call 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.

Hit ID

Custom event number, from 1 through 10

Optional non-negative custom event revenue

An optional email address passed through to postbacks

An optional phone number passed through to postbacks

An optional zipcode passed through to postbacks

Optional external dedupe ID passed through to postbacks

The time when the custom event occurred

Optional custom event data field 1

Optional custom event data field 2

If set to 'none', postbacks are disabled for the uploaded custom events. Other values do not force postbacks for custom events.

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

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

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

If 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.

can be empty string if revenue payout is not specified

Rate limit error code (REPORTING_RATE_LIMITED or EXPLORER_RATE_LIMITED)