{"type":"model","meta":{"id":"/apps/pubhub/media/000-v7-apis/4ec57f8c141f43990cef5c737bb51240bb169e79/4bef5bf8-85e1-3e97-9841-756deb0d4d50","info":{"title":"ThousandEyes for OpenTelemetry API","version":"7.0.117","description":"**Note:** The following ThousandEyes for OpenTelemetry API capabilities are not available for ThousandEyes for Government instance:\n\n* Traces\n* Connected Devices\n\nThousandEyes for OpenTelemetry provides machine-to-machine integration between ThousandEyes and its customers. It allows you to export ThousandEyes telemetry data in OTel format, which is widely used in the industry. With ThousandEyes for OTel, you can leverage frameworks widely used in the observability domain - such as Splunk, Grafana, and Honeycomb - to capture and analyze ThousandEyes data. Any client that supports OTel can use ThousandEyes for OpenTelemetry.\n\nThousandEyes for OTel is made up of the following components:\n\n* Data streaming APIs that you can use to configure and enable your ThousandEyes tests with OTel-compatible streams,\nin particular to configure how ThousandEyes telemetry data is exported to client integrations.\n* A set of streaming pipelines called _collectors_ that actively fetch ThousandEyes network test data, enrich the data with some additional\ndetail, filter, and push the data to the customer-configured endpoints, depending on what you configure via the public APIs.\n* Third-party OTel collectors that receive, transform, filter, and export different metrics to client applications such as AppD, or any other OTel-capable client\nconfiguration.\n\nFor more information about ThousandEyes for OpenTelemetry, see the [product documentation](https://docs.thousandeyes.com/product-documentation/integration-guides/opentelemetry).\n"},"security":[{"BearerAuth":[]}],"tags":[{"name":"Streaming","description":"Configure data streaming"}],"openapi":"3.0.1","servers":[{"description":"ThousandEyes API production URL","url":"https://api.thousandeyes.com/v7"}],"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Bearer authentication token"}}},"spec":{"allOf":[{"type":"object","properties":{"type":{"description":"The type of data stream to configure.\nWhen using `splunk-hec`:\n - `endpointType` must be `http`.\n - `exporterConfig.splunkHec.token` must contain the *Splunk HEC Token*.","type":"string","enum":["opentelemetry","splunk-hec"],"example":"opentelemetry","$$ref":"#/components/schemas/StreamType"},"signal":{"type":"string","description":"The OpenTelemetry signal of the stream integration.\nWhen using `trace` or `log`:\n - `dataModelVersion` must be `v2`.","default":"metric","example":"metric","enum":["metric","trace","log"],"$$ref":"#/components/schemas/Signal"},"endpointType":{"type":"string","description":"The type of connection used to send data to the endpoint.\n**Note**: When using the `splunk-hec` 'type', the `EndpointType` must be `http`.","default":"grpc","example":"grpc","enum":["grpc","http"],"$$ref":"#/components/schemas/EndpointType"},"streamEndpointUrl":{"type":"string","description":"The URL ThousandEyes sends data stream to.\nFor a URL to be valid, it needs to: - Be syntactically correct. - Be reachable. - Use the HTTPS protocol. - When using the `grpc` endpointType, streamEndpointUrl cannot contain paths:\n - Valid . `grpc` - `https://example.com`\n - Invalid . `grpc` - `https://example.com/collector`.\n - Valid . `http` - `https://example.com/collector`.\n\n- When using the `http` endpointType, the operation must match the exact final full URL (including the path if there is one) to which the data will be sent. Examples below:\n - `https://api.honeycomb.io:443/v1/metrics`\n - `https://ingest.eu0.signalfx.com/v2/datapoint/otlp`","example":"https://api.thousandeyes.otel-collector","$$ref":"#/components/schemas/StreamEndpointUrl"},"dataModelVersion":{"description":"The version of the data model used in the data stream.\nWhen using `v1`:\n - The `signal` cannot be `trace`.","default":"v2","type":"string","enum":["v1","v2"],"example":"v2","$$ref":"#/components/schemas/DataModelVersion"}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Name of the data stream. When omitted, a name is generated on creation and the existing name is preserved on update.","example":"Production metrics stream","$$ref":"#/components/schemas/StreamName"},"customHeaders":{"description":"Custom headers. Send `{}` to clear existing headers.","type":"object","additionalProperties":{"type":"string"},"example":{"Authorization":"*****","Content-Type":"*****"}},"streamEndpointUrl":{"type":"string","description":"The URL ThousandEyes sends data stream to.\nFor a URL to be valid, it needs to: - Be syntactically correct. - Be reachable. - Use the HTTPS protocol. - When using the `grpc` endpointType, streamEndpointUrl cannot contain paths:\n - Valid . `grpc` - `https://example.com`\n - Invalid . `grpc` - `https://example.com/collector`.\n - Valid . `http` - `https://example.com/collector`.\n\n- When using the `http` endpointType, the operation must match the exact final full URL (including the path if there is one) to which the data will be sent. Examples below:\n - `https://api.honeycomb.io:443/v1/metrics`\n - `https://ingest.eu0.signalfx.com/v2/datapoint/otlp`","example":"https://api.thousandeyes.otel-collector","$$ref":"#/components/schemas/StreamEndpointUrl"},"tagMatch":{"description":"A collection of tags used to select which tests are included in the data stream. A test is selected if it is associated with any of the specified tags.\n`tagMatch` controls test selection only. It does not filter the tags exported as metric attributes. Tags associated with the streamed tests and their agents are included as OpenTelemetry resource attributes, including tags not specified in `tagMatch`, subject to tag naming restrictions.\nA tag is invalid if the tag key includes characters that are not allowed by the [OpenTelemetry naming recommendations for attributes](https://opentelemetry.io/docs/specs/semconv/general/naming/#recommendations-for-application-developers). See [Tags as Attributes](https://docs.thousandeyes.com/product-documentation/integration-guides/opentelemetry/data-model/data-model-v2/metrics#tags-as-attributes) for details.\nFor backward compatibility, callers can provide `key` and `value` instead of `tagId`; the service resolves that pair to a tag ID. Use only one representation in each `tagMatch` collection.","type":"array","items":{"type":"object","properties":{"tagId":{"type":"string","format":"uuid","description":"The stable ID of the tag to match.","example":"c6b78e57-81a2-4c5f-a11a-d96c3c664d55"},"objectType":{"type":"string","readOnly":true,"description":"The object type of tag","example":"test","enum":["test","endpoint-test"],"$$ref":"#/components/schemas/TagMatchObjectType"},"key":{"type":"string","description":"For requests, use `tagId` instead. This legacy property is retained for compatibility. The key is invalid if it includes characters that are not allowed by the [OpenTelemetry naming recommendations for attributes](https://opentelemetry.io/docs/specs/semconv/general/naming/#recommendations-for-application-developers).","example":"environment"},"value":{"type":"string","description":"For requests, use `tagId` instead. This legacy property is retained for compatibility. The value of the tag to match.","example":"production"}},"$$ref":"#/components/schemas/TagMatch"},"example":[{"tagId":"c6b78e57-81a2-4c5f-a11a-d96c3c664d55"}]},"testMatch":{"description":"A collection of tests to be included in the data stream.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the test to match.","example":"1234"},"domain":{"type":"string","description":"The domain of the test to match.\n `cea` - Cloud and Enterprise Agent\n `endpoint` - Endpoint Agent","example":"cea","enum":["cea","endpoint"],"$$ref":"#/components/schemas/TestMatchDomain"}},"$$ref":"#/components/schemas/TestMatch"},"example":[{"id":"1234","domain":"cea"},{"id":"5678","domain":"endpoint"}]},"enabled":{"description":"Flag to enable or disable the stream integration.","type":"boolean","example":true},"filters":{"type":"object","description":"Controls which test data the integration exports.\n\n`testTypes` is an inclusion filter: when specified, only data from the\nselected test types is included. `metricsFilter` and `attributesFilter`\nexclude metrics or attributes from the included data.\n\nFilter support depends on the stream's signal and data model version:\n\n- For `metric` streams using data model `v1` or `v2`, both\n `metricsFilter` and `attributesFilter` are supported.\n- For `log` and `trace` streams using data model `v2`, only\n `attributesFilter` is supported. `metricsFilter` is not supported.\n\nOn create, an omitted `testTypes` filter includes all test types, while\nomitted exclusion filters exclude nothing. On update, each omitted filter\nremains unchanged. Empty exclusion lists clear existing exclusions;\n`testTypes.values` must not be empty.\n","properties":{"testTypes":{"type":"object","description":"Test types that can be used for filtering data points.","properties":{"values":{"type":"array","minItems":1,"description":"A list of test types to filter data points.","items":{"type":"string","enum":["api","agent-to-agent","agent-to-server","bgp","http-server","page-load","web-transactions","ftp-server","dns-trace","dns-server","dnssec","sip-server","voice"],"description":"This is a read only value, as test type is implicit in the test creation url.","readOnly":true,"example":"agent-to-server","$$ref":"#/components/schemas/TestType"},"example":["agent-to-server","bgp","http-server"],"$$ref":"#/components/schemas/FiltersTestTypesValues"}},"$$ref":"#/components/schemas/FiltersTestTypes"},"metricsFilter":{"type":"object","description":"Excludes case-sensitive metric names for the stream's data model version. An empty list clears existing metric exclusions.","required":["excludedMetrics"],"properties":{"excludedMetrics":{"description":"Metric names to exclude. Values must match the stream's `dataModelVersion`.","anyOf":[{"type":"array","description":"Metrics to be excluded when `signal` is `metric` and `dataModelVersion` is `v1`.","items":{"type":"string","enum":["api.metrics.completion","api.metrics.time","api.step.metrics.completion","api.step.metrics.time","bgp.metrics.path.changes","bgp.metrics.reachability","bgp.metrics.updates","dnssec.metrics.validity","dnsserver.metrics.availability","dnsserver.metrics.resolution.time","dnstrace.metrics.availability","dnstrace.metrics.query.time","ftp.metrics.availability","ftp.metrics.response.time","ftp.metrics.throughput","http.metrics.availability","http.metrics.response.time","http.metrics.throughput","net.metrics.jitter","net.metrics.latency","net.metrics.loss","pageload.metrics.completion","pageload.metrics.time","rtp.metrics.discards","rtp.metrics.latency","rtp.metrics.loss","rtp.metrics.mos","sip.metrics.availability","sip.metrics.response.time","sip.metrics.total.time","webtransaction.metrics.completion","webtransaction.metrics.errors","webtransaction.metrics.transaction.time"],"$$ref":"#/components/schemas/V1MetricFilterName"},"example":["http.metrics.availability"],"$$ref":"#/components/schemas/V1ExcludedMetrics"},{"type":"array","description":"Metrics to be excluded when `signal` is `metric` and `dataModelVersion` is `v2`.","items":{"type":"string","enum":["api.completion","api.duration","api.step.completion","api.step.duration","bgp.path_changes.count","bgp.reachability","bgp.updates.count","dns.lookup.availability","dns.lookup.duration","dns.lookup.validity","ftp.client.request.duration","ftp.server.request.availability","ftp.server.throughput","http.client.request.duration","http.server.request.availability","http.server.request.duration","http.server.request.throughput","http.server.throughput","network.availability","network.connection.link_speed","network.connection.score","network.connection.throughput","network.device.disconnection.duration","network.device.disconnection.packets_lost","network.device.partial_disconnection.transitions","network.jitter","network.latency","network.loss","network.score","network.signal.quality","network.signal.rscp","network.signal.rsrp","network.signal.rsrq","network.signal.rssi","network.signal.sinr","network.throughput","network.wifi.channel.changes.count","network.wifi.retransmission.rate","network.wifi.roaming.events.count","rtp.client.request.discards","rtp.client.request.duration","rtp.client.request.loss","rtp.client.request.mos","rtp.client.request.pdv","sip.client.request.duration","sip.client.request.total_time","sip.server.request.availability","system.battery.charge","system.battery.health","system.cpu.utilization","system.disk.free.utilization","system.memory.utilization","thousandeyes.endpoint.agent.score","web.page_load.completion","web.page_load.dom.duration","web.page_load.dom.objects","web.page_load.dom.size","web.page_load.duration","web.page_load.duration_first_byte","web.page_load.jitter","web.page_load.throughput","web.transaction.completion","web.transaction.duration","web.transaction.errors.count"],"$$ref":"#/components/schemas/V2MetricFilterName"},"example":["http.server.request.duration"],"$$ref":"#/components/schemas/V2ExcludedMetrics"}],"$$ref":"#/components/schemas/FiltersMetricsExcludedMetrics"}},"$$ref":"#/components/schemas/FiltersMetrics"},"attributesFilter":{"type":"object","description":"Excludes case-sensitive attribute names for the stream's signal and data model version.\nAn empty list clears existing attribute exclusions.\n\nReserved attributes are always emitted and cannot be excluded:\n\n- `v1`: `account.id`, `thousandeyes.data.version`, and `thousandeyes.stream.id`\n- `v2`: `thousandeyes.account.id`, `thousandeyes.data.version`, and `thousandeyes.stream.id`\n","required":["excludedAttributes"],"properties":{"excludedAttributes":{"description":"Attribute names to exclude. Values must match the stream's `signal` and `dataModelVersion`.","anyOf":[{"type":"array","description":"Attributes to be excluded when `signal` is `metric` and `dataModelVersion` is `v1`.","items":{"type":"string","enum":["agent.geo.country.iso_code","agent.geo.region.iso_code","agent.geoname.id","agent.id","agent.location","agent.name","datapoint.created","datapoint.id","datapoint.received","direction","error.details","error.num","error.type","finalserver","http.request.method","integration.id","monitor.id","monitor.location","monitor.name","network.as.path","object.num","object.size","permalink","prefix","query.count","query.failed_count","response.code","response.time.dom","response.time.first","round.id","server.id","server.ip","server.name","source.agent.geo.country.iso_code","source.agent.geo.region.iso_code","source.agent.geoname.id","source.agent.id","source.agent.location","source.agent.name","step","target.agent.geo.country.iso_code","target.agent.geo.region.iso_code","target.agent.geoname.id","target.agent.id","target.agent.location","target.agent.name","test.domain","test.id","test.name","test.type","thousandeyes.stream.name","url","url.full"],"$$ref":"#/components/schemas/V1MetricAttributeFilterName"},"example":["agent.name"],"$$ref":"#/components/schemas/V1MetricExcludedAttributes"},{"type":"array","description":"Attributes to be excluded when `signal` is `metric` and `dataModelVersion` is `v2`.","items":{"type":"string","enum":["client.address","detection.type","dns.question.name","error.type","ftp.request.command","ftp.response.status_code","http.request.method","http.response.status_code","http.route","network.as.path","network.carrier.name","network.cellular.generation","network.connection.subtype","network.connection.type","network.interface.driver.model","network.interface.driver.version","network.interface.name","network.io.direction","network.prefix","network.transport","network.wifi.access_point.vendor","network.wifi.bssid","network.wifi.channel","network.wifi.phy_mode","network.wifi.ssid","server.address","server.port","sip.response.status_code","target.type","thousandeyes.monitor.id","thousandeyes.monitor.location","thousandeyes.monitor.name","thousandeyes.permalink","thousandeyes.source.agent.connection.isp","thousandeyes.source.agent.connection.package","thousandeyes.source.agent.geo.country.iso_code","thousandeyes.source.agent.geo.region.iso_code","thousandeyes.source.agent.geoname.id","thousandeyes.source.agent.hw.type","thousandeyes.source.agent.id","thousandeyes.source.agent.local.network.address","thousandeyes.source.agent.location","thousandeyes.source.agent.mac.address","thousandeyes.source.agent.name","thousandeyes.source.agent.network.address","thousandeyes.source.agent.network.address_ipv4","thousandeyes.source.agent.network.address_ipv6","thousandeyes.source.agent.network.as.name","thousandeyes.source.agent.network.as.number","thousandeyes.source.agent.network.org","thousandeyes.source.agent.os.type","thousandeyes.source.agent.serial_number","thousandeyes.source.agent.user.name","thousandeyes.source.unit.id","thousandeyes.stream.name","thousandeyes.target.agent.geo.country.iso_code","thousandeyes.target.agent.geo.region.iso_code","thousandeyes.target.agent.geoname.id","thousandeyes.target.agent.id","thousandeyes.target.agent.location","thousandeyes.target.agent.name","thousandeyes.test.domain","thousandeyes.test.id","thousandeyes.test.name","thousandeyes.test.step","thousandeyes.test.type","thousandeyes.triggering.agent.id","transition.type","url.scheme","vpn.vendor"],"$$ref":"#/components/schemas/V2MetricAttributeFilterName"},"example":["server.address"],"$$ref":"#/components/schemas/V2MetricExcludedAttributes"},{"type":"array","description":"Attributes to be excluded when `signal` is `log` and `dataModelVersion` is `v2`.","items":{"type":"string","enum":["thousandeyes.account.name","thousandeyes.activitylog.resources","thousandeyes.stream.name","thousandeyes.user.address","thousandeyes.user.email","thousandeyes.user.id","thousandeyes.user.name"],"$$ref":"#/components/schemas/V2LogAttributeFilterName"},"example":["thousandeyes.user.email"],"$$ref":"#/components/schemas/V2LogExcludedAttributes"},{"type":"array","description":"Attributes to be excluded when `signal` is `trace` and `dataModelVersion` is `v2`.","items":{"type":"string","enum":["cloud.availability_zone","cloud.platform","cloud.provider","cloud.region","cloud.service","error.type","geo.geoname.id","http.request.method","http.response.code","meta.signal_type","network.local.address","network.local.hostname","network.local.prefix","network.path.hop.index","network.path.hop.rtt","network.peer.address","network.peer.as.number","network.peer.hostname","network.peer.prefix","otel.scope.name","server.address","server.port","service.name","step","thousandeyes.permalink","thousandeyes.source.agent.geo.country.iso_code","thousandeyes.source.agent.geo.region.iso_code","thousandeyes.source.agent.geoname.id","thousandeyes.source.agent.id","thousandeyes.source.agent.location","thousandeyes.source.agent.name","thousandeyes.source.agent.network.address","thousandeyes.stream.name","thousandeyes.test.domain","thousandeyes.test.id","thousandeyes.test.name","thousandeyes.test.type","url.full"],"$$ref":"#/components/schemas/V2TraceAttributeFilterName"},"example":["cloud.provider"],"$$ref":"#/components/schemas/V2TraceExcludedAttributes"}],"$$ref":"#/components/schemas/FiltersAttributesExcludedAttributes"}},"$$ref":"#/components/schemas/FiltersAttributes"}},"$$ref":"#/components/schemas/Filters"},"inputConfig":{"type":"object","description":"Signal-specific input data configuration. The configured property must match the stream signal.","maxProperties":1,"properties":{"trace":{"type":"object","description":"Configuration for trace input data in the stream integration. Omitted sources are disabled on create and unchanged on update. At least one source must remain enabled.","properties":{"har":{"type":"object","description":"Configuration for HTTP Archive (HAR) trace data.","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Flag to enable or disable HTTP Archive trace data.","example":true}},"$$ref":"#/components/schemas/InputConfigTraceHar"},"netpath":{"type":"object","description":"Configuration for network path trace data.","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Flag to enable or disable network path trace data.","example":true}},"$$ref":"#/components/schemas/InputConfigTraceNetPath"}},"$$ref":"#/components/schemas/InputConfigTrace"},"metric":{"type":"object","description":"Configuration for metric input data in the stream integration.","properties":{"connectedDevices":{"type":"object","description":"Configuration for Connected Devices metric data in the stream integration.","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Flag to enable or disable Connected Devices data.","example":true,"default":false}},"$$ref":"#/components/schemas/ConnectedDevices"}},"$$ref":"#/components/schemas/InputConfigMetric"}},"$$ref":"#/components/schemas/InputConfig"},"exporterConfig":{"type":"object","description":"Capability to set exporter configuration.","properties":{"splunkHec":{"type":"object","description":"Splunk HEC configuration. This can only be configured when the `type` is `splunk-hec`.","properties":{"token":{"type":"string","description":"The Splunk HEC `token`. This is a required field.","example":"d0a91307-be2f-4218-a9f8-71c02d98846b"},"source":{"type":"string","description":"The Splunk HEC `source`. This field is optional.","example":"ThousandEyesOTel","default":"ThousandEyesOTel"},"sourceType":{"type":"string","description":"The Splunk HEC `sourceType`. This field is optional.","example":"ThousandEyesOTel","default":"ThousandEyesOTel"},"index":{"type":"string","description":"The name of the Splunk HEC index where the event data will be stored. This field is optional.","example":"thousandeyes_otel_events_index"}},"$$ref":"#/components/schemas/ExporterConfigSplunkHec"},"authorization":{"type":"object","description":"Authentication configuration type.","properties":{"oAuth2":{"type":"object","description":"OAuth2 authentication configuration.","properties":{"clientId":{"type":"string","description":"The OAuth2 client ID.","example":"1234567890"},"clientSecret":{"type":"string","description":"The OAuth2 client secret.","example":"1234567890"},"tokenUrl":{"type":"string","description":"The OAuth2 token URL.","example":"https://example.com/token"},"scopes":{"type":"array","description":"The OAuth2 scopes.","items":{"type":"string"},"example":["read","write"]}},"$$ref":"#/components/schemas/ExporterConfigOAuth2"}},"$$ref":"#/components/schemas/ExporterConfigAuthorization"}},"$$ref":"#/components/schemas/ExporterConfig"},"endpointAgentLabel":{"description":"A collection of Endpoint Agent label IDs that determines what local network data is included in the data stream. `endpointAgentLabel` and `endpointAgentTag` represent the same data. Configure only one; both are synchronized.","type":"array","items":{"type":"object","description":"Endpoint Agent label configuration.","required":["id"],"properties":{"id":{"type":"string","description":"The label ID of Endpoint Agent labels.","example":"1234"}},"$$ref":"#/components/schemas/EndpointAgentLabel"}},"endpointAgentTag":{"description":"A collection of Endpoint Agent Tag IDs that determines what local network data is included in the data stream. `endpointAgentLabel` and `endpointAgentTag` represent the same data. Configure only one; both are synchronized.","type":"array","items":{"type":"object","description":"Endpoint Agent tag configuration.","required":["id"],"properties":{"id":{"type":"string","description":"The tag ID of Endpoint Agent tags.","example":"91863f70-e5a6-4a1c-a266-caf02db3607d"}},"$$ref":"#/components/schemas/EndpointAgentTag"}}},"$$ref":"#/components/schemas/PutStream"}],"$$ref":"#/components/schemas/Stream","title":"Stream"}}