workers-kv_query

For specifying result metrics.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
dimensions	array	Can be used to break down the data by given attributes.
filters	string	Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,)
limit	integer	Limit number of returned metrics.
metrics	array	One or more metrics to compute.
since	string	Start of time interval to query, defaults to 6 hours before request received.
sort	array	Array of dimensions or metrics to sort by, each dimension/metric may be prefixed by - (descending) or + (ascending).
until	string	End of time interval to query, defaults to current time.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/workers-kv_query",
  "title": "workers-kv_query",
  "description": "For specifying result metrics.",
  "properties": {
    "dimensions": {
      "default": "[]",
      "description": "Can be used to break down the data by given attributes.",
      "items": {
        "description": "For drilling down on metrics.",
        "type": "string"
      },
      "type": "array"
    },
    "filters": {
      "default": "\"\"",
      "description": "Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are:\n\nOperator                  | Name                            | URL Encoded\n--------------------------|---------------------------------|--------------------------\n==                        | Equals                          | %3D%3D\n!=                        | Does not equals                 | !%3D\n>                        | Greater Than                    | %3E\n<                         | Less Than                       | %3C\n>=                       | Greater than or equal to        | %3E%3D\n<=                        | Less than or equal to           | %3C%3D     .",
      "type": "string"
    },
    "limit": {
      "default": 10000,
      "description": "Limit number of returned metrics.",
      "type": "integer"
    },
    "metrics": {
      "description": "One or more metrics to compute.",
      "items": {
        "description": "A quantitative measurement of KV usage.",
        "type": "string"
      },
      "type": "array"
    },
    "since": {
      "default": "<6 hours ago>",
      "description": "Start of time interval to query, defaults to 6 hours before request received.",
      "example": "2019-01-02T02:20:00Z",
      "format": "date-time",
      "type": "string"
    },
    "sort": {
      "default": "[]",
      "description": "Array of dimensions or metrics to sort by, each dimension/metric may be prefixed by - (descending) or + (ascending).",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "until": {
      "default": "<now>",
      "description": "End of time interval to query, defaults to current time.",
      "example": "2019-01-02T03:20:00Z",
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}