Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS X-Ray Insights API

Automated anomaly detection insights

AWS X-Ray Insights API is one of 9 APIs that AWS X-Ray publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Insights. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 1 JSON Schema.

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2016-04-12.

Requests are made against a single base URL, https://xray.{region}.amazonaws.com.

2 operations 2 paths 3 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2016-04-12
Base URL
https://xray.{region}.amazonaws.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

AWS X-Ray Insights API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (aws_sig_v4). By default, every request must be authenticated.

  • aws_sig_v4 — AWS Signature Version 4

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Insights 2

Automated anomaly detection insights

POST
/Insights
AWS X-Ray Get Insight Summaries
GetInsightSummaries body → 200
POST
/Insight
AWS X-Ray Get Insight Details
GetInsight body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are InsightSummary (13 properties), Insight (12 properties), ServiceId (4 properties). Each schema is shown below with its type and property counts.

Insight
object
12 properties
InsightSummary
object
13 properties
ServiceId
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-x-ray-insights-api-openapi.yml Raw ↑

Other APIs AWS X-Ray publishes across the network.

AWS X-Ray Encryption API
AWS X-Ray Groups API
AWS X-Ray Sampling API
AWS X-Ray Service Graph API
AWS X-Ray TagResource API
AWS X-Ray Tags API
AWS X-Ray Traces API
AWS X-Ray UntagResource API