The Event Center API v2.0

The Event Center API is a group of REST resources that provide access to event data. This includes event configuration, event reporting, and alerts.

NOTE: Various resources detailed here depend on an accountId value that the API does not provide. If the account under which you administer events is the same as the one under which you provisioned the Event Center API token, then you can simply substitute current-account for the value.

API Summary

Operation Method Endpoint
Events by Account
List Events GET /events/v2/{accountId}/events{?startRange,endRange,sortField,sortOrder,startIndex,limit,customerEventId}
POST a New Event POST /events/v2/{accountId}/events{?startRange,endRange,sortField,sortOrder,startIndex,limit,customerEventId}
PUT a New Event PUT /events/v2/{accountId}/events{?startRange,endRange,sortField,sortOrder,startIndex,limit,customerEventId}
Remove Events DELETE /events/v2/{accountId}/events{?startRange,endRange,sortField,sortOrder,startIndex,limit,customerEventId}
Create a Recurring Event POST /events/v2/{accountId}/events/recurring{?frequency,numberOfTimes}
Get an Event GET /events/v2/{accountId}/events/{eventId}
Modify an Event, with POST POST /events/v2/{accountId}/events/{eventId}
Modify an Event, with PUT PUT /events/v2/{accountId}/events/{eventId}
Remove an Event DELETE /events/v2/{accountId}/events/{eventId}
Get Event with its Services GET /events/v2/{accountId}/events/{eventId}{?services}
List Services GET /events/v2/{accountId}/events/{eventId}/services
List Range of Events GET /events/v2/{accountId}/events/id{?startRange,endRange,sortField,sortOrder,startIndex,limit,customerEventId}
List Events in Progress GET /events/v2/{accountId}/events/live
List Events Current for Specific Time GET /events/v2/{accountId}/events/live/{time}
List Upcoming Events GET /events/v2/{accountId}/events/upcoming
List Impending Events GET /events/v2/{accountId}/events/upcoming/{rangeInHours}
List Alerts GET /events/v2/{accountId}/events/alerts
List Alerts per Event GET /events/v2/{accountId}/events/{eventId}/alerts
Event Traffic by CP Code
Get Event Traffic Data by CP Code GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/edge/bandwidth
Get Edge Bandwidth per CP Code GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/edge/bandwidth/{cpcode}
Get Event’s Edge Requests, per CP Code GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/edge/requests/{cpcode}
Get Event’s Status Totals GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/edge/status
Get Event’s Status Totals per CP Code GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/edge/status/{cpcode}
Get Event’s Bandwidth Data GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/origin/bandwidth
Get Event’s Bandwidth Data per CP Code GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/origin/bandwidth/{cpcode}
Get Event’s Origin Requests GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/origin/requests
Get Event’s Origin Requests per CP Code GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/origin/requests/{cpcode}
Get Event’s Origin Statuses GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/origin/status
Get Event’s Origin Statuses per CP Code GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/origin/status/{cpcode}
Get Event’s I/O Bandwidth GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/bandwidth
Get Event’s I/O Bandwidth per CP Code GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/bandwidth/{cpcode}
Get Event’s Requests GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/requests
Get Event’s Requests per CP Code GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/requests/{cpcode}
Event Live Stream Entry Point Traffic
Get Entry Point Data for Flash Live Streams GET /events/v2/{accountId}/events/{eventId}/trafficdata/entrypoint/flashlive
Get Entry Point Data for a Flash Live Stream GET /events/v2/{accountId}/events/{eventId}/trafficdata/entrypoint/flashlive/{streamId}
Get Entry Point Data for Universal Live Streams GET /events/v2/{accountId}/events/{eventId}/trafficdata/entrypoint/universallive
Get Entry Point Data for a Universal Live Stream GET /events/v2/{accountId}/events/{eventId}/trafficdata/entrypoint/universallive/{streamId}
Event Traffic by Traditional Flash Live Stream
Get Aggregate Data for Flash Live Streams GET /events/v2/{accountId}/events/{eventId}/trafficdata/fl/egressbw
Get Aggregate Data for a Flash Live Stream GET /events/v2/{accountId}/events/{eventId}/trafficdata/fl/egressbw/{streamId}
Get Request Data for Flash Live Streams GET /events/v2/{accountId}/events/{eventId}/trafficdata/fl/egressrequests
Get Request Data for a Flash Live Stream GET /events/v2/{accountId}/events/{eventId}/trafficdata/fl/egressrequests/{streamId}
Get Viewer Data for Flash Live Streams GET /events/v2/{accountId}/events/{eventId}/trafficdata/fl/egressviewers
Get Viewer Data for a Flash Live Stream GET /events/v2/{accountId}/events/{eventId}/trafficdata/fl/egressviewers/{streamId}
Event Traffic by Silverlight Live Stream
Get Aggregate Data for Silverlight Live Streams GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressbw
Get Silverlight Live Stream GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressbw/{streamId}
Get Request Data for Silverlight Live Streams GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressrequests
Get Request Data for a Silverlight Live Stream GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressrequests/{streamId}
Get Status Data for Silverlight Live Streams GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressstatus
Get Status Data for a Silverlight Live Stream GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressstatus/{streamId}
Get Viewer Data for Silverlight Live Streams GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressviewers
Get Viewer Data for a Silverlight Live Stream GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressviewers/{streamId}
Event IPA or SXL Traffic
Get SRIP Connections GET /events/v2/{accountId}/events/{eventId}/trafficdata/srip/connections
Get SRIP Connections per Slot GET /events/v2/{accountId}/events/{eventId}/trafficdata/srip/connections/{slotId}
Get SRIP Bandwidth GET /events/v2/{accountId}/events/{eventId}/trafficdata/srip/sourcebandwidth
Get SRIP Bandwidth per Slot GET /events/v2/{accountId}/events/{eventId}/trafficdata/srip/sourcebandwidth/{slotId}
Event Universal Live Stream Traffic
Get Edge Bandwidth for Universal Live Streams GET /events/v2/{accountId}/events/{eventId}/trafficdata/universallive/edge/bandwidth{?range,deliveryFormat}
Get Edge Bandwidth for a Universal Live Stream GET /events/v2/{accountId}/events/{eventId}/trafficdata/universallive/edge/bandwidth/{streamId}{?range,deliveryFormat}
Get Edge Requests for Universal Live Streams GET /events/v2/{accountId}/events/{eventId}/trafficdata/universallive/edge/requests{?range,deliveryFormat}
Get Edge Requests for a Universal Live Stream GET /events/v2/{accountId}/events/{eventId}/trafficdata/universallive/edge/requests/{streamId}{?range,deliveryFormat}
Get Edge Viewers for Universal Live Streams GET /events/v2/{accountId}/events/{eventId}/trafficdata/universallive/edge/viewers{?range,deliveryFormat}
Get Edge Viewers for a Universal Live Stream GET /events/v2/{accountId}/events/{eventId}/trafficdata/universallive/edge/viewers/{streamId}{?range,deliveryFormat}
QoS and Security Monitor
Get Audience Size GET /events/v2/{accountId}/events/{eventId}/qos/audiencesize{?startDate,endDate,reportPackID,timeAggInterval}
Get Rebuffering Data GET /events/v2/{accountId}/events/{eventId}/qos/rebuffering{?startDate,endDate,reportPackID,timeAggInterval}
Get Report Packs GET /events/v2/{accountId}/qos/getReportPacks
Get Request Denied Data GET /events/v2/{accountId}/events/{eventId}/qos_sm/requestdenied{?startDate,endDate,reportPackID,timeAggInterval}
Get Request Warned Data GET /events/v2/{accountId}/events/{eventId}/qos_sm/requestwarned{?startDate,endDate,reportPackID,timeAggInterval}
Get Rules Triggered Data GET /events/v2/{accountId}/events/{eventId}/qos_sm/rulestriggered{?startDate,endDate,reportPackID,timeAggInterval}
Get Startup Time Data GET /events/v2/{accountId}/events/{eventId}/qos/startuptime{?startDate,endDate,reportPackID,timeAggInterval}
Get Successful Attempts Data GET /events/v2/{accountId}/events/{eventId}/qos/successfulattempts{?startDate,endDate,reportPackID,timeAggInterval}
Site Configurations
List CP Codes GET /events/v2/{accountId}/sites/cpcodes
IPA and SXL Configurations
List IPA and SXL Configurations GET /events/v2/{accountId}/srip{?sortField,sortOrder,limit,startIndex}
Legacy Stream Configurations
List Flash Live Streams GET /events/v2/{accountId}/streams/flashlive
List Silverlight Live Streams GET /events/v2/{accountId}/streams/silverlightlive
Universal Live Stream Configurations
List Universal Live Streams GET /events/v2/{accountId}/streams/universallive{?sortField,sortOrder,limit,startIndex}

List Events

Gets all events for the given account that have an event start date within the given date range if both ends of the range are specified. The range is ignored if either the start or end dates are unspecified.

