> ## 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 Event Statistics

> 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/domains/{domain_id}/stats
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/domains/{domain_id}/stats:
    get:
      tags:
        - Cloud Shield Analytics
      summary: Get Event Statistics
      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_domains_domain_id_stats
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: integer
            title: Domain Id
        - 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: ip
          in: query
          required: false
          schema:
            title: Ip
            anyOf:
              - type: array
                items:
                  type: string
                  format: ipvanyaddress
              - type: 'null'
          style: form
          explode: true
        - name: reference_id
          in: query
          required: false
          schema:
            title: Reference Id
            anyOf:
              - type: array
                items:
                  type: string
              - type: 'null'
          style: form
          explode: true
        - name: action
          in: query
          required: false
          schema:
            title: Action
            anyOf:
              - type: array
                items:
                  type: string
                  enum:
                    - allow
                    - block
                    - captcha
                    - handshake
                  title: EventAction
              - type: 'null'
          style: form
          explode: true
        - name: result
          in: query
          required: false
          schema:
            title: Result
            anyOf:
              - type: array
                items:
                  type: string
                  enum:
                    - passed
                    - blocked
                    - monitored
                    - allowed
              - type: 'null'
          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.