Retrieves the latest notifications for a specific subscription.
GET {{baseUrl}}/api/notifications/subscriptions/:subscriptionId/fetch?position=GRVnChgVZwoy0VvprDPYCJs-AAAAAAAAYzg0MjViMzgtMzg3MS00NWQ5LTk5MGYtZGY4YzhmMjE4NTk4
This call returns notifications for a subscription in chronologic order as they become available, from earliest to newest notification.
Each call provides up to 1000 notifications. In each subsequent call, specify the NextPosition value from the previous response in the position query parameter. Please keep in mind that a position can only be used with its associated subscription. It is the responsibility of the caller to keep track of their subscriptions' position values and pass them in accordingly.
The response also provides an indication whether more notifications are available for the subscription. It is legitimate to immediately fetch subsequent notifications in that case, otherwise do not poll for notifications in very high frequency.
Event notifications are only stored for a certain number of days. If older notifications are not fetched in due time, they will be discarded.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
position | string | (Required) The position received from a previous request of this API function or from a GeneratePosition call (see here) to obtain subsequent notifications. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"SubscriptionId":"222c9efe-c76d-41a9-a41b-c86a955a5529","Count":2,"NextPosition":"qZZBBqiWQQZ7uJSD9dHaCCkJAAAAAAAAMjIyYzllZmUtYzc2ZC00MWE5LWE0MWItYzg2YTk1NWE1NTI5","MoreAvailable":false,"Notifications":[{"EventType":"WebThreatShield.UrlAction","EventObjectName":"WtsUrlActionEvent","UnityAPIEventId":"848d1460-985a-46a4-bdf4-62b09354d963","WtsUrlActionEvent":{"Timestamp":"2022-11-29T10:33:06.9036303Z","GSMKey":null,"GSMConsoleName":null,"SiteKey":"B9CD0CCA3C1B4B938B1D","SiteId":null,"SiteName":null,"MachineId":"41655E5D44CE4024B5756D8948C0C335:::DAEA108BDA734368BD5BD214745EC81F:::DAEA108BDA734368BD5BD214745EC81F","HostName":"MyComputer1","PublicIP":"95.225.121.41","BlockDetails":{"ActionTaken":"BLOCK","BlockedUrl":"http://www.category-domain1.com","BlockReasonId":57,"BlockReasonName":"Phishing and Other Frauds","BCRI":10}}},{"EventType":"Endpoint.FileDetection","EventObjectName":"EndpointFileDetectionEvent","UnityAPIEventId":"32368861-91ae-4c01-862f-d601c0a00c97","EndpointFileDetectionEvent":{"Timestamp":"2022-11-29T10:32:07Z","GSMKey":"B6A023E42C5C48359DCB","GSMConsoleName":"My Management Console","SiteKey":"A755D2940F9B416885E2","SiteId":"691c1c52-637c-fe11-4d33-1edde4dabcea","SiteName":"My GSM Site 2","MachineId":"5FFCF1561C6B419E8AE55E392D9311E9:::8C0DC7B51508467E950CCFBEB2745E51:::8C0DC7B51508467E950CCFBEB2745E51","HostName":"MyComputer2","PublicIP":"95.98.109.185","ScanInfo":{"ScanId":"7b74f9c7-766a-4846-ab5c-9b11bce0eda5","ScanType":"RT"},"DetectionInfo":{"FileName":"eicar.com","FilePath":"c:\\users\\user2\\desktop","FileSize":68,"FileMD5":"44d88612fea8a8f36de82e1278abb02f","FileSHA256":"275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f","Determination":"B","MalwareGroup":"Anti-Malware Testfile"}}}]}