Getting Started

Accessing the API

DEVICES

Cameras
Bridges
PTZ
Speakers
Switches
Multi Cameras
Available Devices
- /availableDevicesget

MEDIA

Media
Feeds
- /feedsget
Exports
- /exportspost
- /exports/{jobId}:copypost
Jobs
Files
Downloads

EVENTS

Events
Event Types
- /eventTypesget
Event Metrics
- /eventMetricsget
Event Subscriptions
Alerts
- /alertsget
- /alerts/{id}get
Notifications

VIDEO SEARCH

Video Analytics Events

VEHICLE SURVEILLANCE PACKAGE

LPR Events
LPR Rules
LPR Vehicle Lists

USER & ACCOUNTS

Users
Accounts
- /accountsget
- /accounts/{id}/credentials/{credentialId}delete
Roles
Auditlog
- /auditLogsget
Resource Grants
Editions
- /editionsget
- /editions/{id}get

RESELLERS ACCOUNT SWITCHING

Tokens
- /authorizationTokenspost

ACCOUNT SETTINGS

SSO
- /accounts/self/ssoAuthSettingsget
- /accounts/self/ssoAuthSettingspatch
Client Settings
- /clientSettingsget

GROUPING

Layouts
Tags
- /tagsget
Locations
Floors
Floor Plans

SYSTEM

Applications
Application OAuth Clients

Getting Started

Accessing the API

DEVICES

Cameras
Bridges
PTZ
Speakers
Switches
Multi Cameras
Available Devices
- /availableDevicesget

MEDIA

Media
Feeds
- /feedsget
Exports
- /exportspost
- /exports/{jobId}:copypost
Jobs
Files
Downloads

EVENTS

Events
Event Types
- /eventTypesget
Event Metrics
- /eventMetricsget
Event Subscriptions
Alerts
- /alertsget
- /alerts/{id}get
Notifications

VIDEO SEARCH

Video Analytics Events

VEHICLE SURVEILLANCE PACKAGE

LPR Events
LPR Rules
LPR Vehicle Lists

USER & ACCOUNTS

Users
Accounts
- /accountsget
- /accounts/{id}/credentials/{credentialId}delete
Roles
Auditlog
- /auditLogsget
Resource Grants
Editions
- /editionsget
- /editions/{id}get

RESELLERS ACCOUNT SWITCHING

Tokens
- /authorizationTokenspost

ACCOUNT SETTINGS

SSO
- /accounts/self/ssoAuthSettingsget
- /accounts/self/ssoAuthSettingspatch
Client Settings
- /clientSettingsget

GROUPING

Layouts
Tags
- /tagsget
Locations
Floors
Floor Plans

SYSTEM

Applications
Application OAuth Clients

/eventSubscriptions/{eventSubscriptionId}/filters

get https://{BaseUrl}/api/v3.0/eventSubscriptions/{eventSubscriptionId}/filters

Gets all event subscription filters defined for the given event subscription.

Path Params

eventSubscriptionId

string

required

Event Subscription ID

Query Params

pageToken

string

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields.

pageSize

integer

1 to 500

Defaults to 100

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.

Responses

Response body

object

nextPageToken

string | null

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.

prevPageToken

string | null

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.

results

array of objects

required

The result set from a collection API call.

results*

object

string

required

Identifier of the filter within the event subscription. Only guaranteed to be unique in the parent event subscription.

actors

array of strings

required

length ≥ 1

List of actors for which events should be delivered to this event subscription.

actors*

types

array of objects

required

length ≥ 1

List of event types of which events should be delivered to this event subscription.

types*

object

string

Only events with this specific event type should be delivered to the event subscription. GET /eventTypes
can be used to get a list of all supported event types.

totalSize

integer

required

Size of the total result set.

Response body

object

code

integer

required

HTTP code defined in EEN Standard Code Values

status

string

required

A string enum describing the code

cancelled unknown invalidArgument deadlineExceeded notFound conflict permissionDenied resourceExhausted failedPrecondition aborted outOfRange unimplemented internal unavailable dataLoss unauthenticated mediaTypeNotSupported acceptNotSupported methodNotSupported tooManyRequests

