Generate Downloadable Report

Generates report data that can be downloaded as a compressed comma-separated value (CSV) or JSON file from AWS S3.

Key information:

Only a single report may be generated at a given time. If a report is already being generated or if the current request will take too long, then the response will be a 202 Accepted. Use the Get Downloadable Report endpoint to check the report's status and/or to retrieve report data.
Upon successfully requesting this endpoint, retrieve report data by requesting the URL returned by the link response property.
The signed URL returned by the link response property is valid for 5 minutes after a report has been retrieved. The expires_at response property indicates the URL's expiration timestamp. Upon expiration, the URL will return a 403 Forbidden.

Generate a new signed URL within 7 days of report generation via the Get Downloadable Report endpoint.
Report data remains available for 7 days after being generated. After which, it will return a 404 Not Found.

Request

Generate a report via the following request:

HTTP Method	Request URI
POST	https://api.vdms.io/report-builder/v1/downloadable-reports

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Unlike requests to api.edgecast.com, requests to our API gateway (api.vdms.io) require an access token (OAuth).

Request Body

Pass the following request body parameters:

Name	Data Type	Description
query Required	Object	Determines how report data will be generated.
filename	String	Determines the file name that will be passed in the Content-Disposition header when report data is requested. Certain user agents (e.g., browsers) use the Content-Disposition header when assigning a file name to downloaded content. Default Value: Report IDRepresents the system-defined ID assigned to the report.
format	String	Determines the format in which report data will be generated. Valid values are: csv \| json Default Value: csv

Name

Data Type

Description

query

Required

Object

Determines how report data will be generated.

filename

String

Determines the file name that will be passed in the Content-Disposition header when report data is requested.

Certain user agents (e.g., browsers) use the Content-Disposition header when assigning a file name to downloaded content.

Default Value:

format

String

Determines the format in which report data will be generated. Valid values are:

csv | json

Default Value:

csv

query Object

The query object contains the following property:

Name	Data Type	Description
params	Object	Contains a configuration for report data generation.

params Object

The params object contains the following properties:

Name

Data Type

Description

String

Identifies a granularity by its system-defined ID.

Use the Get All Granularities endpoint to retrieve a list of available granularities and their system-defined IDs.

Due to our data retention policy, the set of available granularities varies according to the age of the data being requested. Pass the start and end query string parameters when requesting the Get All Granularities endpoint to find out the set of supported granularities for that time range.

dimensions

Object

Contains a string value for each dimension that will be included in the report.

Use the Get All Dimensions endpoint to retrieve a list of dimensions and their system-defined IDs.

end

Required

String

Required for the params Object

Determines the report's relative or fixed end date/time.

Time is only relevant for reports that only contain data that occurred within the last 7 days and whose time interval is set to 5 minutes or hourly.

Learn more about relative dates.

The available relative date keywords are:

Keyword	Description
now	Identifies the date and time (UTC) when the request was submitted.
start_day	Identifies 00:00:00 (UTC) on the day when the request was submitted.
start_week	Identifies 00:00:00 (UTC) on Monday of the week when the request was submitted.
start_month	Identifies 00:00:00 (UTC) on the 1st of the month when the request was submitted.
start_year	Identifies 00:00:00 (UTC) on January 1 of the year when the request was submitted.

The available time units are:

Keyword	Description
y	Year
M	Month
w	Week
d	Day
h	Hour
m	Minute
s	Second

Examples

Sample dates are described below.

Value	Description
2024-01-01T00:00:00Z	Identifies the start of 2024 (UTC).
now-1h	Identifies exactly 60 minutes before the request was submitted.
start_day-7d	Identifies a date that is 7 days prior to the request at 00:00:00 (UTC). Sample request timestamp: 1/8/2024 at 1:00:00 P.M. PST Relative date/time: 1/1/2024 at 00:00:00 UTC
start_month-1d	Identifies the last day of the month prior to the request at 00:00:00 (UTC). Sample request timestamp: 1/8/2020 at 1:00:00 P.M. PST Relative date/time: 12/31/2019 at 00:00:00 UTC
start_year+1d	Identifies the second day of the year on which the request was submitted at 00:00:00 (UTC). Sample request timestamp: 1/8/2024 at 1:00:00 P.M. PST Relative date/time: 1/2/2024 at 00:00:00 UTC

Fixed Date Syntax:

YYYY-MM-DDThh:mm:ss:ffffffZ

Learn more.

filter

String

Contains a list of filters for the data that will be generated for this report.

Key information:

Set this property by converting an array of objects into a string value. Each object in this array represents a filter. Each object contains the following properties:
- field: A string that identifies a dimension by its system-defined ID. Report data will be filtered by this dimension.
  
  Use the Get All Dimensions endpoint to retrieve a list of dimensions and their system-defined IDs.
- operator: A string that identifies a comparison operator by its system-defined ID. This comparison operator establishes the relationship between field and value that report data must meet.
  
  Use the Get All Operators endpoint to retrieve a list of comparison operators and their system-defined IDs.
- value: A string, number, or array that indicates the value to which the comparison operator will be applied. The data type for this property is determined by the comparison operator's multi_value property and the dimension's field_type property.

Example:

The following configuration filters by delivery platform:

Property

Value

field

String

platform

operator

String

value

Array of String Values

Valid values are:

cache: HTTP Large
wac: HTTP Small
adn:ADN

The following code excerpt filters by the ADN delivery platform:

"filter": "[{\"field\":\"platform\",\"operator\":\"in\",\"value\":[\"adn\"]}]",

limit

Integer

Determines the maximum number of rows that may be included in a report. A valid value is any positive integer.

metrics

Required

Array of String Values

Required for the params Object

Identifies one or more metrics that will be included in the report. Specify each metric as a string value.

Use the Get All Metrics endpoint to retrieve a list of metrics and their system-defined IDs.

sort

Array of String Values

Determines how report data will be sorted.

Key information:

Sort report data by dimensions or metrics.
Perform a reverse sort by prepending -.

Example:

Sort report data by number of requests in descending order.

["-request_count"]
The first string value in the array determines how records will be sorted. Additional string values determine sort order for records with the same value.

start

Required

String

Required for the params Object

Determines the report's relative or fixed start date/time.

Learn more about relative dates.

The available relative date keywords are:

Keyword	Description
now	Identifies the date and time (UTC) when the request was submitted.
start_day	Identifies 00:00:00 (UTC) on the day when the request was submitted.
start_week	Identifies 00:00:00 (UTC) on Monday of the week when the request was submitted.
start_month	Identifies 00:00:00 (UTC) on the 1st of the month when the request was submitted.
start_year	Identifies 00:00:00 (UTC) on January 1 of the year when the request was submitted.

The available time units are:

Keyword	Description
y	Year
M	Month
w	Week
d	Day
h	Hour
m	Minute
s	Second

Examples

Sample dates are described below.

Value	Description
2024-01-01T00:00:00Z	Identifies the start of 2024 (UTC).
now-1h	Identifies exactly 60 minutes before the request was submitted.
start_day-7d	Identifies a date that is 7 days prior to the request at 00:00:00 (UTC). Sample request timestamp: 1/8/2024 at 1:00:00 P.M. PST Relative date/time: 1/1/2024 at 00:00:00 UTC
start_month-1d	Identifies the last day of the month prior to the request at 00:00:00 (UTC). Sample request timestamp: 1/8/2020 at 1:00:00 P.M. PST Relative date/time: 12/31/2019 at 00:00:00 UTC
start_year+1d	Identifies the second day of the year on which the request was submitted at 00:00:00 (UTC). Sample request timestamp: 1/8/2024 at 1:00:00 P.M. PST Relative date/time: 1/2/2024 at 00:00:00 UTC

Fixed Date Format:

YYYY-MM-DDThh:mm:ss:ffffffZ

Learn more.

units

Object

Indicates unit information for each metric defined by the metrics property. This information is reported as a key-value pair with the following syntax:

"Metric" : "Unit ID"

Do not provide unit information for metrics that report percentages.

Default Value:

If a unit of measurement is not assigned to a metric, then it will be assigned one that has a matching type and whose scale property is set to 1. Use the Get All Units endpoint to view the type and scale for each unit of measurement.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request contains the following response elements:

