List all periods

GET 
/v1/metadata/periods

Get full list of supported time periods

Available periods

Time unit	Period identifiers
Second	1SEC, 2SEC, 3SEC, 4SEC, 5SEC, 6SEC, 10SEC, 15SEC, 20SEC, 30SEC
Minute	1MIN, 2MIN, 3MIN, 4MIN, 5MIN, 6MIN, 10MIN, 15MIN, 20MIN, 30MIN
Hour	1HRS, 2HRS, 3HRS, 4HRS, 6HRS, 8HRS, 12HRS
Day	1DAY, 2DAY, 3DAY, 5DAY, 7DAY, 10DAY
Month	1MTH, 2MTH, 3MTH, 4MTH, 6MTH
Year	1YRS, 2YRS, 3YRS, 4YRS, 5YRS

tip

You can assume that we will not remove any periods from this response, however, we may add new ones.

Responses

200

successful operation

text/plain

Schema

Schema

• Array [

period_id stringnullable

Gets or sets the period ID.

length_seconds int32

Gets or sets the length of the period in seconds.

length_months int32

Gets or sets the length of the period in months.

unit_count int32nullable

Gets or sets the unit count.

unit_name stringnullable

Gets or sets the unit name.

display_name stringnullable

Gets or sets the display name of the timeseries period.

• ]

Example (from schema)

[
  {
    "period_id": "string",
    "length_seconds": 0,
    "length_months": 0,
    "unit_count": 0,
    "unit_name": "string",
    "display_name": "string"
  }
]

Example response

[
  {
    "period_id": "1SEC",
    "length_seconds": 1,
    "length_months": 0,
    "unit_count": 1,
    "unit_name": "second",
    "display_name": "1 Second"
  },
  {
    "period_id": "10DAY",
    "length_seconds": 864000,
    "length_months": 0,
    "unit_count": 10,
    "unit_name": "day",
    "display_name": "10 Days"
  },
  {
    "period_id": "2YRS",
    "length_seconds": 0,
    "length_months": 24,
    "unit_count": 2,
    "unit_name": "year",
    "display_name": "2 Years"
  }
]

application/json

Schema

Schema

• Array [

period_id stringnullable

Gets or sets the period ID.

length_seconds int32

Gets or sets the length of the period in seconds.

length_months int32

Gets or sets the length of the period in months.

unit_count int32nullable

Gets or sets the unit count.

unit_name stringnullable

Gets or sets the unit name.

display_name stringnullable

Gets or sets the display name of the timeseries period.

• ]

Example (from schema)

[
  {
    "period_id": "string",
    "length_seconds": 0,
    "length_months": 0,
    "unit_count": 0,
    "unit_name": "string",
    "display_name": "string"
  }
]

Example response

[
  {
    "period_id": "1SEC",
    "length_seconds": 1,
    "length_months": 0,
    "unit_count": 1,
    "unit_name": "second",
    "display_name": "1 Second"
  },
  {
    "period_id": "10DAY",
    "length_seconds": 864000,
    "length_months": 0,
    "unit_count": 10,
    "unit_name": "day",
    "display_name": "10 Days"
  },
  {
    "period_id": "2YRS",
    "length_seconds": 0,
    "length_months": 24,
    "unit_count": 2,
    "unit_name": "year",
    "display_name": "2 Years"
  }
]

text/json

Schema

Schema

• Array [

period_id stringnullable

Gets or sets the period ID.

length_seconds int32

Gets or sets the length of the period in seconds.

length_months int32

Gets or sets the length of the period in months.

unit_count int32nullable

Gets or sets the unit count.

unit_name stringnullable

Gets or sets the unit name.

display_name stringnullable

Gets or sets the display name of the timeseries period.

• ]

Example (from schema)

[
  {
    "period_id": "string",
    "length_seconds": 0,
    "length_months": 0,
    "unit_count": 0,
    "unit_name": "string",
    "display_name": "string"
  }
]

Example response

[
  {
    "period_id": "1SEC",
    "length_seconds": 1,
    "length_months": 0,
    "unit_count": 1,
    "unit_name": "second",
    "display_name": "1 Second"
  },
  {
    "period_id": "10DAY",
    "length_seconds": 864000,
    "length_months": 0,
    "unit_count": 10,
    "unit_name": "day",
    "display_name": "10 Days"
  },
  {
    "period_id": "2YRS",
    "length_seconds": 0,
    "length_months": 24,
    "unit_count": 2,
    "unit_name": "year",
    "display_name": "2 Years"
  }
]

application/x-msgpack

Schema

Schema

• Array [

period_id stringnullable

Gets or sets the period ID.

length_seconds int32

Gets or sets the length of the period in seconds.

length_months int32

Gets or sets the length of the period in months.

unit_count int32nullable

Gets or sets the unit count.

unit_name stringnullable

Gets or sets the unit name.

display_name stringnullable

Gets or sets the display name of the timeseries period.

• ]

Example (from schema)

[
  {
    "period_id": "string",
    "length_seconds": 0,
    "length_months": 0,
    "unit_count": 0,
    "unit_name": "string",
    "display_name": "string"
  }
]

Example response

[
  {
    "period_id": "1SEC",
    "length_seconds": 1,
    "length_months": 0,
    "unit_count": 1,
    "unit_name": "second",
    "display_name": "1 Second"
  },
  {
    "period_id": "10DAY",
    "length_seconds": 864000,
    "length_months": 0,
    "unit_count": 10,
    "unit_name": "day",
    "display_name": "10 Days"
  },
  {
    "period_id": "2YRS",
    "length_seconds": 0,
    "length_months": 24,
    "unit_count": 2,
    "unit_name": "year",
    "display_name": "2 Years"
  }
]

Loading...

Was this section helpful?

• 1
• 2
• 3
• 4
• 5