message

string

required

Developer friendly human readable error message in English

details

array of objects

required

An array of extensible objects that define error information

details*

Response body

object

code

integer

required

HTTP code defined in EEN Standard Code Values

status

string

required

A string enum describing the code

message

string

required

Developer friendly human readable error message in English

details

array of objects

required

An array of extensible objects that define error information

details*

Response body

object

code

integer

required

HTTP code defined in EEN Standard Code Values

status

string

required

A string enum describing the code

message

string

required

Developer friendly human readable error message in English

details

array of objects

required

An array of extensible objects that define error information

details*

Response body

object

code

integer

required

HTTP code defined in EEN Standard Code Values

status

string

required

A string enum describing the code

message

string

required

Developer friendly human readable error message in English

details

array of objects

required

An array of extensible objects that define error information

details*

Updated 2 months ago

/eventSubscriptions/{eventSubscriptionId}

/eventSubscriptions/{eventSubscriptionId}/filters

Did this page help you?

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.cxxx.eagleeyenetworks.com/api/v3.0/eventSubscriptions/eventSubscriptionId/filters?pageSize=100' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 2 months ago

/eventSubscriptions/{eventSubscriptionId}

/eventSubscriptions/{eventSubscriptionId}/filters

Did this page help you?

Getting Started
Accessing the API

DEVICES
Cameras
/cameras/{cameraId}/settingspatch
/cameras/{cameraId}/settingsget
/cameras/{cameraId}:swappatch
/cameras/{cameraId}/metricsget
/cameras/{cameraId}/tunneldelete
/cameras/{cameraId}/tunnelput
/cameras/{cameraId}patch
/cameras/{cameraId}delete
/cameras/{cameraId}get
/cameras:bulkUpdatepost
/cameraspost
/camerasget
Bridges
/bridges/{id}/settings/patch
/bridges/{id}/settings/get
/bridges/{bridgeId}:swappatch
/bridges/{bridgeId}/metricsget
/bridges/{bridgeId}delete
/bridges/{bridgeId}get
/bridges/{bridgeId}patch
/bridges:bulkUpdatepost
/bridgespost
/bridgesget
Bridges
PTZ
/cameras/{cameraId}/ptz/settingspatch
/cameras/{cameraId}/ptz/settingsget
/cameras/{cameraId}/ptz/positionput
/cameras/{cameraId}/ptz/positionget
Speakers
/speakers/{speakerId}/settingspatch
/speakers/{speakerId}/settingsget
/speakers/{speakerId}delete
/speakers/{speakerId}patch
/speakers/{speakerId}get
/speakerspost
/speakersget
Switches
/switches/{switchId}/ports/all/actionspost
/switches/{switchId}/ports/{portId}/actionspost
/switches/{switchId}patch
/switches/{switchId}get
/switchesget
Multi Cameras
/multiCameras/{multiCameraId}/channelsget
/multiCameras/{multiCameraId}patch
/multiCameras/{multiCameraId}delete
/multiCameras/{multiCameraId}get
/multiCameraspost
/multiCamerasget
Available Devices
/availableDevicesget

MEDIA
Media
/media/sessionget
/media/liveImage.jpegget
/media/recordedImage.jpegget
/mediaget
Feeds
/feedsget
Exports
/exports/{jobId}:copypost
/exportspost
Jobs
/jobs/{jobId}delete
/jobs/{jobId}get
/jobsget
Files
/deletedFiles/{id}:restorepost
/deletedFiles/alldelete
/deletedFiles/{id}delete
/deletedFiles/{id}get
/deletedFilesget
/files/{id}:downloadget
/files/{id}delete
/files/{id}patch
/files/{id}get
/filespost
/filesget
Downloads
/downloads/{id}:downloadget
/downloads/{id}patch
/downloads/{id}get
/downloadsget