GET /events/v2/{accountId}/events{?startRange,endRange,sortField,sortOrder,startIndex,limit,customerEventId}

Example: /events/v2/1–7KLGH/events?startRange=1379636800000&endRange=1381636800000&sortField=start&sortOrder=asc&startIndex=0&limit=10&customerEventId=642531

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
Optional
customerEventId String 642531 Event identifier for your own use. See Customer Event ID.
endRange Number 1381636800000 End of event, specified as epoch time milliseconds.
limit Number 10 The maximum number of pagination records to include.
sortField String start The field that should be used to sort the result set.
sortOrder String asc The direction of the sort, asc for ascending or desc for descending.
startIndex Number 0 The zero-origin index at which to start the batch of paginated results.
startRange Number 1379636800000 Start of event, specified as epoch time milliseconds.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
        "resultsPerPage": 1,
        "currentPage": 1,
        "totalResultsCount": 1,
        "totalPageCount": 1,
        "sortKey": "START",
        "sortOrder": "ASC",
        "filters": {
            "endRange": 1381636800000,
            "startRange": 1379636800000
        },
        "dataSet": [
            {
                "id": 1142,
                "customerEventId": null,
                "version": 7,
                "name": "myEvent",
                "description": "event description",
                "eventType": "COMBINED",
                "customer": {
                    "accountID": "1234",
                    "accountName": "Test Account",
                    "supportLevel": "PREMIUM"
                },
                "start": 1378478700000,
                "end": 1380122100000,
                "createdDate": 1379444617000,
                "createdBy": "user1",
                "modifiedDate": 1379459101000,
                "modifiedBy": "user1",
                "audienceSize": 0,
                "audienceLocations": [],
                "coordinators": [ "5s.test_nobody" ],
                "locked": false,
                "tags": [
                    {
                        "id": 91150,
                        "name": "test",
                        "global": false
                    }
                ],
                "services": null,
                "supportType": null
            }
        ]
    }
}

POST a New Event

Creates a new event with the given parameters. The only required fields are the event name, start and end date. All other fields are optional.

POST /events/v2/{accountId}/events{?startRange,endRange,sortField,sortOrder,startIndex,limit,customerEventId}

Example: /events/v2/1–7KLGH/events?startRange=1379636800000&endRange=1381636800000&sortField=start&sortOrder=asc&startIndex=0&limit=10&customerEventId=642531

Content-Type: application/json

Request:

{
    "audienceLocations": [],
    "audienceSize": 0,
    "coordinators": [],
    "createdDate": 1380132769680,
    "customer": {},
    "description": "",
    "end": 1380151800000,
    "eventType": "STREAMING",
    "locked": false,
    "modifiedDate": 1380132769680,
    "name": "apiary2",
    "services": {
        "flashLiveStreams": [],
        "qosmReportPackIds": [],
        "silverlightLiveStreams": [],
        "siteCPCodes": [],
        "smReportPackIds": [],
        "sripConfigs": [],
        "universalLiveStreams": []
    },
    "start": 1380132000000,
    "supportType": {},
    "tags": [],
    "version": 0
}

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
Optional
customerEventId String 642531 Event identifier for your own use. See Customer Event ID.
endRange Number 1381636800000 End of event, specified as epoch time milliseconds.
limit Number 10 The maximum number of pagination records to include.
sortField String start The field that should be used to sort the result set.
sortOrder String asc The direction of the sort, asc for ascending or desc for descending.
startIndex Number 0 The zero-origin index at which to start the batch of paginated results.
startRange Number 1379636800000 Start of event, specified as epoch time milliseconds.

Status 200 application/json

Response:

{
    "contents": {
        "audienceLocations": [],
        "audienceSize": 0,
        "coordinators": [],
        "createdBy": "ccare2",
        "createdDate": 1380132781405,
        "customer": {
            "accountID": "1-7KLGH",
            "accountName": "Akamai Internal",
            "supportLevel": null
        },
        "customerEventId": null,
        "description": "",
        "end": 1380151800000,
        "eventType": "COMBINED",
        "id": 117100,
        "locked": false,
        "modifiedBy": "ccare2",
        "modifiedDate": 1380132781408,
        "name": "apiary2",
        "services": {
            "flashLiveStreams": [],
            "qosmReportPackIds": [],
            "silverlightLiveStreams": [],
            "siteCPCodes": [],
            "smReportPackIds": [],
            "sripConfigs": [],
            "universalLiveStreams": []
        },
        "start": 1380132000000,
        "supportType": null,
        "tags": [],
        "version": 0
    },
    "status": "ok"
}

PUT a New Event

Exactly same as the previous POST call. Creates a new event with the given parameters. The only required fields are the event name, start and end date. All other fields are optional.

PUT /events/v2/{accountId}/events{?startRange,endRange,sortField,sortOrder,startIndex,limit,customerEventId}

Example: /events/v2/1–7KLGH/events?startRange=1379636800000&endRange=1381636800000&sortField=start&sortOrder=asc&startIndex=0&limit=10&customerEventId=642531

Content-Type: application/json

Request:

{
    "audienceLocations": [],
    "audienceSize": 0,
    "coordinators": [],
    "createdDate": 1380132769680,
    "customer": {},
    "description": "",
    "end": 1380151800000,
    "eventType": "STREAMING",
    "locked": false,
    "modifiedDate": 1380132769680,
    "name": "apiary2",
    "services": {
        "flashLiveStreams": [],
        "qosmReportPackIds": [],
        "silverlightLiveStreams": [],
        "siteCPCodes": [],
        "smReportPackIds": [],
        "sripConfigs": [],
        "universalLiveStreams": []
    },
    "start": 1380132000000,
    "supportType": {},
    "tags": [],
    "version": 0
}

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
Optional
customerEventId String 642531 Event identifier for your own use. See Customer Event ID.
endRange Number 1381636800000 End of event, specified as epoch time milliseconds.
limit Number 10 The maximum number of pagination records to include.
sortField String start The field that should be used to sort the result set.
sortOrder String asc The direction of the sort, asc for ascending or desc for descending.
startIndex Number 0 The zero-origin index at which to start the batch of paginated results.
startRange Number 1379636800000 Start of event, specified as epoch time milliseconds.

Status 200 application/json

Response:

{
    "contents": {
        "audienceLocations": [],
        "audienceSize": 0,
        "coordinators": [],
        "createdBy": "ccare2",
        "createdDate": 1380132781405,
        "customer": {
            "accountID": "1-7KLGH",
            "accountName": "Akamai Internal",
            "supportLevel": null
        },
        "customerEventId": null,
        "description": "",
        "end": 1380151800000,
        "eventType": "COMBINED",
        "id": 117100,
        "locked": false,
        "modifiedBy": "ccare2",
        "modifiedDate": 1380132781408,
        "name": "apiary2",
        "services": {
            "flashLiveStreams": [],
            "qosmReportPackIds": [],
            "silverlightLiveStreams": [],
            "siteCPCodes": [],
            "smReportPackIds": [],
            "sripConfigs": [],
            "universalLiveStreams": []
        },
        "start": 1380132000000,
        "supportType": null,
        "tags": [],
        "version": 0
    },
    "status": "ok"
}

Remove Events

Delete events for the given event IDs. The IDs are consumed as an array so that multiple events can be deleted at once. IDs that are not found are silently ignored.

DELETE /events/v2/{accountId}/events{?startRange,endRange,sortField,sortOrder,startIndex,limit,customerEventId}

Example: /events/v2/1–7KLGH/events?startRange=1379636800000&endRange=1381636800000&sortField=start&sortOrder=asc&startIndex=0&limit=10&customerEventId=642531

Content-Type: application/json

Request:

{ [ 117100, 117103 ] }

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
Optional
customerEventId String 642531 Event identifier for your own use. See Customer Event ID.
endRange Number 1381636800000 End of event, specified as epoch time milliseconds.
limit Number 10 The maximum number of pagination records to include.
sortField String start The field that should be used to sort the result set.
sortOrder String asc The direction of the sort, asc for ascending or desc for descending.
startIndex Number 0 The zero-origin index at which to start the batch of paginated results.
startRange Number 1379636800000 Start of event, specified as epoch time milliseconds.

Status 200 application/json

Response:

{ "status": "ok" }

Create a Recurring Event

Creates a new event with the given parameters. The only required fields are the event name, start and end date. All other fields are optional.

POST /events/v2/{accountId}/events/recurring{?frequency,numberOfTimes}

Example: /events/v2/1–7KLGH/events/recurring?frequency=WEEKLY&numberOfTimes=6

Content-Type: application/json

Request:

{
    "version": 0,
    "eventType": "STREAMING",
    "description": "",
    "start": 1380132900000,
    "end": 1380138300000,
    "createdDate": 1380133638759,
    "modifiedDate": 1380133638759,
    "customer": {},
    "coordinators": [],
    "audienceLocations": [],
    "audienceSize": 0,
    "tags": [],
    "locked": false,
    "supportType": {},
    "name": "apiary3",
    "services": {
        "universalLiveStreams": [],
        "silverlightLiveStreams": [],
        "flashLiveStreams": [],
        "siteCPCodes": [],
        "sripConfigs": [],
        "qosmReportPackIds": [],
        "smReportPackIds": []
    }
}

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
frequency String WEEKLY Periodicity of the recurring event.
numberOfTimes Number 6 Number of times/periods to follow.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": [
        {
            "id": 117101,
            "customerEventId": null,
            "version": 0,
            "name": "apiary3",
            "description": "",
            "eventType": "COMBINED",
            "customer": {
                "accountID": "1-7KLGH",
                "accountName": "Akamai Internal",
                "supportLevel": null
            },
            "start": 1380132900000,
            "end": 1380138300000,
            "createdDate": 1380133679594,
            "createdBy": "ccare2",
            "modifiedDate": 1380133679596,
            "modifiedBy": "ccare2",
            "audienceSize": 0,
            "audienceLocations": [],
            "coordinators": [],
            "locked": false,
            "tags": [],
            "services": null,
            "supportType": null
        },
        {
            "id": 117102,
            "customerEventId": null,
            "version": 0,
            "name": "apiary3",
            "description": "",
            "eventType": "COMBINED",
            "customer": {
                "accountID": "1-7KLGH",
                "accountName": "Akamai Internal",
                "supportLevel": null
            },
            "start": 1380219300000,
            "end": 1380224700000,
            "createdDate": 1380133679655,
            "createdBy": "ccare2",
            "modifiedDate": 1380133679657,
            "modifiedBy": "ccare2",
            "audienceSize": 0,
            "audienceLocations": [],
            "coordinators": [],
            "locked": false,
            "tags": [],
            "services": null,
            "supportType": null
        }
    ]
}

Get an Event

This operation gets the basic event details, but does not include services associated with this event. To do that, use the Get Event with its Services operation.

GET /events/v2/{accountId}/events/{eventId}

Example: /events/v2/1–7KLGH/events/117100

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
        "id": 117100,
        "customerEventId": null,
        "version": 1,
        "name": "apiary2",
        "description": null,
        "eventType": "COMBINED",
        "customer": {
            "accountID": "1-7KLGH",
            "accountName": "Akamai Internal",
            "supportLevel": null
        },
        "start": 1380132000000,
        "end": 1380151800000,
        "createdDate": 1380132781000,
        "createdBy": "ccare2",
        "modifiedDate": 1380132781000,
        "modifiedBy": "ccare2",
        "audienceSize": 0,
        "audienceLocations": [],
        "coordinators": [],
        "locked": false,
        "tags": [],
        "services": null,
        "supportType": null
    }
}

Modify an Event, with POST

Updates a single event with the response body. This operation can also update the event’s services (e.g. streaming, site, etc.) for the given event. This service expects that the entire service list be submitted, rather than just changes (additions, removals). To load the full list, use the Get Event with its Services operation.

The request must include a version stamp fetched with the Get Event with its Services operation. If the version stamp sent in the response is different from the current version stamp, an error is raised.

Note that the request body (the updated event) may include the ID field, but this is ignored, as the ID is specified in the URL. Likewise, any session-specific data (customer ID, username, modified time, etc.) are ignored if sent in the request.

POST /events/v2/{accountId}/events/{eventId}

Example: /events/v2/1–7KLGH/events/117100

Content-Type: application/json

Request:

{
    "id": 117100,
    "customerEventId": null,
    "version": 1,
    "name": "apiary2",
    "description": null,
    "eventType": "COMBINED",
    "customer": {
        "accountID": "1-7KLGH",
        "accountName": "Akamai Internal",
        "supportLevel": null
    },
    "start": 1380132000000,
    "end": 1380151800000,
    "createdDate": 1380132781000,
    "createdBy": "ccare2",
    "modifiedDate": 1380132781000,
    "modifiedBy": "ccare2",
    "audienceSize": 0,
    "audienceLocations": [],
    "coordinators": [],
    "locked": false,
    "tags": [],
    "services": null,
    "supportType": null
}

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200

Modify an Event, with PUT

Exactly same as the previous POST call.

Updates a single event with the response body. This operation can also update the event’s services (e.g. streaming, site, etc.) for the given event. This service expects that the entire service list be submitted, rather than just changes (additions, removals). To load the full list, use the Get Event with its Services operation.

The request must include a version stamp fetched from the Get Event with its Services operation. If the version stamp sent in the response is different from the current version stamp, an error is raised.

Note that the request body (the updated event) may include the ID field, but this is ignored, as the ID used find the existing event is specified in the URL. Likewise, any session-specific data (customer ID, username, modified time, etc.) are ignored if sent in the request.

PUT /events/v2/{accountId}/events/{eventId}

Example: /events/v2/1–7KLGH/events/117100

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200

Remove an Event

Deletes the event for the given event ID. IDs that are not found are silently ignored.

DELETE /events/v2/{accountId}/events/{eventId}

Example: /events/v2/1–7KLGH/events/117100

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200 application/json

Response:

{ "status": "ok" }

Get Event with its Services

Same response as for Get an Event, but also includes the services associated with the event.

GET /events/v2/{accountId}/events/{eventId}{?services}

Example: /events/v2/1–7KLGH/events/117100?services=detail

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
services String detail Value must be detail, otherwise only returns basic event details.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
        "id": 117100,
        "customerEventId": null,
        "version": 1,
        "name": "apiary2",
        "description": null,
        "eventType": "COMBINED",
        "customer": {
            "accountID": "1-7KLGH",
            "accountName": "Akamai Internal",
            "supportLevel": null
        },
        "start": 1380132000000,
        "end": 1380151800000,
        "createdDate": 1380132781000,
        "createdBy": "ccare2",
        "modifiedDate": 1380132781000,
        "modifiedBy": "ccare2",
        "audienceSize": 0,
        "audienceLocations": [],
        "coordinators": [],
        "locked": false,
        "tags": [],
        "services": {
            "universalLiveStreams": [],
            "flashLiveStreams": [],
            "siteCPCodes": [],
            "sripConfigs": [],
            "silverlightLiveStreams": [],
            "qosmReportPackIds": [],
            "smReportPackIds": []
        },
        "supportType": null
    }
}

List Services

Fetches only the services associated with a given event, but excludes the event data itself.

GET /events/v2/{accountId}/events/{eventId}/services

Example: /events/v2/1–7KLGH/events/116140/services

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 116140 Unique identifier for the event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
        "universalLiveStreams": [
            {
                "streamId": 49207,
                "streamName": "24x7demo",
                "enabledFormats": [
                    "ADOBE_HDS",
                    "APPLE_IOS"
                ],
                "config": {
                    "configId": 306,
                    "configName": "demo",
                    "hostname": "demo-f.akamaihd.net",
                    "cpcode": {
                        "cpcode": 1111,
                        "cpcodeName": "shobanatest"
                    }
                },
                "bitrates": []
            }
        ],
        "flashLiveStreams": [],
        "siteCPCodes": [],
        "sripConfigs": [],
        "silverlightLiveStreams": [],
        "qosmReportPackIds": [],
        "smReportPackIds": []
    }
}

List Range of Events

Gets all event IDs for a given account that have an event start date within the given date range if both ends of the range are specified. If either the start or end dates are unspecified, the range is ignored. Note: This call doesn’t support paging datasets.

GET /events/v2/{accountId}/events/id{?startRange,endRange,sortField,sortOrder,startIndex,limit,customerEventId}

Example: /events/v2/1–7KLGH/events/id?startRange=1379636800000&endRange=1381636800000&sortField=start&sortOrder=asc&startIndex=0&limit=10&customerEventId=642531

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
Optional
customerEventId String 642531 Event identifier for your own use. See Customer Event ID.
endRange Number 1381636800000 End of event, specified as epoch time milliseconds.
limit Number 10 The maximum number of pagination records to include.
sortField String start The field that should be used to sort the result set.
sortOrder String asc The direction of the sort, asc for ascending or desc for descending.
startIndex Number 0 The zero-origin index at which to start the batch of paginated results.
startRange Number 1379636800000 Start of event, specified as epoch time milliseconds.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": [
        111159, 114200, 111161, 112259, 112256, 112258, 112260,
        116138, 116140, 117101, 117114, 117102, 117103, 117104, 117105
    ]
}

List Events in Progress

Gets events that are currently live for the customer associated with this specified account ID. More specifically, the events that have a start time less than or equal to the current time, and an end time greater than or equal to the current time.

GET /events/v2/{accountId}/events/live

