Learn more:

• Event Center

• Download this API’s RAML and JSON schema descriptors.

Overview

The Event Center API lets you access and manage event data available in Akamai Control Center for the contract type and account.

Who should use this API

This API offers a programmatic alternative to many of the features available in the Event Center application in Control Center.

Get started

To configure this API for the first time:

• Review Get Started with APIs for details on how to set up client tokens to access any Akamai API. These tokens appear as custom hostnames that look like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net.

• To enable this API, choose the API service named Event Center, and set the access level to READ WRITE.

Creating and updating events

When creating or updating an event, you can optionally associate it with a set of objects. An object indicates a domain object related to an Akamai product or service that you want to monitor in this event. By default, the objects associated with an event are not included in the response. Retrieving objects can be done using the Get an event operation.

You can associate the following objects with the event:

• QOS_REPORT_PACK. A Quality of Service report pack.

• SM_REPORT_PACK. A Security Monitor report pack.

• SRIP_SLOT. A Sure Route IP slot.

• CP_CODE. A Content Provider code.

• FLASH_LIVE_STREAM. A Flash Live stream.

• UNIVERSAL_LIVE_STREAM. A Universal Live stream.

• MSL4_STREAM. A Media Service Live 4 stream. Note: Associating Media Service Live 4 streams with your events is unavailable at this time.

Event version

To implement cross-HTTP request optimistic locking, each event object sent from the server has a version stamp assigned to it. When updating an event, be sure to load the event data from the server, provide updates, and send the updated event data back to the server with the same version stamp that was sent in the original server’s response.

For example, if the server sends event data with version stamp 12345, you must send back the updated event data with version stamp 12345. If these versions don’t match, it means that the data has been edited by another client, and the server throws an error.

Customer event ID

In the event JSON, use the customerEventId member to store any string up to 100 characters. Use this member to store identifiers other than the Event Center’s ID.

Beyond the 100 character limit, there is no restriction on this member’s value. There is also no unique restriction on the field, allowing multiple events to share the same event ID. Customer event can include many Event Center events.

Event reporting and monitoring

You can obtain event reporting and monitoring data through the following APIs:

• ecresponse-by-time. Shows historical data about completed HTTP origin and edge requests received for each HTTP status code range (for example, 0xx, 1xx, 2xx, 3xx, 4xx, 5xx) per second.

• estimatedecresponse-by-time. Shows estimated data about completed HTTP origin and edge requests received for each HTTP status code range (for example, 0xx, 1xx, 2xx, 3xx, 4xx, 5xx) per second.

• ectraffic-by-time. Shows historical data about origin and edge HTTP/HTTPS traffic.

• estimatedectraffic-by-time. Shows estimated data about origin and edge HTTP/HTTPS traffic.

• flashlivetraffic-by-time. Shows estimated traffic data for traditional Flash Live streams.

• universallivetraffic-by-time. Shows estimated traffic data for Universal Live streams - supports Apple HLS, Adobe HDS, and HD Flash 1.0 formats.

• sriptraffic-by-time. Shows estimated traffic data for IPA/SXL.

• Security Monitor. Shows data about security events logged from Akamai Web Application Firewall (WAF) and Kona Site Defender (KSD).

• QoS Monitor. Shows data about the quality in terms of metrics such as, audience engagement, availability, start-up time, or re-buffering.

Resources

This section provides details on each API operation.

The following list provides a road map of all the conceptual objects you deal with when interacting with the Event Center API:

• Event. A representation of a client’s event. Minimally, it includes a name, start date, and end date. It can also include domain objects related to Akamai’s products associated with the event. Examples of an event may include sports events, sales event, or product premieres.

• Tag. A user-defined label that is attached to an event for easy identification and categorization purposes.

API summary

Download the RAML descriptors for this API.

List events

This operation returns a list of events for the current account and contract type. This call supports paging and sorting of the result data.

