Evaluates an instant query at a single point in time

GET 
https://api.logz.io/v1/metrics/prometheus/api/v1/query

Retrieve data by submitting a GET request with query parameters. Please ensure to change the region in the URL to match your account's region.

Request

Query Parameters

query stringrequired

Prometheus expression query string.

time string

Evaluation timestamp as an RFC3339 or Unix timestamp. Optional.

timeout string

Evaluation timeout. Defaults to the value of the -query.timeout flag.

Responses

200

Query results in a defined format.

application/json

Schema

Schema

status string

Status of the query (e.g., success, fail).

data object
resultType string
Possible values: [matrix, vector, scalar, string]
Type of the result.
result object[]
Array [
metric objectrequired
Labels identifying the metric.
property name* string
value string[]required
Possible values: >= 2, <= 2
The actual data point returned by the query, with timestamp and value.
]

Example (from schema)

{
  "status": "string",
  "data": {
    "resultType": "matrix",
    "result": [
      {
        "metric": {},
        "value": [
          "string"
        ]
      }
    ]
  }
}

400

Invalid request parameters.

500

Internal server error.

Authorization: X-API-TOKEN

name: X-API-TOKENtype: apiKeydescription: You can manage your API tokens from the [Logz.io API tokens](https://app.logz.io/#/dashboard/settings/manage-tokens/api) page.

API tokens are account-specific. You will need to be logged into the relevant Log Management or SIEM account to view the API tokens associated with it.

To manage your API tokens, log into the relevant account in your Logz.io platform, click the gear in the top-right menu, and select [**Tools > Manage tokens > API tokens**](https://app.logz.io/#/dashboard/settings/manage-tokens/api).

It's important to keep your tokens secure. API tokens carry privileges to make changes to users and accounts, so if you believe an API token has been compromised, delete it, and replace it with a new token in your integrations.in: header

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://api.logz.io/v1/metrics/prometheus/api/v1/query' \
-H 'Accept: application/json' \
-H 'X-API-TOKEN: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://api.logz.io

Auth

X-API-TOKEN

Parameters

query — queryrequired

time — query

timeout — query