Get All Reports

Retrieves all reports that have been submitted within the last 7 days.

This endpoint does not return downloadable reports. Use the Get All Downloadable Reports endpoint instead.

Request

Retrieve reports via the following request:

HTTP Method	Request URI
GET	https://api.vdms.io/report-builder/v1/reports?page=PageNumber&page_size=PageSize

Define the following variables when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
PageNumber	Filter the response by a specific page. Replace this variable with the desired page. Use the navigation links within the @links object to navigate between pages. Default Value: 1
PageSize	Limit the response to only include the specified number of results. Default Value: 25

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

Request body parameters are not required by this endpoint.

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 the requested endpoint.
@type	String	Returns Collection.
@links	Object	Contains navigation links for the first, next, previous, and last page. Learn more. This object may contain the following objects: first | next | previous | last Each of the above objects contains a href key-value pair that identifies a relative URL through which you may retrieve paginated results. The next and previous objects will only be returned when appropriate. Specifically, the previous object and its navigation link will not be returned when the response is for the first page. The next object and its navigation link will not be returned when the response contains the entire collection or when the response is for the last page. Sample response excerpt: ... "@links": { "first": { "href": "/rules-engine/v1.1/policies?page_size=100&page=1" }, "last": { "href": "/rules-engine/v1.1/policies?page_size=100&page=1" } }, ...
items	Array	Contains a list of reports.
total_items	Integer	Indicates the total number of reports that have been generated.

items Array

The items array describes each report via the following properties:

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 query'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.
id	String	Identifies this report by its system-defined ID.
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
by	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	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 on how time intervals affect reporting. Data is reported in buckets. The duration of the bucket is determined by either one of the following: by property: If the by property has been defined, then the time interval (i.e., granularity) assigned to it determines the bucket's duration. Learn more about time intervals. Example: If the report's time interval is weekly, then each data bucket starts on Monday at 12:00:00 AM (UTC) and ends on Monday of the following week at 12:00:00 AM (UTC). Default: If the by property has not been defined, then the age of the report determines the duration of each bucket. If the report only contains data that occurred within the last 7 days, then data is reported in 5 minute buckets. If the report contains data that occurred over 7 days ago, then data is reported in daily buckets. If a report's start or end timestamp falls in the middle of a bucket, then the report will include all of the data contained by that bucket. Example: A report is configured as follows: Time Interval: Weekly Start Timestamp: Friday (2/7) at 5:00 PM PST End Timestamp: The following Wednesday (2/12) at 9:00 AM PST Based off of the above configuration, the report's actual date range will be: Start Timestamp: Monday (2/3) at 12:00:00 AM (UTC) End Timestamp: Monday (2/17) at 12:00:00 AM (UTC) 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. 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 in 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. Valid values are: 1 - 30000
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.
start	String	Determines the report's relative or fixed start 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 on how time intervals affect reporting. Data is reported in buckets. The duration of the bucket is determined by either one of the following: by property: If the by property has been defined, then the time interval (i.e., granularity) assigned to it determines the bucket's duration. Learn more about time intervals. Example: If the report's time interval is weekly, then each data bucket starts on Monday at 12:00:00 AM (UTC) and ends on Monday of the following week at 12:00:00 AM (UTC). Default: If the by property has not been defined, then the age of the report determines the duration of each bucket. If the report only contains data that occurred within the last 7 days, then data is reported in 5 minute buckets. If the report contains data that occurred over 7 days ago, then data is reported in daily buckets. If a report's start or end timestamp falls in the middle of a bucket, then the report will include all of the data contained by that bucket. Example: A report is configured as follows: Time Interval: Weekly Start Timestamp: Friday (2/7) at 5:00 PM PST End Timestamp: The following Wednesday (2/12) at 9:00 AM PST Based off of the above configuration, the report's actual date range will be: Start Timestamp: Monday (2/3) at 12:00:00 AM (UTC) End Timestamp: Monday (2/17) at 12:00:00 AM (UTC) 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 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.

A sample JSON response is shown below.