{
    "metadata": {
        "page": 1,
        "pageSize": 25,
        "sort": [
            {
                "property": "name",
                "direction": "asc"
            }
        ],
        "totalResultsCount": 1,
        "totalPageCount": 1
    },
    "data": [
        {
            "id": 1,
            "version": 1,
            "name": "2018 Winter Olympics",
            "customerEventId": "xxiii-owg",
            "start": "2016-02-08T11:00:00Z",
            "end": "2016-02-28T16:41:41Z",
            "tags": [
                {
                    "id": 1,
                    "name": "winter"
                },
                {
                    "id": 2,
                    "name": "olympics"
                }
            ]
        }
    ]
}

Create an event

This operation creates an event with the specified parameters.

{
    "name": "2018 Winter Olympics",
    "description": "XXIII Olympic Winter Games - PyeongChang 2018",
    "customerEventId": "xxiii-owg",
    "start": "2016-02-08T08:00:00Z",
    "end": "2016-02-08T20:00:00Z",
    "audienceSize": 5000000,
    "audienceLocations": [
        "PL",
        "DE"
    ],
    "coordinators": [
        "vsnyder",
        "taklumiere"
    ],
    "tags": [
        "winter",
        "olympics"
    ],
    "objects": [
        {
            "id": 1012345,
            "type": "SM_REPORT_PACK"
        },
        {
            "id": 8765,
            "type": "QOS_REPORT_PACK"
        },
        {
            "id": 87654,
            "type": "CP_CODE"
        },
        {
            "id": 876,
            "type": "SRIP_SLOT"
        },
        {
            "id": 12345,
            "type": "UNIVERSAL_LIVE_STREAM",
            "bitrates": [
                5000,
                10000
            ]
        },
        {
            "id": 6,
            "type": "FLASH_LIVE_STREAM",
            "bitrates": [
                5000,
                10000
            ]
        }
    ],
    "recurrence": {
        "frequency": "DAILY",
        "count": 2
    }
}

