Get Operation

Return the status of one particular operation given the operation ID.

Path Parameters

id string required

The ID of the initiated operation

Responses

200

---

A successful response.

Schema

Example

---

Schema

id string optional

The id of the operation.

type string optional

Possible values: [DELETE_USER, SEARCH_EXPORT, DELETE_SESSION, DELETE_SEGMENT_SESSIONS, DELETE_SEGMENT_USERS]

The type of the operation.

details object optional

May contain additional information about the operation. See Operation Results and Details for operation specific information.

results object optional

If the operation produces results and the operation completed successfully, this will contain information relevant to the type of operation. See Operation Results and Details for operation specific information.

state string optional

Possible values: [PENDING, COMPLETED, FAILED]

The current state of the operation.

errorDetails string optional

If the state is FAILED, this will contain a message describing why the operation failed.

createdAt date-time optional

UTC RFC 3339 timestamp for when the operation was scheduled.

finishedAt date-time optional

UTC RFC 3339 timestamp for when the operation finished, either successfully or with an error.

estimatePctComplete int64 optional

A number from 0 to 100 that indicates an estimation of how much progress has been made on a pending operation.

step string optional

Indicator of the operation's current step which can provide non-quantitative information about an operation's progress.

{
  "id": "abcdefg1234",
  "type": "SEARCH_EXPORT",
  "details": null,
  "results": {
    "expires": "2020-09-29T10:11:12.345Z",
    "searchExportId": "YKDYR5ye_GgeKNkI16aQlEb9j7D7Vbwtv9ILHbugP7s"
  },
  "state": "COMPLETED",
  "errorDetails": "",
  "createdAt": "2020-09-22T22:40:52.174736Z",
  "finishedAt": "2020-09-22T23:30:54.473657Z",
  "estimatePctComplete": 100
}

Loading...