Schemas

If set to true, then the cost update will also take the filtered entrances into account

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

If set, then update cost of traffic that have these tracking field values only. The KeyValuePair object is composed of: * key - The tracking field name * value - The tracking field value

64 bits integer id of the traffic source

'start' is included while 'end' is excluded. Typically, the test is start <= time < end

When a TimeZone object is provided as an input to an API function, then either offset or name is required. If both are given, then 'name' takes precedence. When a TimeZone object is sent back from an API function, both 'offset' and 'name' are filled.

Optional funnel ID to narrow scope. If omitted, cost update applies to all funnels for the traffic source.

'start' is included while 'end' is excluded. Typically, the test is start <= time < end

When a TimeZone object is provided as an input to an API function, then either offset or name is required. If both are given, then 'name' takes precedence. When a TimeZone object is sent back from an API function, both 'offset' and 'name' are filled.

Map of tracking field name to value (or list of values). All conditions are AND-ed; multiple values per field are OR-ed.

64 bits integer corresponding to the hit id

The optional transaction id

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

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.

Time zone's name

The offset in seconds from UTC

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 *

Name of the column to filter. It can be a grouping name as defined in the 'Grouping' object, or a metric name as defined in the 'MetricNames' oject

Grouping filters can contain wildcards '*'. Metric filters can contain '<', '<=', '>', '>='

Column name to sort by. It can be a grouping name as defined in the 'Grouping' object, or a metric name as defined in the 'MetricNames' oject

'flat' returns flattened rows. 'tree' returns full tree rows. 'mixed' returns flattened rows except for groupings like 'conversion paths' that are best represented as a tree.

If true, then the calculated confidence rates also take rows with 0 successes into account.

Selects whether the report time range is applied to entrance time or event time.

If set, stats are restricted to the specified campaign

If set, stats are restricted to the specified funnel

If set, stats are restricted to the specified traffic source

'start' is included while 'end' is excluded. Typically, the test is start <= time < end

When a TimeZone object is provided as an input to an API function, then either offset or name is required. If both are given, then 'name' takes precedence. When a TimeZone object is sent back from an API function, both 'offset' and 'name' are filled.

Optional metric names to include in the response. Omit to return all metrics.

Use compact-v1 to return report row cells as positional arrays [formatted, raw]. Omit or use standard for the legacy cell object shape.

Confidence rate of being the winner. -1 means not calculated

Column name

If type is 'metric', then the column name MUST be one of the names defined in 'MetricNames'. If type is 'grouping', then the column name MUST be one of the names defined in the 'Grouping' object

Column description

Cell's value formatted like 'Google Adwords', '0.23%' or 'N/A'.

Non formatted cell's value like 0.213245454 for the ctr etc ... null means 'N/A'. If the cell is from a grouping column, then this value represents its id.

Unique id of this row

Id of the parent row or null if none. Note that a row cannot have children or a parent when 'RequestOptions.viewType' is 'flat'.

The number of returned rows

The total number of available rows when RequestPaging is not restricting what is returned

Optional filename for the exported CSV

Row offset for paginated exports

Maximum number of rows to export per request

Whether to include a header row in the CSV output

True if all rows have been exported

URL to download the exported CSV file (present when complete)

Offset to use for the next request (present when not complete)

Opaque string identifiers for the background jobs created

ISO 8601 timestamp when the jobs were queued