Example: /events/v2/1–7KLGH/events/live

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
        "resultsPerPage": 3,
        "currentPage": 1,
        "totalResultsCount": 3,
        "totalPageCount": 1,
        "sortKey": "START",
        "sortOrder": "ASC",
        "filters": {
            "endRange": null,
            "startRange": null
        },
        "dataSet": [
            {
                "id": 116140,
                "customerEventId": null,
                "version": 10,
                "name": "apiary",
                "description": null,
                "eventType": "STREAMING",
                "customer": {
                    "accountID": "1-7KLGH",
                    "accountName": "Akamai Internal",
                    "supportLevel": null
                },
                "start": 1380049200000,
                "end": 1380310200000,
                "createdDate": 1380050125000,
                "createdBy": "ccare2",
                "modifiedDate": 1380209381000,
                "modifiedBy": "ccare2",
                "audienceSize": 0,
                "audienceLocations": [ "US" ],
                "coordinators": [],
                "locked": false,
                "tags": [],
                "services": null,
                "supportType": null
            },
            {
                "id": 117114,
                "customerEventId": null,
                "version": 1,
                "name": "apiary2",
                "description": null,
                "eventType": "COMBINED",
                "customer": {
                    "accountID": "1-7KLGH",
                    "accountName": "Akamai Internal",
                    "supportLevel": null
                },
                "start": 1380159000000,
                "end": 1380247200000,
                "createdDate": 1380159339000,
                "createdBy": "ccare2",
                "modifiedDate": 1380159339000,
                "modifiedBy": "ccare2",
                "audienceSize": 0,
                "audienceLocations": [],
                "coordinators": [],
                "locked": false,
                "tags": [],
                "services": null,
                "supportType": null
            }
        ]
    }
}

List Events Current for Specific Time

Gets events that are live for the given account at the specified epoch time. More specifically, the events that have a start time less than or equal to the specified time, and an end time greater than or equal to the specified time.

GET /events/v2/{accountId}/events/live/{time}

Example: /events/v2/1–7KLGH/events/live/1380310100000

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
Optional
time Number 1380310100000 The epoch time.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
        "resultsPerPage": 2,
        "currentPage": 1,
        "totalResultsCount": 2,
        "totalPageCount": 1,
        "sortKey": "START",
        "sortOrder": "ASC",
        "filters": {
            "endRange": null,
            "startRange": null
        },
        "dataSet": [
            {
                "id": 116140,
                "customerEventId": null,
                "version": 10,
                "name": "apiary",
                "description": null,
                "eventType": "STREAMING",
                "customer": {
                    "accountID": "1-7KLGH",
                    "accountName": "Akamai Internal",
                    "supportLevel": null
                },
                "start": 1380049200000,
                "end": 1380310200000,
                "createdDate": 1380050125000,
                "createdBy": "ccare2",
                "modifiedDate": 1380209381000,
                "modifiedBy": "ccare2",
                "audienceSize": 0,
                "audienceLocations": [ "US" ],
                "coordinators": [],
                "locked": false,
                "tags": [],
                "services": null,
                "supportType": null
            },
            {
                "id": 117103,
                "customerEventId": null,
                "version": 0,
                "name": "apiary3",
                "description": null,
                "eventType": "COMBINED",
                "customer": {
                    "accountID": "1-7KLGH",
                    "accountName": "Akamai Internal",
                    "supportLevel": null
                },
                "start": 1380305700000,
                "end": 1380311100000,
                "createdDate": 1380133679000,
                "createdBy": "ccare2",
                "modifiedDate": 1380133679000,
                "modifiedBy": "ccare2",
                "audienceSize": 0,
                "audienceLocations": [],
                "coordinators": [],
                "locked": false,
                "tags": [],
                "services": null,
                "supportType": null
            }
        ]
    }
}

List Upcoming Events

Gets events that are upcoming for the specified account. More specifically, the events that have a start time greater than the current time and less than a given range.

GET /events/v2/{accountId}/events/upcoming

Example: /events/v2/1–7KLGH/events/upcoming

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
        "resultsPerPage": 3,
        "currentPage": 1,
        "totalResultsCount": 3,
        "totalPageCount": 1,
        "sortKey": "START",
        "sortOrder": "ASC",
        "filters": {
            "endRange": null,
            "startRange": null
        },
        "dataSet": [
            {
                "id": 116140,
                "customerEventId": null,
                "version": 10,
                "name": "apiary",
                "description": null,
                "eventType": "STREAMING",
                "customer": {
                    "accountID": "1-7KLGH",
                    "accountName": "Akamai Internal",
                    "supportLevel": null
                },
                "start": 1380049200000,
                "end": 1380310200000,
                "createdDate": 1380050125000,
                "createdBy": "ccare2",
                "modifiedDate": 1380209381000,
                "modifiedBy": "ccare2",
                "audienceSize": 0,
                "audienceLocations": [ "US" ],
                "coordinators": [],
                "locked": false,
                "tags": [],
                "services": null,
                "supportType": null
            },
            {
                "id": 117114,
                "customerEventId": null,
                "version": 1,
                "name": "apiary\"",
                "description": null,
                "eventType": "COMBINED",
                "customer": {
                    "accountID": "1-7KLGH",
                    "accountName": "Akamai Internal",
                    "supportLevel": null
                },
                "start": 1380159000000,
                "end": 1380247200000,
                "createdDate": 1380159339000,
                "createdBy": "ccare2",
                "modifiedDate": 1380159339000,
                "modifiedBy": "ccare2",
                "audienceSize": 0,
                "audienceLocations": [],
                "coordinators": [],
                "locked": false,
                "tags": [],
                "services": null,
                "supportType": null
            },
            {
                "id": 117102,
                "customerEventId": null,
                "version": 0,
                "name": "apiary3",
                "description": null,
                "eventType": "COMBINED",
                "customer": {
                    "accountID": "1-7KLGH",
                    "accountName": "Akamai Internal",
                    "supportLevel": null
                },
                "start": 1380219300000,
                "end": 1380224700000,
                "createdDate": 1380133679000,
                "createdBy": "ccare2",
                "modifiedDate": 1380133679000,
                "modifiedBy": "ccare2",
                "audienceSize": 0,
                "audienceLocations": [],
                "coordinators": [],
                "locked": false,
                "tags": [],
                "services": null,
                "supportType": null
            }
        ]
    }
}

List Impending Events

Gets events that are upcoming for the given account at the specified time range. More specifically, the events that are live between the current time and (current + range) time.

GET /events/v2/{accountId}/events/upcoming/{rangeInHours}

Example: /events/v2/1–7KLGH/events/upcoming/26

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
Optional
rangeInHours Number 26 The range of data in number of hours.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
        "resultsPerPage": 2,
        "currentPage": 1,
        "totalResultsCount": 2,
        "totalPageCount": 1,
        "sortKey": "START",
        "sortOrder": "ASC",
        "filters": {
            "endRange": null,
            "startRange": null
        },
        "dataSet": [
            {
                "id": 117102,
                "customerEventId": null,
                "version": 0,
                "name": "apiary3",
                "description": null,
                "eventType": "COMBINED",
                "customer": {
                    "accountID": "1-7KLGH",
                    "accountName": "Akamai Internal",
                    "supportLevel": null
                },
                "start": 1380219300000,
                "end": 1380224700000,
                "createdDate": 1380133679000,
                "createdBy": "ccare2",
                "modifiedDate": 1380133679000,
                "modifiedBy": "ccare2",
                "audienceSize": 0,
                "audienceLocations": [],
                "coordinators": [],
                "locked": false,
                "tags": [],
                "services": null,
                "supportType": null
            },
            {
                "id": 117103,
                "customerEventId": null,
                "version": 0,
                "name": "apiary3",
                "description": null,
                "eventType": "COMBINED",
                "customer": {
                    "accountID": "1-7KLGH",
                    "accountName": "Akamai Internal",
                    "supportLevel": null
                },
                "start": 1380305700000,
                "end": 1380311100000,
                "createdDate": 1380133679000,
                "createdBy": "ccare2",
                "modifiedDate": 1380133679000,
                "modifiedBy": "ccare2",
                "audienceSize": 0,
                "audienceLocations": [],
                "coordinators": [],
                "locked": false,
                "tags": [],
                "services": null,
                "supportType": null
            }
        ]
    }
}

List Alerts

Returns all the Alerts associated with the CP codes for the current account. Times are converted to the user’s timezone based on their user account. This operation determines the CP codes associated with the services of an event, then determines the correct Alert definition, then pulls only those alerts from AMS. Many CP codes map to an Alert, and if that Alert fires it is returned. It’s not possible at this time to determine which CP code triggered the Alert.

GET /events/v2/{accountId}/events/alerts

Example: /events/v2/1–7KLGH/events/alerts

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": [
        {
            "id": 3333,
            "type": "High Traffic -- Content Delivery",
            "name": "Hightraffic_test",
            "service": "HTTP Content Delivery",
            "startDate": 1365535070000
        },
        {
            "id": 3011,
            "type": "High Traffic -- Secure Content Delivery",
            "name": "Hightraffic_test",
            "service": "HTTP Content Delivery",
            "startDate": 1365535023000
        }
    ]
}

List Alerts per Event