[
    {
        "id": 1,
        "version": 0,
        "name": "2018 Winter Olympics",
        "description": "XXIII Olympic Winter Games - PyeongChang 2018",
        "customerEventId": "xxiii-owg",
        "start": "2016-02-08T08:00:00Z",
        "end": "2016-02-08T20:00:00Z",
        "audienceSize": 5000000,
        "audienceLocations": [
            {
                "code": "PL",
                "name": "Poland"
            },
            {
                "code": "DE",
                "name": "Germany"
            }
        ],
        "coordinators": [
            {
                "userName": "vsnyder",
                "firstName": "Vigilant",
                "lastName": "Snyder"
            },
            {
                "userName": "taklumiere",
                "firstName": "Takeshi",
                "lastName": "Lumiere"
            }
        ],
        "tags": [
            {
                "id": 1,
                "name": "winter"
            },
            {
                "id": 2,
                "name": "olympics"
            }
        ],
        "createdDate": "2017-12-28T16:41:41Z",
        "createdBy": "vsnyder",
        "modifiedDate": "2017-12-28T16:41:41Z",
        "modifiedBy": "vsnyder",
        "objects": [
            {
                "id": 1012345,
                "type": "SM_REPORT_PACK",
                "name": "1012345 - Security_Monitor_winter_games"
            },
            {
                "id": 8765,
                "type": "QOS_REPORT_PACK",
                "name": "8765 - WOG_WEB_QOS"
            },
            {
                "id": 87654,
                "type": "CP_CODE",
                "name": "olympics-open.com/winter"
            },
            {
                "id": 876,
                "type": "SRIP_SLOT",
                "cpCode": 37437,
                "hostname": "open-olympics.com"
            },
            {
                "id": 12345,
                "type": "UNIVERSAL_LIVE_STREAM",
                "cpCode": 98345,
                "name": "olympics_open_universal",
                "bitrates": [
                    5000,
                    10000
                ]
            },
            {
                "id": 6,
                "type": "FLASH_LIVE_STREAM",
                "cpCode": 65401,
                "name": "olympics_open_flash",
                "bitrates": [
                    5000,
                    10000
                ]
            }
        ]
    },
    {
        "id": 2,
        "version": 0,
        "name": "2018 Winter Olympics",
        "description": "XXIII Olympic Winter Games - PyeongChang 2018",
        "customerEventId": "xxiii-owg",
        "start": "2016-02-09T08:00:00Z",
        "end": "2016-02-09T20:00:00Z",
        "audienceSize": 5000000,
        "audienceLocations": [
            {
                "code": "PL",
                "name": "Poland"
            },
            {
                "code": "DE",
                "name": "Germany"
            }
        ],
        "coordinators": [
            {
                "userName": "vsnyder",
                "firstName": "Vigilant",
                "lastName": "Snyder"
            },
            {
                "userName": "taklumiere",
                "firstName": "Takeshi",
                "lastName": "Lumiere"
            }
        ],
        "tags": [
            {
                "id": 1,
                "name": "winter"
            },
            {
                "id": 2,
                "name": "olympics"
            }
        ],
        "createdDate": "2017-12-28T16:41:41Z",
        "createdBy": "vsnyder",
        "modifiedDate": "2017-12-28T16:41:41Z",
        "modifiedBy": "vsnyder",
        "objects": [
            {
                "id": 1012345,
                "type": "SM_REPORT_PACK",
                "name": "1012345 - Security_Monitor_winter_games"
            },
            {
                "id": 8765,
                "type": "QOS_REPORT_PACK",
                "name": "8765 - WOG_WEB_QOS"
            },
            {
                "id": 87654,
                "type": "CP_CODE",
                "name": "olympics-open.com/winter"
            },
            {
                "id": 876,
                "type": "SRIP_SLOT",
                "cpCode": 37437,
                "hostname": "open-olympics.com"
            },
            {
                "id": 12345,
                "type": "UNIVERSAL_LIVE_STREAM",
                "cpCode": 98345,
                "name": "olympics_open_universal",
                "bitrates": [
                    5000,
                    10000
                ]
            },
            {
                "id": 6,
                "type": "FLASH_LIVE_STREAM",
                "cpCode": 65401,
                "name": "olympics_open_flash",
                "bitrates": [
                    5000,
                    10000
                ]
            }
        ]
    }
]

Get an event

This operation returns details of the specified event.

{
    "id": 1,
    "version": 0,
    "name": "2018 Winter Olympics",
    "description": "XXIII Olympic Winter Games - PyeongChang 2018",
    "customerEventId": "xxiii-owg",
    "start": "2016-02-08T08:00:00Z",
    "end": "2016-02-08T20:00:00Z",
    "audienceSize": 5000000,
    "audienceLocations": [
        {
            "code": "PL",
            "name": "Poland"
        },
        {
            "code": "DE",
            "name": "Germany"
        }
    ],
    "coordinators": [
        {
            "userName": "vsnyder",
            "firstName": "Vigilant",
            "lastName": "Snyder"
        },
        {
            "userName": "taklumiere",
            "firstName": "Takeshi",
            "lastName": "Lumiere"
        }
    ],
    "tags": [
        {
            "id": 1,
            "name": "winter"
        },
        {
            "id": 2,
            "name": "olympics"
        }
    ],
    "createdDate": "2017-12-28T16:41:41Z",
    "createdBy": "vsnyder",
    "modifiedDate": "2017-12-28T16:41:41Z",
    "modifiedBy": "vsnyder",
    "objects": [
        {
            "id": 1012345,
            "type": "SM_REPORT_PACK",
            "name": "1012345 - Security_Monitor_winter_games"
        },
        {
            "id": 8765,
            "type": "QOS_REPORT_PACK",
            "name": "8765 - WOG_WEB_QOS"
        },
        {
            "id": 87654,
            "type": "CP_CODE",
            "name": "olympics-open.com/winter"
        },
        {
            "id": 876,
            "type": "SRIP_SLOT",
            "cpCode": 37437,
            "hostname": "open-olympics.com"
        },
        {
            "id": 12345,
            "type": "UNIVERSAL_LIVE_STREAM",
            "cpCode": 98345,
            "name": "olympics_open_universal",
            "bitrates": [
                5000,
                10000
            ]
        },
        {
            "id": 6,
            "type": "FLASH_LIVE_STREAM",
            "cpCode": 65401,
            "name": "olympics_open_flash",
            "bitrates": [
                5000,
                10000
            ]
        }
    ]
}

