List groups

GET https://{{host}}/datastream-config-api/v2/log/groups

Returns access groups with contracts on your account. You can later use the groupId and contractId values to create and view streams or list properties by group. Set the contractId query parameter to get groups for a specific contract.

Request Params

KeyDatatypeRequiredDescription
contractIdstring(Optional) Uniquely identifies the contract that belongs to a group.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"groups":[{"childGroupIds":[],"contractIds":["K-0N7RAK7"],"groupId":32145,"groupName":"Default Group"},{"childGroupIds":[],"contractIds":["K-0N7RAK7"],"groupId":54321,"groupName":"Group-4"},{"childGroupIds":[67377,21484],"contractIds":["K-0N7RAK71"],"groupId":12345,"groupName":"Group-1"},{"childGroupIds":[67377],"contractIds":["C-0N7RAC71"],"groupId":32145,"groupName":"Group 2"},{"childGroupIds":[],"contractIds":["C-0N7RAC71"],"groupId":32145,"groupName":"Group 3"},{"childGroupIds":[],"contractIds":["C-0N7RAC71"],"groupId":54321,"groupName":"Backup Group"}]}