EVENTS
Events
/events:listFieldValuesget
/eventsget
/eventspost
Event Types
/eventTypesget
Event Metrics
/eventMetricsget
Event Subscriptions
/eventSubscriptions/{eventSubscriptionId}/filters/{filterId}delete
/eventSubscriptions/{eventSubscriptionId}/filters/{filterId}get
/eventSubscriptions/{eventSubscriptionId}/filterspost
/eventSubscriptions/{eventSubscriptionId}/filtersget
/eventSubscriptions/{eventSubscriptionId}delete
/eventSubscriptions/{eventSubscriptionId}get
/eventSubscriptionspost
/eventSubscriptionsget
Alerts
/alerts/{id}get
/alertsget
Notifications
/notifications/{id}patch
/notifications/{id}get
/notificationsget

VIDEO SEARCH
Video Analytics Events
/videoAnalyticEvents/{id}get
/videoAnalyticEvents:listObjectValuesget
/videoAnalyticEvents:listFieldValuespost
/videoAnalyticEvents:deepSearchGroupByTimepost
/videoAnalyticEvents:deepSearchGroupByResourcepost
/videoAnalyticEvents:deepSearchpost
/videoAnalyticEvents:parsepost

VEHICLE SURVEILLANCE PACKAGE
LPR Events
/lprEvents:listFieldValuesget
/lprEvents:summaryget
/lprEvents/{id}get
/lprEventsget
LPR Rules
/lprAlertConditionRules/{id}delete
/lprAlertConditionRules/{id}patch
/lprAlertConditionRules/{id}get
/lprAlertConditionRules:listFieldValuesget
/lprAlertConditionRulesget
/lprAlertConditionRulespost
LPR Vehicle Lists
/lprVehicleLists:searchget
/lprVehicleLists/{id}/vehicles/{recordId}delete
/lprVehicleLists/{id}/vehicles/{recordId}patch
/lprVehicleLists/{id}/vehicles/{recordId}get
/lprVehicleLists/{id}/vehicles:bulkCreatepost
/lprVehicleLists/{id}/vehiclespost
/lprVehicleLists/{id}/vehiclesget
/lprVehicleLists/{id}delete
/lprVehicleLists/{id}patch
/lprVehicleLists/{id}get
/lprVehicleLists:listFieldValuesget
/lprVehicleLists:listFieldsget
/lprVehicleListspost
/lprVehicleListsget

USER & ACCOUNTS
Users
/users/self/trustedClients/{trustedClientId}delete
/users/self/trustedClientsget
/users/selfpatch
/users/selfget
/users/{userId}patch
/users/{userId}delete
/users/{userId}get
/userspost
/usersget
Accounts
/accounts/{id}/credentials/{credentialId}delete
/accountsget
Roles
/roleAssignments:bulkdeletepost
/roleAssignments:bulkcreatepost
/roleAssignmentsget
/roles/{roleId}patch
/roles/{roleId}get
/roles/{roleId}delete
/rolespost
/rolesget
Auditlog
/auditLogsget
Resource Grants
/resourceGrants:bulkDeletepost
/resourceGrants:bulkCreatepost
/resourceGrantsget
Editions
/editions/{id}get
/editionsget

RESELLERS ACCOUNT SWITCHING
Tokens
/authorizationTokenspost

ACCOUNT SETTINGS
SSO
/accounts/self/ssoAuthSettingspatch
/accounts/self/ssoAuthSettingsget
Client Settings
/clientSettingsget

GROUPING
Layouts
/layouts/{layoutId}patch
/layouts/{layoutId}get
/layouts/{layoutId}delete
/layoutspost
/layoutsget
Tags
/tagsget
Locations
/locations/{id}/locationsget
/locations/{id}delete
/locations/{id}patch
/locations/{id}get
/locationspost
/locationsget
Floors
/locations/{locationId}/floors/{id}.{type}get
/locations/{locationId}/floors/{id}delete
/locations/{locationId}/floors/{id}patch
/locations/{locationId}/floors/{id}get
/locations/{locationId}/floorspost
/locations/{locationId}/floorsget
Floor Plans
/locations/{locationId}/floors/{id}/plans/{planId}delete
/locations/{locationId}/floors/{id}/planspost
/locations/{locationId}/floors/{id}/plansget

