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

OpenObserve Dashboards API

Dashboard operations

OpenObserve Dashboards API is one of 33 APIs that OpenObserve publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Dashboards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 15 operations across 9 paths, and defines 57 schemas. It is described by OpenAPI 3.1.0, at version 0.90.0.

Requests are made against the base URL https://api.openobserve.ai.

15 operations 9 paths 57 schemas 4 DELETE3 GET1 PATCH3 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.90.0
Base URL
https://api.openobserve.ai
Authentication
API Key, HTTP Basic
License
AGPL-3.0
Resource Areas
1

Authentication & Security 2

OpenObserve Dashboards API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (Authorization). It accepts HTTP basic authentication (BasicAuth).

Paths & Operations 15

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

Dashboards 15

Dashboard operations

GET
/api/{org_id}/dashboards
List organization dashboards
ListDashboards 4 params → 200
POST
/api/{org_id}/dashboards
Create new dashboard
CreateDashboard 2 params body → 201404500
PATCH
/api/{org_id}/dashboards/move
Move multiple dashboards
MoveDashboards 1 param body → 200404500
GET
/api/{org_id}/dashboards/{dashboard_id}
Get dashboard details
GetDashboard 3 params → 200403404
PUT
/api/{org_id}/dashboards/{dashboard_id}
Update existing dashboard
UpdateDashboard 4 params body → 200404409500
DELETE
/api/{org_id}/dashboards/{dashboard_id}
Delete dashboard
DeleteDashboard 3 params → 200403404500
GET
/api/{org_id}/dashboards/{dashboard_id}/annotations
Get timed annotations for dashboard
GetAnnotations 5 params → 200400500
POST
/api/{org_id}/dashboards/{dashboard_id}/annotations
Create timed annotations for dashboard
CreateAnnotations 2 params body → 200500
DELETE
/api/{org_id}/dashboards/{dashboard_id}/annotations
Delete timed annotations from dashboard
DeleteAnnotations 2 params body → 200500
DELETE
/api/{org_id}/dashboards/{dashboard_id}/annotations/panels/{timed_annotation_id}
Remove timed annotation from panel
RemoveTimedAnnotationFromPanel 3 params body → 200500
PUT
/api/{org_id}/dashboards/{dashboard_id}/annotations/{timed_annotation_id}
Update timed annotation
UpdateAnnotations 3 params body → 200500
POST
/api/{org_id}/dashboards/{dashboard_id}/panels
Add a panel to a dashboard
AddPanel 4 params body → 200400404409
PUT
/api/{org_id}/dashboards/{dashboard_id}/panels/{panel_id}
Update a single panel in a dashboard
UpdatePanel 5 params body → 200400404409
DELETE
/api/{org_id}/dashboards/{dashboard_id}/panels/{panel_id}
Delete a single panel from a dashboard
DeletePanel 6 params → 200400404409
PUT
/api/{org_id}/folders/dashboards/{dashboard_id}
Move dashboard to folder
MoveDashboard 2 params body → 200404

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are PanelConfig (59 properties), ListDashboardsResponseBodyItem (19 properties), PanelFields (17 properties), VariableList (14 properties). Each schema is shown below with its type and property counts.

DrillDownVariables
object
2 properties
ColorBySeries
object
3 properties
PanelFields
object
17 properties 5 required
Panel
object
11 properties 6 required
TimedAnnotation
object
7 properties
PromQLOperation
object
2 properties
ListDashboardsResponseBodyItem
object
An item in the list returned by the ListDashboards endpoint.
19 properties 11 required
AxisType
string
Variables
object
2 properties
AxisArg
object
2 properties
LegendHeight
object
2 properties
Join
object
4 properties 4 required
MarkLine
object
3 properties
Trellis
object
3 properties
PromQLLabelFilter
object
3 properties
AxisArgValueWrapper
JoinCondition
object
3 properties 3 required
BaseMap
object
1 property
FilterCondition
object
7 properties 4 required
StreamFieldObj
object
2 properties
Field
object
2 properties
DateTimeOptions
object
4 properties
DrillDown
object
5 properties
DrillDownData
object
8 properties
Query
object
6 properties 3 required
AxisItem
object
13 properties 2 required
LabelPosition
string
HavingConditions
object
2 properties
PromQLOperationParam
Background
object
2 properties 1 required
Dashboard
object
10 properties 2 required
QueryConfig
object
8 properties 1 required
SizeByValue
object
2 properties
Layout
object
5 properties
LabelOption
object
2 properties
SelectedField
object
2 properties 1 required
MapSymbolStyle
object
3 properties
Tab
object
3 properties 2 required
Filters
object
3 properties
MapType
object
1 property
PanelConfig
object
59 properties 1 required
MapView
object
3 properties
TimeShift
object
1 property
OverrideConfig
object
2 properties
ColorCfg
object
4 properties
Config
GroupType
object
3 properties 3 required
Mapping
object
8 properties
LegendWidth
object
2 properties
StreamType
string
CustomFieldsOption
object
3 properties
QueryData
object
5 properties
AxisArgValue
object
2 properties
PanelFilter
BackgroundValue
object
1 property 1 required
LineInterpolation
string
VariableList
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openobserve-dashboards-api-openapi.yml Raw ↑

Other APIs OpenObserve publishes across the network.

OpenObserve Actions API
OpenObserve Alerts API
OpenObserve Clusters API
OpenObserve Folders API
OpenObserve Functions API
OpenObserve Groups API
OpenObserve Incidents API
OpenObserve Key API
OpenObserve Keys API
OpenObserve KV API
OpenObserve Logs API
OpenObserve MCP API
Where this information came from

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