Update an event

This operation updates the specified event.

{
    "version": 0,
    "name": "2018 Winter Olympics",
    "description": "XXIII Olympic Winter Games - PyeongChang 2018",
    "customerEventId": "xxiii-owg",
    "start": "2016-02-08T08:00:00Z",
    "end": "2016-02-08T20:00:00Z",
    "audienceSize": 5000000,
    "audienceLocations": [
        "PL",
        "DE"
    ],
    "coordinators": [
        "vsnyder",
        "taklumiere"
    ],
    "tags": [
        "winter",
        "olympics"
    ],
    "objects": [
        {
            "id": 1012345,
            "type": "SM_REPORT_PACK"
        },
        {
            "id": 8765,
            "type": "QOS_REPORT_PACK"
        },
        {
            "id": 87654,
            "type": "CP_CODE"
        },
        {
            "id": 876,
            "type": "SRIP_SLOT"
        },
        {
            "id": 5,
            "type": "FLASH_LIVE_STREAM",
            "bitrates": [
                5000,
                10000
            ]
        },
        {
            "id": 12345,
            "type": "UNIVERSAL_LIVE_STREAM",
            "bitrates": [
                5000,
                10000
            ]
        }
    ]
}

{
    "id": 1,
    "version": 0,
    "name": "2018 Winter Olympics",
    "description": "XXIII Olympic Winter Games - PyeongChang 2018",
    "customerEventId": "xxiii-owg",
    "start": "2016-02-08T08:00:00Z",
    "end": "2016-02-08T20:00:00Z",
    "audienceSize": 5000000,
    "audienceLocations": [
        {
            "code": "PL",
            "name": "Poland"
        },
        {
            "code": "DE",
            "name": "Germany"
        }
    ],
    "coordinators": [
        {
            "userName": "vsnyder",
            "firstName": "Vigilant",
            "lastName": "Snyder"
        },
        {
            "userName": "taklumiere",
            "firstName": "Takeshi",
            "lastName": "Lumiere"
        }
    ],
    "tags": [
        {
            "id": 1,
            "name": "winter"
        },
        {
            "id": 2,
            "name": "olympics"
        }
    ],
    "createdDate": "2017-12-28T16:41:41Z",
    "createdBy": "vsnyder",
    "modifiedDate": "2017-12-28T16:41:41Z",
    "modifiedBy": "vsnyder",
    "objects": [
        {
            "id": 1012345,
            "type": "SM_REPORT_PACK",
            "name": "1012345 - Security_Monitor_winter_games"
        },
        {
            "id": 8765,
            "type": "QOS_REPORT_PACK",
            "name": "8765 - WOG_WEB_QOS"
        },
        {
            "id": 87654,
            "type": "CP_CODE",
            "name": "olympics-open.com/winter"
        },
        {
            "id": 876,
            "type": "SRIP_SLOT",
            "cpCode": 37437,
            "hostname": "open-olympics.com"
        },
        {
            "id": 12345,
            "type": "UNIVERSAL_LIVE_STREAM",
            "cpCode": 98345,
            "name": "olympics_open_universal",
            "bitrates": [
                5000,
                10000
            ]
        },
        {
            "id": 6,
            "type": "FLASH_LIVE_STREAM",
            "cpCode": 65401,
            "name": "olympics_open_flash",
            "bitrates": [
                5000,
                10000
            ]
        }
    ]
}

