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

SigNoz metrics API

The metrics API from SigNoz — 10 operation(s) for metrics.

SigNoz metrics API is one of 29 APIs that SigNoz publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metrics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a GitHub repository, pricing, and a getting-started guide.

This API exposes 11 operations across 10 paths, and defines 38 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{host}:{port}{base_path}.

11 operations 10 paths 38 schemas 7 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{host}:{port}
Authentication
API Key, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

SigNoz metrics API declares 2 security schemes for authenticating requests. An API key is passed in the header as SigNoz-Api-Key (api_key). It accepts HTTP bearer tokens (Tokenizer) (tokenizer).

  • api_key — API Keys
  • tokenizer — Tokens generated by the tokenizer

Paths & Operations 11

Across 10 paths, the API surfaces 11 operations — 7 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

metrics 11
GET
/api/v2/metrics
List metric names
ListMetrics 5 params → 200400401403500
GET
/api/v2/metrics/{metric_name}/alerts
Get metric alerts
GetMetricAlerts 1 param → 200400401403404500
GET
/api/v2/metrics/{metric_name}/attributes
Get metric attributes
GetMetricAttributes 3 params → 200400401403404500
GET
/api/v2/metrics/{metric_name}/dashboards
Get metric dashboards
GetMetricDashboards 1 param → 200400401403404500
GET
/api/v2/metrics/{metric_name}/highlights
Get metric highlights
GetMetricHighlights 1 param → 200400401403404500
GET
/api/v2/metrics/{metric_name}/metadata
Get metric metadata
GetMetricMetadata 1 param → 200400401403404500
POST
/api/v2/metrics/{metric_name}/metadata
Update metric metadata
UpdateMetricMetadata 1 param body → 200400401403500
POST
/api/v2/metrics/inspect
Inspect raw metric data points
InspectMetrics body → 200400401403500
GET
/api/v2/metrics/onboarding
Check if non-SigNoz metrics have been received
GetMetricsOnboardingStatus → 200401403500
POST
/api/v2/metrics/stats
Get metrics statistics
GetMetricsStats body → 200400401403500
POST
/api/v2/metrics/treemap
Get metrics treemap
GetMetricsTreemap body → 200400401403500

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are Querybuildertypesv5OrderByKey (6 properties), MetricsexplorertypesUpdateMetricMetadataRequest (6 properties), MetricsexplorertypesStatsRequest (6 properties), MetricsexplorertypesStat (6 properties). Each schema is shown below with its type and property counts.

TelemetrytypesFieldContext
string
RenderErrorResponse
object
2 properties 2 required
Querybuildertypesv5OrderDirection
string
MetricsexplorertypesMetricHighlightsResponse
object
4 properties 4 required
Querybuildertypesv5Bucket
object
1 property
MetricsexplorertypesStatsRequest
object
6 properties 3 required
MetricsexplorertypesTreemapRequest
object
5 properties 4 required
MetricsexplorertypesMetricDashboardsResponse
object
1 property 1 required
Querybuildertypesv5Filter
object
1 property
Querybuildertypesv5TimeSeries
object
2 properties
MetricsexplorertypesMetricAlertsResponse
object
1 property 1 required
MetricsexplorertypesMetricMetadata
object
5 properties 5 required
MetricsexplorertypesMetricsOnboardingResponse
object
1 property 1 required
MetricsexplorertypesMetricAttributesResponse
object
2 properties 2 required
ErrorsResponseerroradditional
object
1 property
MetricsexplorertypesTreemapMode
string
Querybuildertypesv5OrderBy
object
2 properties
MetricsexplorertypesMetricDashboard
object
4 properties 4 required
TelemetrytypesSignal
string
MetricsexplorertypesTreemapEntry
object
3 properties 3 required
MetricsexplorertypesInspectMetricsResponse
object
1 property 1 required
Querybuildertypesv5Label
object
2 properties
MetricsexplorertypesListMetric
object
6 properties 6 required
MetrictypesType
string
Querybuildertypesv5TimeSeriesValue
object
5 properties
ErrorsJSON
object
4 properties 2 required
MetricsexplorertypesStat
object
6 properties 6 required
TelemetrytypesFieldDataType
string
MetricsexplorertypesMetricAlert
object
2 properties 2 required
MetricsexplorertypesInspectMetricsRequest
object
4 properties 3 required
MetricsexplorertypesTreemapResponse
object
2 properties 2 required
MetricsexplorertypesUpdateMetricMetadataRequest
object
6 properties 6 required
MetricsexplorertypesMetricAttribute
object
3 properties 3 required
Querybuildertypesv5OrderByKey
object
6 properties 1 required
MetrictypesTemporality
string
MetricsexplorertypesStatsResponse
object
2 properties 2 required
TelemetrytypesTelemetryFieldKey
object
6 properties 1 required
MetricsexplorertypesListMetricsResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signoz-metrics-api-openapi.yml Raw ↑

Other APIs SigNoz publishes across the network.

SigNoz alerts API
SigNoz authdomains API
SigNoz authz API
SigNoz channels API
SigNoz cloudintegration API
SigNoz dashboard API
SigNoz downtimeschedules API
SigNoz features API
SigNoz fields API
SigNoz gateway API
SigNoz global API
SigNoz health API
Where this information came from

This is an independent, third-party profile of SigNoz 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.