--- title: "Get a dataset's traces sampling policy" description: "The dataset's edge tail sampling policy for traces. A dataset that never had one answers enabled false, no rules, version 0 and the dataset's createdAt. 404 while sampling isn't offered yet." --- > 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}/sampling` The dataset's edge tail sampling policy for traces. A dataset that never had one answers enabled false, no rules, version 0 and the dataset's createdAt. 404 while sampling isn't offered yet. ## Authentication Requires one of the following: - `apiKey`, http, header `Authorization` - `oauth`, http, header `Authorization` - `sessionCookie`, apiKey, in cookie ## Path parameters - `GetDatasetSampling.path.orgId` (string, required) - format `uuid` - `GetDatasetSampling.path.projectId` (string, required) - format `uuid` - `GetDatasetSampling.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/sampling \ --header 'Authorization: Bearer ' ``` ### 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/sampling'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; 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/sampling" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.text) ``` ## Responses ### 200 The policy. #### Example ```json { "policy": { "decisionWait": "30s", "default": "all", "enabled": true, "rules": [ { "keep": "all", "name": "string", "when": { "attributes": [ { "equals": "string", "exists": true, "key": "string", "scope": "record" } ], "minDuration": "string", "root": true, "service": [ "string" ], "spanName": [ "string" ], "status": "error" } } ] }, "updatedAt": "2019-08-24T14:15:22Z", "version": 0 } ``` - `GetDatasetSampling.response.200.policy` (object, required) — As stored: decisionWait and rules are always present. - `GetDatasetSampling.response.200.policy.enabled` (boolean, required) - `GetDatasetSampling.response.200.policy.decisionWait` (string, optional) — A Go duration from 5s to 120s: how long a trace's spans are buffered before it's decided. - default `"30s"` - `GetDatasetSampling.response.200.policy.default` (one of, optional) — all, none or percent; required when enabled. - one of: `string`, `object`, `object` - `GetDatasetSampling.response.200.policy.rules` (array, optional) - `GetDatasetSampling.response.200.policy.rules.keep` (one of, required) — What a rule (or the default) decides: all keeps, none drops, percent keeps the traces whose trace ID randomness is below the threshold (the same answer on every replay), perSecond keeps up to n traces a second for the rule in the dataset (when spent, the rule doesn't match and evaluation goes on). The default takes all, none or percent. - one of: `string`, `object`, `object` - `GetDatasetSampling.response.200.policy.rules.name` (string, required) — Unique in the policy; default is reserved. - pattern `^[a-z0-9][a-z0-9_-]{0,39}$` - `GetDatasetSampling.response.200.policy.rules.when` (object, required) — Every condition given must hold over the trace's buffered spans; {} matches every trace. - `GetDatasetSampling.response.200.policy.rules.when.attributes` (array, optional) — One span satisfies all of these. - `GetDatasetSampling.response.200.policy.rules.when.attributes.key` (string, required) - minLength 1; maxLength 255 - `GetDatasetSampling.response.200.policy.rules.when.attributes.scope` (string, required) — record: span attributes; resource: resource attributes. - one of `"record"`, `"resource"` - `GetDatasetSampling.response.200.policy.rules.when.attributes.equals` (string, optional) - maxLength 255 - `GetDatasetSampling.response.200.policy.rules.when.attributes.exists` (boolean, optional) - one of `true` - `GetDatasetSampling.response.200.policy.rules.when.minDuration` (string, optional) — A Go duration ("2s"), more than 0 and at most 1h: the trace's latest span end minus its earliest start is at least this. - `GetDatasetSampling.response.200.policy.rules.when.root` (boolean, optional) — Narrows service, spanName and attributes to the root span. - `GetDatasetSampling.response.200.policy.rules.when.service` (array, optional) — A span's service key is one of these. - minLength 1; maxLength 255 - `GetDatasetSampling.response.200.policy.rules.when.spanName` (array, optional) — A span's name is one of these. - minLength 1; maxLength 255 - `GetDatasetSampling.response.200.policy.rules.when.status` (string, optional) — A span has status ERROR. - one of `"error"` - `GetDatasetSampling.response.200.updatedAt` (string, required) — UTC, millisecond precision: 2026-10-02T10:20:00.000Z. - format `date-time` - `GetDatasetSampling.response.200.version` (integer, required) — 0 before the first PUT. - min 0 ### 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" } } } ``` - `GetDatasetSampling.response.400.error` (object, required) - `GetDatasetSampling.response.400.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDatasetSampling.response.400.error.message` (string, required) - maxLength 1024 - `GetDatasetSampling.response.400.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDatasetSampling.response.400.error.issues.message` (string, required) - `GetDatasetSampling.response.400.error.issues.path` (string, required) - `GetDatasetSampling.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDatasetSampling.response.400.error.quota.id` (string, required) - `GetDatasetSampling.response.400.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDatasetSampling.response.400.error.quota.limit` (integer, required) - min 0 - `GetDatasetSampling.response.400.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDatasetSampling.response.400.error.quota.inFlight` (integer, optional) - min 0 - `GetDatasetSampling.response.400.error.quota.periodStart` (string, optional) - format `date-time` - `GetDatasetSampling.response.400.error.quota.region` (string, optional) - `GetDatasetSampling.response.400.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDatasetSampling.response.400.error.quota.scopeResourceName` (string, optional) - `GetDatasetSampling.response.400.error.quota.used` (integer, optional) - min 0 - `GetDatasetSampling.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" } } } ``` - `GetDatasetSampling.response.401.error` (object, required) - `GetDatasetSampling.response.401.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDatasetSampling.response.401.error.message` (string, required) - maxLength 1024 - `GetDatasetSampling.response.401.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDatasetSampling.response.401.error.issues.message` (string, required) - `GetDatasetSampling.response.401.error.issues.path` (string, required) - `GetDatasetSampling.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDatasetSampling.response.401.error.quota.id` (string, required) - `GetDatasetSampling.response.401.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDatasetSampling.response.401.error.quota.limit` (integer, required) - min 0 - `GetDatasetSampling.response.401.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDatasetSampling.response.401.error.quota.inFlight` (integer, optional) - min 0 - `GetDatasetSampling.response.401.error.quota.periodStart` (string, optional) - format `date-time` - `GetDatasetSampling.response.401.error.quota.region` (string, optional) - `GetDatasetSampling.response.401.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDatasetSampling.response.401.error.quota.scopeResourceName` (string, optional) - `GetDatasetSampling.response.401.error.quota.used` (integer, optional) - min 0 - `GetDatasetSampling.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" } } } ``` - `GetDatasetSampling.response.403.error` (object, required) - `GetDatasetSampling.response.403.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDatasetSampling.response.403.error.message` (string, required) - maxLength 1024 - `GetDatasetSampling.response.403.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDatasetSampling.response.403.error.issues.message` (string, required) - `GetDatasetSampling.response.403.error.issues.path` (string, required) - `GetDatasetSampling.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDatasetSampling.response.403.error.quota.id` (string, required) - `GetDatasetSampling.response.403.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDatasetSampling.response.403.error.quota.limit` (integer, required) - min 0 - `GetDatasetSampling.response.403.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDatasetSampling.response.403.error.quota.inFlight` (integer, optional) - min 0 - `GetDatasetSampling.response.403.error.quota.periodStart` (string, optional) - format `date-time` - `GetDatasetSampling.response.403.error.quota.region` (string, optional) - `GetDatasetSampling.response.403.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDatasetSampling.response.403.error.quota.scopeResourceName` (string, optional) - `GetDatasetSampling.response.403.error.quota.used` (integer, optional) - min 0 - `GetDatasetSampling.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" } } } ``` - `GetDatasetSampling.response.404.error` (object, required) - `GetDatasetSampling.response.404.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDatasetSampling.response.404.error.message` (string, required) - maxLength 1024 - `GetDatasetSampling.response.404.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDatasetSampling.response.404.error.issues.message` (string, required) - `GetDatasetSampling.response.404.error.issues.path` (string, required) - `GetDatasetSampling.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDatasetSampling.response.404.error.quota.id` (string, required) - `GetDatasetSampling.response.404.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDatasetSampling.response.404.error.quota.limit` (integer, required) - min 0 - `GetDatasetSampling.response.404.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDatasetSampling.response.404.error.quota.inFlight` (integer, optional) - min 0 - `GetDatasetSampling.response.404.error.quota.periodStart` (string, optional) - format `date-time` - `GetDatasetSampling.response.404.error.quota.region` (string, optional) - `GetDatasetSampling.response.404.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDatasetSampling.response.404.error.quota.scopeResourceName` (string, optional) - `GetDatasetSampling.response.404.error.quota.used` (integer, optional) - min 0 - `GetDatasetSampling.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" } } } ``` - `GetDatasetSampling.response.429.error` (object, required) - `GetDatasetSampling.response.429.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDatasetSampling.response.429.error.message` (string, required) - maxLength 1024 - `GetDatasetSampling.response.429.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDatasetSampling.response.429.error.issues.message` (string, required) - `GetDatasetSampling.response.429.error.issues.path` (string, required) - `GetDatasetSampling.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDatasetSampling.response.429.error.quota.id` (string, required) - `GetDatasetSampling.response.429.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDatasetSampling.response.429.error.quota.limit` (integer, required) - min 0 - `GetDatasetSampling.response.429.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDatasetSampling.response.429.error.quota.inFlight` (integer, optional) - min 0 - `GetDatasetSampling.response.429.error.quota.periodStart` (string, optional) - format `date-time` - `GetDatasetSampling.response.429.error.quota.region` (string, optional) - `GetDatasetSampling.response.429.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDatasetSampling.response.429.error.quota.scopeResourceName` (string, optional) - `GetDatasetSampling.response.429.error.quota.used` (integer, optional) - min 0 - `GetDatasetSampling.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" } } } ``` - `GetDatasetSampling.response.500.error` (object, required) - `GetDatasetSampling.response.500.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDatasetSampling.response.500.error.message` (string, required) - maxLength 1024 - `GetDatasetSampling.response.500.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDatasetSampling.response.500.error.issues.message` (string, required) - `GetDatasetSampling.response.500.error.issues.path` (string, required) - `GetDatasetSampling.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDatasetSampling.response.500.error.quota.id` (string, required) - `GetDatasetSampling.response.500.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDatasetSampling.response.500.error.quota.limit` (integer, required) - min 0 - `GetDatasetSampling.response.500.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDatasetSampling.response.500.error.quota.inFlight` (integer, optional) - min 0 - `GetDatasetSampling.response.500.error.quota.periodStart` (string, optional) - format `date-time` - `GetDatasetSampling.response.500.error.quota.region` (string, optional) - `GetDatasetSampling.response.500.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDatasetSampling.response.500.error.quota.scopeResourceName` (string, optional) - `GetDatasetSampling.response.500.error.quota.used` (integer, optional) - min 0 - `GetDatasetSampling.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" } } } ``` - `GetDatasetSampling.response.503.error` (object, required) - `GetDatasetSampling.response.503.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetDatasetSampling.response.503.error.message` (string, required) - maxLength 1024 - `GetDatasetSampling.response.503.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetDatasetSampling.response.503.error.issues.message` (string, required) - `GetDatasetSampling.response.503.error.issues.path` (string, required) - `GetDatasetSampling.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetDatasetSampling.response.503.error.quota.id` (string, required) - `GetDatasetSampling.response.503.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetDatasetSampling.response.503.error.quota.limit` (integer, required) - min 0 - `GetDatasetSampling.response.503.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetDatasetSampling.response.503.error.quota.inFlight` (integer, optional) - min 0 - `GetDatasetSampling.response.503.error.quota.periodStart` (string, optional) - format `date-time` - `GetDatasetSampling.response.503.error.quota.region` (string, optional) - `GetDatasetSampling.response.503.error.quota.resetsAt` (string, optional) - format `date-time` - `GetDatasetSampling.response.503.error.quota.scopeResourceName` (string, optional) - `GetDatasetSampling.response.503.error.quota.used` (integer, optional) - min 0 - `GetDatasetSampling.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. Source: https://docs.ezghcloud.com/obs-api/GetDatasetSampling/index.md