Returns all the Alerts associated with the CP codes for this event. Times are converted to the user’s timezone based on their user account. This operation determines the CP codes associated with the services of an event, then determines the correct Alert definition, then pulls only those alerts from AMS. Many CP codes map to an Alert, and if that alert fires it is returned. It’s not possible at this time to determine which CP code triggered the Alert.

GET /events/v2/{accountId}/events/{eventId}/alerts

Example: /events/v2/1–7KLGH/events/117104/alerts

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117104 Unique identifier for the event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": []
}

Get Event Traffic Data by CP Code

Fetches traffic data for provided CP codes. The resources in this class are intended mainly for use with site traffic. While they may return traffic data for HD streams, this is not guaranteed, nor is the data guaranteed to be accurate. Data is returned as data and time pairs, where data is an array of potentially multiple values. Time is the Unix epoch time (in milliseconds), and data is always represented in kilobits per second. Data may have multiple values in many cases; for example, HTTP status code traffic data.

Gets the sum of all edge bandwidth data for all CP codes that are associated with the event. The data is returned in kilobits per second.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/edge/bandwidth

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/edge/bandwidth

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
        "labels": [],
        "graphType": "line",
        "scale": "KBITS",
        "data": [
            {
                "d": [ 2812241.9488000004 ],
                "t": 1344774600000
            },
            {
                "d": [ 2700129.2544 ],
                "t": 1344774900000
            },
            {
                "d": [ 2629139.4256 ],
                "t": 1344775200000
            }
        ]
    }
}

Get Edge Bandwidth per CP Code

Gets the edge bandwidth data for the given CP code, if that CP code is associated with the given event ID. The data is returned in kilobits per second.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/edge/bandwidth/{cpcode}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/edge/bandwidth/24601

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
cpcode Number 24601 The CP code associated with the given event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "labels": [],
       "graphType": "line",
       "scale": "KBITS",
       "data": [
          {
             "d": [ 2812241.9488000004 ],
             "t": 1344774600000
          },
          {
             "d": [ 2700129.2544 ],
             "t": 1344774900000
          },
          {
             "d": [ 2629139.4256 ],
             "t": 1344775200000
          }
       ]
    }
 }

Get Event’s Edge Requests, per CP Code

Gets the number of edge requests for the given CP code, which must be associated with the given event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/edge/requests/{cpcode}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/edge/requests/24601

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
cpcode Number 24601 The CP code associated with the given event.

Status 200

Get Event’s Status Totals

For each CP code associated with the given event, gets the edge total of each HTTP status code category (i.e. 1xx, 2xx, 3xx, 4xx, 5xx). The data has multiple values in the data array, where the first element represents the count for 1xx responses and the last element is 5xx, with all elements in between in order. The data returned represents the number of completed HTTP request/responses (served from the edge) for that status code range.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/edge/status

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/edge/status

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "data": [
          {
             "t": 1344871200000,
             "d": [ 0.0, 0.1, 0.0, 0.1, 0.0 ]
          },
          {
             "t": 1344871500000,
             "d": [ 0.0, 0.2, 0.0, 0.1, 0.0 ]
          },
          {
             "t": 1344871800000,
             "d": [ 0.0, 0.1, 0.0, 0.2, 0.0 ]
          }
       ],
       "labels": [ "1xx", "2xx", "3xx", "4xx", "5xx" ],
       "graphType": "stacked",
       "scale": "HITS"
    }
 }

Get Event’s Status Totals per CP Code

For for the given CP code (which must be associated with the given event ID), gets the number of completed HTTP requests received for each HTTP status code range (i.e. 1xx, 2xx, 3xx, 4xx, 5xx). The data has multiple values in the data array, where the first element represents the count for 1xx responses and the last element is 5xx, with all elements in between in order. The data returned represents the number of completed HTTP request/responses for that status code range.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/edge/status/{cpcode}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/edge/status/24601

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
cpcode Number 24601 The CP code associated with the given event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "data": [
          {
             "t": 1344871200000,
             "d": [ 0.0, 0.1, 0.0, 0.1, 0.0 ]
          },
          {
             "t": 1344871500000,
             "d": [ 0.0, 0.2, 0.0, 0.1, 0.0 ]
          },
          {
             "t": 1344871800000,
             "d": [ 0.0, 0.1, 0.0, 0.2, 0.0 ]
          }
       ],
       "labels": [ "1xx", "2xx", "3xx", "4xx", "5xx" ],
       "graphType": "stacked",
       "scale": "HITS"
    }
 }

Get Event’s Bandwidth Data

Gets the sum of all origin bandwidth data for all CP codes that are associated with the event. The data is returned in kilobits per second.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/origin/bandwidth

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/origin/bandwidth

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "labels": [],
       "graphType": "line",
       "scale": "KBITS",
       "data": [
          {
             "d": [ 2812241.9488000004 ],
             "t": 1344774600000
          },
          {
             "d": [ 2700129.2544 ],
             "t": 1344774900000
          },
          {
             "d": [ 2629139.4256 ],
             "t": 1344775200000
          }
       ]
    }
 }

Get Event’s Bandwidth Data per CP Code

Gets the origin bandwidth data for the given CP code, if that CP code is associated with the given event ID. The data is returned in kilobits per second.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/origin/bandwidth/{cpcode}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/origin/bandwidth/24601

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
cpcode Number 24601 The CP code associated with the given event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "labels": [],
       "graphType": "line",
       "scale": "KBITS",
       "data": [
          {
             "d": [ 2812241.9488000004 ],
             "t": 1344774600000
          },
          {
             "d": [ 2700129.2544 ],
             "t": 1344774900000
          },
          {
             "d": [ 2629139.4256 ],
             "t": 1344775200000
          }
       ]
    }
 }

Get Event’s Origin Requests

Gets the number of origin requests for all CP codes associated with the given event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/origin/requests

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/origin/requests

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200

Get Event’s Origin Requests per CP Code

Gets the number of origin requests for the given CP code, which must be associated with the given event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/origin/requests/{cpcode}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/origin/requests/24601

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
cpcode Number 24601 The CP code associated with the given event.

Status 200

Get Event’s Origin Statuses

For all CP codes associated with the given event, gets the origin total for each HTTP status code category (i.e. 1xx, 2xx, 3xx, 4xx, 5xx). The data has multiple values in the data array, where the first element represents the count for 1xx responses and the last element is 5xx, with all elements in between in order. The data returned represents the number of completed HTTP request/responses (served from the origin) for that status code range.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/origin/status

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/origin/status

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "data": [
          {
             "t": 1344871200000,
             "d": [ 0.0, 0.1, 0.0, 0.1, 0.0 ]
          },
          {
             "t": 1344871500000,
             "d": [ 0.0, 0.2, 0.0, 0.1, 0.0 ]
          },
          {
             "t": 1344871800000,
             "d": [ 0.0, 0.1, 0.0, 0.2, 0.0 ]
          }
       ],
       "labels": [ "1xx", "2xx", "3xx", "4xx", "5xx" ],
       "graphType": "stacked",
       "scale": "HITS"
    }
 }

Get Event’s Origin Statuses per CP Code

For for the given CP code (which must be associated with the given event ID), gets the number of completed HTTP origin requests received for each HTTP status code range (i.e. 1xx, 2xx, 3xx, 4xx, 5xx). The data has multiple values in the data array, where the first element represents the count for 1xx responses and the last element is 5xx, with all elements in between in order. The data returned represents the number of completed HTTP request/responses for that status code range.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/origin/status/{cpcode}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/origin/status/24601

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
cpcode Number 24601 The CP code associated with the given event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "data": [
          {
             "t": 1344871200000,
             "d": [ 0.0, 0.1, 0.0, 0.1, 0.0 ]
          },
          {
             "t": 1344871500000,
             "d": [ 0.0, 0.2, 0.0, 0.1, 0.0 ]
          },
          {
             "t": 1344871800000,
             "d": [ 0.0, 0.1, 0.0, 0.2, 0.0 ]
          }
       ],
       "labels": [ "1xx", "2xx", "3xx", "4xx", "5xx" ],
       "graphType": "stacked",
       "scale": "HITS"
    }
}

Get Event’s I/O Bandwidth

Gets the ingress/origin (incoming) and egress/edge (outgoing) bandwidth data for all CP codes that are associated with the event. The data is returned in kilobits per second.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/bandwidth

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/bandwidth

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "labels": [],
       "graphType": "line",
       "scale": "KBITS",
       "data": [
          {
             "d": [ 2812241.9488000004 ],
             "t": 1344774600000
          },
          {
             "d": [ 2700129.2544 ],
             "t": 1344774900000
          },
          {
             "d": [ 2629139.4256 ],
             "t": 1344775200000
          }
       ]
    }
 }

Get Event’s I/O Bandwidth per CP Code

