Get Granularity

Retrieves a specific granularity.

Request

Retrieve a dimension via the following request:

HTTP Method	Request URI
GET	https://api.vdms.io/report-builder/v1/granularities/Granularity 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
Granularity ID	Replace this variable with the system-defined ID of the desired granularity. Use the Get All Granularities endpoint to retrieve a list of granularities 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 granularity.
@type	String	Returns Granularity.
description	String	Describes the purpose of the current granularity.
duration_seconds	Integer	This property is reserved for future use.
id	String	Identifies the granularity by its system-defined ID.
name	String	Identifies the granularity by its friendly name.

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/granularities/hour",
	"@type": "Granularity",
	"description": "Aggregate every 1 hour",
	"duration_seconds": 3600,
	"id": "hour",
	"name": "Hourly"
}