EAeagleeyenetworks
Event Types

GET /eventTypes

Fetches all the event types that are currently supported.

Request

  • Base URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0
  • URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0/eventTypes
  • Auth
    HTTP bearer

Query parameters

pageTokenstring

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.

pageSizeinteger

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.

languagestring

IETF language tag used as main identifier of the language in the Eagle Eye Networks API. The format can be just the two character "primary language subtag" or a combination of the two character "primary language subtag" and 2 character "region subtag". Use /api/v3.0/languages API to retrieve supported language codes.

Example:pt-BR

Allows clients to request translated versions of human readable fields such as the name and description fields. If no translation is available, the values will be returned in English. If both the Accept-Language and language= query parameter are used, the query parameter value is used and the header is ignored.

Headers

Accept-Languagestring

IETF language tag used as main identifier of the language in the Eagle Eye Networks API. The format can be just the two character "primary language subtag" or a combination of the two character "primary language subtag" and 2 character "region subtag". Use /api/v3.0/languages API to retrieve supported language codes.

Example:pt-BR

Allows clients to request translated versions of human readable fields such as the name and description fields. If no translation is available, the values will be returned in English. If both the Accept-Language and language= query parameter are used, the query parameter value is used and the header is ignored.

Response

Success, lists field values as populated in the events.

nextPageTokenstring nullable required

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.

prevPageTokenstring nullable required

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.

totalSizeinteger required

Size of the total result set.

Example response

{
  "results": [
    {
      "type": "een.deviceCloudStatusUpdateEvent.v1",
      "name": "Device status",
      "description": "A new event of this type is created when a device's status changes from the viewpoint of the cloud. The event represents the span of time the device stays in the given state, and a null `endTimestamp` indicates it was still in the given state when the event was retrieved. If a device is in \"bridgeOffline\" status, it might still be online and recording, but the cloud doesn't know at this time.\n"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.