Name	Data Type	Description
@id	String	Indicates the relative path to an endpoint through which you may retrieve the current report.
@type	String	Returns Report.
completed_at	String	Indicates the timestamp (UTC) at which report data generation completed. Syntax: YYYY-MM-DDThh:mm:ss:ffffffZ Learn more.
created_at	String	Indicates the timestamp (UTC) at which report data was requested. Syntax: YYYY-MM-DDThh:mm:ss:ffffffZ Learn more.
dimensions	Array of String Values	Indicates the report's actual dimensions. Time is automatically reported when a time interval has been defined. If the report's configuration defines the by property, then the time dimension, if not already present, will be added to this property's value. If this occurs, then this property will not match the dimensions property in the query object.
expires_at	String	Indicates the timestamp (UTC) at which the signed URL defined by the link property will expire. Syntax: YYYY-MM-DDThh:mm:ss:ffffffZ Learn more.
id	String	Identifies this report by its system-defined ID.
link	String	Indicates a signed URL through which you may download report data. This signed URL expires after 5 minutes. Check the expiration date via the expires_at property. Compressed File Syntax: https://s3-us-west-2.amazonaws.com/cdna-rtap-reports2/Report IDRepresents the system-defined ID assigned to the report..FormatRepresents either csv or json..zip?response-content-disposition=attachment%3B%20filename%3D%22Report ID.zip%22&Signature=Token%3D&Expires=Unix Time&AWSAccessKeyId=Key ID The file name defined in the query string determines the file name that will be passed by the Content-Disposition header. By default, it is set to the report ID. Override it when generating report data by passing the filename request body property. File Name Syntax: Report IDRepresents the system-defined ID assigned to the report..FormatRepresents either csv or json.
metrics	Array of String Values	Indicates the report's metrics.
query	Object	Contains the query used to generate report data.
status	String	Indicates the current status for the request to generate report data. Valid values are: submitted \| processing \| error \| canceled \| completed

query Object

The query object describes the query used to generate report data via the following properties:

Name	Data Type	Description
params	Object	Defines the query for the data generated in the current report.

params Object

The params object contains the following properties:

Name

Data Type

Description

String

Identifies a granularity by its system-defined ID.

Use the Get All Granularities endpoint to retrieve a list of available granularities and their system-defined IDs.

dimensions

Object

Contains a string value for each dimension assigned to this report.

Use the Get All Dimensions endpoint to retrieve a list of dimensions and their system-defined IDs.

end

String

Indicates the report's fixed end date/time.

Upon generating a downloadable report, relative dates are converted to fixed dates.

Syntax:

YYYY-MM-DDThh:mm:ss:ffffffZ

Learn more.

filter

String

Contains a list of filters.

Key information:

This property is an array of objects expressed as a string value. Each object in this array represents a filter. Each object contains the following properties:
- field: A string that identifies a dimension by its system-defined ID. Report data will be filtered by this dimension.
  
  Use the Get All Dimensions endpoint to retrieve a list of dimensions and their system-defined IDs.
- operator: A string that identifies a comparison operator by its system-defined ID. This comparison operator establishes the relationship between field and value that report data must meet.
  
  Use the Get All Operators endpoint to retrieve a list of comparison operators and their system-defined IDs.
- value: A string, number, or array that indicates the value to which the comparison operator will be applied. The data type for this property is determined by the comparison operator's multi_value property and the dimension's field_type property.

Example:

The following configuration filters by delivery platform:

Property

Value

field

String

platform

operator

String

value

Array of String Values

Valid values are:

cache: HTTP Large
wac: HTTP Small
adn: ADN

The following code excerpt filters by the ADN delivery platform:

"filter": "[{\"field\":\"platform\",\"operator\":\"in\",\"value\":[\"adn\"]}]",

limit

Integer

Determines the maximum number of rows that may be included in a report. A valid value is any positive integer.

metrics

Array of String Values

Identifies one or more metrics that will be included when report data is generated from this report.

Use the Get All Metrics endpoint to retrieve a list of metrics and their system-defined IDs.

sort

Array of String Values

Determines how report data will be sorted.

Key information:

Sort report data by dimensions or metrics.
Perform a reverse sort by prepending -.

Example:

Sort report data by number of requests in descending order.

["-request_count"]
The first string value in the array determines how records will be sorted. Additional string values determine sort order for records with the same value.

end

String

Indicates the report's fixed start date/time.

Upon generating a downloadable report, relative dates are converted to fixed dates.

Syntax:

YYYY-MM-DDThh:mm:ss:ffffffZ

Learn more.

units

Object

Indicates unit information for each metric defined in the report. This information is reported as a key-value pair with the following syntax:

"Metric" : "Units"

Use the Get All Units endpoint to retrieve a list of units of measurements and their system-defined IDs.

Unit information is not provided for metrics that report percentages.

Errors

The response body for an unsuccessful request will contain an error response that provides additional information.

Sample Request and Response

A sample JSON request is shown below.

POST https://api.vdms.io/report-builder/v1/downloadable-reports HTTP/1.1