Remove an event

This operation deletes the specified event.

List tags

This operation returns a list of all event tags for the current account and contract type. This call supports paging and sorting of the result data.

{
    "metadata": {
        "page": 1,
        "pageSize": 25,
        "sort": [
            {
                "property": "name",
                "direction": "asc"
            }
        ],
        "totalResultsCount": 2,
        "totalPageCount": 1
    },
    "data": [
        {
            "name": "Tag 1",
            "id": 1
        },
        {
            "name": "Tag 2",
            "id": 2
        }
    ]
}

Data

This section provides details for each type of data object that the API exchanges.

Download the JSON schemas for this API.

The data schema tables below list membership requirements as follows:

Event

Contains detailed information about the event, including tags and objects associated with this event.

Download schema: event-details.json

Sample GET response:

{
    "id": 1,
    "version": 0,
    "name": "2018 Winter Olympics",
    "description": "XXIII Olympic Winter Games - PyeongChang 2018",
    "customerEventId": "xxiii-owg",
    "start": "2016-02-08T08:00:00Z",
    "end": "2016-02-08T20:00:00Z",
    "audienceSize": 5000000,
    "audienceLocations": [
        {
            "code": "PL",
            "name": "Poland"
        },
        {
            "code": "DE",
            "name": "Germany"
        }
    ],
    "coordinators": [
        {
            "userName": "vsnyder",
            "firstName": "Vigilant",
            "lastName": "Snyder"
        },
        {
            "userName": "taklumiere",
            "firstName": "Takeshi",
            "lastName": "Lumiere"
        }
    ],
    "tags": [
        {
            "id": 1,
            "name": "winter"
        },
        {
            "id": 2,
            "name": "olympics"
        }
    ],
    "createdDate": "2017-12-28T16:41:41Z",
    "createdBy": "vsnyder",
    "modifiedDate": "2017-12-28T16:41:41Z",
    "modifiedBy": "vsnyder",
    "objects": [
        {
            "id": 1012345,
            "type": "SM_REPORT_PACK",
            "name": "1012345 - Security_Monitor_winter_games"
        },
        {
            "id": 8765,
            "type": "QOS_REPORT_PACK",
            "name": "8765 - WOG_WEB_QOS"
        },
        {
            "id": 87654,
            "type": "CP_CODE",
            "name": "olympics-open.com/winter"
        },
        {
            "id": 876,
            "type": "SRIP_SLOT",
            "cpCode": 37437,
            "hostname": "open-olympics.com"
        },
        {
            "id": 12345,
            "type": "UNIVERSAL_LIVE_STREAM",
            "cpCode": 98345,
            "name": "olympics_open_universal",
            "bitrates": [
                5000,
                10000
            ]
        },
        {
            "id": 6,
            "type": "FLASH_LIVE_STREAM",
            "cpCode": 65401,
            "name": "olympics_open_flash",
            "bitrates": [
                5000,
                10000
            ]
        }
    ]
}

Event members

CpCode

Contains information about a Content Provider (CP) code associated with the event.

Download schema: cp-code.json

CpCode members

FlashLiveStream

Contains information about a Flash Live stream associated with the event.

Download schema: flash-live-stream.json

FlashLiveStream members

UniversalLiveStream

Contains information about a Universal Live stream associated with the event.

Download schema: universal-live-stream.json

UniversalLiveStream members

SripSlot

Contains information about a Sure Route IP (SRIP) slot associated with the event.

Download schema: srip-slot.json

SripSlot members

SmReportPack

Contains information about a Security Monitor (SM) report pack associated with the event.

Download schema: sm-report-pack.json

SmReportPack members

QosReportPack

