Historical Index Value w/Composition

GET 
/v1/indexes/:index_id/history

Historical Index Value w/Composition

Request

Path Parameters

index_id stringrequired

Query Parameters

time_start date-time
time_end date-time
limit int32

Default value: 100

Responses

200

successful operation

text/plain

Schema

Schema

• Array [

timestamp date-time
value double

composition

object[]

nullable

Array [

component_id stringnullable

component_value double

]

• ]

Example (from schema)

[
  {
    "timestamp": "2024-11-07T14:04:50.707Z",
    "value": 0,
    "composition": [
      {
        "component_id": "string",
        "component_value": 0
      }
    ]
  }
]

Example response

[
  {
    "timestamp": "2024-09-05T11:29:04+00:00",
    "value": 56786.84840020827,
    "composition": []
  },
  {
    "timestamp": "2024-09-05T11:29:03+00:00",
    "value": 56786.84840020827,
    "composition": []
  },
  {
    "timestamp": "2024-09-05T11:29:02+00:00",
    "value": 56786.84840020827,
    "composition": []
  }
]

application/json

Schema

Schema

• Array [

timestamp date-time
value double

composition

object[]

nullable

Array [

component_id stringnullable

component_value double

]

• ]

Example (from schema)

[
  {
    "timestamp": "2024-11-07T14:04:50.707Z",
    "value": 0,
    "composition": [
      {
        "component_id": "string",
        "component_value": 0
      }
    ]
  }
]

Example response

[
  {
    "timestamp": "2024-09-05T11:29:04+00:00",
    "value": 56786.84840020827,
    "composition": []
  },
  {
    "timestamp": "2024-09-05T11:29:03+00:00",
    "value": 56786.84840020827,
    "composition": []
  },
  {
    "timestamp": "2024-09-05T11:29:02+00:00",
    "value": 56786.84840020827,
    "composition": []
  }
]

text/json

Schema

Schema

• Array [

timestamp date-time
value double

composition

object[]

nullable

Array [

component_id stringnullable

component_value double

]

• ]

Example (from schema)

[
  {
    "timestamp": "2024-11-07T14:04:50.707Z",
    "value": 0,
    "composition": [
      {
        "component_id": "string",
        "component_value": 0
      }
    ]
  }
]

Example response

[
  {
    "timestamp": "2024-09-05T11:29:04+00:00",
    "value": 56786.84840020827,
    "composition": []
  },
  {
    "timestamp": "2024-09-05T11:29:03+00:00",
    "value": 56786.84840020827,
    "composition": []
  },
  {
    "timestamp": "2024-09-05T11:29:02+00:00",
    "value": 56786.84840020827,
    "composition": []
  }
]

application/x-msgpack

Schema

Schema

• Array [

timestamp date-time
value double

composition

object[]

nullable

Array [

component_id stringnullable

component_value double

]

• ]

Example (from schema)

[
  {
    "timestamp": "2024-11-07T14:04:50.708Z",
    "value": 0,
    "composition": [
      {
        "component_id": "string",
        "component_value": 0
      }
    ]
  }
]

Example response

[
  {
    "timestamp": "2024-09-05T11:29:04+00:00",
    "value": 56786.84840020827,
    "composition": []
  },
  {
    "timestamp": "2024-09-05T11:29:03+00:00",
    "value": 56786.84840020827,
    "composition": []
  },
  {
    "timestamp": "2024-09-05T11:29:02+00:00",
    "value": 56786.84840020827,
    "composition": []
  }
]

Loading...

Was this section helpful?

• 1
• 2
• 3
• 4
• 5