Event Viewer API Data

This section details the JSON objects that the Event Viewer API provides as data. For these read-only objects, the data members listed below are always present in the response objects.

The data schema tables below list membership requirements as follows:

Member is required to be present, regardless of whether the value is empty or null.
Member is optional, and may be omitted in some cases.
Member is excluded from the specified interaction context. It is either ignored, or causes an error.

Download the JSON schemas for this API.

Event

Encapsulates information about the event.

Download schema: event.json

Sample GET:

{
    "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"
        }
    ]
}

Event Members

Member Type Description
eventData Event.eventData[n] The map of user-defined keys and values that describe additional event data.
eventId String The unique identifier for the event.
eventTime String The date and time of the event.
eventType Event.eventType Encapsulates information about the event type.
impersonator Boolean Whether an impersonating user created the event.
username String The username of the user who created the event.

Event.eventData[n]  

The map of user-defined keys and values that describe additional event data.

Member Type Description
key String A key that specifies the event data type.
value String The value of a particular key.

Event.eventType  

Encapsulates information about the event type.

Member Type Description
eventDefinition Event.eventType.eventDefinition Encapsulates information about the event type definition
eventTypeId String The ID of the event type.
eventTypeName String The name of the event type.

Event.eventType.eventDefinition  

Encapsulates information about the event type definition

Member Type Description
eventDefinitionId String The ID of the event definition.
eventDescription String The description of the event.
eventName String The name of the event.

EventType

Encapsulates an event type with possible multiple event definitions.

Download schema: event-type.json

Sample GET:

[
    {
        "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."
            }
        ]
    }
]

EventType Members

Member Type Description
eventDefinitions EventType.eventDefinitions[n] Encapsulates information about an event type definition
eventTypeId String The ID of the event type.
eventTypeName String The name of the event type.

EventType.eventDefinitions[n]  

Encapsulates information about an event type definition

Member Type Description
eventDefinitionId String The ID of an event definition.
eventDescription String The description of an event.
eventName String The name of an event.

Last modified: 3/28/2018