POST /contacts/v1/addresses/count
Fetches contact counts for the given search criteria
Name | Type | | Description |
---|
queryFilter | object | Required | Filter used in search criteria to fetch contact counts that match search criteria |
queryFilter.hasCriteria | boolean | Required | Indicates the filter specifies search criteria. This property should always include a "true" value |
queryFilter.rootExpressionSet | object | Required | Container for all expressions used in specifying search criteria. |
queryFilter.rootExpressionSet.expressions | array | Required | List of all expressions used in specifying search criteria. This resource supports only one expression |
queryFilter.rootExpressionSet.expressions.customerDataDefinitionID | short | Required | Short Numbers representing the attributeName of the search. ContactKey: 101 LastModfiedDate: 102 Source: 103 Channel: 104 Status: 105 AudienceID: 106 |
queryFilter.rootExpressionSet.expressions.operator | string | Required | The filter condition operator name. Supports only the "Equal" operator |
queryFilter.rootExpressionSet.expressions.values | array | Required | Value for attribute used in search criteria to fetch contact counts as a string array. The "Channel" attributeName (CustomerDataDefinitionID: 104) supports these channels: MOBILE PUSH LINE EMAIL |
Status | Name | Type | Description |
---|
200 | | | Successfully retrieved contact counts for specified criteria |
| totalCount | integer | Total count of contacts matching search criteria |
| requestServiceMessageID | guid | Service message ID value of request |
| resultMessages | array | Array of returned messages generated while processing request |
| serviceMessageID | guid | Service message ID value of response |
| | | |
default | | | Unexpected error |
| totalCount | integer | Total count of contacts matching search criteria |
| hasErrors | boolean | Indicates errors occured while processing request |
| requestServiceMessageID | guid | Service message ID value of request |
| resultMessages | array | Array of returned error messages generated while processing request |
| serviceMessageID | guid | Service message ID value of response |