Authorization: Bearer A1bcbGciOiJSUzI1NiIsImtpZCI6Ij13N1VGQ01z...A1bcbGciOiJSUzI1NiIsImtpZCI6Ij13N1VGQ01zOTIzQjI1MTYzRjU4MU1wQ0I3MUNBRDk3QjAzNkUwQjgiLCJ01XAiOiJKV1QiLCJ4NXQiOiJGMDc4bzVJN0pSWV9XQm9Ndcc5dGw3QTI0TGcifQ.1yJuYmYiOj11NjUzMDgwNzgsImV4cCI6MTU2NTMwODM3OCwiaXNzIjoiacR0ccM6Ly9pZC52ZG1zLmlvIiwiYXVkIjpbImc0dcBzOi8vaWQudmRtcy5pby9yZXNvdXJjZXMiLCJlYy5ydWxlcyJdLCJjbGllbnRfaWQiOiIxNTccOWZmZi04MTQzLTRmOW1tOWY1Yi1jNDgzZWVkNzclM2QiLCJzY29wZSI6WyJlYy5ydWxlcyJdfQ.XQ4TvzDrwLo4bO71cb1TbgYxmtcgTzC46Do0A9F3inAqw1qcr_Nr9IgRDxJDqR4Udc9QR86LVTQC2-ogGWP3pI12GtDtiUQdKYs5fpcuMf2Kbqau6kuU1M5BJm_GOcBNCCAJnU7SrDprVbPlwanGqk3yjcyo9nto8KWCRTwq2t31UQ1Ci31FZSr4vaMZJqk1vBW6NS3-yGowGCZbSIQBKpSgcc75coPtSjF1Qi6M4yORDyMC8c3KKlIp2b-6mpfDFXINIFV-XvnNuQ9v-lcc43_VWuDA_cQO8wmS4VzS1Ac1tpg1Pp4Bcdtjt12yKAXvi0X19R1BDmpxmO17cRRKYQ

Accept: application/json

Content-Type: application/json

Host: api.vdms.io

Content-Length: 253

{
	"query": {
		"params": {
			"by": null,
			"end": "now",
			"metrics": [
				"file_size"
			],
			"sort": [
				"-file_size"
			],
			"start": "start_day-7d",
			"units": {
				"file_size": "megabyte"
			}
		}
	}
}

A sample JSON response for a completed report is shown below.

HTTP/1.1 200 OK

Cache-Control: no-cache

Content-Type: application/json; charset=utf-8

Date: Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 882

{
	"@id": "/report-builder/v1/downloadable-reports/24586183a2a10b7a645fcd69",
	"@type": "DownloadableReport",
	"completed_at": "2020-02-28T00:40:36.479000Z",
	"created_at": "2020-02-28T00:40:35.741000Z",
	"dimensions": [],
	"expires_at": "2020-02-28T00:45:38Z",
	"id": "24586183a2a10b7a645fcd69",
	"link": "https://cdna-rtap-reports2.s3.amazonaws.com/24586183a2a10b7a645fcd69.csv.zip?resp...https://cdna-rtap-reports2.s3.amazonaws.com/24586183a2a10b7a645fcd69.csv.zip?response-content-disposition=attachment%3B%20filename%3D%2224586183a2a10b7a645fcd69.zip%22&amp;Expires=1582850738&amp;Signature=I52VF4bZmFxg4a0rt0chBIfDGzU%3D&amp;AWSAccessKeyId=AKIAZJIESJWHBI7NDUVF",
	"metrics": [
		"file_size"
	],
	"query": {
		"params": {
			"end": "2020-02-28T00:40:35Z",
			"metrics": [
				"file_size"
			],
			"sort": [
				"-file_size"
			],
			"start": "2020-02-21T00:00:00Z",
			"units": {
				"file_size": "megabyte"
			}
		}
	},
	"status": "completed"
}

A sample JSON response for a report that is still being processed is shown below.

HTTP/1.1 202 Accepted

Cache-Control: no-cache

Content-Type: application/json; charset=utf-8

Date: Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 516

{
	"@id": "/report-builder/v1/downloadable-reports/24586183a2a10b7a645fcd69",
	"@type": "DownloadableReport",
	"created_at": "2020-02-28T00:40:35.741000Z",
	"dimensions": [],
	"id": "24586183a2a10b7a645fcd69",
	"metrics": [
		"file_size"
	],
	"query": {
		"params": {
			"end": "2020-02-28T00:40:35Z",
			"metrics": [
				"file_size"
			],
			"sort": [
				"-file_size"
			],
			"start": "2020-02-21T00:00:00Z",
			"units": {
				"file_size": "megabyte"
			}
		}
	},
	"status": "submitted"
}