Analytics API
The Analytics API provides detailed information and analysis of threat intelligence entities in the ThreatWinds platform. It allows you to retrieve entity details, including attributes, metadata, geolocations, and relationships with other entities.
Overview
ThreatWinds Analytics API allows you to:
| Feature | Description |
|---|---|
| Entity Details | Get detailed information about threat intelligence entities |
| Entity Relations | View relationships between entities in a graph format |
| Metadata Access | Access extended metadata and geolocation information |
Authentication
Like all ThreatWinds APIs, the Analytics API requires authentication. You can authenticate using either:
| Authentication Method | Description |
|---|---|
| Authorization Header | Include a bearer token in the Authorization header |
| API Key and Secret | Include your API key and secret in the request headers |
For more details on authentication, see the Authentication section.
API Endpoints
The base URL for the Analytics API is:
https://apis.threatwinds.com/api/analytics/v1
For detailed information about each endpoint, please refer to the specific documentation pages.
Error Response Headers
All error responses include the following custom headers:
| Header | Description |
|---|---|
| x-error | Human-readable error message describing what went wrong |
| x-error-id | Unique MD5 hash identifier for error tracking and support |
Error Codes
| Status Code | Description | Possible Cause |
|---|---|---|
| 200 | OK | Request successful with entity details or relations |
| 400 | Bad Request | Invalid entity ID, malformed parameters, or validation error |
| 401 | Unauthorized | Missing or invalid authentication credentials |
| 404 | Not Found | Entity not found or relations not found |
| 500 | Internal Server Error | Database error or server-side error |