GET   groups

Gets a hierarchy of all monitor groups that are visible to you as a user or a customer depending on the request context.

Remarks

1) Since "top" groups may contain "sub" groups, in the example they are displayed as NULL. But they contain the same fields.
2) The default context for the route is the user context. To enable customer context (if it's allowed for the user) use the request query parameter customer_context=1.

Request example

curl --request GET "https://api-asm1.apica.io/v3/groups?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"

Response body model example and description

[
  {
    "id": 13,
    "name": "Group #2",
    "rank": 4,
    "groups": null
  },
  {
    "id": 13,
    "name": "Group #3",
    "rank": 4,
    "groups": null
  },
  {
    "id": 13,
    "name": "Group #2",
    "rank": 4,
    "groups": null
  }
]
NameType Description
id Integer

The group's numeric identity.

name String

The group's name.

rank Integer

The group's rank.

groups Array

The group's sub-groups.

id Integer

The group's numeric identity.

name String

The group's name.

rank Integer

The group's rank.

groups Array

The group's sub-groups.