---
updatedAt: 2026-05-12T09:59:37.000Z
---

# Retrieve events collection

This operation returns an object containing information about user activity and scan events.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Event API (Legacy)",
    "license": {
      "name": "(c) Copyright 2020 WhiteHat Security"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com"
    }
  ],
  "paths": {
    "/api/event": {
      "get": {
        "tags": [
          "Event API v1.0"
        ],
        "summary": "Retrieve events collection",
        "description": "This operation returns an object containing information about user activity and scan events.",
        "operationId": "getEventsCollection",
        "parameters": [
          {
            "name": "query_category",
            "in": "query",
            "description": "Retrieve events from one or more comma-separated categories. EXAMPLE: vuln,scan,user.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query_type",
            "in": "query",
            "description": "Retrieve events of a particular type. 'type' is a single value classification of an 'event'. An event may have multiple categories. EXAMPLE: Event \"user created\", has type \"new_user\". Categories of \"new_user\" would be \"user\" and \"user_create\".",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query_type_like",
            "in": "query",
            "description": "Retrieve events that have a type that contains the given string. Example: 'gr' would retrieve events that would match 'group_added' and 'asset_assigned_to_group', etc.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query_before",
            "in": "query",
            "description": "Retrieve events logged before the given date (and optionally a time). Requires a valid ISO-8601 (UTC/GMT) date format string. EXAMPLES: Date: '2020-06-25' Date with timestamp: '2020-06-24T19:43:37.740Z'",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query_after",
            "in": "query",
            "description": "Retrieve events logged after the given date (and optionally a time). Requires a valid ISO-8601 (UTC/GMT) date format string. EXAMPLES: Date: '2020-06-25' Date with timestamp: '2020-06-24T19:43:37.740Z'",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query_asset_type",
            "in": "query",
            "description": "Retrieve events for a particular asset type.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "site",
              "example": "site",
              "enum": [
                "site",
                "user",
                "application"
              ]
            }
          },
          {
            "name": "query_asset_string_like",
            "in": "query",
            "description": "Retrieve events logged for an asset that contains the given string in its name.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page:limit",
            "in": "query",
            "description": "Limit results to n number of pages.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "page:offset",
            "in": "query",
            "description": "Begin showing results from page number n.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "page:order_by",
            "in": "query",
            "description": "Order the results.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "id",
              "example": "id",
              "enum": [
                "id",
                "id_asc",
                "id_desc",
                "time",
                "time_asc",
                "time_desc"
              ]
            }
          },
          {
            "name": "format",
            "in": "query",
            "description": "Data format for results.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "xml",
              "example": "json",
              "enum": [
                "json",
                "xml",
                "csv"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Provides the information of events.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Events"
                }
              },
              "application/xml": {
                "example": "XML preview is currently not supported."
              },
              "text/csv, text/comma-separated-values": {
                "schema": {
                  "type": "string",
                  "description": "Column headers for data that may be returned using this format.",
                  "example": "id,asset_type,message,time,type"
                }
              }
            }
          },
          "400": {
            "description": "BadRequestResponse indicates a request with invalid parameters.",
            "content": {}
          },
          "401": {
            "description": "UnauthorizedResponse signals an unauthorized API access.",
            "content": {}
          },
          "403": {
            "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized.",
            "content": {}
          },
          "500": {
            "description": "GenericError generic error.",
            "content": {}
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "EventResources": {
        "properties": {
          "string": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "href": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "Event": {
        "properties": {
          "time": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "type": {
            "type": "string"
          },
          "resources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventResources"
            }
          },
          "asset_type": {
            "type": "string"
          },
          "id": {
            "type": "number"
          }
        }
      },
      "Events": {
        "properties": {
          "type": {
            "type": "string"
          },
          "href": {
            "type": "string"
          },
          "page": {
            "properties": {
              "order_by": {
                "type": "string"
              },
              "offset": {
                "type": "string"
              },
              "total": {
                "type": "number",
                "nullable": true
              },
              "limit": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "collection": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Event"
            }
          }
        }
      }
    }
  },
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```