Estimate Segment Result Count (Hub Data)

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

Returns the estimated result count for the specified query, useful for query result comparisons and data transfer preparation before an actual call to the Evaluate Static Segment Query operation.

Request

The request is constructed as follows:

HTTP Verb Request URI
POST <Hub-endpoint>/data/segments/estimation?api-version=2017-04-26

URI Parameters

URI Parameter Required Description
Hub-endpoint Yes The base URL for your Customer Insights Hub

Request Body

Must contain a JSON object that contains the filter query and target member type, for example:

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

Response

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

Response Body

Upon success, an estimated count of the form:

{ 
  "estimatedCount": <int> 
} 

Status Code

  • 200 (OK) - Query result count was returned successfully.
  • 400 (Bad Request) - Missing or invalid query
  • 408 (Request timeout) - Query processing exceeded maximum time limit.