Gets the ingress/origin (incoming) and egress/edge (outgoing) bandwidth data for a single CP code that is associated with the event. The data is returned in kilobits per second.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/bandwidth/{cpcode}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/bandwidth/24601

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
cpcode Number 24601 The CP code associated with the given event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "labels": [],
       "graphType": "line",
       "scale": "KBITS",
       "data": [
          {
             "d": [ 2812241.9488000004 ],
             "t": 1344774600000
          },
          {
             "d": [ 2700129.2544 ],
             "t": 1344774900000
          },
          {
             "d": [ 2629139.4256 ],
             "t": 1344775200000
          }
       ]
    }
 }

Get Event’s Requests

Gets the origin and edge request data for all CP codes associated with the given event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/requests

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/requests

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200

Get Event’s Requests per CP Code

Gets the origin and edge request data for the given CP code, which must be associated with the given event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/cpcode/requests/{cpcode}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/cpcode/requests/24601

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
cpcode Number 24601 The CP code associated with the given event.

Status 200

Get Entry Point Data for Flash Live Streams

Gets entry point data for all Flash Live streams of a specified event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/entrypoint/flashlive

Example: /events/v2/1–7KLGH/events/117100/trafficdata/entrypoint/flashlive

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
        "dataSet": [
            {
                "streamId": 90027,
                "primary": [
                    {
                        "publishedStreamName": "stream@230",
                        "encoderIP": "49",
                        "entryPointIP": "664",
                        "publishedBitrate": 431
                    }
                ],
                "backup": [
                    {
                        "publishedStreamName": "stream@230",
                        "encoderIP": "49",
                        "entryPointIP": "664",
                        "publishedBitrate": 431
                    }
                ]
            }
        ]
    }
}

Get Entry Point Data for a Flash Live Stream

Gets entry point data for the given Flash Live stream, which must exist in the specified event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/entrypoint/flashlive/{streamId}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/entrypoint/flashlive/90027

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
streamId Number 90027 Unique identifier for the stream.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
        "dataSet": [
            {
                "streamId": 90027,
                "primary": [
                    {
                        "publishedStreamName": "stream@230",
                        "encoderIP": "49",
                        "entryPointIP": "664",
                        "publishedBitrate": 431
                    }
                ],
                "backup": [
                    {
                        "publishedStreamName": "stream@230",
                        "encoderIP": "49",
                        "entryPointIP": "664",
                        "publishedBitrate": 431
                    }
                ]
            }
        ]
    }
}

Get Entry Point Data for Universal Live Streams

Gets entry point data for all Universal Live streams of a specified event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/entrypoint/universallive

Example: /events/v2/1–7KLGH/events/117100/trafficdata/entrypoint/universallive

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
        "dataSet": [
            {
                "streamId": 90027,
                "primary": [
                    {
                        "publishedStreamName": "stream@230",
                        "encoderIP": "49",
                        "entryPointIP": "664",
                        "publishedBitrate": 431
                    }
                ],
                "backup": [
                    {
                        "publishedStreamName": "stream@230",
                        "encoderIP": "49",
                        "entryPointIP": "664",
                        "publishedBitrate": 431
                    }
                ]
            }
        ]
    }
}

Get Entry Point Data for a Universal Live Stream

Gets entry point data for the given Universal Live stream, which must exist in the specified event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/entrypoint/universallive/{streamId}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/entrypoint/universallive/90027

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
streamId Number 90027 Unique identifier for the stream.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
        "dataSet": [
            {
                "streamId": 90027,
                "primary": [
                    {
                        "publishedStreamName": "stream@230",
                        "encoderIP": "49",
                        "entryPointIP": "664",
                        "publishedBitrate": 431
                    }
                ],
                "backup": [
                    {
                        "publishedStreamName": "stream@230",
                        "encoderIP": "49",
                        "entryPointIP": "664",
                        "publishedBitrate": 431
                    }
                ]
            }
        ]
    }
}

Get Aggregate Data for Flash Live Streams

Returns the aggregate data for all traditional Flash Live streams in this event. All available data for the duration of the event is returned.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/fl/egressbw

Example: /events/v2/1–7KLGH/events/117100/trafficdata/fl/egressbw

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "labels": [],
       "graphType": "line",
       "scale": "KBITS",
       "data": [
          {
             "d": [ 2812241.9488000004 ],
             "t": 1344774600000
          },
          {
             "d": [ 2700129.2544 ],
             "t": 1344774900000
          },
          {
             "d": [ 2629139.4256 ],
             "t": 1344775200000
          }
       ]
    }
}

Get Aggregate Data for a Flash Live Stream

Gets the aggregate data for the given stream, which must exist in the specified event. All available data for the duration of the event is returned.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/fl/egressbw/{streamId}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/fl/egressbw/90027

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
streamId Number 90027 Unique identifier for the stream.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "labels": [],
       "graphType": "line",
       "scale": "KBITS",
       "data": [
          {
             "d": [ 2812241.9488000004 ],
             "t": 1344774600000
          },
          {
             "d": [ 2700129.2544 ],
             "t": 1344774900000
          },
          {
             "d": [ 2629139.4256 ],
             "t": 1344775200000
          }
       ]
    }
}

Get Request Data for Flash Live Streams

Gets the aggregate data for the given stream, which must exist in the specified event. All available data for the duration of the event is returned.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/fl/egressrequests

Example: /events/v2/1–7KLGH/events/117100/trafficdata/fl/egressrequests

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200

Get Request Data for a Flash Live Stream

Gets the aggregate data for the given stream, which must exist in the specified event. All available data for the duration of the event is returned.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/fl/egressrequests/{streamId}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/fl/egressrequests/90027

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
streamId Number 90027 Unique identifier for the stream.

Status 200

Get Viewer Data for Flash Live Streams

Gets the total number of viewers for the Flash Live streams associated with the given event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/fl/egressviewers

Example: /events/v2/1–7KLGH/events/117100/trafficdata/fl/egressviewers

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200

Get Viewer Data for a Flash Live Stream

Gets the total number of viewers for the traditional Flash Live streams associated with the given event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/fl/egressviewers/{streamId}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/fl/egressviewers/90027

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
streamId Number 90027 Unique identifier for the stream.

Status 200

Get Aggregate Data for Silverlight Live Streams

Returns the aggregate data for all HD Silverlight Live streams in this event. All available data for the duration of the event is returned.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressbw

Example: /events/v2/1–7KLGH/events/117100/trafficdata/hdsll/egressbw

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "labels": [],
       "graphType": "line",
       "scale": "KBITS",
       "data": [
          {
             "d": [ 2812241.9488000004 ],
             "t": 1344774600000
          },
          {
             "d": [ 2700129.2544 ],
             "t": 1344774900000
          },
          {
             "d": [ 2629139.4256 ],
             "t": 1344775200000
          }
       ]
    }
}

Get Silverlight Live Stream

Gets the aggregate data for the given stream, which must exist in the specified event. All available data for the duration of the event is returned. The Silverlight Stream traffic info is pulled from DAS by CP codes instead of streamId.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressbw/{streamId}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/hdsll/egressbw/90027

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
streamId Number 90027 Unique identifier for the stream.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "labels": [],
       "graphType": "line",
       "scale": "KBITS",
       "data": [
          {
             "d": [ 2812241.9488000004 ],
             "t": 1344774600000
          },
          {
             "d": [ 2700129.2544 ],
             "t": 1344774900000
          },
          {
             "d": [ 2629139.4256 ],
             "t": 1344775200000
          }
       ]
    }
}

Get Request Data for Silverlight Live Streams

Gets the aggregate data for the given stream, which must exist in the specified event. All available data for the duration of the event is returned.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressrequests

Example: /events/v2/1–7KLGH/events/117100/trafficdata/hdsll/egressrequests

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200

Get Request Data for a Silverlight Live Stream

Gets the aggregate data for the given stream, which must exist in the specified event. All available data for the duration of the event is returned.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressrequests/{streamId}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/hdsll/egressrequests/90027

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
streamId Number 90027 Unique identifier for the stream.

Status 200

Get Status Data for Silverlight Live Streams

Returns the aggregate status data for all HD Silverlight streams in this event. All available data for the duration of the event is returned.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressstatus

Example: /events/v2/1–7KLGH/events/117100/trafficdata/hdsll/egressstatus

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "data": [
          {
             "t": 1344871200000,
             "d": [ 0.0, 0.1, 0.0, 0.1, 0.0 ]
          },
          {
             "t": 1344871500000,
             "d": [ 0.0, 0.2, 0.0, 0.1, 0.0 ]
          },
          {
             "t": 1344871800000,
             "d": [ 0.0, 0.1, 0.0, 0.2, 0.0 ]
          }
       ],
       "labels": [ "1xx", "2xx", "3xx", "4xx", "5xx" ],
       "graphType": "stacked",
       "scale": "HITS"
    }
 }

Get Status Data for a Silverlight Live Stream

