Get Segmentation Session Status

• Asset Onboarding

Get segmentation session status

Retrieves detailed real-time status information for a segmentation session. This endpoint provides the current status, progress, and any errors without returning the full session object. Use this for polling or monitoring session progress.

Notes

• Polling states for the session are FILE_VALIDATING, FILE_PARSING, ANALYSIS_PENDING, ANALYSIS_IN_PROGRESS
• Refer to PUT /segmentation/{session-id}/ for details on expected state transitions and actions.
• Returns 200 on success

Request

URI

GET

https://{api_host}/ssp/segmentation/{session-id}/status

COPY

Path Parameters

string

session-id

Required  

Unique identifier of the segmentation session

---

Authentication

This operation uses the following authentication methods.

enterprise_admin

security_engineer

security_op

auditor

Responses

200

Hide Details

Successfully retrieved session status

Returns SegmentationSessionStatusInfo of type(s) application/json

{
    "status": "ANALYSIS_PENDING",
    "progress_percent": 5,
    "error_messages": [],
    "parsing_error_count": 0
}

string

status

Required  

Current status of the segmentation session.

• FILE_VALIDATING: CSV file is being validated
• FILE_VALIDATE_ERROR: CSV file validation failed
• FILE_VALIDATED: CSV file successfully validated
• FILE_READY_TO_PARSE: File is ready for parsing
• FILE_PARSING: File is being parsed
• FILE_PARSING_ERROR: File parsing failed
• FILE_PARSED: File successfully parsed
• ANALYSIS_PENDING: Analysis is queued but not started
• ANALYSIS_IN_PROGRESS: Analysis is currently running
• ANALYSIS_ERROR: Analysis encountered an error
• ANALYSIS_SUCCESS: Analysis completed successfully

Enumeration: FILE_VALIDATING, FILE_VALIDATE_ERROR, FILE_VALIDATED, FILE_READY_TO_PARSE, FILE_PARSING, FILE_PARSING_ERROR, FILE_PARSED, ANALYSIS_PENDING, ANALYSIS_IN_PROGRESS, ANALYSIS_ERROR, ANALYSIS_SUCCESS

integer

progress_percent

Required   Read-Only  

Constraints: minimum: 0 maximum: 100

Progress percentage of current operation (0-100)

array of string

error_messages

Optional

List of error messages if session encountered issues

integer

parsing_error_count

Read-Only  

Constraints: minimum: 0

Count of rows that encountered errors during CSV parsing

400

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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/{session-id}/status
                

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

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