Evaluate Static Segment Query (Hub Data)

[This topic is pre-release documentation and is subject to change.]

Evaluates the supplied query for static Segment member candidates.

Request

The request is constructed as follows:

HTTP Verb Request URI
POST <Hub-endpoint>/data/segments/evaluation

Request Body

The request body must contain a JSON object that contains the filter query and target member type, for example:

{ 
   "query":"PROFILE(Customer).FILTER(FirstName!='Sally')",
   "targetProfileTypeName":"Customer"
}

Filtering and Ordering

The following OData query parameters can be used to control the output: top, skip, orderby and select, for example:

POST /data/segments/evaluation?$top=200&$skip=5&$orderBy=LastName asc&select=LastName,ProfileId

Where the $top and $skip parameters support pagination; their default values are 30 and 0, respectively.


Response

The response includes an HTTP status code, a response body and a set of response headers.

Response Body

The body contains an array of Profile instances, potentially filtered by the specified select expression.

Status Code

  • 200 (OK) - the request succeeded.
  • 400 (Bad Request) - invalid URI parameters, often an unrecognized continuation token.
  • 404 (Not Found) - the named segment was not found.