{
	"@id": "/report-builder/v1/report?page=1&page_size=25",
	"@links": {
		"first": {
			"href": "/report-builder/v1/report?page=1&page_size=25"
		},
		"last": {
			"href": "/report-builder/v1/report?page=1&page_size=25"
		}
	},
	"@type": "Collection",
	"items": [{
			"@id": "/report-builder/v1/reports/2e556ab99cdf5a3573fcac21?page=1&page_size=25",
			"@type": "Report",
			"completed_at": "2020-02-25T18:43:07.216000Z",
			"created_at": "2020-02-25T18:43:05.800000Z",
			"dimensions": ["root_directory"],
			"id": "2e556ab99cdf5a3573fcac21",
			"metrics": ["request_count", "bytes_out"],
			"query": {
				"id": "5e4ef75da2a10b6e1331052d",
				"params": {
					"dimensions": ["root_directory"],
					"end": "2020-02-25T18:43:05Z",
					"filter": "[{\"field\":\"platform\",\"operator\":\"in\",\"value\":[\"adn\"]}]",
					"limit": 30000,
					"metrics": ["request_count", "bytes_out"],
					"sort": ["-request_count"],
					"start": "2020-02-18T00:00:00Z",
					"units": {
						"bytes_out": "gigabyte",
						"request_count": "thousand"
					}
				}
			},
			"status": "completed"
		}, {
			"@id": "/report-builder/v1/reports/5e556992611449f26b840b7c?page=1&page_size=25",
			"@type": "Report",
			"completed_at": "2020-02-25T18:38:12.483000Z",
			"created_at": "2020-02-25T18:38:10.658000Z",
			"dimensions": ["time", "method", "content_type"],
			"id": "5e556992611449f26b840b7c",
			"metrics": ["bytes_out", "file_size", "cache_hit_percentage"],
			"query": {
				"id": "5e4ef7759cdf5a3573fcac08",
				"params": {
					"by": "week",
					"dimensions": ["method", "content_type"],
					"end": "2020-02-25T18:38:10Z",
					"filter": "[{\"field\":\"platform\",\"operator\":\"in\",\"value\":[\"adn\"]},{\"field\":\"root_directory\",\"operator\":\"contains\",\"value\":\"/marketing/\"}]",
					"limit": 30000,
					"metrics": ["bytes_out", "file_size", "cache_hit_percentage"],
					"sort": ["-bytes_out"],
					"start": "2020-01-26T00:00:00Z",
					"units": {
						"bytes_out": "kilobyte",
						"file_size": "gigabyte"
					}
				}
			},
			"status": "completed"
		}, {
			"@id": "/report-builder/v1/reports/5e546f83a2a10b6e11f1db9c?page=1&page_size=25",
			"@type": "Report",
			"completed_at": "2020-02-25T00:51:31.736000Z",
			"created_at": "2020-02-25T00:51:15.791000Z",
			"dimensions": ["time", "method", "content_type"],
			"id": "5e546f83a2a10b6e11f1db9c",
			"metrics": ["bytes_out", "file_size", "cache_hit_percentage"],
			"query": {
				"id": "5e4ef7759cdf5a3573fcac08",
				"params": {
					"by": "week",
					"dimensions": ["method", "content_type"],
					"end": "2020-02-25T00:51:15Z",
					"filter": "[{\"field\":\"platform\",\"operator\":\"in\",\"value\":[\"adn\"]},{\"field\":\"root_directory\",\"operator\":\"contains\",\"value\":\"/sales/\"}]",
					"limit": 30000,
					"metrics": ["bytes_out", "file_size", "cache_hit_percentage"],
					"sort": ["-bytes_out"],
					"start": "2020-01-26T00:00:00Z",
					"units": {
						"bytes_out": "kilobyte",
						"file_size": "gigabyte"
					}
				}
			},
			"status": "completed"
		}, {
			"@id": "/report-builder/v1/reports/5e540989611449f26b840b78?page=1&page_size=25",
			"@type": "Report",
			"completed_at": "2020-02-24T17:36:11.461000Z",
			"created_at": "2020-02-24T17:36:09.288000Z",
			"dimensions": ["time", "method", "content_type"],
			"id": "5e540989611449f26b840b78",
			"metrics": ["bytes_out", "file_size", "cache_hit_percentage"],
			"query": {
				"id": "5e4ef7759cdf5a3573fcac08",
				"params": {
					"by": "week",
					"dimensions": ["method", "content_type"],
					"end": "2020-02-24T17:36:09Z",
					"filter": "[{\"field\":\"platform\",\"operator\":\"in\",\"value\":[\"adn\"]},{\"field\":\"root_directory\",\"operator\":\"contains\",\"value\":\"/collateral/\"}]",
					"limit": 30000,
					"metrics": ["bytes_out", "file_size", "cache_hit_percentage"],
					"sort": ["-bytes_out"],
					"start": "2020-01-25T00:00:00Z",
					"units": {
						"bytes_out": "kilobyte",
						"file_size": "gigabyte"
					}
				}
			},
			"status": "completed"
		}, {
			"@id": "/report-builder/v1/reports/5e509887a2a10b6e185b52e3?page=1&page_size=25",
			"@type": "Report",
			"completed_at": "2020-02-22T02:57:14.323000Z",
			"created_at": "2020-02-22T02:57:11.828000Z",
			"dimensions": ["time", "method", "content_type"],
			"id": "5e509887a2a10b6e185b52e3",
			"metrics": ["bytes_out", "file_size", "cache_hit_percentage"],
			"query": {
				"id": "5e4ef7759cdf5a3573fcac08",
				"params": {
					"by": "week",
					"dimensions": ["method", "content_type"],
					"end": "2020-02-22T02:57:11Z",
					"filter": "[{\"field\":\"platform\",\"operator\":\"in\",\"value\":[\"adn\"]},{\"field\":\"root_directory\",\"operator\":\"contains\",\"value\":\"/conferences/\"}]",
					"limit": 30000,
					"metrics": ["bytes_out", "file_size", "cache_hit_percentage"],
					"sort": ["-bytes_out"],
					"start": "2020-01-23T00:00:00Z",
					"units": {
						"bytes_out": "kilobyte",
						"file_size": "gigabyte"
					}
				}
			},
			"status": "completed"
		}, {
			"@id": "/report-builder/v1/reports/5e508b64a2a10b7a39803b1e?page=1&page_size=25",
			"@type": "Report",
			"created_at": "2020-02-22T02:01:08.731000Z",
			"id": "5e508b64a2a10b7a39803b1e",
			"query": {
				"id": "5e4ef7759cdf5a3573fcac08",
				"params": {
					"by": "week",
					"dimensions": ["method", "content_type"],
					"end": "2020-02-22T02:00:50Z",
					"filter": "[{\"field\":\"platform\",\"operator\":\"in\",\"value\":[\"adn\"]},{\"field\":\"root_directory\",\"operator\":\"contains\",\"value\":\"/resources/\"}]",
					"limit": 30000,
					"metrics": ["bytes_out", "file_size", "cache_hit_percentage"],
					"sort": ["-bytes_out"],
					"start": "2020-01-23T00:00:00Z",
					"units": {
						"bytes_out": "kilobyte",
						"file_size": "gigabyte"
					}
				}
			},
			"status": "completed"
		}
	],
	"total_items": 6
}