Skip to main content
GET
/
directory
/
stats
Get directory user statistics
curl --request GET \
  --url https://api.wirespeed.co/directory/stats \
  --header 'Authorization: Bearer <token>'
{
  "totalCount": 123,
  "containedCount": 123,
  "enabledCount": 123,
  "disabledCount": 123,
  "userTypes": [
    {
      "type": "VIP",
      "count": 123
    }
  ],
  "integrations": [
    {
      "integrationId": "<string>",
      "platform": "aws",
      "count": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

User statistics including counts by type, status, and source

totalCount
number
required

Total number of managed users

containedCount
number
required

Number of contained users

enabledCount
number
required

Number of enabled users

disabledCount
number
required

Number of disabled users

userTypes
object[]
required

User counts by tag. Tags are non-exclusive; a user can appear in multiple types. "Other" counts users with none of the tracked tags.

integrations
object[]
required

User counts by integration source