List Operation

Returns a paginated list of all operations, ongoing and completed.

Query Parameters

paginationToken string optional

Optional pagination token for retrieving further results from a known state. List params should not change between consecutive paginated requests (limit is an exception).

limit int32 optional

Optional limit to the number of operations returned. If not specified, the max (100) operations are returned.

state string optional

Possible values: [PENDING, COMPLETED, FAILED]

If set, filters the returned operations to include only those in the given state.

type string optional

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

If set, filters the returned operations to include only those with the given type.

Responses

200

---

A successful response.

Schema

Example

---

Schema

operations object[] optional
The list of matching operations up to the limit. If empty, no operations matched.
Array [
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.
]
nextPaginationToken string optional

If present, this pagination token can be supplied in a subsequent request to get the next batch of results. If not present, there are no further results.

{
  "nextPaginationToken": "fbvcfghgfrw",
  "operations": [
    {
      "id": "YnVsa3k6NTc0OTU2MzMzMTcwNjg4MA==",
      "type": "DELETE_USER",
      "details": null,
      "results": null,
      "state": "PENDING",
      "errorDetails": "",
      "createdAt": "2018-04-19T22:40:52.174736Z",
      "finishedAt": "2018-04-19T22:40:54.473657Z",
      "estimatePctComplete": 10
    }
  ]
}

Loading...