Skip to content
API Catalog/
Vanda Analytics Timeserie...
/
/
Get basket by ID

Get basket by ID

Request

Retrieve a specific basket (cached per user)

Security
HTTPBearer
Path
basket_idinteger(Basket Id)required

Basket ID

curl -i -X GET \
  'https://docs.vanda-analytics.com/_mock/apis/aggregates/vanda-msvc-aggregates/aggregates/baskets/{basket_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
namestring, [ 1 .. 100 ] characters(Name)required
idinteger(Id)required
vanda_idstring(Vanda Id)required
user_idinteger(User Id)required
underlying_idsArray of integers(Underlying Ids)required
activeboolean(Active)required
agg_px_ref_sec_idinteger or null(Agg Px Ref Sec Id)required
Any of:
integer
constituent_countinteger(Constituent Count)required
Response
{
  "name": "string",
  "id": 0,
  "vanda_id": "string",
  "user_id": 0,
  "underlying_ids": [
    0
  ],
  "active": true,
  "agg_px_ref_sec_id": 0,
  "constituent_count": 0
}

Get basket by ID

Request

Retrieve a specific basket (cached per user)

Security
HTTPBearer
Path
basket_idinteger(Basket Id)required

Basket ID

curl -i -X GET \
  'https://docs.vanda-analytics.com/_mock/apis/aggregates/vanda-msvc-aggregates/aggregates/baskets/{basket_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
namestring, [ 1 .. 100 ] characters(Name)required
idinteger(Id)required
vanda_idstring(Vanda Id)required
user_idinteger(User Id)required
underlying_idsArray of integers(Underlying Ids)required
activeboolean(Active)required
agg_px_ref_sec_idinteger or null(Agg Px Ref Sec Id)required
Any of:
integer
constituent_countinteger(Constituent Count)required
Response
{
  "name": "string",
  "id": 0,
  "vanda_id": "string",
  "user_id": 0,
  "underlying_ids": [
    0
  ],
  "active": true,
  "agg_px_ref_sec_id": 0,
  "constituent_count": 0
}