Create a dashboard

post

https://{customerid}.observeinc.com/v1/dashboards

Beta — may change; breaking changes are coordinated with affected
customers. Suitable for evaluation, not production reliance.

Create a dashboard. The server assigns id, createdAt, updatedAt,
createdBy, and updatedBy.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

expand

boolean

Whether to expand resources referenced in the response to include additional fields

Body Params

Request body for creating a dashboard. Identity and audit fields are
assigned by the server.

schemaVersion

integer

enum

required

Must be 2.

Allowed:

name

string

required

length ≥ 1

description

string | null

visibility

string

enum

Default Listed when omitted.

Allowed:

objectTags

object

User-applied tags for organization and discovery, as a map of tag key
to a list of values. For example: {"env": ["prod", "staging"], "team": ["platform"]}.

definition

object

required

The dashboard body — what the dashboard shows — kept separate
from the identity, audit, and governance metadata on the
dashboard itself so the two can evolve independently. This is
the object governed by schemaVersion.

Responses

Language

Credentials

Bearer

Authorization: Bearer <customerid> <apitoken>

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Dashboard created successfully

400Bad request

401Unauthorized

403Forbidden

409Conflict

429Rate limit reached

5XXInternal server error