Favicon

You are here: Home > API Reference > Workspace > Segment > Get segment counts

Get segment counts

Required Permission: base.organization.segment.counts

Get segment counts

GET
/v1/organizations/:organizationId/segments/:segmentId/counts
Copy to clipboard

Get segment counts

Required Permission: base.organization.segment.counts

Get segment counts

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
segmentId integer
required
expandTo string
optional
ancestorschildren

Responses

200 Response application/json
status boolean required
data object required
segment object required
id number required
name string required
≤ 256 characters
counts object required
mdm object required
users number required
android object required
devices number required
policies number required
pendingEnrollmentTokens number required
apple object required
devices number required
policies number required
profiles number required
applications number required
enrollments number required
windows object required
devices number required
policies number required
pendingEnrollmentTokens number required
assets object required
apps number required
books number required
scripts number required
storage number required
certificates number required
images number required
{
    "status": true,
    "data": {
        "segment": {
            "id": 0,
            "name": "string"
        },
        "counts": {
            "mdm": {
                "users": 0,
                "android": {
                    "devices": 0,
                    "policies": 0,
                    "pendingEnrollmentTokens": 0
                },
                "apple": {
                    "devices": 0,
                    "policies": 0,
                    "profiles": 0,
                    "applications": 0,
                    "enrollments": 0
                },
                "windows": {
                    "devices": 0,
                    "policies": 0,
                    "pendingEnrollmentTokens": 0
                },
                "assets": {
                    "apps": 0,
                    "books": 0,
                    "scripts": 0,
                    "storage": 0,
                    "certificates": 0,
                    "images": 0
                }
            }
        }
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}