Event Viewer API Resources

This section provides details on the Event Viewer API’s various operations and parameters.

API Summary

Download the RAML descriptors for this API.

Operation Method Endpoint
Event Viewer API  
List Event Types GET event-viewer-api/v1/event-types
Events  
List Events GET event-viewer-api/v1/events{?eventTypeId,start,end,afterEventId,beforeEventId,username}

List Event Types

This operation returns all defined event types with related event definitions.

GET event-viewer-api/v1/event-types

Status 200 application/json

Response Body:

[
    {
        "eventTypeId": "16",
        "eventTypeName": "All Logins",
        "eventDefinitions": [
            {
                "eventDefinitionId": "415195",
                "eventName": "Login",
                "eventDescription": "A user logged in."
            }
        ]
    },
    {
        "eventTypeId": "198",
        "eventTypeName": "API Definition",
        "eventDefinitions": [
            {
                "eventDefinitionId": "800313",
                "eventName": "Update an Endpoint Resources Details",
                "eventDescription": "Update an Endpoint Resources Details."
            },
            {
                "eventDefinitionId": "892355",
                "eventName": "Create an Endpoint",
                "eventDescription": "Add a new Endpoint"
            },
            {
                "eventDefinitionId": "913159",
                "eventName": "Delete Endpoint Resource",
                "eventDescription": "Deletes an endpoint resource details."
            }
        ]
    }
]

List Events

This operation returns one or more pages of portal-visible events stored in the Event Logger system and related to a particular user account. Each page lists 50 events. You can move between pages by using the ‘afterEventId’ and ‘beforeEventId’ query parameters or by clicking a relevant hypermedia link at the bottom of a page.

GET event-viewer-api/v1/events{?eventTypeId,start,end,afterEventId,beforeEventId,username}

Sample: event-viewer-api/v1/events?eventTypeId=50&start=2017-07-11T04%3A25%3A28&end=2017-07-13T06%3A05%3A00&afterEventId=626a345e–3a3f–49af–87ba-e60eff1e2f15&beforeEventId=626a345e–3a3f–49af–87ba-e60eff1e2f15&username=name

Parameter Type Sample Description
Optional Query Parameters
afterEventId String 626a345e-3a3f-49af-87ba-e60eff1e2f15 The unique identifier for the event. Use this parameter to view all events that occurred after the event with the specified event ID.
beforeEventId String 626a345e-3a3f-49af-87ba-e60eff1e2f15 The unique identifier for the event. Use this parameter to view all events that occurred before the event with the specified event ID.
end String 2017-07-13T06:05:00 The end date and time of the event. Use this parameter to view all events that occurred before the specified date and time.
eventTypeId Integer 50 The unique identifier for the event type. Use this parameter to view all events with the specified event type ID.
start String 2017-07-11T04:25:28 The start date and time of the event. Use this parameter to view all events that occurred after the specified date and time.
username String name The name of the user that created the event. Use this parameter to view all events generated by the specified user.

Status 200 application/json

Response Body:

{
    "events": [
        {
            "eventId": "b5ac4d16-8223-4cbd-86f3-f42f52a8f6ff",
            "eventTime": "2017-07-27T12:13:37.15Z",
            "eventData": [],
            "eventType": {
                "eventTypeId": "16",
                "eventTypeName": "All Logins",
                "eventDefinition": {
                    "eventDefinitionId": "415195",
                    "eventName": "Login",
                    "eventDescription": "A user logged in."
                }
            },
            "impersonator": true,
            "username": "-"
        },
        {
            "eventId": "5409ed6f-d532-4832-b2be-961a21380416",
            "eventTime": "2017-07-27T12:13:10.426Z",
            "eventData": [
                {
                    "key": "Email To",
                    "value": "aaa@akamai.com"
                },
                {
                    "key": "Start Time",
                    "value": "Thu, Jul 27, 12:13 GMT 2017"
                }
            ],
            "eventType": {
                "eventTypeId": "50",
                "eventTypeName": "Alert Activity",
                "eventDefinition": {
                    "eventDefinitionId": "169758",
                    "eventName": "Alert Fired",
                    "eventDescription": "The condition that this alert was set up to monitor has occurred."
                }
            },
            "impersonator": false,
            "username": "-"
        }
    ],
    "links": [
        {
            "rel": "next",
            "href": "/event-viewer-api/v1/events?beforeEventId=038a9f69-121f-4248-acd2-74103012c680"
        },
        {
            "rel": "prev",
            "href": "/event-viewer-api/v1/events?afterEventId=68bb2c73-bf1b-4cb0-ae56-b4fcd7210317"
        },
        {
            "rel": "self",
            "href": "/event-viewer-api/v1/events"
        }
    ]
}

Last modified: 3/28/2018