SYSTEM
Applications
/timeZonesget
/languagesget
/applications/{applicationId}delete
/applications/{applicationId}patch
/applications/{applicationId}get
/applicationspost
/applicationsget
Application OAuth Clients
/applications/{applicationId}/oauthClients/{clientId}delete
/applications/{applicationId}/oauthClients/{clientId}patch
/applications/{applicationId}/oauthClients/{clientId}get
/applications/{applicationId}/oauthClientspost
/applications/{applicationId}/oauthClientsget

Getting Started
Accessing the API

DEVICES
Cameras
/cameras/{cameraId}/settingspatch
/cameras/{cameraId}/settingsget
/cameras/{cameraId}:swappatch
/cameras/{cameraId}/metricsget
/cameras/{cameraId}/tunneldelete
/cameras/{cameraId}/tunnelput
/cameras/{cameraId}patch
/cameras/{cameraId}delete
/cameras/{cameraId}get
/cameras:bulkUpdatepost
/cameraspost
/camerasget
Bridges
/bridges/{id}/settings/patch
/bridges/{id}/settings/get
/bridges/{bridgeId}:swappatch
/bridges/{bridgeId}/metricsget
/bridges/{bridgeId}delete
/bridges/{bridgeId}get
/bridges/{bridgeId}patch
/bridges:bulkUpdatepost
/bridgespost
/bridgesget
Bridges
PTZ
/cameras/{cameraId}/ptz/settingspatch
/cameras/{cameraId}/ptz/settingsget
/cameras/{cameraId}/ptz/positionput
/cameras/{cameraId}/ptz/positionget
Speakers
/speakers/{speakerId}/settingspatch
/speakers/{speakerId}/settingsget
/speakers/{speakerId}delete
/speakers/{speakerId}patch
/speakers/{speakerId}get
/speakerspost
/speakersget
Switches
/switches/{switchId}/ports/all/actionspost
/switches/{switchId}/ports/{portId}/actionspost
/switches/{switchId}patch
/switches/{switchId}get
/switchesget
Multi Cameras
/multiCameras/{multiCameraId}/channelsget
/multiCameras/{multiCameraId}patch
/multiCameras/{multiCameraId}delete
/multiCameras/{multiCameraId}get
/multiCameraspost
/multiCamerasget
Available Devices
/availableDevicesget

MEDIA
Media
/media/sessionget
/media/liveImage.jpegget
/media/recordedImage.jpegget
/mediaget
Feeds
/feedsget
Exports
/exports/{jobId}:copypost
/exportspost
Jobs
/jobs/{jobId}delete
/jobs/{jobId}get
/jobsget
Files
/deletedFiles/{id}:restorepost
/deletedFiles/alldelete
/deletedFiles/{id}delete
/deletedFiles/{id}get
/deletedFilesget
/files/{id}:downloadget
/files/{id}delete
/files/{id}patch
/files/{id}get
/filespost
/filesget
Downloads
/downloads/{id}:downloadget
/downloads/{id}patch
/downloads/{id}get
/downloadsget

EVENTS
Events
/events:listFieldValuesget
/eventsget
/eventspost
Event Types
/eventTypesget
Event Metrics
/eventMetricsget
Event Subscriptions
/eventSubscriptions/{eventSubscriptionId}/filters/{filterId}delete
/eventSubscriptions/{eventSubscriptionId}/filters/{filterId}get
/eventSubscriptions/{eventSubscriptionId}/filterspost
/eventSubscriptions/{eventSubscriptionId}/filtersget
/eventSubscriptions/{eventSubscriptionId}delete
/eventSubscriptions/{eventSubscriptionId}get
/eventSubscriptionspost
/eventSubscriptionsget
Alerts
/alerts/{id}get
/alertsget
Notifications
/notifications/{id}patch
/notifications/{id}get
/notificationsget

