---
title: "Get a trace"
description: "Every span of the trace whose start time is in [from, to), oldest first. from and to default to the last 7 days and may span at most 31 days. An unknown trace answers 200 with no spans: check visibleThrough."
---

> 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}/traces/{trace}`

Every span of the trace whose start time is in [from, to), oldest first. from and to default to the last 7 days and may span at most 31 days. An unknown trace answers 200 with no spans: check visibleThrough.

## Authentication

Requires one of the following:

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

## Path parameters

- `GetTrace.path.orgId` (string, required)
  - format `uuid`
- `GetTrace.path.projectId` (string, required)
  - format `uuid`
- `GetTrace.path.datasetId` (string, required)
  - format `uuid`
- `GetTrace.path.trace` (string, required) — The trace ID: 32 hexadecimal characters, not all zero.
  - pattern `^[0-9a-fA-F]{32}$`

## Query parameters

- `GetTrace.query.from` (string, optional)
  - format `date-time`
- `GetTrace.query.to` (string, optional)
  - format `date-time`
- `GetTrace.query.limit` (integer, optional)
  - min 1; max 10000; default `1000`
- `GetTrace.query.cursor` (string, optional) — The previous page's nextCursor. Bound to the organization, the list and its filters.

## 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/traces/string \
  --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/traces/string';
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/traces/string"

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

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

print(response.text)
```

## Responses

### 200

A page of the trace's spans.

#### Example

```json
{
  "from": "2019-08-24T14:15:22Z",
  "nextCursor": "string",
  "spans": [
    {
      "application": "string",
      "attributes": {
        "property1": "string",
        "property2": "string"
      },
      "durationNanos": 0,
      "endTime": "2019-08-24T14:15:22Z",
      "environment": "string",
      "kind": "string",
      "name": "string",
      "parentSpanId": "string",
      "resourceAttributes": {
        "property1": "string",
        "property2": "string"
      },
      "serviceName": "string",
      "spanId": "string",
      "startTime": "2019-08-24T14:15:22Z",
      "status": {
        "code": "unset",
        "message": "string"
      },
      "traceId": "string",
      "dropped": {
        "attributes": 0,
        "events": 0,
        "links": 0
      },
      "events": [
        {}
      ],
      "flags": 0,
      "links": [
        {}
      ],
      "scope": {
        "name": "string",
        "version": "string"
      },
      "traceState": "string"
    }
  ],
  "to": "2019-08-24T14:15:22Z",
  "traceId": "string",
  "visibleThrough": {
    "lanes": [
      {
        "datasetId": "6586f21b-ad4d-4d06-a309-712af47184a2",
        "ingestedAt": "2019-08-24T14:15:22Z",
        "lane": 0
      }
    ],
    "token": "string"
  }
}
```

- `GetTrace.response.200.from` (string, required)
  - format `date-time`
- `GetTrace.response.200.nextCursor` (string | null, required)
- `GetTrace.response.200.spans` (array<unknown>, required)
  - `GetTrace.response.200.spans.application` (string, required)
  - `GetTrace.response.200.spans.attributes` (map<string>, required)
  - `GetTrace.response.200.spans.durationNanos` (integer, required)
  - `GetTrace.response.200.spans.endTime` (string, required)
    - format `date-time`
  - `GetTrace.response.200.spans.environment` (string, required)
  - `GetTrace.response.200.spans.kind` (string, required)
  - `GetTrace.response.200.spans.name` (string, required)
  - `GetTrace.response.200.spans.parentSpanId` (string | null, required)
  - `GetTrace.response.200.spans.resourceAttributes` (map<string>, required)
  - `GetTrace.response.200.spans.serviceName` (string, required)
  - `GetTrace.response.200.spans.spanId` (string, required)
  - `GetTrace.response.200.spans.startTime` (string, required)
    - format `date-time`
  - `GetTrace.response.200.spans.status` (object, required)
    - `GetTrace.response.200.spans.status.code` (string, required)
      - one of `"unset"`, `"ok"`, `"error"`
    - `GetTrace.response.200.spans.status.message` (string, required)
  - `GetTrace.response.200.spans.traceId` (string, required)
  - `GetTrace.response.200.spans.dropped` (object, required)
    - `GetTrace.response.200.spans.dropped.attributes` (integer, optional)
    - `GetTrace.response.200.spans.dropped.events` (integer, optional)
    - `GetTrace.response.200.spans.dropped.links` (integer, optional)
  - `GetTrace.response.200.spans.events` (array<object>, required)
  - `GetTrace.response.200.spans.flags` (integer, required)
  - `GetTrace.response.200.spans.links` (array<object>, required)
  - `GetTrace.response.200.spans.scope` (object, required)
    - `GetTrace.response.200.spans.scope.name` (string, optional)
    - `GetTrace.response.200.spans.scope.version` (string, optional)
  - `GetTrace.response.200.spans.traceState` (string, required)
- `GetTrace.response.200.to` (string, required)
  - format `date-time`
- `GetTrace.response.200.traceId` (string, required)
- `GetTrace.response.200.visibleThrough` (object, required)
  - `GetTrace.response.200.visibleThrough.lanes` (array<object>, required)
    - `GetTrace.response.200.visibleThrough.lanes.datasetId` (string, required)
      - format `uuid`
    - `GetTrace.response.200.visibleThrough.lanes.ingestedAt` (one of, required)
      - one of: [Instant](/obs-api/schemas/Instant/), `null`
    - `GetTrace.response.200.visibleThrough.lanes.lane` (integer, required)
  - `GetTrace.response.200.visibleThrough.token` (string, required) — Opaque: the accepted data this answer covers.

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

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

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

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

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

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

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

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


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