---
title: "POST /v1/{+parent}/securityReports"
method: POST
path: "/v1/{+parent}/securityReports"
tags: ["organizations"]
---

# POST /v1/{+parent}/securityReports

`POST /v1/{+parent}/securityReports`

Submit a report request to be processed in the background. If the submission succeeds, the API returns a 200 status and an ID that refer to the report request. In addition to the HTTP status 200, the `state` of "enqueued" means that the request succeeded.

## Path parameters

- `parent` string, required

## Request body

- GoogleCloudApigeeV1SecurityReportQuery — Body structure when user makes a request to create a security report.
  - `metrics` GoogleCloudApigeeV1SecurityReportQueryMetric[] — A list of Metrics.
    - `operator` string — One of `+`, `-`, `/`, `%`, `*`.
    - `value` string — Operand value should be provided when operator is set.
    - `name` string — Required. Metric name.
    - `alias` string — Alias for the metric. Alias will be used to replace metric name in query results.
    - `aggregationFunction` string — Aggregation function: avg, min, max, or sum.
  - `envgroupHostname` string — Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.
  - `dimensions` string[] — A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
  - `limit` integer — Maximum number of rows that can be returned in the result.
  - `reportDefinitionId` string — Report Definition ID.
  - `displayName` string — Security Report display name which users can specify.
  - `filter` string — 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` string — 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.
  - `mimeType` string — Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property.
  - `csvDelimiter` string — Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\t`).
  - `timeRange` unknown

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/apigee.md) · [All operations](https://skmtc.net/google/apis/apigee/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/apigee/versions/6e272fa448a7/schema)