Timeline Tags

#340260

Description

This resource is used to return the timeline definition. It returns details of the four predictive timeframes using tags "7D", "30D", "60D" and "90D". This resource is useful when interpreting stats and metrics of the Control Environment, Infrastructure Group and Sensor objects.

Resource

/timeline-tags

Supported Operations

Table: Timeline Tags Supported Operations

Operation	HTTP Method	Input	Output	Description
Get Timeline Tags	GET /timeline-tags	None	Timeline Tags: Resource Elements	The timeline definition for the four predictive timeframes. Example: Getting the Timeline Tags

Operation

HTTP Method

Input

Output

Description

Get Timeline Tags

GET /timeline-tags

None

Timeline Tags: Resource Elements

The timeline definition for the four predictive timeframes.

Example: Getting the Timeline Tags

Resource Elements

Table: Timeline Tags Resource Elements

Element	Type	Description
<tag>	Complex, as specified in the Description	For each timeframe tag, provides the following as defined in Administration > Timeline Definition: short_name—Short Name, with default "7", "30", "60", "90" long_name—Long Name, with default "7 Days", "30 Days", "60 Days", "90 Days" offset—Offset converted to days (offset from today's date), with default 7, 30, 60, 90 order_index—Predictive Timeframe (i.e. 1..4 indicating the order of the timeframes) date—UTC date rounding—"RND_NM" to round up to the next month, "RND_NFQ" to the next quarter, "RND_NONE" for no rounding. The above information is defined for each timeframe tag <tag>, which are constants and defined as "7D", "30D", "60D" and "90D".

Element

Type

Description

<tag>

Complex, as specified in the Description

For each timeframe tag, provides the following as defined in Administration > Timeline Definition:

short_name—Short Name, with default "7", "30", "60", "90"
long_name—Long Name, with default "7 Days", "30 Days", "60 Days", "90 Days"
offset—Offset converted to days (offset from today's date), with default 7, 30, 60, 90
order_index—Predictive Timeframe (i.e. 1..4 indicating the order of the timeframes)
date—UTC date
rounding—"RND_NM" to round up to the next month, "RND_NFQ" to the next quarter, "RND_NONE" for no rounding.

The above information is defined for each timeframe tag <tag>, which are constants and defined as "7D", "30D", "60D" and "90D".

Examples

Example: Getting the Timeline Tags

The following example shows you how to get the timeline tags that are in use.

Example: Getting the Timeline Tags

Request:

GET /timeline-tags

Response:

{

"90D": {

"short_name": "24",

"long_name": "24 Months",

"offset": 720,

"order_index": 4,

"date": 1451538000000,

"rounding": "RND_NM"

"30D": {

"short_name": "3",

"long_name": "3 Months",

"offset": 90,

"order_index": 2,

"date": 1396238400000,

"rounding": "RND_NM"

"60D": {

"short_name": "12",

"long_name": "12 Months",

"offset": 360,

"order_index": 3,

"date": 1420002000000,

"rounding": "RND_NM"

"7D": {

"short_name": "1",

"long_name": "1 Month",

"offset": 30,

"order_index": 1,

"date": 1391144400000,

"rounding": "RND_NM"

}