Skip to content
API Catalog/
Vanda Analytics Timeserie...
/Comparison

Compare multiple aggregates

Request

Compare metrics across multiple aggregates over a date range (Testing).

Security
HTTPBearer
Bodyapplication/jsonrequired
aggregate_idsArray of integers, [ 2 .. 10 ] items(Aggregate Ids)required

List of aggregate IDs to compare

intervalstring(IntervalEnum)

Time interval

Default:"1d"
Enum:"10min""30min""1h""1d""1w""1m""1y"
start_datestring, (date-time)(Start Date)required

Start date

end_datestring, (date-time)(End Date)required

End date

metricsArray of strings, [ 1 .. 10 ] items(Metrics)

Metrics to compare

Default:["retail_net_turnover"]
asset_classstring(AssetClassEnum)

Asset class

Default:"cash"
Enum:"all""cash""options"
curl -i -X POST \
  https://docs.vanda-analytics.com/_mock/apis/aggregates/vanda-msvc-aggregates/aggregates/comparison/compare \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "aggregate_ids": [
      0,
      0
    ],
    "interval": "10min",
    "start_date": "2019-08-24T14:15:22Z",
    "end_date": "2019-08-24T14:15:22Z",
    "metrics": [
      "retail_net_turnover"
    ],
    "asset_class": "all"
  }'

Responses

Successful Response

Bodyapplication/json
aggregatesobject(Aggregates)required

Comparison data grouped by aggregate ID

intervalstring(Interval)required

Time interval

metricsArray of strings(Metrics)required

Metrics compared

date_rangeobject(Date Range)required

Date range

Response
{
  "aggregates": {
    "property1": {},
    "property2": {}
  },
  "interval": "string",
  "metrics": [
    "string"
  ],
  "date_range": {
    "property1": "2019-08-24T14:15:22Z",
    "property2": "2019-08-24T14:15:22Z"
  }
}

Compare multiple aggregates

Request

Compare metrics across multiple aggregates over a date range (Testing).

Security
HTTPBearer
Bodyapplication/jsonrequired
aggregate_idsArray of integers, [ 2 .. 10 ] items(Aggregate Ids)required

List of aggregate IDs to compare

intervalstring(IntervalEnum)

Time interval

Default:"1d"
Enum:"10min""30min""1h""1d""1w""1m""1y"
start_datestring, (date-time)(Start Date)required

Start date

end_datestring, (date-time)(End Date)required

End date

metricsArray of strings, [ 1 .. 10 ] items(Metrics)

Metrics to compare

Default:["retail_net_turnover"]
asset_classstring(AssetClassEnum)

Asset class

Default:"cash"
Enum:"all""cash""options"
curl -i -X POST \
  https://docs.vanda-analytics.com/_mock/apis/aggregates/vanda-msvc-aggregates/aggregates/comparison/compare \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "aggregate_ids": [
      0,
      0
    ],
    "interval": "10min",
    "start_date": "2019-08-24T14:15:22Z",
    "end_date": "2019-08-24T14:15:22Z",
    "metrics": [
      "retail_net_turnover"
    ],
    "asset_class": "all"
  }'

Responses

Successful Response

Bodyapplication/json
aggregatesobject(Aggregates)required

Comparison data grouped by aggregate ID

intervalstring(Interval)required

Time interval

metricsArray of strings(Metrics)required

Metrics compared

date_rangeobject(Date Range)required

Date range

Response
{
  "aggregates": {
    "property1": {},
    "property2": {}
  },
  "interval": "string",
  "metrics": [
    "string"
  ],
  "date_range": {
    "property1": "2019-08-24T14:15:22Z",
    "property2": "2019-08-24T14:15:22Z"
  }
}