List Segmentation Sessions

List Segmentation Sessions
List segmentation sessions

Retrieves all active segmentation sessions, once a session is deleted it will no longer appear here.

Notes

  • The id from each session entry is the session-id used in all /{session-id}/* endpoints.
  • Sessions are returned in no guaranteed order; use GET /{session-id}/status to check the current lifecycle state of a specific session.
  • Returns 200 on success.
Request
URI
GET
https://{api_host}/ssp/segmentation
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved list of segmentation session Ids

Returns SegmentationSessionsList of type(s) application/json 
{
    "sessions": [
        {
            "action": "NONE",
            "_create_user": "admin",
            "_create_time": 1781138986293,
            "_last_modified_user": "admin",
            "_last_modified_time": 1781138986293,
            "_revision": 0,
            "id": "f4a7eb15-43c4-44cb-ac5c-8a5d5c15235b",
            "display_name": "session_f4a7eb15-43c4-44cb-ac5c-8a5d5c15235b",
            "site_ids": [],
            "status": {
                "status": "FILE_VALIDATED",
                "progress_percent": 0,
                "error_messages": [],
                "parsing_error_count": 0
            },
            "output_files": [
                {
                    "file_name": "sample-asset-file.csv"
                }
            ]
        }
    ]
}
array of sessions
sessions
Required  

List of segmentation sessions


400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


412

Precondition Failed

Returns PreconditionFailed of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


428

Precondition Required

Returns PreconditionRequired of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


429

Too Many Requests

Returns TooManyRequests of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


default

Unexpected error

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/ssp/segmentation
On This Page
Asset Onboarding Operations
GET
List Segmentation Sessions
POST
Create Segmentation Session
GET
Get Segmentation Settings
PUT
Update Segmentation Settings
GET
Get Segmentation Session
PUT
Update Segmentation Session
DELETE
Delete Segmentation Session
GET
Get Segmentation Session Status
GET
Get Segmentation Session Settings
PUT
Update Segmentation Session Settings
POST
Query Csv Entries
GET
Export Annotated Csv
POST
Query Resolved Objects
POST
Query Analysis Alerts
POST
Query Proposed Segmentation Objects
GET
Get Proposed Segmentation Object
PUT
Update Proposed Segmentation Object
GET
Get Proposed Segmentation Object Status
POST
Query Proposed Segmentation Group Resolved Members
POST
Query Proposed Segmentation Group Ip Addresses