Gets the aggregate data for the given stream, which must exist in the specified event. All available data for the duration of the event is returned.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressstatus/{streamId}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/hdsll/egressstatus/90027

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
streamId Number 90027 Unique identifier for the stream.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "data": [
          {
             "t": 1344871200000,
             "d": [ 0.0, 0.1, 0.0, 0.1, 0.0 ]
          },
          {
             "t": 1344871500000,
             "d": [ 0.0, 0.2, 0.0, 0.1, 0.0 ]
          },
          {
             "t": 1344871800000,
             "d": [ 0.0, 0.1, 0.0, 0.2, 0.0 ]
          }
       ],
       "labels": [ "1xx", "2xx", "3xx", "4xx", "5xx" ],
       "graphType": "stacked",
       "scale": "HITS"
    }
 }

Get Viewer Data for Silverlight Live Streams

Gets the total number of viewers for the HD Flash Live streams associated with the given event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressviewers

Example: /events/v2/1–7KLGH/events/117100/trafficdata/hdsll/egressviewers

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200

Get Viewer Data for a Silverlight Live Stream

Gets the total number of viewers for the HD Flash Live streams associated with the given event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/hdsll/egressviewers/{streamId}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/hdsll/egressviewers/90027

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
streamId Number 90027 Unique identifier for the stream.

Status 200

Get SRIP Connections

Gets the total number of SRIP connections for a given event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/srip/connections

Example: /events/v2/1–7KLGH/events/117100/trafficdata/srip/connections

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200

Get SRIP Connections per Slot

Gets the total number of SRIP connections for a given, specific slot ID. This slot must be associated with the event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/srip/connections/{slotId}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/srip/connections/123

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
slotId String 123 Unique identifier for the slot.

Status 200

Get SRIP Bandwidth

Gets the SRIP bandwidth for a given event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/srip/sourcebandwidth

Example: /events/v2/1–7KLGH/events/117100/trafficdata/srip/sourcebandwidth

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.

Status 200

Get SRIP Bandwidth per Slot

Gets the SRIP bandwidth for a given slot ID. This slot must be associated with the event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/srip/sourcebandwidth/{slotId}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/srip/sourcebandwidth/123

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
slotId String 123 Unique identifier for the slot.

Status 200

Get Edge Bandwidth for Universal Live Streams

Gets the Edge bandwidth, grouped by delivery format, for all Universal Live streams associated with the given event. Optionally, a deliveryFormat query string parameter can be added to return data only for that given format.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/universallive/edge/bandwidth{?range,deliveryFormat}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/universallive/edge/bandwidth?range=120&deliveryFormat=APPLE_IOS

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
deliveryFormat String APPLE_IOS The stream format, discussed above.
range String 120 The range, in minutes, of data to retrieve. If omitted, all data for the duration of the event is returned.

Status 200 application/json

Response:

{
   "status": "ok",
   "contents": {
      "data": [
         {
            "t": 1364236200,
            "d": [ 383.221, 1676.8651, 0 ]
         },
         {
            "t": 1374236500,
            "d": [ 0, 790.439, 1.0934534 ]
         }
      ],
      "labels": [ "ADOBE_HDS", "APPLE_IOS", "AKAMAI_HDFLASH_ONE" ],
      "graphType": "stacked",
      "scale": "KBITS"
   }
}

Get Edge Bandwidth for a Universal Live Stream

Gets the Edge bandwidth, grouped by delivery format, for the provided Universal Live stream. Optionally, a deliveryFormat query string parameter can be added to return only data for that given format. The stream must be associated with the specified event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/universallive/edge/bandwidth/{streamId}{?range,deliveryFormat}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/universallive/edge/bandwidth/90027?range=120&deliveryFormat=APPLE_IOS

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
deliveryFormat String APPLE_IOS The stream format, discussed above.
range String 120 The range, in minutes, of data to retrieve. If omitted, all data for the duration of the event is returned.
streamId Number 90027 Unique identifier for the stream.

Status 200 application/json

Response:

{
   "status": "ok",
   "contents": {
      "data": [
         {
            "t": 1364236200,
            "d": [ 383.221, 1676.8651, 0 ]
         },
         {
            "t": 1374236500,
            "d": [ 0, 790.439, 1.0934534 ]
         }
      ],
      "labels": [ "ADOBE_HDS", "APPLE_IOS", "AKAMAI_HDFLASH_ONE" ],
      "graphType": "stacked",
      "scale": "KBITS"
   }
}

Get Edge Requests for Universal Live Streams

Gets the Edge requests, grouped by delivery format, for all Universal Live streams associated with the given event. Optionally, a deliveryFormat query string parameter can be added to return only data for that given format. Note that the results do not include data for HD Flash Live 1.0 delivery, as the request metric is not supported for that format.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/universallive/edge/requests{?range,deliveryFormat}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/universallive/edge/requests?range=120&deliveryFormat=APPLE_IOS

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
deliveryFormat String APPLE_IOS The stream format, discussed above.
range String 120 The range, in minutes, of data to retrieve. If omitted, all data for the duration of the event is returned.

Status 200

Get Edge Requests for a Universal Live Stream

Gets the Edge requests, grouped by delivery format, for the provided Universal Live stream. Optionally, a deliveryFormat query string parameter can be added to return only data for that given format. The stream must be associated with the specified event. Note that the results do not include data for HD Flash Live 1.0 delivery, as the request metric is not supported for that format.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/universallive/edge/requests/{streamId}{?range,deliveryFormat}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/universallive/edge/requests/90027?range=120&deliveryFormat=APPLE_IOS

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
deliveryFormat String APPLE_IOS The stream format, discussed above.
range String 120 The range, in minutes, of data to retrieve. If omitted, all data for the duration of the event is returned.
streamId Number 90027 Unique identifier for the stream.

Status 200

Get Edge Viewers for Universal Live Streams

Gets the Edge viewers, grouped by delivery format, for all Universal Live streams associated with the given event. Optionally, a deliveryFormat query string parameter can be added to only return data for that given format.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/universallive/edge/viewers{?range,deliveryFormat}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/universallive/edge/viewers?range=120&deliveryFormat=APPLE_IOS

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
deliveryFormat String APPLE_IOS The stream format, discussed above.
range String 120 The range, in minutes, of data to retrieve. If omitted, all data for the duration of the event is returned.

Status 200

Get Edge Viewers for a Universal Live Stream

Gets the Edge viewers, grouped by delivery format, for the provided Universal Live stream. Optionally, a deliveryFormat query string parameter can be added to only return data for that given format. The stream must be associated with the specified event.

GET /events/v2/{accountId}/events/{eventId}/trafficdata/universallive/edge/viewers/{streamId}{?range,deliveryFormat}

Example: /events/v2/1–7KLGH/events/117100/trafficdata/universallive/edge/viewers/90027?range=120&deliveryFormat=APPLE_IOS

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
deliveryFormat String APPLE_IOS The stream format, discussed above.
range String 120 The range, in minutes, of data to retrieve. If omitted, all data for the duration of the event is returned.
streamId Number 90027 Unique identifier for the stream.

Status 200

Get Audience Size

Pulls audience data for a given QoS Report pack.

NOTE: Data is limited to a maximum of 1.5 days. At present the only timeAggInterval available is 60.

GET /events/v2/{accountId}/events/{eventId}/qos/audiencesize{?startDate,endDate,reportPackID,timeAggInterval}

Example: /events/v2/1–7KLGH/events/117100/qos/audiencesize?startDate=1365535070000&endDate=1468800000&reportPackID=321&timeAggInterval=60

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
endDate String 1468800000 The end date.
reportPackID String 321 Unique numeric identifier for the report pack.
startDate String 1365535070000 The start date.
timeAggInterval Number 60 Defaults to 60 minutes.

Status 200

Get Rebuffering Data

Pulls the rebuffering percentage for a given QoS Report pack.

NOTE: Data is limited to a maximum of 1.5 days. At present the only timeAggInterval available is 60.

GET /events/v2/{accountId}/events/{eventId}/qos/rebuffering{?startDate,endDate,reportPackID,timeAggInterval}

Example: /events/v2/1–7KLGH/events/117100/qos/rebuffering?startDate=1365535070000&endDate=1468800000&reportPackID=321&timeAggInterval=60

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
endDate String 1468800000 The end date.
reportPackID String 321 Unique numeric identifier for the report pack.
startDate String 1365535070000 The start date.
timeAggInterval Number 60 Defaults to 60 minutes.

Status 200

Get Report Packs

Pulls only QoS and WAF/Security Monitor Report Packs Types Support (clientside_qos1_live, clientside_qos1_sm).

GET /events/v2/{accountId}/qos/getReportPacks

Example: /events/v2/1–7KLGH/qos/getReportPacks

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.

Status 200

Get Request Denied Data

Pulls the request denied data for a given WAF/Security Monitor Report pack.

NOTE: Data is limited to a maximum of 1.5 days. At present the only timeAggInterval available is 60.

GET /events/v2/{accountId}/events/{eventId}/qos_sm/requestdenied{?startDate,endDate,reportPackID,timeAggInterval}

