Get summary data

GET 
/api/v1/summary

Request

Query Parameters

id stringrequired

Index ID

Responses

200

successful operation

application/json

Schema

Schema

serverTime date-time
error stringnullable

description of error in natural language, absent in case of successful operation

payload

object

nullable

The response data

value stringnullable

Most recently published index value

time int64nullable

Milliseconds since Unix epoch of most recent value

last24Hours

object[]

Published values and times from the last 24 hours

Array [

value string

Published index value

time int64

Time of value publication in milliseconds since Unix epoch

]

Example (from schema)

{
  "serverTime": "2024-01-01T09:00:00.000Z",
  "error": "string",
  "payload": {
    "value": "string",
    "time": 0,
    "last24Hours": [
      {
        "value": "string",
        "time": 0
      }
    ]
  }
}

Loading...