Summary Contacts
Endpoint: GET v2/contacts/meta
This endpoint provides a summary of the contact data stored in the contact system.
Response data type
{ "totalCount": 10, "labels": [ { "labelName": "all", "usageCount": 10 }, { "labelName": "Customer", "usageCount": 7 }, { "labelName": " Coworker", "usageCount": 3 } ], "properties": [ { "propertyName": "email", "usageCount": 9, "averageLength": 20, "maxLength": 26, "minLength": 16 }, { "propertyName": "firstName", "usageCount": 10, "averageLength": 5, "maxLength": 6, "minLength": 3 }, { "propertyName": "lastName", "usageCount": 10, " averageLength": 7, "maxLength": 12, "minLength": 5 }, { "propertyName": "department", "usageCount": 10, "averageLength": 4, "maxLength": 8, "minLength": 3 }, { "propertyName": "phoneNumber", "usageCount": 10, "averageLength": 12, "maxLength": 12, "minLength": 12 } ] }
totalCount
The total number of contacts stored.
labels
One entry for each label used.
labels.labelName
An individual Labels name
labels.usageCount
The number of stored contacts assigned to the label.
properties
One record for each property used.
properties.propertyName
The name/key of the property.
properties.usageCount
The number of contacts that have a value for the property.
properties.averageLength
The average length of the property among stored contacts.
properties.maxLength
The longest value for the property among the stored contact.
properties.minLength
The shortest value of the property among the stored contact.