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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
SigNoz

SigNoz dashboard API

The dashboard API from SigNoz — 3 operation(s) for dashboard.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Dashboard. 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 6 operations across 3 paths, and defines 31 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}.

6 operations 3 paths 31 schemas 1 DELETE3 GET1 POST1 PUT

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
Contact
SigNoz Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

SigNoz dashboard 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 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

dashboard 6
DELETE
/api/v1/dashboards/{id}/public
Delete public dashboard
DeletePublicDashboard 1 param → 204401403500
GET
/api/v1/dashboards/{id}/public
Get public dashboard
GetPublicDashboard 1 param → 200401403500
POST
/api/v1/dashboards/{id}/public
Create public dashboard
CreatePublicDashboard 1 param body → 201401403500
PUT
/api/v1/dashboards/{id}/public
Update public dashboard
UpdatePublicDashboard 1 param body → 204401403500
GET
/api/v1/public/dashboards/{id}
Get public dashboard data
GetPublicDashboardData 1 param → 200401403500
GET
/api/v1/public/dashboards/{id}/widgets/{idx}/query_range
Get query range result
GetPublicDashboardWidgetQueryRange 2 params → 200401403500

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are Querybuildertypesv5ColumnDescriptor (10 properties), Querybuildertypesv5AggregationBucket (8 properties), DashboardtypesDashboard (8 properties), TelemetrytypesTelemetryFieldKey (6 properties). Each schema is shown below with its type and property counts.

TelemetrytypesFieldContext
string
DashboardtypesUpdatablePublicDashboard
object
2 properties
Querybuildertypesv5QueryWarnData
object
3 properties
Querybuildertypesv5QueryRangeResponse
object
Response from the v5 query range endpoint. The data.results array contains typed results depending on the requestType: TimeSeriesData for timeseries, ScalarDat…
4 properties
RenderErrorResponse
object
2 properties 2 required
Querybuildertypesv5ExecStats
object
Execution statistics for the query, including rows scanned, bytes scanned, and duration.
4 properties
Querybuildertypesv5Bucket
object
1 property
DashboardtypesGettablePublicDasbhboard
object
3 properties
DashboardtypesGettablePublicDashboardData
object
2 properties
Querybuildertypesv5RawData
object
3 properties
Querybuildertypesv5TimeSeries
object
2 properties
ErrorsResponseerroradditional
object
1 property
Querybuildertypesv5AggregationBucket
object
8 properties
Querybuildertypesv5QueryWarnDataAdditional
object
1 property
DashboardtypesDashboard
object
8 properties
Querybuildertypesv5RawRow
object
2 properties
DashboardtypesPostablePublicDashboard
object
2 properties
TelemetrytypesSignal
string
Querybuildertypesv5Label
object
2 properties
Querybuildertypesv5TimeSeriesData
object
2 properties
Querybuildertypesv5TimeSeriesValue
object
5 properties
TypesIdentifiable
object
1 property 1 required
Querybuildertypesv5ColumnDescriptor
object
10 properties 1 required
Querybuildertypesv5RequestType
string
ErrorsJSON
object
4 properties 2 required
Querybuildertypesv5ColumnType
string
TelemetrytypesFieldDataType
string
DashboardtypesStorableDashboardData
object
Querybuildertypesv5QueryData
object
1 property
Querybuildertypesv5ScalarData
object
3 properties
TelemetrytypesTelemetryFieldKey
object
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signoz-dashboard-api-openapi.yml Raw ↑

Other APIs SigNoz publishes across the network.

SigNoz alerts API
AE Profile APIs.io
SigNoz authdomains API
AE Profile APIs.io
SigNoz authz API
AE Profile APIs.io
SigNoz channels API
AE Profile APIs.io
SigNoz cloudintegration API
AE Profile APIs.io
SigNoz downtimeschedules API
AE Profile APIs.io
SigNoz features API
AE Profile APIs.io
SigNoz fields API
AE Profile APIs.io
SigNoz gateway API
AE Profile APIs.io
SigNoz global API
AE Profile APIs.io
SigNoz health API
AE Profile APIs.io
SigNoz inframonitoring API
AE Profile APIs.io
#Dashboard
← Back to S APIs
API Details
ID
signoz:signoz-dashboard-api
Base URL
https://{host}:{port}
Docs
https://signoz.io
Provider
SigNoz
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=signoz-dashboard-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/signoz-dashboard-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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