Query Stored Data Analytics

Retrieves Workers KV stored data metrics for the given account.

Responses

🟢200Query Stored Data Analytics response

application/json

Body

result

stored_components-schemas-result

required

Any of

schemas-result

allOf {3}

Metrics on Workers KV requests.

data

array [object {1}] | null

required

Example:

[{"metrics":[[2,4],[16,32]]}]

data_lag

number

required

Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing.

>= 0

Example:

max

required

Maximum results for each metric.

Example:

{"storedBytes":32,"storedKeys":4}

min

required

Minimum results for each metric.

Example:

{"storedBytes":16,"storedKeys":2}

query

object

components-schemas-query

required

For specifying result metrics.

rows

number

required

Total number of rows in the result.

>= 0

Example:

totals

required

Total results for metrics across all data.

Example:

{"storedBytes":48,"storedKeys":6}

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "data": [
            {
                "metrics": [
                    [
                        2,
                        4
                    ],
                    [
                        16,
                        32
                    ]
                ]
            }
        ],
        "data_lag": 0,
        "max": {
            "storedBytes": 32,
            "storedKeys": 4
        },
        "min": {
            "storedBytes": 16,
            "storedKeys": 2
        },
        "query": {
            "dimensions": [
                "namespaceId"
            ],
            "filters": "namespaceId==a4e8cbb7-1b58-4990-925e-e026d40c4c64",
            "limit": 10000,
            "metrics": [
                "storedBytes",
                "storedKeys"
            ],
            "since": "2019-01-02T02:20:00Z",
            "sort": [
                "+storedBytes",
                "-namespaceId"
            ],
            "until": "2019-01-02T03:20:00Z"
        },
        "rows": 2,
        "totals": {
            "storedBytes": 48,
            "storedKeys": 6
        }
    },
    "success": true
}

🟢200Query Stored Data Analytics response failure

Query Stored Data Analytics

Request

Request samples

Responses