SearchAnalyticsQueryRequest class
Properties
-
aggregationType
↔ String
-
Optional; Default is "auto"
How data is aggregated. If aggregated by
property, all data for the same property is aggregated; if aggregated by
page, all data is aggregated by canonical URI. If you filter or group by
page, choose AUTO; otherwise you can aggregate either by property or by
page, depending on how you want your data calculated; see the help
documentation to learn how data is calculated differently by site versus
by page. [...]
read / write
-
dimensionFilterGroups
↔ List<ApiDimensionFilterGroup>
-
Optional
Zero or more filters to apply to the dimension grouping values;
for example, 'query contains "buy"' to see only data where the query
string contains the substring "buy" (not case-sensitive). You can filter
by a dimension without grouping by it.
read / write
-
dimensions
↔ List<String>
-
Optional
Zero or more dimensions to group results by. Dimensions are the
group-by values in the Search Analytics page. Dimensions are combined to
create a unique row key for each row. Results are grouped in the order
that you supply these dimensions.
read / write
-
endDate
↔ String
-
Required End date of the requested date range, in YYYY-MM-DD format, in
PST (UTC - 8:00). Must be greater than or equal to the start date. This
value is included in the range.
read / write
-
hashCode
→ int
-
The hash code for this object. [...]
read-only, inherited
-
rowLimit
↔ int
-
Optional; Default is 1000
The maximum number of rows to return. Must be
a number from 1 to 5,000 (inclusive).
read / write
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
read-only, inherited
-
searchType
↔ String
-
Optional; Default is "web"
The search type to filter for.
read / write
-
startDate
↔ String
-
Required Start date of the requested date range, in YYYY-MM-DD format,
in PST time (UTC - 8:00). Must be less than or equal to the end date. This
value is included in the range.
read / write
-
startRow
↔ int
-
Optional; Default is 0
Zero-based index of the first row in the
response. Must be a non-negative number.
read / write