You are here:
Get Objects by Attribute and Object Type
Get all objects for a given attribute and object type.
GET /v1/segment/objects/{segment code}/count?type={type}
Description
This API is used in the same manner as GET /segment/interests/{ObjectType}?ID={ID1},{ID2},{ID3}. It includes an optional object type filter on the results to return only that object type. This service goes through all objects in the ProfileSegmentAssignment object and filters by type, if provided.
Package
-
Communication (vlocity_cmt)
-
Vlocity Health (vlocity_ins)
-
Insurance (vlocity_ins)
-
Government (vlocity_ps)
Parameters
Parameter |
Description |
Optional |
Example |
|---|---|---|---|
SegmentCode |
Segment code, uniquely generated per segment |
Required |
|
Type |
Object type, which is the same as the subject type |
Optional |
|
Resource information
Response Format |
JSON |
|---|---|
Resource URL |
services/apexrest/{namespace}/v1/segment/objects/{segment code}/count?type={type} |
EXAMPLE REQUEST
GET
/services/apexrest/vlocity_cmt/v1/segment/objects/ATTRIBUTE-255/count?type=Contact
EXAMPLE RESULT
{
"count": "3",
"objectName": "Contact",
"segment": "ATTRIBUTE-255"
}
