SessionID

String (Alphanumeric)

Required

Session ID obtained from InitSession call.

ChannelIds

List of Strings

Required

List of full UUIDs (not minified) of up to 10 channels. These are the UUIDs returned by the News Campaign API method GetTargetingDetails in the TargetingDimensons: DimentionsName: Channels output.

StartTime

String (date)

Required

Start date of report period, formatted as yyyy-mm-dd.

EndTime

String (date)

Required

End date of report period, formatted as yyyy-mm-dd.

Timezone

String

Optional

Must be either UTC (Coordinated Universal Time, GMT) or ATZ (Account Time Zone, determined from your account settings). Default is UTC.

Interval

String

Required

Must be either Hourly or Daily.

Metrics

Collection

Collection of revenue metrics parameters and values.

Metrics: ChannelId

String

Full channel UUID for each channel output returned.

Metrics: ChannelName

String

Channel name for each channel output returned.

Metrics: Country

String

Two-character country code, “AU”, “GB”, or “US”.

Metrics: AdPosition

String

All potential Ad positions.

Metrics: DeviceClass

String

Type of device. The only device types are iPhone and iPad.

Metrics: DateTime

String

For Hourly, the value will be the date and hour: yyyy-mm-dd hh:mm

For Daily, the value is the date: yyyy-mm-dd hh:mm

Metrics: TimeZone

String

Will be either UTC (Coordinated Universal Time, GMT) or ATZ (Account Time Zone, determined from your account settings). Default is UTC.

Metrics: Taps

String

Number of times users have tapped on ads.

Metrics: iAdBackfillCPM

String

Estimated revenue per thousand clicks.

Metrics: iAdBackfillImpressions

String

Number of times that iAd backfill ads appeared in your channels.

Metrics: DirectSoldImpressions

String

Number of times that direct-sold ads appeared in your channels.

Metrics: HouseImpressions

String

Number of times that in-house ads appeared in your channels.

Metrics: TTR

String

Tap-through rate.

Metrics: iAdBackfillRevenue

String

Revenue from iAd backfill ads displayed.

Metrics: Supply

String

The number of ad requests that are eligible for ads. Some ad requests might be ineligible for a variety of reasons. Supply is an indication of the maximum number of ad impressions that could have been delivered during the reporting time period..

Metrics: FillRate

String

The ratio of total impressions to the total supply, in percent.

Success

Boolean

true or false, depending on whether the call succeeded or not.

SessionID

String (Alphanumeric)

Required

Session ID obtained from InitSession call.

ChannelIds

List of Strings

Required

List of full UUIDs (not minified) of up to 10 channels. These are the UUIDs returned by the News Campaign API method GetTargetingDetails in the TargetingDimensons: DimentionsName: Channels output.

StartTime

String (date)

Required

Start date of report period, formatted as yyyy-mm-dd.

EndTime

String (date)

Required

End date of report period, formatted as yyyy-mm-dd.

Timezone

String

Optional

Must be either UTC (Coordinated Universal Time, GMT) or ATZ (Account Time Zone, determined from your account settings). Default is UTC.

Interval

String

Required

Must be either Hourly or Daily.

Metrics

Collection

Collection of revenue metrics parameters and values.

Metrics: ChannelId

String

Full channel UUID for each channel output returned.

Metrics: ChannelName

String

Channel name for each channel output returned.

Metrics: Country

String

Two-character country code, “AU”, “GB”, or “US”.

Metrics: AdPosition

String

All potential ad positions.

Metrics: DeviceClass

String

Type of device. The only device types are iPhone and iPad.

Metrics: CreativeType

String

A different CreativeType value will be provided to identify each Dim structure returned.

Metrics: DateTime

String

For hourly, the value will be the date and hour: yyyy-mm-dd hh:mm

For daily, the value is the date: yyyy-mm-dd hh:mm

Metrics: TimeZone

String

Will be either UTC (Coordinated Universal Time, GMT) or ATZ (Account Time Zone, determined from your account settings). Default is UTC.

Metrics: Taps

String

Number of times users have tapped on ads.

Metrics: iAdBackfillCPM

String

Estimated revenue per thousand clicks.

Metrics: iAdBackfillImpressions

String

Number of times that iAd backfill ads appeared in your channels.

Metrics: DirectSoldImpressions

String

Number of times that direct-sold ads appeared in your channels.

Metrics: HouseImpressions

String

Number of times that in-house ads appeared in your channels.

Metrics: TTR

String

Tap-through rate.

Metrics: iAdBackfillRevenue

String

Revenue from iAd backfill ads displayed.

Success

Boolean

true or false depending on whether the call succeeded or not.