Body structure when user makes a request to create a security report.
JSON representation |
---|
{
"metrics": [
{
object ( |
Fields | |
---|---|
metrics[] |
A list of Metrics. |
dimensions[] |
A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions |
timeRange |
Required. Time range for the query. Can use the following predefined strings to specify the time range: Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" } |
filter |
Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax |
groupByTimeUnit |
Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision. |
limit |
Maximum number of rows that can be returned in the result. |
mimeType |
Valid values include: |
csvDelimiter |
Delimiter used in the CSV file, if |
envgroupHostname |
Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by |
reportDefinitionId |
Report Definition ID. |
displayName |
Security Report display name which users can specify. |
Metric
Metric of the Query
JSON representation |
---|
{ "name": string, "aggregationFunction": string, "alias": string, "operator": string, "value": string } |
Fields | |
---|---|
name |
Required. Metric name. |
aggregationFunction |
Aggregation function: avg, min, max, or sum. |
alias |
Alias for the metric. Alias will be used to replace metric name in query results. |
operator |
One of |
value |
Operand value should be provided when operator is set. |