VIDEO SEARCH
Video Analytics Events
/videoAnalyticEvents/{id}get
/videoAnalyticEvents:listObjectValuesget
/videoAnalyticEvents:listFieldValuespost
/videoAnalyticEvents:deepSearchGroupByTimepost
/videoAnalyticEvents:deepSearchGroupByResourcepost
/videoAnalyticEvents:deepSearchpost
/videoAnalyticEvents:parsepost

VEHICLE SURVEILLANCE PACKAGE
LPR Events
/lprEvents:listFieldValuesget
/lprEvents:summaryget
/lprEvents/{id}get
/lprEventsget
LPR Rules
/lprAlertConditionRules/{id}delete
/lprAlertConditionRules/{id}patch
/lprAlertConditionRules/{id}get
/lprAlertConditionRules:listFieldValuesget
/lprAlertConditionRulesget
/lprAlertConditionRulespost
LPR Vehicle Lists
/lprVehicleLists:searchget
/lprVehicleLists/{id}/vehicles/{recordId}delete
/lprVehicleLists/{id}/vehicles/{recordId}patch
/lprVehicleLists/{id}/vehicles/{recordId}get
/lprVehicleLists/{id}/vehicles:bulkCreatepost
/lprVehicleLists/{id}/vehiclespost
/lprVehicleLists/{id}/vehiclesget
/lprVehicleLists/{id}delete
/lprVehicleLists/{id}patch
/lprVehicleLists/{id}get
/lprVehicleLists:listFieldValuesget
/lprVehicleLists:listFieldsget
/lprVehicleListspost
/lprVehicleListsget

USER & ACCOUNTS
Users
/users/self/trustedClients/{trustedClientId}delete
/users/self/trustedClientsget
/users/selfpatch
/users/selfget
/users/{userId}patch
/users/{userId}delete
/users/{userId}get
/userspost
/usersget
Accounts
/accounts/{id}/credentials/{credentialId}delete
/accountsget
Roles
/roleAssignments:bulkdeletepost
/roleAssignments:bulkcreatepost
/roleAssignmentsget
/roles/{roleId}patch
/roles/{roleId}get
/roles/{roleId}delete
/rolespost
/rolesget
Auditlog
/auditLogsget
Resource Grants
/resourceGrants:bulkDeletepost
/resourceGrants:bulkCreatepost
/resourceGrantsget
Editions
/editions/{id}get
/editionsget

RESELLERS ACCOUNT SWITCHING
Tokens
/authorizationTokenspost

ACCOUNT SETTINGS
SSO
/accounts/self/ssoAuthSettingspatch
/accounts/self/ssoAuthSettingsget
Client Settings
/clientSettingsget

GROUPING
Layouts
/layouts/{layoutId}patch
/layouts/{layoutId}get
/layouts/{layoutId}delete
/layoutspost
/layoutsget
Tags
/tagsget
Locations
/locations/{id}/locationsget
/locations/{id}delete
/locations/{id}patch
/locations/{id}get
/locationspost
/locationsget
Floors
/locations/{locationId}/floors/{id}.{type}get
/locations/{locationId}/floors/{id}delete
/locations/{locationId}/floors/{id}patch
/locations/{locationId}/floors/{id}get
/locations/{locationId}/floorspost
/locations/{locationId}/floorsget
Floor Plans
/locations/{locationId}/floors/{id}/plans/{planId}delete
/locations/{locationId}/floors/{id}/planspost
/locations/{locationId}/floors/{id}/plansget

SYSTEM
Applications
/timeZonesget
/languagesget
/applications/{applicationId}delete
/applications/{applicationId}patch
/applications/{applicationId}get
/applicationspost
/applicationsget
Application OAuth Clients
/applications/{applicationId}/oauthClients/{clientId}delete
/applications/{applicationId}/oauthClients/{clientId}patch
/applications/{applicationId}/oauthClients/{clientId}get
/applications/{applicationId}/oauthClientspost
/applications/{applicationId}/oauthClientsget

200OK

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

404Referenced resource could not be found.

500Something went wrong in the server. Please try again.