--- title: Retrieve a Telemetry Destination url: https://platform.claude.com/docs/en/api/ruby/beta/organization/telemetry_destinations/retrieve --- # Retrieve a Telemetry Destination `beta.organization.telemetry_destinations.retrieve(destination_id, **kwargs) -> BetaTelemetryDestination` **GET** `/v1/organizations/telemetry_destinations/{destination_id}` Read a destination's configuration, state, and most recent delivery results. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=ruby#delivery-and-health) to learn how the API delivers spans and when it disables a destination. ## Parameters - `destination_id: String` (path parameter) ID of the destination (`tdst_...`). - `betas: Array[AnthropicBeta]` (header parameter) This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header. - `String = String` - `:"message-batches-2024-09-24"` - `:"prompt-caching-2024-07-31"` - `:"computer-use-2024-10-22"` - `:"computer-use-2025-01-24"` - `:"pdfs-2024-09-25"` - `:"token-counting-2024-11-01"` - `:"token-efficient-tools-2025-02-19"` - `:"output-128k-2025-02-19"` - `:"files-api-2025-04-14"` - `:"mcp-client-2025-04-04"` - `:"mcp-client-2025-11-20"` - `:"dev-full-thinking-2025-05-14"` - `:"interleaved-thinking-2025-05-14"` - `:"code-execution-2025-05-22"` - `:"extended-cache-ttl-2025-04-11"` - `:"context-1m-2025-08-07"` - `:"context-management-2025-06-27"` - `:"model-context-window-exceeded-2025-08-26"` - `:"skills-2025-10-02"` - `:"fast-mode-2026-02-01"` - `:"output-300k-2026-03-24"` - `:"user-profiles-2026-03-24"` - `:"user-profiles-2026-08-18"` - `:"user-profiles-2026-09-04"` - `:"advisor-tool-2026-03-01"` - `:"managed-agents-2026-04-01"` - `:"cache-diagnosis-2026-04-07"` - `:"dreaming-2026-04-21"` - `:"thinking-token-count-2026-05-13"` - `:"server-side-fallback-2026-06-01"` - `:"server-side-fallback-2026-07-01"` - `:"fallback-credit-2026-06-01"` - `:"fallback-credit-2026-07-01"` - `:"agent-memory-2026-07-22"` - `:"mid-conversation-tool-changes-2026-07-01"` - `:"compact-2026-01-12"` - `:"computer-use-2025-11-24"` - `:"mcp-tunnels-2026-06-22"` - `:"structured-outputs-2025-11-13"` - `:"task-budgets-2026-03-13"` - `:"thinking-display-updates-2026-08-18"` - `:"ce-user-management-2026-07-13"` - `:"mid-conversation-output-config-2026-07-01"` - `:"thinking-binding-controls-2026-08-01"` - `:"mid-conversation-system-clear-at-2026-08-21"` - `:"compact-2026-09-04"` - `:"inline-tools-2026-09-15"` - `:"mcp-client-2026-09-15"` - `:"ce-plugins-2026-09-01"` - `:"spend-limit-reads-2026-09-26"` - `:"telemetry-destinations-2026-08-11"` ## Returns - `class BetaTelemetryDestination` An OpenTelemetry destination: an OTLP/HTTP endpoint, the request headers sent with every delivery to it, what the exported spans contain, and which workspaces it covers. A destination belongs to an organization. A workspace's spans go to every enabled destination that covers it. - `type: :telemetry_destination` - `id: String` The unique ID of the destination (`tdst_...`). - `created_at: Time` Time the destination was created. format: date-time - `delivery_health: BetaTelemetryDestinationDeliveryHealth` The most recent delivery results for this destination. - `last_error: String` A message that describes the most recent failed delivery to the destination, or `null` if no delivery has failed yet. Examples are `temporary DNS failure`, `TLS failure`, `timeout`, `connection failure`, `invalid address`, `HTTP error (status 503)`, and `redirect (status 301)`. The message is `invalid address` both for a hostname that doesn't exist and for an address that isn't publicly routable. It never contains the endpoint's response body, a header value, a network address, or TLS details. `last_error` and `last_error_at` always change together. A later successful delivery doesn't clear them. If `last_success_at` is later than `last_error_at`, a delivery has succeeded since this failure. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=ruby#delivery-errors) to learn the likely cause of each error. - `last_error_at: Time` Time of the failure that `last_error` describes. Changes together with `last_error`. Null until a delivery first fails. format: date-time - `last_success_at: Time` Time of the most recent successful delivery to the destination, or `null` if no delivery has succeeded yet. format: date-time - `display_name: String` Human-readable name for the destination. Null when none was set. - `endpoint_url: String` The base URL of the destination's OTLP/HTTP endpoint, exactly as registered. The API appends the per-signal path, such as `/v1/traces`, on delivery, unless `traces.endpoint_url` is set. - `header_names: Array[String]` Names of the registered request headers. Header values are write-only and are never returned. - `state: BetaTelemetryDestinationState` Whether the destination receives deliveries. - `class BetaTelemetryDestinationStateEnabled` The telemetry destination receives the spans of the workspaces that it covers. - `type: :enabled` - `class BetaTelemetryDestinationStateDisabled` The API doesn't deliver anything to the telemetry destination. Spans produced while it is disabled aren't delivered later. - `type: :disabled` - `reason: BetaTelemetryDestinationDisabledReason` Whether a caller or the API disabled the destination and, when the API did, why. Read-only. - `class BetaTelemetryDestinationDisabledReasonCaller` A caller disabled the destination with an update that set `state` to `disabled`. - `type: :caller` - `class BetaTelemetryDestinationDisabledReasonSustainedFailure` The API disabled the destination because deliveries to it failed, with no successful delivery in between, for longer than a threshold that Anthropic configures and that is not part of this contract. The reason is `invalid_address` instead when the most recent failed delivery failed with an invalid address. - `type: :sustained_failure` - `class BetaTelemetryDestinationDisabledReasonInvalidAddress` The API disabled the destination because deliveries to it failed for longer than the same threshold as for `sustained_failure`, and the most recent failed delivery failed with an invalid address: the DNS answer says that the endpoint's hostname doesn't exist or doesn't have an address, or the address that the API would connect to isn't publicly routable or is reserved, for example a loopback, link-local, private-network, or cloud-metadata address. The API doesn't connect to such an address, and retries the delivery a bounded number of times as it does after a timeout. A timeout or a server failure of the DNS lookup is a temporary DNS failure instead, not an invalid address. - `type: :invalid_address` - `class BetaTelemetryDestinationDisabledReasonRedirect` The API disabled the destination because the endpoint answered a delivery with a 3xx status. Redirects are never followed, and one such answer disables the destination at once. - `type: :redirect` - `traces: BetaTelemetryDestinationTraces` The destination's settings for the traces it receives. - `content_mode: BetaTelemetryDestinationContentMode` What the exported spans contain. - `:metadata_only` The spans contain identifiers, timing, status, token counts, and similar metadata. They don't contain prompt text, completion text, or tool inputs and outputs. - `:content` The spans contain the same metadata as `metadata_only`, plus message and tool content. An organization with a data-handling restriction, such as under HIPAA, can't choose this mode. The API exports only metadata for such an organization, even to a destination that already has `content`. - `enabled: bool` Whether the destination receives traces. A destination whose `enabled` is false keeps its other settings. - `endpoint_url: String` The full URL that the API posts traces to, exactly as registered, or `null` if the destination doesn't have one. When it is `null`, the API posts traces to `endpoint_url` with `/v1/traces` appended. - `max_content_bytes: Integer` The most bytes of content that one exported span can contain, or `null` if only the API's maximum applies. Content means model prompts and responses, and tool inputs and outputs. The API shortens longer content to this size before it delivers the span. A destination whose `content_mode` is `metadata_only` keeps this value. It applies once `content_mode` is `content`. format: int32 - `updated_at: Time` Time of the last change to the destination's configuration or state. Changes to `delivery_health` don't change it. An update that sets a header value always changes it, even when the value is the same as before. Adding or removing a single workspace on the destination's list doesn't change it. An update that changes the list does. format: date-time - `workspaces: BetaTelemetryDestinationWorkspaces` Which of the organization's workspaces the destination covers. - `class BetaTelemetryDestinationWorkspacesAll` The destination covers every workspace of the organization, including the default workspace, archived workspaces, and workspaces created later. It doesn't have a list. - `type: :all` - `class BetaTelemetryDestinationWorkspacesInclude` The destination covers the workspaces on its list, and no others. - `type: :include` - `class BetaTelemetryDestinationWorkspacesExclude` The destination covers every workspace of the organization except the workspaces on its list. A workspace created later is covered until it is added to the list. - `type: :exclude` ## Example ```ruby require "anthropic" anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key") beta_telemetry_destination = anthropic.beta.organization.telemetry_destinations.retrieve("destination_id") puts(beta_telemetry_destination) ``` ### Response (200) ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "delivery_health": { "last_error": "last_error", "last_error_at": "2019-12-27T18:11:19.117Z", "last_success_at": "2019-12-27T18:11:19.117Z" }, "display_name": "display_name", "endpoint_url": "endpoint_url", "header_names": [ "string" ], "state": { "type": "enabled" }, "traces": { "content_mode": "metadata_only", "enabled": true, "endpoint_url": "endpoint_url", "max_content_bytes": 0 }, "type": "telemetry_destination", "updated_at": "2019-12-27T18:11:19.117Z", "workspaces": { "type": "all" } } ```