Eagle Eye Networks Alerts API

openapi: 3.2.0
info:
  title: EVENTS Alerts API
  version: 3.0.0
  description: Alerts generated by the system.
servers:
- url: https://{BaseUrl}/api/v3.0
  description: Eagle Eye Networks API Server
  variables:
    BaseUrl:
      default: api.cxxx.eagleeyenetworks.com
      description: HTTPS Base url to use for all API calls, retrieved from https://api.eagleeyenetworks.com/api/v3.0/clientSettings
security:
- bearerAuth: []
tags:
- name: Alerts
  description: Alerts generated by the system.
paths:
  /alertTypes:
    get:
      tags:
      - Alerts
      description: Fetches all the alert types that are currently supported.
      operationId: listAlertTypes
      parameters:
      - $ref: '#/components/parameters/pageToken'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Success, lists field values as populated in the alerts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiPaginatedAlertTypesResponse'
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: List alert types
      x-summary-source: derived
  /alerts:
    get:
      tags:
      - Alerts
      operationId: listAlerts
      description: Search and sort alerts by creatorId, alertType, actorId, actorType, actorAccountId, ruleId, eventId, locationId, and priority. Optional information can be requested with include.
      parameters:
      - $ref: '#/components/parameters/acceptLanguage'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/creatorId'
      - $ref: '#/components/parameters/timestamp__lte1'
      - $ref: '#/components/parameters/timestamp__gte1'
      - $ref: '#/components/parameters/alertType__in'
      - $ref: '#/components/parameters/actorId__in'
      - $ref: '#/components/parameters/actorType__in'
      - $ref: '#/components/parameters/actorAccountId'
      - $ref: '#/components/parameters/ruleId'
      - $ref: '#/components/parameters/ruleId__in'
      - $ref: '#/components/parameters/eventId'
      - $ref: '#/components/parameters/locationId__in'
      - $ref: '#/components/parameters/eventType__in'
      - $ref: '#/components/parameters/priority__gte'
      - $ref: '#/components/parameters/priority__lte'
      - $ref: '#/components/parameters/showInvalidAlerts'
      - $ref: '#/components/parameters/alertActionId__in'
      - $ref: '#/components/parameters/alertActionStatus__in'
      - $ref: '#/components/parameters/include1'
      - $ref: '#/components/parameters/sort1'
      - $ref: '#/components/parameters/pageToken'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Alert results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alerts'
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: List alerts
      x-summary-source: derived
  /alerts/{id}:
    get:
      tags:
      - Alerts
      operationId: getAlert
      description: Get an alert
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: '#/components/parameters/include1'
      responses:
        '200':
          description: Alert result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alert'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/resourceNotFound'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: Get alert
      x-summary-source: derived
