---
title: "Get a dataset"
---

> 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/datasets/{datasetId}`

## Authentication

Requires one of the following:

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

## Path parameters

- `GetDataset.path.orgId` (string, required)
  - format `uuid`
- `GetDataset.path.projectId` (string, required)
  - format `uuid`
- `GetDataset.path.datasetId` (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/datasets/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/datasets/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/datasets/497f6eca-6276-4993-bfeb-53cbbbba6f08"

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

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

print(response.text)
```

## Responses

### 200

The dataset.

#### Example

```json
{
  "activeSeries": {
    "estimate": 0,
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z"
  },
  "allowColdIngest": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "defaultPlacement": "hot",
  "environment": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "lastReceivedAt": {
    "logs": "2019-08-24T14:15:22Z",
    "metrics": "2019-08-24T14:15:22Z",
    "traces": "2019-08-24T14:15:22Z"
  },
  "name": "string",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "origin": "api",
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "region": "string",
  "resourceName": "string",
  "retention": {
    "logs": "string",
    "metrics": "string",
    "traces": "string"
  },
  "retentionClass": "string",
  "samplingEnabled": true,
  "slug": "string",
  "status": "active",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z"
}
```

- `GetDataset.response.200.allowColdIngest` (boolean, required)
- `GetDataset.response.200.createdAt` (string, required) — UTC, millisecond precision: 2026-10-02T10:20:00.000Z.
  - format `date-time`
- `GetDataset.response.200.defaultPlacement` (unknown, required)
  - one of `"hot"`, `"cold"`
- `GetDataset.response.200.environment` (string, required) — The value of the resource attribute ezgh.metadata.environment, trimmed and lowercased; unknown collects records without a valid one.
  - pattern `^[a-z0-9][a-z0-9._-]{0,62}$`
- `GetDataset.response.200.id` (string, required)
  - format `uuid`
- `GetDataset.response.200.name` (string, required)
  - minLength 1; maxLength 100
- `GetDataset.response.200.organizationId` (string, required)
  - format `uuid`
- `GetDataset.response.200.origin` (unknown, required) — auto: created when logs first arrived for the environment.
  - one of `"api"`, `"auto"`
- `GetDataset.response.200.projectId` (string, required)
  - format `uuid`
- `GetDataset.response.200.region` (string, required)
- `GetDataset.response.200.resourceName` (string, required)
- `GetDataset.response.200.retention` (object, required) — The retention class of each signal this deployment serves.
  - `GetDataset.response.200.retention.logs` (string, required) — A retention class from GET …/obs/retention-classes, such as 7d-30d.
  - `GetDataset.response.200.retention.metrics` (string, optional) — A retention class from GET …/obs/retention-classes, such as 7d-30d.
  - `GetDataset.response.200.retention.traces` (string, optional) — A retention class from GET …/obs/retention-classes, such as 7d-30d.
- `GetDataset.response.200.retentionClass` (string, required) — The logs class; the same as retention.logs.
- `GetDataset.response.200.slug` (string, required) — dst_ followed by 12 characters.
- `GetDataset.response.200.status` (unknown, required)
  - one of `"active"`, `"deleting"`
- `GetDataset.response.200.tags` (map<string>, required) — At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved.
- `GetDataset.response.200.updatedAt` (string, required) — UTC, millisecond precision: 2026-10-02T10:20:00.000Z.
  - format `date-time`
- `GetDataset.response.200.activeSeries` (one of, optional) — Metric series received in the previous complete hour, by acceptance time. null when the estimate is unavailable. Returned by get only, while the deployment serves metrics.
  - one of: `object`, `null`
- `GetDataset.response.200.lastReceivedAt` (object, optional) — When each signal's data was last received and committed, null if none in about the last 45 days. Lags acceptance by a few seconds, or up to about a minute for cold placement. It says data arrived, not that it's still stored. Returned by get and list only.
  - `GetDataset.response.200.lastReceivedAt.logs` (one of, required)
    - one of: [Instant](/obs-api/schemas/Instant/), `null`
  - `GetDataset.response.200.lastReceivedAt.metrics` (one of, required)
    - one of: [Instant](/obs-api/schemas/Instant/), `null`
  - `GetDataset.response.200.lastReceivedAt.traces` (one of, required)
    - one of: [Instant](/obs-api/schemas/Instant/), `null`
- `GetDataset.response.200.samplingEnabled` (boolean, optional) — Whether the dataset's trace sampling policy is enabled (GET .../sampling has the policy). Returned by get and list only, while the deployment serves sampling.

### 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"
    }
  }
}
```

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

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

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

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

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

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

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


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