ReportAggregation Value Set - Reporting

Article
11/13/2024

Defines the aggregation values that you can use for a report.

Note

We don't support partial data aggregation for weekly, monthly, and yearly time period columns. If the selected dates are not full weeks/months/years and the corresponding weekly/monthly/yearly time period column is requested, the selected dates will be converted to full weeks/months/years.

Syntax

<xs:simpleType name="ReportAggregation" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:restriction base="xs:string">
    <xs:enumeration value="Summary" />
    <xs:enumeration value="Hourly" />
    <xs:enumeration value="Daily" />
    <xs:enumeration value="Weekly" />
    <xs:enumeration value="Monthly" />
    <xs:enumeration value="Yearly" />
    <xs:enumeration value="HourOfDay" />
    <xs:enumeration value="DayOfWeek" />
    <xs:enumeration value="WeeklyStartingMonday" />
  </xs:restriction>
</xs:simpleType>

Values

The ReportAggregation value set has the following values: Daily, DayOfWeek, Hourly, HourOfDay, Monthly, Summary, Weekly, WeeklyStartingMonday, Yearly.

Value	Description
Daily	Each row of the report identifies the month, day, and year when the transaction occurred. The report data will be aggregated by each day. The time period will be formatted as yyyy-mm-dd.
DayOfWeek	Each row of the report identifies the day of the week when the transaction occurred. The report data will be aggregated by each of the seven days in a week. The possible data values are 1 - 7 where 1 represents Sunday and 7 represents Saturday. If the report time spans multiple weeks, then the performance data across all weeks for a given day of the week will be aggregated in one row. For example if Campaign A has 5 impressions every Monday (day 2) throughout each of the 3 weeks included in the report time range, then the report will include one row with a 2 in the TimePeriod column and the impressions in that row totaling 15.
Hourly	Each row of the report identifies the hour when the transaction occurred. The report data will be aggregated by each hour of the day. By default the time period will be formatted with the date and hour (int value) delimited by a single pipe i.e., "mm/dd/yyyy 12:00:00 AM\|hour" where 12:00:00 AM can be ignored. For example, if the click occurred March 15, 2018 between 07:00 and 08:00, then the field in the downloaded report would be "3/15/2018 12:00:00 AM\|7". If you set the report FormatVersion to "2.0", the time period will be formatted as "yyyy-mm-dd\|hour". For example, if the click occurred March 15, 2020 between 07:00 and 08:00, then the field in the downloaded report would be "2020-03-15\|7". The possible values for the hour component are 0 - 23. If the report time spans multiple days, then the performance data for a given hour will be provided separately across multiple rows i.e. the report will include one row for each unique day and hour. For example if Campaign A has 5 impressions during Hour 7 on each of the 3 days included in the report time range, then the report will include three rows each with 5 impressions for Hour 7.
HourOfDay	Each row of the report identifies the hour of the day when the transaction occurred. The report data will be aggregated by each of the 24 hours across all days. The possible values are 0 - 23. If the report time spans multiple days, then the performance data across all days for a given hour will be aggregated in one row. For example if Campaign A has 5 impressions during hour 7 on each of the 3 days included in the report time range, then the report will include one row with impressions for HourOfDay totaling 15.
Monthly	Each row of the report identifies the month when the transaction occurred. The report data will be aggregated by each month. The time period that contains the first day of the month will be formatted as yyyy-mm-dd.
Summary	The report data will be aggregated by the entire specified report time. The report will not include a time period column.
Weekly	Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week running from Sunday through Saturday. The time period that contains the date of the Sunday for each week will be formatted as yyyy-mm-dd.
WeeklyStartingMonday	Each row of the report identifies the week when the transaction occurred. The report data will be aggregated by each week running from Monday through Sunday. The time period that contains the date of the Monday for each week will be formatted as yyyy-mm-dd.
Yearly	Each row of the report identifies the year when the transaction occurred. The report data will be aggregated by each year. The time period that contains the year will be formatted as yyyy.

Requirements

Service: ReportingService.svc v13
Namespace: https://bingads.microsoft.com/Reporting/v13

Used By

Share via

ReportAggregation Value Set - Reporting

Syntax

Values

Requirements

Used By

Feedback

Additional resources