Initiate request by specifying a Segment Group name. You can optionally pass lastdatetime to retrieve data for a specific period.
You can also specify MatchCriteria to retrieve data for specific profiles. ProfileID, AlternateID, EmailAddress, and PhoneNumber are the supported match criteria.
When MatchCriteria is provided in a request, it is merged with the segment group's predefined criteria to produce an output dataset that meets the segment group configuration while including only the specified profiles. If MatchCriteria is not supplied, the API returns all profiles that match the search criteria defined in the segment group.
The MatchType parameter is required when MatchCriteria is set to AlternateId, ensuring precise identifier resolution. For ProfileID, EmailAddress, and PhoneNumber, MatchType is optional. When provided, it filters the results to include only profiles that match the specified type. If omitted, the API processes the request based solely on the Values specified in the request.
When EmailAddress or PhoneNumber is used as the MatchCriteria, the MatchType can be a corresponding email or phone type. In this case, the returned data is filtered by the segment group criteria but includes only the profiles from your request that also contain the specified email address or phone number.
When ProfileID is used as the MatchCriteria, MatchType can be a customer type. In this case, the returned data is filtered based on the segment group criteria, including only the requested profiles that match the given customer type.
Response
Response Attributes
AccessTokeninteger
Secure token returned by the Initiate call, required as a URL parameter in all subsequent API requests.
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
The requested resource cannot be found. Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found. See error description for more details.
The server is unable to handle your request due to a temporary condition. You must delay your request for some time before trying again. Notify PossibleNOW Support if it’s a continuous occurrence.
