List Segment Types (ARM)

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

Lists all the static and dynamic Segment types for a hub.


The request is constructed as follows:

HTTP Verb Request URI
GET <<subId>/resourceGroups/<rgName>/providers/Microsoft.CustomerInsights/hubs/<hubName>/segments?api-version=2017-04-26&locale=<locale-code>

URI Parameters

URI Parameter Required Description
subId Yes The Azure subscription ID
rgName Yes The resource group name
hubName Yes Name of your Customer Insights Hub
locale-code No The localization code to apply to any returned properties. If no locale code is specified, then 'en-us' is used as default.

Optionally, pagination is supported by the top and skip query parameters, for example:

GET . . .<hubName>/segments?$top=2&$skip=10


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

Response Body

Upon success, a collection of Segment type definitions, for example:

            "description":"Test Descrtion", 
            "tags": [] 
         "segmentState":{ "evaluationDuration":"00:00:35", "segmentEvaluationState":"Success", "segmentSize":7 }, 
            "memberIds":[ "1", "2", "3" ], 
            "tags": [] 
         "segmentState":{ "segmentSize":0 }, 

Status Code

  • 200 (OK) - Segment was returned successfully.
  • 403 (Forbidden) - Operation was blocked, often because the Segmentation feature flag is disabled.