Get All Metrics

Retrieve all available metrics. A metric measures the rate, an amount, or the total number of times that a particular attribute occurred over a given record.

Request

Retrieve metrics via the following request:

HTTP Method	Request URI
GET	https://api.vdms.io/report-builder/v1/metrics

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.
items	Array	Contains a list of metrics.

items Array

The items array describes each metric via the following properties:

Name	Data Type	Description
@id	String	Indicates the relative path to an endpoint through which you may retrieve the current metric.
@type	String	Returns Metric.
description	String	Describes the purpose of the current metric.
field_type	String	Indicates the metric's data type.
id	String	Identifies the metric by its system-defined ID.
name	String	Identifies the metric by its friendly name.
unit	String	Identifies the type of unit of measurement supported by this metric. Look up this value within the response for the Get All Units endpoint to discover the units of measurements supported by this metric. Metrics that contain percentages will not include this property.

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/metrics",
	"@type": "Collection",
	"items": [{
			"@id": "/report-builder/v1/metrics/request-count",
			"@type": "Metric",
			"description": "The number of requests.",
			"field_type": "number",
			"id": "request_count",
			"name": "Requests",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/file-size",
			"@type": "Metric",
			"description": "The size of the response.",
			"field_type": "number",
			"id": "file_size",
			"name": "File Size",
			"unit": "byte"
		}, {
			"@id": "/report-builder/v1/metrics/bytes-in",
			"@type": "Metric",
			"description": "The number of bytes uploaded.",
			"field_type": "number",
			"id": "bytes_in",
			"name": "Bytes In",
			"unit": "byte"
		}, {
			"@id": "/report-builder/v1/metrics/bytes-out",
			"@type": "Metric",
			"description": "The number of bytes downloaded.",
			"field_type": "number",
			"id": "bytes_out",
			"name": "Data Transferred",
			"unit": "byte"
		}, {
			"@id": "/report-builder/v1/metrics/complete-downloads",
			"@type": "Metric",
			"description": "The number of completed downloads.",
			"field_type": "number",
			"id": "completed_downloads",
			"name": "Completed Downloads",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/download-attempts",
			"@type": "Metric",
			"description": "The number of download attempts.",
			"field_type": "number",
			"id": "download_attempts",
			"name": "Download Attempts",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/cache-hit",
			"@type": "Metric",
			"description": "The number of requests that hit cache.",
			"field_type": "number",
			"id": "cache_hit",
			"name": "Cache Hits",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/cache-hit-percentage",
			"@type": "Metric",
			"description": "The ratio of requests that hit cache in percentage.",
			"field_type": "number",
			"id": "cache_hit_percentage",
			"name": "Cache Hit Ratio"
		}, {
			"@id": "/report-builder/v1/metrics/cache-miss",
			"@type": "Metric",
			"description": "The number of requests that missed cache.",
			"field_type": "number",
			"id": "cache_miss",
			"name": "Cache Misses",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/cache-miss-percentage",
			"@type": "Metric",
			"description": "The ratio of requests that missed cache in percentage.",
			"field_type": "number",
			"id": "cache_miss_percentage",
			"name": "Cache Miss Ratio"
		}, {
			"@id": "/report-builder/v1/metrics/status-4xx",
			"@type": "Metric",
			"description": "The number of 400 ~ 499 response statuses.",
			"field_type": "number",
			"id": "status_4xx",
			"name": "4xx Responses",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/status-4xx-percentage",
			"@type": "Metric",
			"description": "The ratio of 400 ~ 499 response statuses in percentage.",
			"field_type": "number",
			"id": "status_4xx_percentage",
			"name": "4xx Error Rate"
		}, {
			"@id": "/report-builder/v1/metrics/status-5xx",
			"@type": "Metric",
			"description": "The number of 500 ~ 599 response statuses.",
			"field_type": "number",
			"id": "status_5xx",
			"name": "5xx Responses",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/status-5xx-percentage",
			"@type": "Metric",
			"description": "The ratio of 500 ~ 599 response statuses in percentage.",
			"field_type": "number",
			"id": "status_5xx_percentage",
			"name": "5xx Error Rate"
		}, {
			"@id": "/report-builder/v1/metrics/total-time",
			"@type": "Metric",
			"description": "Total time taken for the request",
			"field_type": "number",
			"id": "total_time",
			"name": "Total Time",
			"unit": "time"
		}, {
			"@id": "/report-builder/v1/metrics/transfer-rate",
			"@type": "Metric",
			"description": "Transfer Rate (bytes / sec)",
			"field_type": "number",
			"id": "transfer_rate",
			"name": "Transfer Rate",
			"unit": "data_rate"
		}, {
			"@id": "/report-builder/v1/metrics/config-nocache",
			"@type": "Metric",
			"description": "The number of requests with cache_status CONFIG_NOCACHE",
			"field_type": "number",
			"id": "config_nocache",
			"name": "CONFIG_NOCACHE",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/unreachable",
			"@type": "Metric",
			"description": "The number of requests with cache_status UNREACHABLE",
			"field_type": "number",
			"id": "unreachable",
			"name": "UNREACHABLE",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/tcp-hit",
			"@type": "Metric",
			"description": "The number of requests with cache_status TCP_HIT",
			"field_type": "number",
			"id": "tcp_hit",
			"name": "TCP_HIT",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/tcp-miss",
			"@type": "Metric",
			"description": "The number of requests with cache_status TCP_MISS",
			"field_type": "number",
			"id": "tcp_miss",
			"name": "TCP_MISS",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/tcp-partial-hit",
			"@type": "Metric",
			"description": "The number of requests with cache_status TCP_PARTIAL_HIT",
			"field_type": "number",
			"id": "tcp_partial_hit",
			"name": "TCP_PARTIAL_HIT",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/tcp-partial-miss",
			"@type": "Metric",
			"description": "The number of requests with cache_status TCP_PARTIAL_MISS",
			"field_type": "number",
			"id": "tcp_partial_miss",
			"name": "TCP_PARTIAL_MISS",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/tcp-expired-hit",
			"@type": "Metric",
			"description": "The number of requests with cache_status TCP_EXPIRED_HIT",
			"field_type": "number",
			"id": "tcp_expired_hit",
			"name": "TCP_EXPIRED_HIT",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/tcp-expired-miss",
			"@type": "Metric",
			"description": "The number of requests with cache_status TCP_EXPIRED_MISS",
			"field_type": "number",
			"id": "tcp_expired_miss",
			"name": "TCP_EXPIRED_MISS",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/tcp-mem-hit",
			"@type": "Metric",
			"description": "The number of requests with cache_status TCP_MEM_HIT",
			"field_type": "number",
			"id": "tcp_mem_hit",
			"name": "TCP_MEM_HIT",
			"unit": "number"
		}, {
			"@id": "/report-builder/v1/metrics/tcp-client-refresh-miss",
			"@type": "Metric",
			"description": "The number of requests with cache_status TCP_CLIENT_REFRESH_MISS",
			"field_type": "number",
			"id": "tcp_client_refresh_miss",
			"name": "TCP_CLIENT_REFRESH_MISS",
			"unit": "number"
		}
	]
}