This API call provides detailed information about events in each POP, including the operation type and summary, status, start and end time, duration, and request ID. All Observability events are returned sorted by time.
Note: Observability data is retained for a limited period and is not stored indefinitely. Ensure that any data required for long-term analysis or auditing is exported or archived externally within your retention window.
For more details about Administration API Authentication, check out the Authentication APIs documentation
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123
The Environment ID can be found under the Details Tab in the Environment Settings.
POP ID. You can find the POP ID using the GET List of POPs API or through the UI under your POP settings in the Integration Workspace.
Input one or more flow types to filter by. To filter by multiple flow types, separate them with commas (e.g. discovery,accept-all-platform-changes).
Input multiple flow types to filter by. You can choose multiple and separate them using a comma.
Input one or more statuses to filter by. To filter by multiple statuses, separate them with commas (e.g. Completed,Failed).
Input multiple types of statuses to filter by. Refer to the filter[status] parameter to filter by a single status.
The start of the time range to filter workflows by (must be in UTC). If omitted, the API defaults to the last 30 days from the time of the request.
When provided, the value must be formatted as RFC3339 or RFC3339Nano (e.g. 2024-06-01T12:00:00Z). Malformed values return a 400 error. If filter[toTime] is also set, fromTime must not be later than filter[toTime].
The end of the time range to filter workflows by (must be in UTC). If omitted, the API defaults to the current time of the request.
When provided, the value must be formatted as RFC3339 or RFC3339Nano (e.g. 2024-06-01T12:00:00Z). Malformed values return a 400 error. If filter[fromTime] is also set, toTime must not be earlier than filter[fromTime].
Maximum number of events to return (default 20, maximum 100).
Number of matching events to skip before returning results.
Success
Completed discovery event
{
"data": [
{
"flowType": "discovery",
"popId": "POPS269J5C16H8N4",
"status": "Completed",
"startTime": "2024-06-14T08:15:00Z",
"endTime": "2024-06-14T08:18:42Z",
"summary": "Discovery summary from Snowflake: 12 policies were discovered from Credit Risk Control Center",
"executionId": "0192a1b2-c3d4-7890-abcd-ef1234567890",
"requestId": "req-7f3a9c2e-4b1d-4e8a-9f0c-1a2b3c4d5e6f",
"durationMs": 222000,
"discoveryResult": {
"isDiscoveryChanged": true,
"vendorObjectsDiscovered": 45,
"vendorObjectAttributesDiscovered": 128,
"vendorIdpsDiscovered": 3,
"policiesDiscovered": 12
}
}
],
"meta": {
"total": 1,
"limit": 20,
"offset": 0
}
}Running accept-all-platform-changes event
{
"data": [
{
"flowType": "accept-all-platform-changes",
"popId": "POPS269J5C16H8N4",
"status": "Running",
"startTime": "2024-06-15T09:00:00Z",
"summary": "Accept All Platform Changes Running",
"executionId": "0192b2c3-d4e5-8901-bcde-f12345678901",
"requestId": "req-8a4b0d3f-5c2e-4f9b-a0d1-2b3c4d5e6f70",
"policiesDeployedCount": 8
}
],
"meta": {
"total": 1,
"limit": 20,
"offset": 0
}
}A single orchestration flow execution for observability listings.
Type of Operation selected
POP ID
Workflow status
Start time range for the workflow
End time range for the workflow
Scheduled time for workflow
Summary in case there is a workflow failure
Execution ID for Workflow. You can use this for the Get Observability Detailed Events API call.
Flow Execution Request ID
Operation start time to end in milliseconds. This is omitted if the operation is still running.
Discovery outcome summary from workflow memo (when available).
Page size requested (maximum 100).
Bad Request
Unauthorized
Not Found
Internal Server Error