AIXBT Docs
REST APIReference

Get Intel by ID

GET
/v2/intel/{id}

Returns full intel detail including activity history and cluster composition.

Authorization

ApiKeyAuth
x-api-key<token>

API key to authorize requests

In: header

Path Parameters

id*string

Intel (summary) ID

Query Parameters

activity?string

Controls whether the activity timeline is full, observation-only, or omitted.

Default"all"
Value in"all" | "observations" | "none"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v2/intel/string"
{
  "status": 200,
  "meta": {
    "history": {
      "archiveAccess": true,
      "enforced": true,
      "lookbackDays": 90,
      "earliestAvailableAt": "2019-08-24T14:15:22Z",
      "enforcementAt": "2026-08-17T00:00:00.000Z"
    }
  },
  "data": {
    "id": "string",
    "detectedAt": "2019-08-24T14:15:22Z",
    "reinforcedAt": "2019-08-24T14:15:22Z",
    "description": "string",
    "headline": "string",
    "citations": [
      "string"
    ],
    "projectName": "string",
    "projectId": "string",
    "projectImage": "http://example.com",
    "category": "string",
    "observationCount": 0,
    "hasOfficialSource": true,
    "sentiment": -1,
    "referencesMetrics": true,
    "metrics": {
      "usd": 0,
      "usdMarketCap": 0,
      "usd24hVol": 0,
      "usd24hChange": 0,
      "lastUpdatedAt": 0
    },
    "clusters": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "activity": [
      {
        "id": "string",
        "date": "2019-08-24T14:15:22Z",
        "action": "string",
        "source": "string",
        "actor": {
          "type": "string"
        },
        "officialSourceUrl": "http://example.com",
        "clusters": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "incoming": "string",
        "result": "string",
        "headline": "string",
        "sentiment": -1,
        "citationEvidence": [
          {
            "id": "string",
            "url": "string",
            "targetActivityIds": [
              "string"
            ]
          }
        ],
        "fromSignal": {
          "signalId": "string",
          "projectId": "string",
          "projectName": "string"
        },
        "isOfficial": true,
        "changelog": "string"
      }
    ],
    "clusterComposition": [
      {
        "id": "string",
        "name": "string",
        "percentage": 0
      }
    ]
  }
}
{
  "error": "string",
  "message": "string",
  "code": "string",
  "status": 0,
  "data": null,
  "meta": {},
  "details": {},
  "pagination": {
    "page": 1,
    "limit": 1,
    "totalCount": 0,
    "hasMore": true
  },
  "limitType": "minute",
  "retryAfterMs": 0,
  "limits": {
    "minute": {
      "limit": 0,
      "remaining": 0,
      "resetAt": "2019-08-24T14:15:22Z"
    },
    "day": {
      "limit": 0,
      "remaining": 0,
      "resetAt": "2019-08-24T14:15:22Z"
    }
  },
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "error": "string",
  "message": "string",
  "code": "string",
  "status": 0,
  "data": null,
  "meta": {},
  "details": {},
  "pagination": {
    "page": 1,
    "limit": 1,
    "totalCount": 0,
    "hasMore": true
  },
  "limitType": "minute",
  "retryAfterMs": 0,
  "limits": {
    "minute": {
      "limit": 0,
      "remaining": 0,
      "resetAt": "2019-08-24T14:15:22Z"
    },
    "day": {
      "limit": 0,
      "remaining": 0,
      "resetAt": "2019-08-24T14:15:22Z"
    }
  },
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "error": "string",
  "message": "string",
  "code": "string",
  "status": 0,
  "data": null,
  "meta": {},
  "details": {},
  "pagination": {
    "page": 1,
    "limit": 1,
    "totalCount": 0,
    "hasMore": true
  },
  "limitType": "minute",
  "retryAfterMs": 0,
  "limits": {
    "minute": {
      "limit": 0,
      "remaining": 0,
      "resetAt": "2019-08-24T14:15:22Z"
    },
    "day": {
      "limit": 0,
      "remaining": 0,
      "resetAt": "2019-08-24T14:15:22Z"
    }
  },
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "error": "string",
  "message": "string",
  "code": "string",
  "status": 0,
  "data": null,
  "meta": {},
  "details": {},
  "pagination": {
    "page": 1,
    "limit": 1,
    "totalCount": 0,
    "hasMore": true
  },
  "limitType": "minute",
  "retryAfterMs": 0,
  "limits": {
    "minute": {
      "limit": 0,
      "remaining": 0,
      "resetAt": "2019-08-24T14:15:22Z"
    },
    "day": {
      "limit": 0,
      "remaining": 0,
      "resetAt": "2019-08-24T14:15:22Z"
    }
  },
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}