{ "components": { "schemas": { "event-type": { "additionalProperties": false, "description": "Provides an event type with possible multiple event definitions.", "properties": { "eventDefinitions": { "description": "Provides information about an event type definition.", "items": { "additionalProperties": false, "properties": { "eventDefinitionId": { "description": "The ID of an event definition.", "type": "string" }, "eventDescription": { "description": "The description of an event.", "type": "string" }, "eventName": { "description": "The name of an event.", "type": "string" } }, "type": "object" }, "type": "array" }, "eventTypeId": { "description": "The ID of the event type.", "type": "string" }, "eventTypeName": { "description": "The name of the event type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/event-type.yaml" } }, "event-types-200": { "description": "Provides a collection of event types with possible multiple event definitions.", "items": { "additionalProperties": false, "description": "Provides an event type with possible multiple event definitions.", "properties": { "eventDefinitions": { "description": "Provides information about an event type definition.", "items": { "additionalProperties": false, "properties": { "eventDefinitionId": { "description": "The ID of an event definition.", "type": "string" }, "eventDescription": { "description": "The description of an event.", "type": "string" }, "eventName": { "description": "The name of an event.", "type": "string" } }, "type": "object" }, "type": "array" }, "eventTypeId": { "description": "The ID of the event type.", "type": "string" }, "eventTypeName": { "description": "The name of the event type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/event-type.yaml" } }, "type": "array", "x-akamai": { "file-path": "schemas/event-types-200.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's Event Viewer API", "url": "https://techdocs.akamai.com/event-viewer/reference" }, "info": { "description": "Monitor and analyze Control Center events.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Event Viewer API", "version": "v1" }, "openapi": "3.0.0", "paths": { "/event-types": { "get": { "description": "Returns all defined event types with related event definitions.", "externalDocs": { "description": "See documentation for this operation in Akamai's Event Viewer API", "url": "https://techdocs.akamai.com/event-viewer/reference/get-event-types" }, "operationId": "get-event-types", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "eventDefinitions": [ { "eventDefinitionId": "415195", "eventDescription": "A user logged in.", "eventName": "Login" } ], "eventTypeId": "16", "eventTypeName": "All Logins" }, { "eventDefinitions": [ { "eventDefinitionId": "800313", "eventDescription": "Update an Endpoint Resources Details.", "eventName": "Update an Endpoint Resources Details" }, { "eventDefinitionId": "892355", "eventDescription": "Add a new Endpoint", "eventName": "Create an Endpoint" }, { "eventDefinitionId": "913159", "eventDescription": "Deletes an endpoint resource details.", "eventName": "Delete Endpoint Resource" } ], "eventTypeId": "198", "eventTypeName": "API Definition" } ], "schema": { "description": "Provides a collection of event types with possible multiple event definitions.", "items": { "additionalProperties": false, "description": "Provides an event type with possible multiple event definitions.", "properties": { "eventDefinitions": { "description": "Provides information about an event type definition.", "items": { "additionalProperties": false, "properties": { "eventDefinitionId": { "description": "The ID of an event definition.", "type": "string" }, "eventDescription": { "description": "The description of an event.", "type": "string" }, "eventName": { "description": "The name of an event.", "type": "string" } }, "type": "object" }, "type": "array" }, "eventTypeId": { "description": "The ID of the event type.", "type": "string" }, "eventTypeName": { "description": "The name of the event type.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/event-type.yaml" } }, "type": "array", "x-akamai": { "file-path": "schemas/event-types-200.yaml" } } } }, "description": "List Event Types." } }, "summary": "List event types", "tags": [ "Event types" ] }, "x-akamai": { "file-path": "paths/event-types.yaml", "path-info": "/event-types" } }, "/events": { "get": { "description": "Returns each user account's portal-visible events stored in the Event Logger system. The response format is determined by the `Accept` header. Supported formats are `application/json` and `text/csv`.", "externalDocs": { "description": "See documentation for this operation in Akamai's Event Viewer API", "url": "https://techdocs.akamai.com/event-viewer/reference/get-events" }, "operationId": "get-events", "parameters": [ { "description": "The unique identifier for the event type. Use this parameter to view all events with the specified event type ID.", "in": "query", "name": "eventTypeId", "schema": { "example": 50, "type": "integer" }, "x-akamai": { "file-path": "parameters/event-type-id-query.yaml" } }, { "description": "The start date and time of the event. Use this parameter to view all events that occurred after the specified date and time.", "in": "query", "name": "start", "schema": { "example": "2021-07-11T04:25:28", "type": "string" }, "x-akamai": { "file-path": "parameters/start-query.yaml" } }, { "description": "The end date and time of the event. Use this parameter to view all events that occurred before the specified date and time.", "in": "query", "name": "end", "schema": { "example": "2021-07-13T06:05:00", "type": "string" }, "x-akamai": { "file-path": "parameters/end-query.yaml" } }, { "description": "The unique identifier for the event. Use this parameter to view all events that occurred after the event with the specified event ID.", "in": "query", "name": "afterEventId", "schema": { "example": "626a345e-3a3f-49af-87ba-e60eff1e2f15", "type": "string" }, "x-akamai": { "file-path": "parameters/after-event-id-query.yaml" } }, { "description": "The unique identifier for the event. Use this parameter to view all events that occurred before the event with the specified event ID.", "in": "query", "name": "beforeEventId", "schema": { "example": "626a345e-3a3f-49af-87ba-e60eff1e2f15", "type": "string" }, "x-akamai": { "file-path": "parameters/before-event-id-query.yaml" } }, { "description": "The name of the user that created the event. Use this parameter to view all events generated by the specified user.", "in": "query", "name": "username", "schema": { "example": "jdupont", "type": "string" }, "x-akamai": { "file-path": "parameters/username-query.yaml" } }, { "description": "Limits the set of results. The maximum limit is 50 for `application/json`, and 1000 for `text/csv`.", "in": "query", "name": "limit", "schema": { "example": 50, "type": "integer" }, "x-akamai": { "file-path": "parameters/limit-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "events": [ { "eventData": [], "eventId": "b5ac4d16-8223-4cbd-86f3-f42f52a8f6ff", "eventTime": "2017-07-27T12:13:37.15Z", "eventType": { "eventDefinition": { "eventDefinitionId": "415195", "eventDescription": "A user logged in.", "eventName": "Login" }, "eventTypeId": "16", "eventTypeName": "All Logins" }, "impersonator": true, "username": "jperez" }, { "eventData": [ { "key": "Email To", "value": "aaa@akamai.com" }, { "key": "Start Time", "value": "Thu, Jul 27, 12:13 GMT 2017" } ], "eventId": "5409ed6f-d532-4832-b2be-961a21380416", "eventTime": "2017-07-27T12:13:10.426Z", "eventType": { "eventDefinition": { "eventDefinitionId": "169758", "eventDescription": "The condition that this alert was set up to monitor has occurred.", "eventName": "Alert Fired" }, "eventTypeId": "50", "eventTypeName": "Alert Activity" }, "impersonator": false, "username": "szhang" } ], "links": [ { "href": "/event-viewer-api/v1/events?beforeEventId=038a9f69-121f-4248-acd2-74103012c680", "rel": "next" }, { "href": "/event-viewer-api/v1/events?afterEventId=68bb2c73-bf1b-4cb0-ae56-b4fcd7210317", "rel": "prev" }, { "href": "/event-viewer-api/v1/events", "rel": "self" } ] }, "schema": { "additionalProperties": false, "description": "Provides a collection of events with information about each event.", "properties": { "events": { "description": "Provides information about the event.", "items": { "additionalProperties": false, "description": "Provides information about the event.", "properties": { "eventData": { "description": "The map of user-defined keys and values that describe additional event data.", "items": { "additionalProperties": false, "properties": { "key": { "description": "A key that specifies the event data type. Note that it's not necessary to make keys in the array of objects unique. There may be objects in the array with the same key that represent a collection of the same type. For example, a list of CP codes with different values.", "type": "string" }, "value": { "description": "The value of a particular key.", "type": "string" } }, "type": "object" }, "type": "array" }, "eventId": { "description": "The unique identifier for the event.", "type": "string" }, "eventTime": { "description": "The date and time of the event.", "type": "string" }, "eventType": { "additionalProperties": false, "description": "Provides information about the event type.", "properties": { "eventDefinition": { "additionalProperties": false, "description": "Provides information about the event type definition.", "properties": { "eventDefinitionId": { "description": "The ID of the event definition.", "type": "string" }, "eventDescription": { "description": "The description of the event.", "type": "string" }, "eventName": { "description": "The name of the event.", "type": "string" } }, "type": "object" }, "eventTypeId": { "description": "The ID of the event type.", "type": "string" }, "eventTypeName": { "description": "The name of the event type.", "type": "string" } }, "type": "object" }, "impersonator": { "description": "Whether an impersonating user created the event.", "type": "boolean" }, "username": { "description": "The username of the user who created the event.", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/event.yaml" } }, "type": "array" }, "links": { "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`, `next`, or `prev`.", "items": { "additionalProperties": false, "description": "Hypermedia links to help navigate through the result set, or to identify the current item whose `rel` is `self`, `next`, or `prev`.", "properties": { "href": { "description": "A relative path to the currently requested object or a specific page of the result set.", "type": "string" }, "rel": { "description": "The relationship between the current and linked result sets. A value of `self` links to the current result set, while `prev` and `next` link to different sets of data.", "type": "string" } }, "required": [ "href", "rel" ], "type": "object", "x-akamai": { "file-path": "schemas/links.yaml" } }, "type": "array" } }, "required": [ "events", "links" ], "type": "object", "x-akamai": { "file-path": "schemas/events-200.yaml" } } }, "text/csv": { "example": "EventId,Username,Event Type Id,Event Type Name,Activity,Date,Event Data\nb5ac4d16-8223-4cbd-86f3-f42f52a8f6ff,jperez,16,All Logins,Login,\"Jul 27, 2017, 12:13:37 PM +00:00\",\"\"\n5409ed6f-d532-4832-b2be-961a21380416,szhang,50,Alert Activity,Alert Fired,\"Jul 27, 2017, 12:13:10 PM +00:00\",\"'Email To'='aaa@akamai.com' 'Start Time'='Thu, Jul 27, 12:13 GMT 2017'\"" } }, "description": "Successful response." } }, "summary": "List events", "tags": [ "Events" ] }, "x-akamai": { "file-path": "paths/events.yaml", "path-info": "/events" } } }, "servers": [ { "url": "https://{hostname}/event-viewer-api/v1" } ], "tags": [ { "description": "Get data about user-defined events.", "name": "Event types" }, { "description": "Get data about portal events stored in event logs in either JSON or\nCSV format", "name": "Events" } ], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } }