ATattentive
Segments

Get the status of the most recent clear-segment operation

Changed on

Returns the status of the most recent clear-segment operation for the segment identified by its external ID. The response includes the processing status, timestamps, and a failure reason if applicable.

Only segments created via the Public API can be queried using this endpoint.

Scopes Required: [segments:Read]

Default Rate Limit: 100 requests per second

get/v2/segments/external/{externalId}/clear-segment/status

Request

  • Base URL
    https://api.attentivemobile.com
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://ui-devel.attentivemobile.com/integrations/oauth-install?client_id={clientId}&redirect_uri={redirectUri}&scope={scope}
      Token URL: https://api.attentivemobile.com/v1/authorization-codes/tokens scopes: segments:read

Path parameters

externalIdstring required

External ID of the segment to check clear status for

Response

Clear segment status retrieved successfully

status'RUNNING' | 'COMPLETED' | 'FAILED' | 'NOT_FOUND'

The status of the most recent clear-segment operation. RUNNING indicates the operation is still in progress. COMPLETED indicates the operation finished successfully. FAILED indicates the operation encountered an error. NOT_FOUND indicates no clear operation has been performed for this segment.

startedAtstring date-time

The timestamp when the clear operation started processing

completedAtstring date-time

The timestamp when the clear operation finished. Only present when status is COMPLETED or FAILED.

failureReasonstring

A description of why the clear operation failed. Only present when status is FAILED.

Example response

{
  "status": "COMPLETED",
  "startedAt": "2026-09-22T14:30:00Z",
  "completedAt": "2026-09-22T14:31:00Z",
  "failureReason": "The clear operation failed"
}

Changes