
Event Center API v3
Create, view, and manage your event configurations.
Learn more:
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.
Create and update 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 aren’t in the response. Retrieving objects can be done using the Get an event operation.
You can associate these 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 another client has modified the data, 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, no restriction on this member’s value is present. No unique restriction is also present on the field, allowing more 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 these APIs:
ecresponse-by-time. Shows historical data about completed HTTP origin and edge requests received for each HTTP status code range per second. For example, 0xx, 1xx, 2xx, 3xx, 4xx, or 5xx.
estimatedecresponse-by-time. Shows estimated data about completed HTTP origin and edge requests received for each HTTP status code range per second. For example, 0xx, 1xx, 2xx, 3xx, 4xx, or 5xx.
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. It 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, rebuffering and bit rate.
Resources
This section provides details on each API operation.
This 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 you attach to an event for easy identification and categorization purposes.
API summary
Download the RAML descriptors for this API.
Operation | Method | Endpoint |
---|---|---|
Events | ||
List events | GET | /events/ |
Create an event | POST | /events/ |
Get an event | GET | /events/ |
Update an event | PUT | /events/ |
Remove an event | DELETE | /events/ |
Tags | ||
List tags | GET | /events/ |
List events
Returns a list of events for the current account and contract type. This call supports paging and sorting of the result data.
GET /events/
Sample: /events/
Parameter | Type | Sample | Description |
---|---|---|---|
Optional query parameters | |||
customerEventId |
String | id1 |
A list of user-defined IDs to filter event data by. |
maxEnd |
Date | 2016-02-28T16:41:41Z |
The inclusive upper bound of an end date. |
maxStart |
Date | 2016-02-28T16:41:41Z |
The exclusive upper bound of a start date. |
minEnd |
Date | 2016-02-28T16:41:41Z |
The exclusive lower bound of an end date. |
minStart |
Date | 2016-02-28T16:41:41Z |
The inclusive lower bound of a start date. |
page |
Integer | 1 |
The number of the page. Page numbers start at 1. |
pageSize |
Integer | 25 |
The number of records on a page. By default, a page has 25 records. The maximum value is 1000 records on a page. |
sort |
String | name,asc |
The sorting property and the sorting direction for the result data. These properties are available: name to sort by name, start to sort by start date, and end to sort by end date. Use asc for alphabetically ascending order or desc for alphabetically descending order. |
tag |
String | Tag 1 |
A list of tags to filter event data by. |
Status 200
application/json
Object type: Event
Download schema: event-page.json
Response body:
{
"metadata": {
"page": 1,
"pageSize": 25,
"totalResultsCount": 1,
"totalPageCount": 1,
"sort": [
{
"property": "name",
"direction": "asc"
}
]
},
"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
Creates an event with the specified parameters.
POST /events/
Content-Type: application/json
Object type: EventCreate
Download schema: event-create.json
Request body:
{
"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": [
"coordinator1",
"coordinator2"
],
"tags": [
"winter",
"olympics"
],
"recurrence": {
"frequency": "DAILY",
"count": 2
},
"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
]
}
]
}
Status 200
application/json
Object type: Event
Download schema: event-details-list.json
Response body:
[
{
"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,
"createdDate": "2017-12-28T16:41:41Z",
"createdBy": "coordinator1",
"modifiedDate": "2017-12-28T16:41:41Z",
"modifiedBy": "cpoordinator1",
"audienceLocations": [
{
"code": "PL",
"name": "Poland"
},
{
"code": "DE",
"name": "Germany"
}
],
"coordinators": [
{
"userName": "coordinator1",
"firstName": "Peter",
"lastName": "Example"
},
{
"userName": "coordinator2",
"firstName": "Mark",
"lastName": "Example"
}
],
"tags": [
{
"id": 1,
"name": "winter"
},
{
"id": 2,
"name": "olympics"
}
],
"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,
"createdDate": "2017-12-28T16:41:41Z",
"createdBy": "coordinator1",
"modifiedDate": "2017-12-28T16:41:41Z",
"modifiedBy": "coordinator2",
"audienceLocations": [
{
"code": "PL",
"name": "Poland"
},
{
"code": "DE",
"name": "Germany"
}
],
"coordinators": [
{
"userName": "coordinator1",
"firstName": "Peter",
"lastName": "Example"
},
{
"userName": "coordinator2",
"firstName": "Mark",
"lastName": "Example"
}
],
"tags": [
{
"id": 1,
"name": "winter"
},
{
"id": 2,
"name": "olympics"
}
],
"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
]
}
]
}
]
Specify the parameters and a list of tags for the event.
Optionally associate the event with a set of objects. To get the identifier of the object that you want to associate with the event, you can:
List QoS report packs to get the
id
of the appropriateQOS_REPORT_PACK
.List SM report packs to get the
id
of the appropriateSM_REPORT_PACK
.Contact your account representative to get the
id
of the appropriateSRIP_SLOT
.List CP codes to get the
id
of the appropriateCP_CODE
.Contact your account representative to get the
id
of the appropriateFLASH_LIVE_STREAM
.List streams to get the
stream-id
of the appropriateUNIVERSAL_LIVE_STREAM
.List MSL4 streams to get the
id
of the appropriateMSL4_STREAM
.
Make a POST request to
/events/v3/events
.
Get an event
Returns details of the specified event.
GET /events/
Sample: /events/
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
eventId |
Integer | 1 |
The identifier of the event. |
Status 200
application/json
Object type: Event
Download schema: event-details.json
Response body:
{
"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,
"createdDate": "2017-12-28T16:41:41Z",
"createdBy": "coordinator1",
"modifiedDate": "2017-12-28T16:41:41Z",
"modifiedBy": "coordinator1",
"audienceLocations": [
{
"code": "PL",
"name": "Poland"
},
{
"code": "DE",
"name": "Germany"
}
],
"coordinators": [
{
"userName": "coordinator1",
"firstName": "Peter",
"lastName": "Example"
},
{
"userName": "coordinator2",
"firstName": "Mark",
"lastName": "Example"
}
],
"tags": [
{
"id": 1,
"name": "winter"
},
{
"id": 2,
"name": "olympics"
}
],
"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
]
}
]
}
Prepare the
eventId
of the appropriate event. You can find it by listing all events.Make a GET request to
/events/v3/events/{eventId}
.
Update an event
Updates the specified event.
PUT /events/
Sample: /events/
Content-Type: application/json
Object type: EventUpdate
Download schema: event-update.json
Request body:
{
"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": [
"coordinator1",
"coordinator2"
],
"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
]
}
]
}
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
eventId |
Integer | 1 |
The identifier of the event. |
Status 200
application/json
Object type: Event
Download schema: event-details.json
Response body:
{
"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,
"createdDate": "2017-12-28T16:41:41Z",
"createdBy": "coordinator1",
"modifiedDate": "2017-12-28T16:41:41Z",
"modifiedBy": "coordinator1",
"audienceLocations": [
{
"code": "PL",
"name": "Poland"
},
{
"code": "DE",
"name": "Germany"
}
],
"coordinators": [
{
"userName": "coordinator1",
"firstName": "Peter",
"lastName": "Example"
},
{
"userName": "coordinator2",
"firstName": "Mark",
"lastName": "Example"
}
],
"tags": [
{
"id": 1,
"name": "winter"
},
{
"id": 2,
"name": "olympics"
}
],
"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
]
}
]
}
Prepare the
eventId
of the appropriate event. You can find it by listing all events.Get the details of the event that you want to update. You can do it by getting an event.
Update the parameters of the event and the objects associated with it. To get the identifier of the object that you want to associate with the event, you can:
List QoS report packs to get the
id
of the appropriateQOS_REPORT_PACK
.List SM report packs to get the
id
of the appropriateSM_REPORT_PACK
.Contact your account representative to get the
id
of the appropriateSRIP_SLOT
.List CP codes to get the
id
of the appropriateCP_CODE
.Contact your account representative to get the
id
of the appropriateFLASH_LIVE_STREAM
.List streams to get the
stream-id
of the appropriateUNIVERSAL_LIVE_STREAM
.List MSL4 streams to get the
id
of the appropriateMSL4_STREAM
.
In the
version
member of the request, enter the version of the event that you’re updating included in the server’s original response.Make a PUT request to
/events/v3/events/{eventId}
.
Remove an event
Deletes the specified event.
DELETE /events/
Sample: /events/
Parameter | Type | Sample | Description |
---|---|---|---|
URL path parameters | |||
eventId |
Integer | 1 |
The identifier of the event. |
Status 204
Prepare the
eventId
of the appropriate event. You can find it by listing all events.Make a DELETE request to
/events/v3/events/{eventId}
.
List tags
Returns a list of all event tags for the current account and contract type. This call supports paging and sorting of the result data.
GET /events/
Sample: /events/
Parameter | Type | Sample | Description |
---|---|---|---|
Optional query parameters | |||
page |
Integer | 1 |
The number of the page. Page numbers start at 1. |
pageSize |
Integer | 25 |
The number of records on a page. By default, a page has 25 records. The maximum value is 1000 records on a page. |
sort |
String | name,asc |
The sorting property and the sorting direction for the result data. Use name to sort by name. Use asc for alphabetically ascending order or desc for alphabetically descending order. |
Status 200
application/json
Object type: Tag
Download schema: tag-page.json
Response body:
{
"metadata": {
"page": 1,
"pageSize": 25,
"totalResultsCount": 2,
"totalPageCount": 1,
"sort": [
{
"property": "name",
"direction": "asc"
}
]
},
"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.
This section’s data schema tables list membership requirements as follows:
✓ | Member is required in requests, or always present in responses, even if its value is empty or null . |
○ | Member is optional, and may be omitted in some cases. |
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,
"createdDate": "2017-12-28T16:41:41Z",
"createdBy": "coordinator1",
"modifiedDate": "2017-12-28T16:41:41Z",
"modifiedBy": "coordinator1",
"audienceLocations": [
{
"code": "PL",
"name": "Poland"
},
{
"code": "DE",
"name": "Germany"
}
],
"coordinators": [
{
"userName": "coordinator1",
"firstName": "Peter",
"lastName": "Example"
},
{
"userName": "coordinator2",
"firstName": "Mark",
"lastName": "Example"
}
],
"tags": [
{
"id": 1,
"name": "winter"
},
{
"id": 2,
"name": "olympics"
}
],
"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
Member | Type | Required | Description |
---|---|---|---|
Event : Contains detailed information about the event, including tags and objects associated with this event. |
|||
audience |
Event. |
○ | A collection of countries that match the geographic locations of audiences. |
audienceSize |
Integer | ○ | The audience’s size for the event. |
coordinators |
Event. |
○ | A collection of coordinators assigned to the event. |
createdBy |
String | ✓ | The person who created the event. |
createdDate |
String | ✓ | An ISO 8601 timestamp indicating the date and time when the event was created. |
customerEventId |
String | ○ | The user-specified ID for the event. See Customer Event ID. |
description |
String | ○ | The description of the event. |
end |
String | ✓ | An ISO 8601 timestamp indicating the end date of the event. |
id |
Integer | ✓ | The identifier of the event. |
modifiedBy |
String | ✓ | The person who last modified the event. |
modifiedDate |
String | ✓ | An ISO 8601 timestamp indicating the date and time when the event was last modified. |
name |
String | ✓ | The name of the event. |
objects |
Array of Cp |
○ | A collection of objects associated with the event. |
start |
String | ✓ | An ISO 8601 timestamp indicating the start date of the event. |
tags |
Tag Array | ○ | A collection of tags associated with the event. |
version |
Integer | ✓ | The version of the event. |
Event.audienceLocations[] : A collection of countries that match the geographic locations of audiences. |
|||
code |
String | ✓ | A two-letter ISO 3166 country code. |
name |
String | ✓ | Name of the country that corresponds to the country code. |
Event.coordinators[] : A collection of coordinators assigned to the event. |
|||
firstName |
String | ✓ | The coordinator’s first name. |
lastName |
String | ✓ | The coordinator’s last name. |
userName |
String | ✓ | The coordinator’s username as defined in Control Center. |
CpCode
Contains information about a Content Provider (CP) code associated with the event.
Download schema:
cp-code.json
CpCode members
Member | Type | Required | Description |
---|---|---|---|
CpCode : Contains information about a Content Provider (CP) code associated with the event. |
|||
id |
Integer | ✓ | The identifier of the CP code. |
name |
String | ✓ | The name of the CP code. |
type |
Enumeration | ✓ | The type of event object. CP_CODE in this case. |
FlashLiveStream
Contains information about a Flash Live stream associated with the event.
Download schema:
flash-live-stream.json
FlashLiveStream members
Member | Type | Required | Description |
---|---|---|---|
FlashLiveStream : Contains information about a Flash Live stream associated with the event. |
|||
bitrates |
Array | ○ | A list of expected bit rates in kbit/s for the stream. |
cpCode |
Integer | ✓ | The Content Provider code associated with the stream. |
id |
Integer | ✓ | The identifier of the Flash Live stream. |
name |
String | ✓ | The name of the stream. |
type |
Enumeration | ✓ | The type of stream. FLASH_LIVE_STREAM in this case. |
UniversalLiveStream
Contains information about a Universal Live stream associated with the event.
Download schema:
universal-live-stream.json
UniversalLiveStream members
Member | Type | Required | Description |
---|---|---|---|
UniversalLiveStream : Contains information about a Universal Live stream associated with the event. |
|||
bitrates |
Array | ○ | A list of expected bit rates in kbit/s for the stream. |
cpCode |
Integer | ✓ | The CP code associated with the Universal Live stream. |
id |
Integer | ✓ | The identifier of the Universal Live stream. |
name |
String | ✓ | The name of the Universal Live stream. |
type |
Enumeration | ✓ | The type of stream. UNIVERSAL_LIVE_STREAM in this case. |
SripSlot
Contains information about a Sure Route IP (SRIP) slot associated with the event.
Download schema:
srip-slot.json
SripSlot members
Member | Type | Required | Description |
---|---|---|---|
SripSlot : Contains information about a Sure Route IP (SRIP) slot associated with the event. |
|||
cpCode |
Integer | ✓ | The CP code associated with the SRIP slot. |
hostname |
String | ○ | The Accelerated hostname associated with the SRIP slot. |
id |
Integer | ✓ | The identifier of the SRIP slot. |
type |
Enumeration | ✓ | The type of object. SRIP_SLOT in this case. |
SmReportPack
Contains information about a Security Monitor (SM) report pack associated with the event.
Download schema:
sm-report-pack.json
SmReportPack members
Member | Type | Required | Description |
---|---|---|---|
SmReportPack : Contains information about a Security Monitor (SM) report pack associated with the event. |
|||
id |
Integer | ✓ | The identifier of the SM report pack. |
name |
String | ✓ | The name of the SM report pack. |
type |
Enumeration | ✓ | The type of object. SM_REPORT_PACK in this case. |
QosReportPack
Contains information about a Quality of Service (QoS) report pack associated with the event.
Download schema:
qos-report-pack.json
QosReportPack members
Member | Type | Required | Description |
---|---|---|---|
QosReportPack : Contains information about a Quality of Service (QoS) report pack associated with the event. |
|||
id |
Integer | ✓ | The identifier of the QoS report pack. |
name |
String | ✓ | The name of the QoS report pack. |
type |
Enumeration | ✓ | The type of object. QOS_REPORT_PACK in this case. |
MSL4Stream
Contains information about a Media Service Live 4 (MSL4) stream associated with the event.
Download schema:
msl4-stream.json
MSL4Stream members
Member | Type | Required | Description |
---|---|---|---|
MSL4Stream : Contains information about a Media Service Live 4 (MSL4) stream associated with the event. |
|||
bitrates |
Array | ○ | A list of expected bit rates in kbit/s for the stream. |
cpCode |
Integer | ✓ | The ingest Content Provider code associated with the stream. |
id |
Integer | ✓ | The identifier of the MSL4 stream. |
name |
String | ✓ | The name of the MSL4 stream. |
type |
Enumeration | ✓ | The type of stream. MSL4_STREAM in this case. |
Tag
Contains information about a tag.
Download schema:
tag.json
Tag members
Member | Type | Required | Description |
---|---|---|---|
Tag : Contains information about a tag. |
|||
id |
Integer | ✓ | The identifier of the tag. |
name |
String | ✓ | The description of the tag. |
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": [
"coordinator1",
"coordinator2"
],
"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
Member | Type | Required | Description |
---|---|---|---|
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. |
|||
audience |
Array, Null | ○ | A list of two-letter ISO 3166 country codes that indicate geographic areas of audiences. This array can be up to 20 unique items. |
audienceSize |
Integer, Null | ○ | The audience’s size for the event. The minimum value is 1. |
coordinators |
Array, Null | ○ | A list of up to 20 Control Center usernames of those who serve as the event’s coordinators. |
customerEventId |
String, Null | ○ | The user-specified ID for the event. This ID can be up to 100 characters long. See Customer Event ID. |
description |
String, Null | ○ | The description of the event. This description can be up to 2000 characters long. |
end |
String | ✓ | An ISO 8601 timestamp indicating the end date of the event. |
name |
String | ✓ | The name of the event. This name can be up to 750 characters long. |
objects |
Event |
○ | A collection of objects associated with the event. This array can include only unique items. |
start |
String | ✓ | An ISO 8601 timestamp indicating the start date of the event. |
tags |
Array, Null | ○ | A list of tags associated with the event. A tag can be up to 100 characters long. This array can be up to 20 unique items. |
version |
Integer | ✓ | The version of the event. Use the version of the event sent in the original server’s response. See Event version. |
EventUpdate.objects[] : A collection of objects associated with the event. This array can include only unique items. |
|||
bitrates |
Array, Null | ○ | A list of expected bit rates in kbit/s for the stream. Specify for FLASH_LIVE_STREAM , UNIVERSAL_LIVE_STREAM , and MSL4_STREAM objects. This array can be up to 20 unique items. |
id |
Integer | ✓ | The identifier of the object. |
type |
Enumeration | ✓ | The type of object associated with the event. Use QOS_REPORT_PACK to associate a quality report pack, SM_REPORT_PACK to associate a security monitor report pack, CP_CODE to associate a Content Provider code, SRIP_SLOT to associate a Sure Route IP slot, FLASH_LIVE_STREAM to associate a Flash Live stream, UNIVERSAL_LIVE_STREAM to associate a Universal Live stream, or MSL4_STREAM to associate Media Services Live v4.1 stream. |
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 recurrence 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": [
"coordinator1",
"coordinator2"
],
"tags": [
"winter",
"olympics"
],
"recurrence": {
"frequency": "DAILY",
"count": 2
},
"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
]
}
]
}
EventCreate members
Member | Type | Required | Description |
---|---|---|---|
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 recurrence context for the event. |
|||
audience |
Array, Null | ○ | A list of two-letter ISO 3166 country codes that indicate geographic areas of audiences. This array can be up to 20 unique items. |
audienceSize |
Integer, Null | ○ | The audience’s size for the event. The minimum value is 1. |
coordinators |
Array, Null | ○ | A list of up to 20 Control Center usernames of those who serve as the event’s coordinators. |
customerEventId |
String, Null | ○ | The user-specified ID for the event. This ID can be up to 100 characters long. See Customer Event ID. |
description |
String, Null | ○ | The description of the event. This description can be up to 2000 characters long. |
end |
String | ✓ | An ISO 8601 timestamp indicating the end date of the event. |
name |
String | ✓ | The name of the event. This name can be up to 750 characters long. |
objects |
Event |
○ | A collection of objects associated with the event. This array can include only unique items. |
recurrence |
Event |
○ | Contains information about the recurrence parameters that you can specify when creating the event. |
start |
String | ✓ | An ISO 8601 timestamp indicating the start date of the event. |
tags |
Array, Null | ○ | A list of tags associated with the event. A tag can be up to 100 characters long. This array can be up to 20 unique items. |
EventCreate.objects[] : A collection of objects associated with the event. This array can include only unique items. |
|||
bitrates |
Array, Null | ○ | A list of expected bit rates in kbit/s for the stream. Specify for FLASH_LIVE_STREAM , UNIVERSAL_LIVE_STREAM , and MSL4_STREAM objects. This array can be up to 20 unique items. |
id |
Integer | ✓ | The identifier of the object. |
type |
Enumeration | ✓ | The type of object associated with the event. Use QOS_REPORT_PACK to associate a quality report pack, SM_REPORT_PACK to associate a security monitor report pack, CP_CODE to associate a Content Provider code, SRIP_SLOT to associate a Sure Route IP slot, FLASH_LIVE_STREAM to associate a Flash Live stream, UNIVERSAL_LIVE_STREAM to associate a Universal Live stream, or MSL4_STREAM to associate Media Services Live v4.1 stream. |
EventCreate.recurrence : Contains information about the recurrence parameters that you can specify when creating the event. |
|||
count |
Integer | ✓ | The number of times to repeat the event. Specify a value between 1 and 366. |
frequency |
Enumeration | ✓ | The periodicity of the recurring event. Use HOURLY to repeat the event once an hour, DAILY to repeat the event once a day, WEEKLY to repeat the event once a week, or MONTHLY to repeat the event once a month. |
PageMetadata
Collects context about the requested data based on the request’s parameters.
Download schema:
page-metadata.json
PageMetadata members
Member | Type | Required | Description |
---|---|---|---|
PageMetadata : Collects context about the requested data based on the request’s parameters. |
|||
page |
Integer | ✓ | The number of the page. |
pageSize |
Integer | ✓ | The number of records per page. |
sort |
Page |
✓ | Contains information about the sorting property and the sorting direction for the result data. |
totalPageCount |
Integer | ✓ | The total number of pages. |
total |
Integer | ✓ | The total number of records. |
PageMetadata.sort[] : Contains information about the sorting property and the sorting direction for the result data. |
|||
direction |
Enumeration | ✓ | The sorting direction for the result data. Either asc for alphabetically ascending order or desc for alphabetically descending order. |
property |
String | ✓ | The sorting property for the result data. |
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.
Code | Description |
---|---|
200 | The operation was successful. |
204 | Successfully processed request. |
400 | Bad Request. |
401 | Authentication failure. |
403 | Access is forbidden. |
404 | Resource not found. |
405 | Method not supported. |
409 | Conflict with current state of resource. |
415 | Unsupported media type. |
429 | Too many requests. |
500 | Internal server error. |
503 | Service is temporarily unavailable. |