Contains information about a Quality of Service (QoS) report pack associated with the event.

Download schema: qos-report-pack.json

QosReportPack members

MSL4Stream

Contains information about a Media Service Live 4 (MSL4) stream associated with the event.

Download schema: msl4-stream.json

MSL4Stream members

Tag

Contains information about a tag.

Download schema: tag.json

Tag members

EventUpdate

Contains information about the request body parameters that you can specify when updating an event. It also includes tags and objects that you can associate with an event.

Download schema: event-update.json

Sample PUT request:

{
    "version": 0,
    "name": "2018 Winter Olympics",
    "description": "XXIII Olympic Winter Games - PyeongChang 2018",
    "customerEventId": "xxiii-owg",
    "start": "2016-02-08T08:00:00Z",
    "end": "2016-02-08T20:00:00Z",
    "audienceSize": 5000000,
    "audienceLocations": [
        "PL",
        "DE"
    ],
    "coordinators": [
        "vsnyder",
        "taklumiere"
    ],
    "tags": [
        "winter",
        "olympics"
    ],
    "objects": [
        {
            "id": 1012345,
            "type": "SM_REPORT_PACK"
        },
        {
            "id": 8765,
            "type": "QOS_REPORT_PACK"
        },
        {
            "id": 87654,
            "type": "CP_CODE"
        },
        {
            "id": 876,
            "type": "SRIP_SLOT"
        },
        {
            "id": 5,
            "type": "FLASH_LIVE_STREAM",
            "bitrates": [
                5000,
                10000
            ]
        },
        {
            "id": 12345,
            "type": "UNIVERSAL_LIVE_STREAM",
            "bitrates": [
                5000,
                10000
            ]
        }
    ]
}

EventUpdate members

EventCreate

Contains information about the request body parameters that you can specify when creating an event. It also includes tags and objects that you can associate with a new event and the recurence context for the event.

Download schema: event-create.json

Sample POST request:

{
    "name": "2018 Winter Olympics",
    "description": "XXIII Olympic Winter Games - PyeongChang 2018",
    "customerEventId": "xxiii-owg",
    "start": "2016-02-08T08:00:00Z",
    "end": "2016-02-08T20:00:00Z",
    "audienceSize": 5000000,
    "audienceLocations": [
        "PL",
        "DE"
    ],
    "coordinators": [
        "vsnyder",
        "taklumiere"
    ],
    "tags": [
        "winter",
        "olympics"
    ],
    "objects": [
        {
            "id": 1012345,
            "type": "SM_REPORT_PACK"
        },
        {
            "id": 8765,
            "type": "QOS_REPORT_PACK"
        },
        {
            "id": 87654,
            "type": "CP_CODE"
        },
        {
            "id": 876,
            "type": "SRIP_SLOT"
        },
        {
            "id": 12345,
            "type": "UNIVERSAL_LIVE_STREAM",
            "bitrates": [
                5000,
                10000
            ]
        },
        {
            "id": 6,
            "type": "FLASH_LIVE_STREAM",
            "bitrates": [
                5000,
                10000
            ]
        }
    ],
    "recurrence": {
        "frequency": "DAILY",
        "count": 2
    }
}

EventCreate members

PageMetadata

Collects context about the requested data based on the request’s parameters.

Download schema: page-metadata.json

PageMetadata members

Errors

This section provides details on the data object that reflect the API’s common response to error cases, and lists the API’s range of response status codes for both error and success cases.

Error responses

If an error case occurs, this API responds with an error message that provides details useful for debugging. This example shows a typical error response object:

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "errors": [
    {
      "type": "about:blank",
      "title": "Bad Request",
      "detail": "Invalid value: 'lastName', parameter: sort",
      "parameter": "sort",
      "value": "lastName"
    }
  ]
}

HTTP status codes

This section lists the full range of response codes that the API may generate.

Last modified: 1/7/2019