Favicon

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

Get segment counts

Required Permission: base.organization.segment.counts

Get segment counts

GET
https://api.applivery.io/v1/organizations/{organizationId}/segments/{segmentId}/counts 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/segments/{segmentId}/counts" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/segments/{segmentId}/counts", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();
import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/segments/{segmentId}/counts",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request 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 
{
    "status": true,
    "data": {
        "segment": {
            "id": 0,
            "name": "string"
        },
        "counts": {
            "mdm": {
                "users": 0,
                "android": {
                    "devices": 0,
                    "policies": 0,
                    "pendingEnrollmentTokens": 0
                },
                "aosp": {
                    "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"
    }
}