components:
  schemas:
    ErrorInfoExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - errorInfo
        reason:
          description: 'The reason for the error. This is a constant value that identifies the proximate cause of the

            error. Error reasons are unique within a particular domain of errors.

            '
          type: string
          enum:
          - unauthenticated
          - unexpectedArgument
          - missingRequiredArgument
          - wrongArgumentValue
          - invalidPermission
          - wrongEdition
          - wrongAccountType
          - resourceNotFound
          - endpointNotFound
          - methodNotSupported
          - unexpectedError
          - acceptNotSupported
          - alreadyExists
          - foreignKeyConflict
          - childDevicesExist
          - contentNotSupported
          - deadlineExpired
          - tooManyRequests
          - deviceUnavailable
          - serviceUnavailable
          - invalidJSON
          - resourceLocked
          - notSupportedOnBridge
          - outOfRetention
          - deviceIdentificationFailed
          - credentialValidationFailed
          - credentialSetupFailed
          - localUrlValidationFailed
          - hwRegistrationFailed
          - failedAddingCameraAfterValidation
          - neverConnected
          - reconnectFailed
          - unsupportedModel
          - purged
          - userBlocked
          - userTemporarilyBlocked
          - quotaExceeded
          - alreadyValidated
          - reAuthenticationRequired
          - badGateway
        domain:
          description: 'Logical grouping to which the "reason" belongs

            '
          type: string
        metadata:
          $ref: '#/components/schemas/ExceptionMetadata'
    Alert:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: d290f1ee-6c54-4b01-90e6-d701748f0851
        timestamp:
          type: string
          format: date-time
          example: '2021-04-22T00:00:00.000+00:00'
        createTimestamp:
          type: string
          format: date-time
          example: '2021-04-22T00:00:00.000+00:00'
        creatorId:
          type: string
          example: een.auditLog
        alertType:
          type: string
          example: userLogin
        alertName:
          type: string
          example: Motion Detection Alert
        category:
          type: string
          example: motion
        serviceRuleId:
          type: string
          example: d290f1ee-6c54-4b01-90e6-d701748f0851
          description: The UUID of the service rule id for creation.
        eventType:
          type: string
          example: een.vehicleDetectionEvent.v1
        actorId:
          type: string
          example: d22d1939-2e14-434b-8185-d324be6cf363
        actorType:
          type: string
          example: user
        actorAccountId:
          type: string
          example: '00011557'
        actorName:
          type: string
          example: John Doe
        ruleId:
          type: string
          example: ''
        eventId:
          type: string
          example: ''
        locationId:
          type: string
          example: 6a4dec07-d507-43d3-9977-c537fb48d341
        locationName:
          type:
          - string
          - 'null'
          example: Office
        priority:
          type: integer
          minimum: 0
          maximum: 20
        dataSchemas:
          type: array
          items:
            type: string
        data:
          type: object
        actions:
          type: object
          additionalProperties:
            type: object
            required:
            - name
            - type
            - success
            - timestamp
            properties:
              name:
                type: string
                example: Email John
              type:
                description: Alert action type, see `type` field in `/alertActions` endpoint for possible values.
                type: string
                example: notification
              success:
                type: boolean
                description: Denotes if the action was taken successfully.
                example: true
              timestamp:
                type: string
                format: date-time
                description: Time at which the action was taken.
                example: '2021-04-22T00:00:00.000+00:00'
              status:
                type: string
                description: Detailed Status of the alert action, e.g. "fired", "success", "partialSuccess", "silenced", "failed", "internalError".
                example: silenced
        description:
          type: string
          example: User "John Doe (john.doe@example.com)" logged in.
    Language:
      description: Source data set is api/v3.0/languages
      type: string
      example: en-US
    ExceptionDetail:
      type: object
      oneOf:
      - $ref: '#/components/schemas/ErrorInfoExceptionDetail'
      - $ref: '#/components/schemas/BadRequestExceptionDetail'
      - $ref: '#/components/schemas/ResourceInfoExceptionDetail'
      discriminator:
        propertyName: type
        mapping:
          errorInfo: '#/components/schemas/ErrorInfoExceptionDetail'
          badRequest: '#/components/schemas/BadRequestExceptionDetail'
          resourceInfo: '#/components/schemas/ResourceInfoExceptionDetail'
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - errorInfo
          - badRequest
          - resourceInfo
      required:
      - type
    ApiV3Error:
      type: object
      properties:
        code:
          description: HTTP code defined in EEN Standard Code Values
          type: integer
        status:
          description: A string enum describing the code
          type: string
          enum:
          - cancelled
          - unknown
          - invalidArgument
          - deadlineExceeded
          - notFound
          - conflict
          - permissionDenied
          - resourceExhausted
          - failedPrecondition
          - aborted
          - outOfRange
          - unimplemented
          - internal
          - unavailable
          - dataLoss
          - unauthenticated
          - mediaTypeNotSupported
          - acceptNotSupported
          - methodNotSupported
          - tooManyRequests
          - badGateway
        message:
          description: Developer friendly human readable error message in English
          type: string
        details:
          description: An array of extensible objects that define error information
          type: array
          items:
            $ref: '#/components/schemas/ExceptionDetail'
      required:
      - code
      - status
      - message
      - details
    BadRequestExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - badRequest
        argumentViolations:
          type: array
          items:
            $ref: '#/components/schemas/ArgumentViolation'
    PaginatedResponseNoTotalSize:
      type: object
      description: 'Used to wrap results for a paginated response, containing information on how to retrieve further pages.

        '
      properties:
        nextPageToken:
          type:
          - string
          - 'null'
          readOnly: true
          description: 'Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

            '
        prevPageToken:
          type:
          - string
          - 'null'
          readOnly: true
          description: 'Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

            '
        results:
          type: array
          readOnly: true
          description: The result set from a collection API call.
          items:
            type: object
      required:
      - nextPageToken
      - prevPageToken
      - results
    ApiPaginatedAlertTypesResponse:
      allOf:
      - $ref: '#/components/schemas/PaginatedResponseNoTotalSize'
      - type: object
        properties:
          results:
            type: array
            items:
              $ref: '#/components/schemas/AlertType'
    language:
      description: Source data set is api/v3.0/languages
      type: string
      example: en-US
    Alerts:
      allOf:
      - $ref: '#/components/schemas/PaginatedResponseNoTotalSize'
      - type: object
        properties:
          results:
            type: array
            items:
              $ref: '#/components/schemas/Alert'
    ResourceInfoExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - resourceInfo
        resource:
          description: Referenced resource type, eg "cameras", "bridges", or "locations".
          type: string
        ids:
          type: array
          description: Identities of resources
          items:
            type: string
    ArgumentViolation:
      properties:
        argumentName:
          type: string
          description: Name of the argument
        description:
          type: string
          description: Description of the violation
    ExceptionMetadata:
      properties:
        path:
          description: Path of the request
          type: string
        method:
          description: Method of the request
          type: string
    AlertType:
      type: object
      properties:
        type:
          type: string
          description: Unique identifier for the specific alert type.
          example: een.deviceCloudStatusUpdateAlert.v1
        description:
          type: string
          description: Short text to display to users to identify the alert type. Currently only returned in English.
          example: Device status
  parameters:
    priority__gte:
      in: query
      name: priority__gte
      description: Filter by priority__gte
      required: false
      schema:
        type: integer
        minimum: 0
        maximum: 10
    language:
      description: Language query overrides Accept-Language header
      in: query
      name: language
      required: false
      schema:
        $ref: '#/components/schemas/language'
    actorId__in:
      in: query
      name: actorId__in
      description: Filter by actorId (supports multiple values)
      required: false
      schema:
        type: array
        items:
          type: string
      style: form
      explode: false
      example:
      - d22d1939
      - b33f3a55
    eventType__in:
      in: query
      name: eventType__in
      description: Filter by eventType (supports multiple values)
      required: false
      schema:
        type: array
        items:
          type: string
      style: form
      explode: false
      example:
      - een.motionDetectionEvent.v1
      - een.vehicleDetectionEvent.v1
    id:
      in: path
      name: id
      description: Alert id
      required: true
      schema:
        type: string
      example: 4109d54b-4e62-41a4-92fa-cac6c1ff0183
    alertActionId__in:
      in: query
      name: alertActionId__in
      description: Filter by one or more alert action IDs (supports multiple values)
      required: false
      schema:
        type: array
        items:
          type: string
          format: uuid
      style: form
      explode: false
      example:
      - 7a7c7313-d010-40ff-8b10-eeed1fccd00a
      - 395b2b01-8416-4d93-ae52-a204bcd1c2a2
    actorAccountId:
      in: query
      name: actorAccountId
      description: Filter by actorAccountId
      required: false
      schema:
        type: string
    creatorId:
      in: query
      name: creatorId
      description: Filter by creatorId
      required: false
      schema:
        type: string
      example: een.auditLog
    pageSize:
      in: query
      name: pageSize
      description: 'The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and  maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a `nextPageToken` value.

        '
      example: 100
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 500
        default: 100
    alertActionStatus__in:
      in: query
      name: alertActionStatus__in
      description: Filter by one or more alert action statuses (supports multiple values)
      required: false
      schema:
        type: array
        items:
          type: string
          enum:
          - fired
          - success
          - partialSuccess
          - silenced
          - failed
          - internalError
      style: form
      explode: false
      example:
      - success
      - failed
    ruleId__in:
      in: query
      name: ruleId__in
      description: Filter by one or more rule IDs (supports multiple values)
      required: false
      schema:
        type: array
        items:
          type: string
          format: uuid
      style: form
      explode: false
      example:
      - d290f1ee-6c54-4b01-90e6-d701748f0851
      - a123b45c-678d-9012-3456-789abc012def
    alertType__in:
      in: query
      name: alertType__in
      description: Filter by alertType (supports multiple values)
      required: false
      schema:
        type: array
        items:
          type: string
      style: form
      explode: false
      example:
      - motion
      - intrusion
    priority__lte:
      in: query
      name: priority__lte
      description: Filter by priority__lte
      required: false
      schema:
        type: integer
        minimum: 0
        maximum: 10
    timestamp__gte1:
      in: query
      name: timestamp__gte
      description: Filter by timestamp__gte
      required: false
      schema:
        type: string
        format: date-time
    ruleId:
      in: query
      name: ruleId
      description: Filter by ruleId
      required: false
      schema:
        type: string
        format: uuid
      example: d290f1ee-6c54-4b01-90e6-d701748f0851
    sort1:
      in: query
      name: sort
      description: Sort by timestamp
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          enum:
          - +timestamp
          - -timestamp
        default:
        - -timestamp
      example:
      - +timestamp
    acceptLanguage:
      in: header
      name: Accept-Language
      required: false
      schema:
        $ref: '#/components/schemas/Language'
    showInvalidAlerts:
      in: query
      name: showInvalidAlerts
      description: 'If set to true, the API will include alerts that are invalidated by Human reviewer.

        '
      required: false
      schema:
        type: boolean
      example: true
    timestamp__lte1:
      in: query
      name: timestamp__lte
      description: Filter by timestamp__lte
      required: false
      schema:
        type: string
        format: date-time
    locationId__in:
      in: query
      name: locationId__in
      description: Filter by one or more location IDs.
      required: false
      schema:
        type: array
        items:
          type: string
      style: form
      explode: false
      example:
      - acd0dd1-05a0-4d75-a14b-30e0f4083c70
      - d0e4aad4-06c5-4c43-a4ac-3106738ed206
    include1:
      in: query
      name: include
      description: Specify additional data to include in the response (supports multiple values like `data` and `actions`).
      required: false
      schema:
        type: array
        items:
          type: string
          enum:
          - data
          - actions
          - dataSchemas
          - description
      style: form
      explode: false
      example:
      - data
      - actions
    eventId:
      in: query
      name: eventId
      description: Filter by eventId
      required: false
      schema:
        type: string
    actorType__in:
      in: query
      name: actorType__in
      description: Filter by actorType (supports multiple values)
      required: false
      schema:
        type: array
        items:
          type: string
      style: form
      explode: false
      example:
      - user
      - device
    pageToken:
      in: query
      name: pageToken
      description: 'Token string value that references a page for pagination. This value is received when retrieving the first page in the `nextPageToken` and `prevPageToken` fields.

        When a pageToken is provided, the backend remembers search parameters from the original request, so search  parameters that affect the result set or order are optional and will be ignored if provided. Representation  parameters like `include` should still be applied.

        '
      example: b2Zmc2V0PTEwJmxpbWl0PTEw
      required: false
      schema:
        type: string
  responses:
    forbidden:
      description: You have no permission to access the specified resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          examples:
            invalidPermission:
              value:
                code: 403
                status: permissionDenied
                message: The client caller does not have permission for the specified operation
                details:
                - type: errorInfo
                  reason: invalidPermission
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            wrongEdition:
              value:
                code: 403
                status: permissionDenied
                message: This feature is not enabled for the account
                details:
                - type: errorInfo
                  reason: wrongEdition
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/locations
            wrongAccountType:
              value:
                code: 403
                status: permissionDenied
                message: This feature is only available for end users
                details:
                - type: errorInfo
                  reason: wrongAccountType
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/locations
    resourceNotFound:
      description: Referenced resource could not be found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          examples:
            endpointNotFound:
              value:
                code: 404
                status: notFound
                message: The API endpoint was not found
                details:
                - type: errorInfo
                  reason: endpointNotFound
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            resourceNotFound:
              value:
                code: 404
                status: notFound
                message: The resource was not found
                details:
                - type: errorInfo
                  reason: resourceNotFound
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
                - type: resourceInfo
                  resource: <resource>
                  ids:
                  - <ids>
    internalServerError:
      description: Something went wrong in the server. Please try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          example:
            code: 500
            status: internal
            message: An internal error has occurred. Please try again later.
            details:
            - type: errorInfo
              reason: unexpectedError
              domain: apiv3
              metadata:
                path: /api/v3.0/<resource>
    unauthorized:
      description: You are not authenticated. Please authenticate and try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          example:
            code: 401
            status: unauthenticated
            message: The client caller does not have a valid authentication credential
            details:
            - type: errorInfo
              reason: unauthenticated
              domain: apiv3
              metadata:
                path: /api/v3.0/<resource>
    validationError:
      description: The supplied object is invalid. Error detail will contain the validation error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          examples:
            unexpectedArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Unexpected argument: name'
                details:
                - type: errorInfo
                  reason: unexpectedArgument
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            missingRequiredArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Missing required arguments: name, id'
                details:
                - type: errorInfo
                  reason: missingRequiredArgument
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            badRequestInvalidJSON:
              value:
                code: 400
                status: invalidArgument
                message: Invalid JSON
                details:
                - type: errorInfo
                  reason: invalidJSON
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            badRequestInvalidArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Invalid Argument: Argument name is too long'
                details:
                - type: errorInfo
                  reason: wrongArgumentValue
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
                - type: badRequest
                  argumentViolations:
                  - argumentName: name
                    description: Name is too long
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: searched
  source: https://developer.eagleeyenetworks.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.eagleeyenetworks.com/reference/createevent.md
  - https://developer.eagleeyenetworks.com/reference/createeventsubscription.md
  - https://developer.eagleeyenetworks.com/reference/createeventsubscriptionfilter.md
  - https://developer.eagleeyenetworks.com/reference/deleteeventsubscription.md
  - https://developer.eagleeyenetworks.com/reference/deleteeventsubscriptionfilter.md
  - https://developer.eagleeyenetworks.com/reference/getalert.md
  - https://developer.eagleeyenetworks.com/reference/geteventbyid.md
  - https://developer.eagleeyenetworks.com/reference/geteventmetrics.md
  - https://developer.eagleeyenetworks.com/reference/geteventsubscription.md
  - https://developer.eagleeyenetworks.com/reference/geteventsubscriptionfilter.md
  - https://developer.eagleeyenetworks.com/reference/getnotification.md
  - https://developer.eagleeyenetworks.com/reference/listalerts.md
  - https://developer.eagleeyenetworks.com/reference/listalerttypes.md
  - https://developer.eagleeyenetworks.com/reference/listevents.md
  - https://developer.eagleeyenetworks.com/reference/listeventsfieldvalues.md
  - https://developer.eagleeyenetworks.com/reference/listeventsubscriptionfilters.md
  - https://developer.eagleeyenetworks.com/reference/listeventsubscriptions.md
  - https://developer.eagleeyenetworks.com/reference/listeventtypes.md
  - https://developer.eagleeyenetworks.com/reference/listnotifications.md
  - https://developer.eagleeyenetworks.com/reference/listrecenteventsbytype.md
  - https://developer.eagleeyenetworks.com/reference/updatenotification.md
  merge:
    pages: 21
    deduped: 793
    conflicts_kept_first: 0