Get Metric

Retrieves a specific metric.

Request

Retrieve a metric via the following request:

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

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
Metric ID	Replace this variable with the system-defined ID of the desired metric. Use the Get All Metrics endpoint to retrieve a list of metrics and their system-defined IDs.

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 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/request-count",
	"@type": "Metric",
	"description": "The number of requests.",
	"field_type": "number",
	"id": "request_count",
	"name": "Requests",
	"unit": "number"
}