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, including metadata, geolocation, and attributes |
| Entity Relations | View relationships between entities in a graph format |
| Corpus Analytics | Aggregate overview, recent activity, and origin attribution |
| Live Threat Feed | Stream new and malicious entities over a WebSocket |
Authentication
Like all ThreatWinds APIs, the Analytics API supports optional authentication. Endpoints accept both authenticated and unauthenticated requests. Unauthenticated requests are subject to lower rate limits than authenticated requests. 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 identifier for error tracking and support |
Error Codes
| Status Code | Description | Possible Cause |
|---|---|---|
| 400 | Bad Request | Invalid entity ID, malformed parameters, or validation error |
| 401 | Unauthorized | Invalid authentication credentials |
| 403 | Forbidden | Insufficient permissions to access the entity |
| 404 | Not Found | Entity not found or relations not found |
| 429 | Too Many Requests | Rate limit exceeded; check the Retry-After header |
| 500 | Internal Server Error | Server-side error |
Rate Limits
Requests are metered per minute, and unauthenticated (Public) requests get lower limits than authenticated ones. Per-tier values are not published in this documentation — read them live:
GET /api/billing/v1/limits/analytics-api
Exceeding a limit returns 429 with a Retry-After header. See Usage Limits.