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

# POST /v1/{+parent}/queries

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

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

## Path parameters

- `parent` string, required

## Request body

- GoogleCloudApigeeV1Query
  - `metrics` GoogleCloudApigeeV1QueryMetric[] — A list of Metrics.
    - `name` string — Required. Metric name.
    - `function` string — Aggregation function: avg, min, max, or sum.
    - `alias` string — Alias for the metric. Alias will be used to replace metric name in query results.
    - `value` string — Operand value should be provided when operator is set.
    - `operator` string — One of `+`, `-`, `/`, `%`, `*`.
  - `outputFormat` string — Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property.
  - `limit` integer — Maximum number of rows that can be returned in the result.
  - `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 CreateHostAsyncQuery 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
  - `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
  - `reportDefinitionId` string — Asynchronous Report ID.
  - `timeRange` unknown
  - `name` string — Asynchronous Query Name.
  - `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.
  - `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`).

## 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)