Contact Properties Statistics

POST

/v1/contact-property-definitions/{{id}}/statistics

Returns a breakdown of how many contacts in the workspace have each value of a Select-type custom property. e.g. "how many contacts are Gold / Silver / unset for Loyalty Tier," optionally scoped by the same filters used in Search Contacts.

Request body is optional — omit it (or send {}) to compute statistics across all contacts in the workspace. When provided, it accepts the same filter fields as Search Contacts: name, phoneNumber, customPropertyFilters, conversationAssigneeIds, includeUnassignedConversations.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢200OK

application/json

Per-option contact counts for the given Select property.

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://api.voxa.sa/v1/contact-property-definitions/{{id}}/statistics' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "conversationAssigneeIds": [
        "USER_ID"
    ],
    "includeUnassignedConversations": false
}'

Response Example

{
    "propertyDefinitionId": "3a214c...............",
    "propertyName": "workspace_stage",
    "totalContacts": 20120,
    "nullCount": 15625,
    "optionCounts": [
        {
            "value": "Activation",
            "color": "#84CC16",
            "count": 344
        },
        {
            "value": "ChurnedRisk",
            "color": "#EC4899",
            "count": 327
        },
        {
            "value": "Activated",
            "color": "#10B981",
            "count": 416
        },
        {
            "value": "Lead",
            "color": "#F59E0B",
            "count": 3408
        }
    ]
}

Modified at 2026-06-21 13:12:31

List Contact Properties

Create Contact Property