RErecordedfuture
Alert V3

Fetch a flat collection of hits

Changed on

Returns only a flat array of all hits (the Intelligence Cloud data that caused the alert to trigger) for one or several alerts.

This endpoint will also include the alert ID and a numeric index for each hits object.

get/v3/hits

Request

  • Base URL
    api.recordedfuture.com/alert (relative, and the document’s source URL is not known)
  • Auth
    API key in header X-RFToken

Query parameters

idsstring required
Example:5PqsAw

Alert ids separated by comma

taggedTextboolean

Include text tags

Response

A list of hits for the alert(s)

Example response

{
  "data": [
    {
      "id": "Gb7LZpBRHpP",
      "language": "eng",
      "document": {
        "source": {
          "id": "idn:services.onlinebox.com",
          "name": "services.onlinebox.com",
          "type": "InternetDomainName"
        },
        "authors": [
          {
            "id": "idn:services.onlinebox.com",
            "name": "services.onlinebox.com",
            "type": "InternetDomainName"
          }
        ]
      },
      "entities": [
        {
          "id": "idn:services.onlinebox.com",
          "name": "services.onlinebox.com",
          "type": "InternetDomainName"
        }
      ],
      "primary_entity": {
        "id": "idn:services.onlinebox.com",
        "name": "services.onlinebox.com",
        "type": "InternetDomainName"
      },
      "analyst_note": {
        "id": "ZVUGoO",
        "url": {
          "portal": "https://app.recordedfuture.com/portal/analyst-note/shared/true/doc:ZVUGoO",
          "api": "https://api.recordedfuture.com/v2/analystnote/ZVUGoO"
        }
      },
      "alert_id": "Yo0T32",
      "index": 4
    }
  ]
}

Changes

  • 46a67c0859e1Revision changes
    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added subschema #2 to the / response property allOf list for the response status