Get Object Delivery historical data

get deprecatedhttps://{hostname}/media-delivery-reports/v1/object-delivery/data

Retrieves past Object Delivery activity data using parameters you specify.

🚧
This endpoint is deprecated and will be decommissioned on June 30, 2025.

Query Params

dimensions

string

required

Specify the dimensions to use for the report, as comma-separated IDs. You need to include at least the dimensions or metrics parameter, but you can include both if desired. See the table of available Object Delivery dimensions which includes their API-specific id values.

metrics

string

required

Specify the metrics to use for the report, as comma-separated IDs. You need to include at least the metrics or dimensions parameter, but you can include both if desired. See the table of available Object Delivery metrics which includes their API-specific id values.

cpcodes

string

Limit data to a specific set of comma-delimited CP codes. These CP codes pertain to the individual configurations set up, per product, to deliver media content. For example, when you set up a property in Property Manager to deliver content, you assign it a CP code.

endDate

string

required

The end date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm, using the GMT (UTC) time zone.

startDate

string

required

The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm, using the GMT (UTC) time zone.

limit

integer

1 to 10000

Defaults to 300

The number of rows to return from 1 to 10000. 300 is the default.

offset

integer

≥ 0

Defaults to 0

The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.

filterParams

string

A UTF-8 URL-encoded JSON object representing filter parameters that limit reported data.

sortParams

string

A UTF-8 URL-encoded JSON object representing sort parameters that rearrange the reported data. When no sortParams are specified, the response is sorted chronologically for time based queries, or otherwise on the first metric.

deliveryOption

string

Defaults to all

Enum Limits data to the type of traffic, non-secure for HTTP traffic, secure-shared for standard secure (HTTPS) traffic using the Akamai "shared certificate, secure-standard for Standard TLS HTTPS traffic, secure-premium for Enhanced TLS HTTPS traffic, or the default all. Older options are still supported including, http for non-secure traffic, ssl for secure shared-certificate traffic, and essl for secure customer-certificate traffic. However, it's best to use the newer options.

enableCPCodeName

boolean

If set to true, the name you've set for each CP code is included along with its numeric identifier.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Response

`rows` when there's no available data.

Response body

object

columns

array of objects

required

length ≥ 1

Encapsulates context for each element listed within corresponding rows.

columns*

object

aggregate

string

length ≥ 1

TBD Add description.

dataType

string

Type of data: STRING, NUMBER, ENCODED, DATE, COUNT, TIME, BIT_FLAG, VOLUME, BANDWIDTH, PERCENT, CONTINENT, COUNTRY, REGION, CPCODE, ACGID, DOMAIN or STREAM.

STRING NUMBER ENCODED DATE COUNT TIME BIT_FLAG VOLUME BANDWIDTH PERCENT CONTINENT COUNTRY REGION CPCODE ACGID DOMAIN STREAM

description

string

length ≥ 1

TBD Add description.

integer

required

≥ 0

TBD Add description.

index

integer

required

≥ 0

Positions each column within the table.

name

string

required

length ≥ 1

Depending on the type, provides the name of the relevant dimension or metric.

type

string

required

Type of data: DIMENSION or METRIC.

DIMENSION METRIC

unit

string

Unit of column: TIME, SECONDS, MINUTES, COUNT, HITS, BYTES, MS, MBPS, KBPS, MB, GB, NUMBER, MBIT/SEC, HITS/SEC or %.

TIME SECONDS COUNT BYTES MS MBPS KBPS MB GB HITS MINUTES NUMBER MBIT/SEC HITS/SEC %

metaData

object

required

Reflects the set of parameter values included in the request that determines this report's results.

aggregation

integer

required

≥ 0

The time span included in each record, expressed in seconds.

dasTable

string

length ≥ 1

TBD Add description.

endTimeInEpoch

integer

required

≥ 0

The end of the requested time range, in epoch seconds.

hasMoreData

boolean

required

Indicates that a constrained set of requested data doesn't represent the entire set.

limit

integer

required

≥ 0

Defaults to 300

The maximum number of requested data rows.

messages

array of strings

length ≥ 1

TBD Add description.

messages

offset

integer

required

≥ 0

The offset of the row from which the data should start. Used with overall limit, it reflects where a batch of data starts. For example, setting both offset and limit to 100 selects rows 101-200 from the overall results.

reportPack

string

length ≥ 1

TBD Add description.

rtWindow

integer

≥ 0

TBD Add description.

startTimeInEpoch

integer

required

≥ 0

The start of the requested time range, in epoch seconds.

timeZone

string

required

length ≥ 1

Identifies the time zone from which the request was made.

rows

array of arrays of strings

required

length ≥ 0

Encapsulates the report's two-dimensional table data. If there's no data to report, the array is empty.

rows*

array of strings

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/media-delivery-reports/v1/object-delivery/data \
3
     --header 'accept: application/json'


xxxxxxxxxx
56
}
1
{
2
  "columns": [
3
    {
4
      "description": "Indicates the time at which content was consumed. This dimension is set automatically.",
5
      "id": 700,
6
      "index": 0,
7
      "name": "Time",
8
      "type": "DIMENSION"
9
    },
10
    {
11
      "aggregate": "119",
12
      "dataType": "COUNT",
13
      "description": "Edge Proxy Hits",
14
      "id": 704,
15
      "index": 1,
16
      "name": "Edge Proxy Hits",
17
      "type": "METRIC"
18
    }
19
  ],
20
  "metaData": {
21
    "aggregation": 3600,
22
    "endTimeInEpoch": 1392616800,
23
    "hasMoreData": false,
24
    "limit": 10,
25
    "offset": 0,

🚧

200OK. The response includes empty rows when there's no available data.

`rows` when there's no available data.