> ## Documentation Index > Fetch the complete documentation index at: https://developers.aptranet.com/llms.txt > Use this file to discover all available pages before exploring further. # Get security events > Project-scoped operation. Successful JSON and status-only responses vary by operation. The service does not declare a stable response schema for this operation; do not assume a collection envelope or undocumented fields. ## OpenAPI ````yaml /openapi-shield.json get /shield/analytics/events openapi: 3.1.0 info: title: Aptranet Cloud Shield API version: 1.0.0 description: >- Public project-scoped API. Use the access key and secret together. Browser-only organization administration is documented separately. Request schemas and query parameters follow the service operation allowlist. Plan entitlements apply in addition to API permissions. Some analytics and action responses have operation-specific JSON shapes; where the implementation provides no stable response contract, the reference deliberately does not invent one. servers: - url: https://api.aptranet.com security: - bearerAuth: [] apiSecret: [] paths: /shield/analytics/events: get: tags: - Cloud Shield Analytics summary: Get security events description: >- Project-scoped operation. Successful JSON and status-only responses vary by operation. The service does not declare a stable response schema for this operation; do not assume a collection envelope or undocumented fields. operationId: GET_shield_analytics_events parameters: - name: domains in: query required: false schema: type: array title: Domains items: type: integer style: form explode: true - name: has_policy_override in: query required: false schema: title: Has Policy Override anyOf: - type: boolean - type: 'null' - name: order_by in: query required: false schema: type: string enum: - request_time.asc - request_time.desc default: request_time.desc example: request_time.asc title: Order By - name: limit in: query required: false schema: type: integer default: 100 minimum: 1 maximum: 100 title: Limit - name: next in: query required: false schema: title: Next anyOf: - type: string - type: 'null' - name: start in: query required: true schema: type: string example: '2024-04-13T00:00:00+01:00' title: Start - name: end in: query required: false schema: title: End anyOf: - type: string - type: 'null' - name: ips in: query required: false schema: type: array maxItems: 10 title: Ips items: type: string format: ipvanyaddress style: form explode: true - name: path in: query required: false schema: type: array title: Path items: type: string style: form explode: true - name: countries in: query required: false schema: type: array title: Countries items: type: string style: form explode: true - name: status_codes in: query required: false schema: type: array title: Status Codes items: type: integer minimum: 100 maximum: 599 style: form explode: true - name: http_methods in: query required: false schema: type: array title: Http Methods items: type: string enum: - DELETE - GET - HEAD - OPTIONS - PATCH - POST - PUT - TRACE title: HttpMethodType style: form explode: true - name: reference_ids in: query required: false schema: type: array title: Reference Ids items: type: string style: form explode: true - name: request_ids in: query required: false schema: type: array title: Request Ids items: type: string style: form explode: true - name: exclude_request_ids in: query required: false schema: type: array title: Exclude Request Ids items: type: string style: form explode: true - name: session_ids in: query required: false schema: type: array title: Session Ids items: type: string style: form explode: true - name: security_rule_names in: query required: false schema: type: array title: Security Rule Names items: type: string maxLength: 100 style: form explode: true - name: decision in: query required: false schema: type: array title: Decision items: type: string enum: - blocked - monitored - allowed - passed title: EventDecision style: form explode: true - name: optional_action in: query required: false schema: type: array title: Optional Action items: type: string enum: - captcha - challenge title: OptionalAction style: form explode: true - name: exclude_ips in: query required: false schema: type: array title: Exclude Ips items: type: string format: ipvanyaddress style: form explode: true - name: exclude_countries in: query required: false schema: type: array title: Exclude Countries items: type: string style: form explode: true - name: exclude_session_ids in: query required: false schema: type: array title: Exclude Session Ids items: type: string style: form explode: true - name: exclude_reference_ids in: query required: false schema: type: array title: Exclude Reference Ids items: type: string style: form explode: true - name: exclude_security_rule_names in: query required: false schema: type: array title: Exclude Security Rule Names items: type: string maxLength: 100 style: form explode: true - name: exclude_domains in: query required: false schema: type: array title: Exclude Domains items: type: integer style: form explode: true - name: ja3 in: query required: false schema: type: array maxItems: 10 title: Ja3 items: type: string style: form explode: true - name: ja4 in: query required: false schema: type: array maxItems: 10 title: Ja4 items: type: string style: form explode: true - name: user_agent in: query required: false schema: type: array maxItems: 10 title: User Agent items: type: string maxLength: 300 style: form explode: true - name: user_agent_clients in: query required: false schema: type: array maxItems: 10 title: User Agent Clients items: type: string maxLength: 50 style: form explode: true - name: user_agent_devices in: query required: false schema: type: array maxItems: 10 title: User Agent Devices items: type: string maxLength: 50 style: form explode: true - name: tags in: query required: false schema: type: array maxItems: 5 title: Tags items: type: string maxLength: 50 style: form explode: true - name: organizations in: query required: false schema: type: array maxItems: 10 title: Organizations items: type: string maxLength: 100 style: form explode: true - name: exclude_user_agent in: query required: false schema: type: array maxItems: 10 title: Exclude User Agent items: type: string maxLength: 300 style: form explode: true - name: exclude_user_agent_clients in: query required: false schema: type: array maxItems: 10 title: Exclude User Agent Clients items: type: string maxLength: 50 style: form explode: true - name: exclude_user_agent_devices in: query required: false schema: type: array maxItems: 10 title: Exclude User Agent Devices items: type: string maxLength: 50 style: form explode: true - name: exclude_ja3 in: query required: false schema: type: array maxItems: 10 title: Exclude Ja3 items: type: string style: form explode: true - name: exclude_ja4 in: query required: false schema: type: array maxItems: 10 title: Exclude Ja4 items: type: string style: form explode: true - name: exclude_tags in: query required: false schema: type: array maxItems: 5 title: Exclude Tags items: type: string maxLength: 50 style: form explode: true - name: exclude_organizations in: query required: false schema: type: array maxItems: 10 title: Exclude Organizations items: type: string maxLength: 100 style: form explode: true - name: exclude_status_codes in: query required: false schema: type: array title: Exclude Status Codes items: type: integer minimum: 100 maximum: 599 style: form explode: true - name: exclude_http_methods in: query required: false schema: type: array title: Exclude Http Methods items: type: string enum: - DELETE - GET - HEAD - OPTIONS - PATCH - POST - PUT - TRACE title: HttpMethodType style: form explode: true - name: exclude_optional_action in: query required: false schema: type: array title: Exclude Optional Action items: type: string enum: - captcha - challenge title: OptionalAction style: form explode: true - name: exclude_decision in: query required: false schema: type: array title: Exclude Decision items: type: string enum: - blocked - monitored - allowed - passed title: EventDecision style: form explode: true - name: exclude_path in: query required: false schema: type: array title: Exclude Path items: type: string style: form explode: true responses: 2XX: description: Successful response. default: description: >- Request rejected or service unavailable. See the error code and description; refresh before retrying a mutation whose result is uncertain. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Error: type: object properties: error: type: string error_description: type: string securitySchemes: bearerAuth: type: http scheme: bearer description: Project API access key. apiSecret: type: apiKey in: header name: Aptranet-Secret description: Current secret for the access key. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.