---
title: "Get a dashboard"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Observability API

`GET /v1/organizations/{orgId}/projects/{projectId}/obs/dashboards/{dashboardId}`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `GetDashboard.path.orgId` (string, required)
  - format `uuid`
- `GetDashboard.path.projectId` (string, required)
  - format `uuid`
- `GetDashboard.path.dashboardId` (string, required)
  - format `uuid`

## Code samples

### cURL

```curl
curl --request GET \
  --url https://obs.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/obs/dashboards/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://obs.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/obs/dashboards/497f6eca-6276-4993-bfeb-53cbbbba6f08';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://obs.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/obs/dashboards/497f6eca-6276-4993-bfeb-53cbbbba6f08"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

The dashboard.

#### Example

```json
{
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string",
    "type": "string"
  },
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "panelCount": 50,
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "region": "string",
  "resourceName": "string",
  "slug": "string",
  "status": "active",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "updatedBy": {
    "id": "string",
    "type": "string"
  },
  "version": 1,
  "spec": {}
}
```

- `GetDashboard.response.200.createdAt` (string, required) — UTC, millisecond precision: 2026-10-02T10:20:00.000Z.
  - format `date-time`
- `GetDashboard.response.200.createdBy` (object, required)
  - `GetDashboard.response.200.createdBy.id` (string, required)
  - `GetDashboard.response.200.createdBy.type` (string, required) — user or bot (org-api's principal type).
- `GetDashboard.response.200.description` (string, required)
  - maxLength 1000
- `GetDashboard.response.200.id` (string, required)
  - format `uuid`
- `GetDashboard.response.200.name` (string, required)
  - minLength 1; maxLength 100
- `GetDashboard.response.200.organizationId` (string, required)
  - format `uuid`
- `GetDashboard.response.200.panelCount` (integer, required)
  - min 0; max 50
- `GetDashboard.response.200.projectId` (string, required)
  - format `uuid`
- `GetDashboard.response.200.region` (string, required)
- `GetDashboard.response.200.resourceName` (string, required)
- `GetDashboard.response.200.slug` (string, required) — dsh_ followed by 12 characters.
- `GetDashboard.response.200.status` (unknown, required)
  - one of `"active"`
- `GetDashboard.response.200.tags` (map<string>, required) — At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved.
- `GetDashboard.response.200.updatedAt` (string, required) — UTC, millisecond precision: 2026-10-02T10:20:00.000Z.
  - format `date-time`
- `GetDashboard.response.200.updatedBy` (object, required)
  - `GetDashboard.response.200.updatedBy.id` (string, required)
  - `GetDashboard.response.200.updatedBy.type` (string, required) — user or bot (org-api's principal type).
- `GetDashboard.response.200.version` (integer, required) — The latest saved version: 1 at create, one more for each change of name, description or spec.
  - min 1
- `GetDashboard.response.200.spec` (object, required) — The dashboard's variables, default time range, refresh interval and panels, as the JSON Schema contracts/schemas/obs-dashboard-spec.v1.json (service-template) defines them: at most 256 KiB, 50 panels, 4 queries per panel and 10 variables; unknown fields are refused. Queries aren't checked: a bad one fails when its panel runs.

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetDashboard.response.400.error` (object, required)
  - `GetDashboard.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetDashboard.response.400.error.message` (string, required)
    - maxLength 1024
  - `GetDashboard.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetDashboard.response.400.error.issues.message` (string, required)
    - `GetDashboard.response.400.error.issues.path` (string, required)
  - `GetDashboard.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetDashboard.response.400.error.quota.id` (string, required)
    - `GetDashboard.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetDashboard.response.400.error.quota.limit` (integer, required)
      - min 0
    - `GetDashboard.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetDashboard.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetDashboard.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetDashboard.response.400.error.quota.region` (string, optional)
    - `GetDashboard.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetDashboard.response.400.error.quota.scopeResourceName` (string, optional)
    - `GetDashboard.response.400.error.quota.used` (integer, optional)
      - min 0
    - `GetDashboard.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetDashboard.response.401.error` (object, required)
  - `GetDashboard.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetDashboard.response.401.error.message` (string, required)
    - maxLength 1024
  - `GetDashboard.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetDashboard.response.401.error.issues.message` (string, required)
    - `GetDashboard.response.401.error.issues.path` (string, required)
  - `GetDashboard.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetDashboard.response.401.error.quota.id` (string, required)
    - `GetDashboard.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetDashboard.response.401.error.quota.limit` (integer, required)
      - min 0
    - `GetDashboard.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetDashboard.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetDashboard.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetDashboard.response.401.error.quota.region` (string, optional)
    - `GetDashboard.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetDashboard.response.401.error.quota.scopeResourceName` (string, optional)
    - `GetDashboard.response.401.error.quota.used` (integer, optional)
      - min 0
    - `GetDashboard.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetDashboard.response.403.error` (object, required)
  - `GetDashboard.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetDashboard.response.403.error.message` (string, required)
    - maxLength 1024
  - `GetDashboard.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetDashboard.response.403.error.issues.message` (string, required)
    - `GetDashboard.response.403.error.issues.path` (string, required)
  - `GetDashboard.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetDashboard.response.403.error.quota.id` (string, required)
    - `GetDashboard.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetDashboard.response.403.error.quota.limit` (integer, required)
      - min 0
    - `GetDashboard.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetDashboard.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetDashboard.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetDashboard.response.403.error.quota.region` (string, optional)
    - `GetDashboard.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetDashboard.response.403.error.quota.scopeResourceName` (string, optional)
    - `GetDashboard.response.403.error.quota.used` (integer, optional)
      - min 0
    - `GetDashboard.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetDashboard.response.404.error` (object, required)
  - `GetDashboard.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetDashboard.response.404.error.message` (string, required)
    - maxLength 1024
  - `GetDashboard.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetDashboard.response.404.error.issues.message` (string, required)
    - `GetDashboard.response.404.error.issues.path` (string, required)
  - `GetDashboard.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetDashboard.response.404.error.quota.id` (string, required)
    - `GetDashboard.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetDashboard.response.404.error.quota.limit` (integer, required)
      - min 0
    - `GetDashboard.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetDashboard.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetDashboard.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetDashboard.response.404.error.quota.region` (string, optional)
    - `GetDashboard.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetDashboard.response.404.error.quota.scopeResourceName` (string, optional)
    - `GetDashboard.response.404.error.quota.used` (integer, optional)
      - min 0
    - `GetDashboard.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetDashboard.response.429.error` (object, required)
  - `GetDashboard.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetDashboard.response.429.error.message` (string, required)
    - maxLength 1024
  - `GetDashboard.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetDashboard.response.429.error.issues.message` (string, required)
    - `GetDashboard.response.429.error.issues.path` (string, required)
  - `GetDashboard.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetDashboard.response.429.error.quota.id` (string, required)
    - `GetDashboard.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetDashboard.response.429.error.quota.limit` (integer, required)
      - min 0
    - `GetDashboard.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetDashboard.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetDashboard.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetDashboard.response.429.error.quota.region` (string, optional)
    - `GetDashboard.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetDashboard.response.429.error.quota.scopeResourceName` (string, optional)
    - `GetDashboard.response.429.error.quota.used` (integer, optional)
      - min 0
    - `GetDashboard.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetDashboard.response.500.error` (object, required)
  - `GetDashboard.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetDashboard.response.500.error.message` (string, required)
    - maxLength 1024
  - `GetDashboard.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetDashboard.response.500.error.issues.message` (string, required)
    - `GetDashboard.response.500.error.issues.path` (string, required)
  - `GetDashboard.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetDashboard.response.500.error.quota.id` (string, required)
    - `GetDashboard.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetDashboard.response.500.error.quota.limit` (integer, required)
      - min 0
    - `GetDashboard.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetDashboard.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetDashboard.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetDashboard.response.500.error.quota.region` (string, optional)
    - `GetDashboard.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetDashboard.response.500.error.quota.scopeResourceName` (string, optional)
    - `GetDashboard.response.500.error.quota.used` (integer, optional)
      - min 0
    - `GetDashboard.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetDashboard.response.503.error` (object, required)
  - `GetDashboard.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetDashboard.response.503.error.message` (string, required)
    - maxLength 1024
  - `GetDashboard.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetDashboard.response.503.error.issues.message` (string, required)
    - `GetDashboard.response.503.error.issues.path` (string, required)
  - `GetDashboard.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetDashboard.response.503.error.quota.id` (string, required)
    - `GetDashboard.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetDashboard.response.503.error.quota.limit` (integer, required)
      - min 0
    - `GetDashboard.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetDashboard.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetDashboard.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetDashboard.response.503.error.quota.region` (string, optional)
    - `GetDashboard.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetDashboard.response.503.error.quota.scopeResourceName` (string, optional)
    - `GetDashboard.response.503.error.quota.used` (integer, optional)
      - min 0
    - `GetDashboard.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/obs-api/GetDashboard/index.md