Example: /events/v2/1–7KLGH/events/117100/qos_sm/requestdenied?startDate=1365535070000&endDate=1468800000&reportPackID=321&timeAggInterval=60

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
endDate String 1468800000 The end date.
reportPackID String 321 Unique numeric identifier for the report pack.
startDate String 1365535070000 The start date.
timeAggInterval Number 60 Defaults to 60 minutes.

Status 200

Get Request Warned Data

Pulls the request warned data for a given WAF/Security Monitor Report pack.

NOTE: Data is limited to a maximum of 1.5 days. At present the only timeAggInterval available is 60.

GET /events/v2/{accountId}/events/{eventId}/qos_sm/requestwarned{?startDate,endDate,reportPackID,timeAggInterval}

Example: /events/v2/1–7KLGH/events/117100/qos_sm/requestwarned?startDate=1365535070000&endDate=1468800000&reportPackID=321&timeAggInterval=60

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
endDate String 1468800000 The end date.
reportPackID String 321 Unique numeric identifier for the report pack.
startDate String 1365535070000 The start date.
timeAggInterval Number 60 Defaults to 60 minutes.

Status 200

Get Rules Triggered Data

Pulls the rules triggered data for a given WAF/Security Monitor Report pack.

NOTE: Data is limited to a maximum of 1.5 days. At present the only timeAggInterval available is 60.

GET /events/v2/{accountId}/events/{eventId}/qos_sm/rulestriggered{?startDate,endDate,reportPackID,timeAggInterval}

Example: /events/v2/1–7KLGH/events/117100/qos_sm/rulestriggered?startDate=1365535070000&endDate=1468800000&reportPackID=321&timeAggInterval=60

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
endDate String 1468800000 The end date.
reportPackID String 321 Unique numeric identifier for the report pack.
startDate String 1365535070000 The start date.
timeAggInterval Number 60 Defaults to 60 minutes.

Status 200

Get Startup Time Data

Pulls Start up time data for a given QoS Report pack.

NOTE: Data is limited to a maximum of 1.5 days. At present the only timeAggInterval available is 60.

GET /events/v2/{accountId}/events/{eventId}/qos/startuptime{?startDate,endDate,reportPackID,timeAggInterval}

Example: /events/v2/1–7KLGH/events/117100/qos/startuptime?startDate=1365535070000&endDate=1468800000&reportPackID=321&timeAggInterval=60

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
endDate String 1468800000 The end date.
reportPackID String 321 Unique numeric identifier for the report pack.
startDate String 1365535070000 The start date.
timeAggInterval Number 60 Defaults to 60 minutes.

Status 200

Get Successful Attempts Data

Pulls Successful Attempts Data for a given QoS Report pack.

NOTE: Data is limited to a maximum of 1.5 days. At present the only timeAggInterval available is 60.

GET /events/v2/{accountId}/events/{eventId}/qos/successfulattempts{?startDate,endDate,reportPackID,timeAggInterval}

Example: /events/v2/1–7KLGH/events/117100/qos/successfulattempts?startDate=1365535070000&endDate=1468800000&reportPackID=321&timeAggInterval=60

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
eventId Number 117100 Unique identifier for the event.
Optional
endDate String 1468800000 The end date.
reportPackID String 321 Unique numeric identifier for the report pack.
startDate String 1365535070000 The start date.
timeAggInterval Number 60 Defaults to 60 minutes.

Status 200

List CP Codes

This controller deals specifically with provisioned data, that is, a CP code or a configuration. It does not provide traffic data for a site.

Gets all CP codes for the given account. For the time being, these CP codes aren’t limited only to the site.

GET /events/v2/{accountId}/sites/cpcodes

Example: /events/v2/1–7KLGH/sites/cpcodes

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.

Status 200 application/json

Response:

{
   "status": "ok",
   "contents": {
      "resultsPerPage": 3,
      "currentPage": 1,
      "totalResultsCount": 3,
      "totalPageCount": 1,
      "sortKey": null,
      "sortOrder": "ASC",
      "filters": {},
      "dataSet": [
         {
            "name": "Test CP Code",
            "masterACG": "1-23ABC",
            "cpcode": 1234
         },
         {
            "name": "HD Silverlight Live",
            "masterACG": "1-23ABC",
            "cpcode": 5678
         },
         {
            "name": "SL VOD",
            "masterACG": "2-23ZXY",
            "cpcode": 9101112
         }
      ]
   }
}

List IPA and SXL Configurations

GET /events/v2/{accountId}/srip{?sortField,sortOrder,limit,startIndex}

Example: /events/v2/1–7KLGH/srip?sortField=description&sortOrder=asc&limit=10&startIndex=0

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
Optional
limit Number 10 The maximum number of pagination records to include.
sortField String description The field to sort the result set, either description or hostname.
sortOrder String asc The direction of the sort, asc for ascending or desc for descending.
startIndex Number 0 The zero-origin index at which to start the batch of paginated results.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
        "resultsPerPage": 8,
        "currentPage": 1,
        "totalResultsCount": null,
        "totalPageCount": null,
        "sortKey": null,
        "sortOrder": null,
        "filters": {},
        "dataSet": [
            {
                "slotId": 123,
                "description": "My IPA configuration",
                "hostname": "secure.mysite.com",
                "active": true
            }
        ]
    }
}

List Flash Live Streams

The streams returned by this resource collection are general and outside of the context of an event.

Gets all traditional Flash Live streams for the customer associated with this session.

GET /events/v2/{accountId}/streams/flashlive

Example: /events/v2/1–7KLGH/streams/flashlive

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "resultsPerPage": 2,
       "currentPage": 1,
       "totalResultsCount": 2,
       "totalPageCount": 1,
       "sortKey": null,
       "sortOrder": "ASC",
       "filters": {},
       "dataSet": [
          {
             "streamId": "12345",
             "config": {
                "id": "2865",
                "name": "test 1",
                "hostname": "test-f.examplehd.net",
                "masterACG": "3-123ABC",
                "cpCode": 12345
             },
             "streamName": "test_test"
          },
          {
             "streamId": "12345",
             "config": {
                "id": "5320",
                "name": "test2",
                "hostname": "test2-f.examplehd.net",
                "masterACG": "3-456XYZ",
                "cpCode": 45678
             },
             "streamName": "test2"
          }
       ]
    }
 }

List Silverlight Live Streams

Gets all HD Silverlight Live streams for the current session’s account.

GET /events/v2/{accountId}/streams/silverlightlive

Example: /events/v2/1–7KLGH/streams/silverlightlive

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.

Status 200 application/json

Response:

{
    "status": "ok",
    "contents": {
       "resultsPerPage": 1,
       "currentPage": 1,
       "totalResultsCount": 1,
       "totalPageCount": 1,
       "sortKey": null,
       "sortOrder": "ASC",
       "filters": {},
       "dataSet": [
          {
             "streamId": "12345",
             "config": {
                "id": "1920",
                "name": "Secure Silverlight",
                "hostname": "secure-s.examplehd.net",
                "masterACG": "3-123ABC",
                "cpCode": 12345
             },
             "streamName": "test_1",
             "backupStream": {
                "streamId": "222837",
                "config": {
                   "id": "1920",
                   "name": "Secure Silverlight",
                   "hostname": "secure-s.examplehd.net",
                   "masterACG": "3-123ABC",
                   "cpCode": 12345
                },
                "streamName": "test_1_backup"
             }
          }
       ]
    }
 }

List Universal Live Streams

Gets all Universal Live streams that are associated with the specified account.

GET /events/v2/{accountId}/streams/universallive{?sortField,sortOrder,limit,startIndex}

Example: /events/v2/1–7KLGH/streams/universallive?sortField=description&sortOrder=asc&limit=10&startIndex=0

Parameter Type Sample Description
Required
accountId String 1-7KLGH Unique identifier for the account, or current-account as described above.
Optional
limit Number 10 The maximum number of pagination records to include.
sortField String description The field to sort the result set, either description or hostname.
sortOrder String asc The direction of the sort, asc for ascending or desc for descending.
startIndex Number 0 The zero-origin index at which to start the batch of paginated results.

Status 200 application/json

Response:

{
    "dataSet": [
        {
            "streamId": 123,
            "streamName": "example1",
            "enabledFormats": [
                "ADOBE_HDS",
                "APPLE_IOS"
            ],
            "config": {
                "configId": 789,
                "configName": "MyConfiguration",
                "hostname": "myuniversal-f.examplehd.net",
                "cpcode": {
                    "cpcode": 123456,
                    "cpcodeName": "My CP Code For Billing"
                }
            }
        },
        {
            "streamId": 456,
            "streamName": "example2",
            "enabledFormats": [ "AKAMAI_HDFLASH_ONE" ],
            "config": {
                "configId": 101112,
                "configName": "Another Configuration",
                "hostname": "anotheruniversal-lh.examplehd.net",
                "cpcode": {
                    "cpcode": 987654,
                    "cpcodeName": "Billed To Another Department"
                }
            }
        }
    ]
}


Last modified: 12/12/2016