How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Grafana Metrics API

The Metrics API from Grafana — 1 operation(s) for metrics.

Grafana Metrics API is one of 78 APIs that Grafana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Metrics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, and 1 JSON Schema.

This API exposes 1 operation across 1 path, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 0.0.1.

Requests are made against 2 base URLs: http://{defaultHost}, https://{defaultHost}.

1 operations 1 paths 18 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.1
Base URL
http://localhost:3000/api
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

Grafana Metrics API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (api_key). It accepts HTTP basic authentication (basic). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Metrics 1
POST
/ds/query
Grafana Query Metrics With Expressions
queryMetricsWithExpressions body → 200207400401403500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are QueryStatisusedforstoringarbitrarystatisticsmetadatarelatedtoaqueryanditsresulte.g.totalrequesttimedataprocessingtime. (19 properties), FieldConfigrepresentsthedisplaypropertiesforaField. (18 properties), FrameMetamatches (13 properties), InternalDataLink (6 properties). Each schema is shown below with its type and property counts.

FrameMetamatches
object
https://github.com/grafana/grafana/blob/master/packages/grafana-data/src/types/data.tsL11 NOTE -- in javascript this can accept any [key: string]: any; however…
13 properties
NoticeprovidesastructureforpresentingnotificationsinGrafanasuserinterface.
object
4 properties
FieldTypeConfig
object
FieldTypeConfig has type specific configs, only one should be active at a time
1 property
Threshold
object
Threshold a single step on the threshold list
3 properties
QueryDataResponsecontainstheresultsfromaQueryDataRequest.
object
It is the return type of a QueryData call.
1 property
InternalDataLink
object
InternalDataLink definition to allow Explore links to be constructed in the backend
6 properties
ErrorResponseBody
object
3 properties 1 required
LinkTransformationConfig
object
4 properties
FieldrepresentsatypedcolumnofdatawithinaFrame.
object
A Field is essentially a slice of various types with extra properties and methods. See NewField() for supported types. The slice data in the Field is a not exp…
3 properties
DataLink
object
DataLink define what
4 properties
FieldConfigrepresentsthedisplaypropertiesforaField.
object
18 properties
FrameisacolumnardatastructurewhereeachcolumnisaField.
object
Each Field is well typed by its FieldType and supports optional Labels. A Frame is a general data container for Grafana. A Frame can be table data or time seri…
4 properties
MetricRequest
object
4 properties 3 required
TimeRange
object
Redefining this to avoid an import cycle
2 properties
QueryStatisusedforstoringarbitrarystatisticsmetadatarelatedtoaqueryanditsresulte.g.totalrequesttimedataprocessingtime.
object
The embedded FieldConfig's display name must be set. It corresponds to the QueryResultMetaStat on the frontend (https://github.com/grafana/grafana/blob/master/…
19 properties
DataResponsecontainstheresultsfromaDataQuery.
object
A map of RefIDs (unique query identifiers) to this type makes up the Responses property of a QueryDataResponse. The Error property is used to allow for partial…
4 properties
EnumFieldConfig
object
Enum field config Vector values are used as lookup keys into the enum fields
4 properties
ThresholdsConfig
object
ThresholdsConfig setup thresholds
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

grafana-metrics-api-openapi.yml Raw ↑

Other APIs Grafana publishes across the network.

Grafana Access API
Grafana Account API
Grafana Accounts API
Grafana Add API
Grafana Address API
Grafana Administrative API
Grafana Alerts API
Grafana All API
Grafana Annotations API
Grafana Built API
Grafana Cache API
Grafana Call API
Where this information came from

This is an independent, third-party profile of Grafana Metrics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.