Documentation Index

Fetch the complete documentation index at: https://docs.plainid.io/llms.txt

Use this file to discover all available pages before exploring further.

Get Observability Detailed Events

Prev Next
Get
/orchestrator/1.0/observability-detailed-events/env/{envId}/pop/{popId}/executions/{executionId}

This API lists more observability details for the POP workflow.

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.

Security
HTTP
Type bearer

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

Path parameters
envId
stringRequired

The Environment ID can be found under the Details Tab in the Environment Settings.

Exampleec3ff4ee-81f9-4e7f-9037-6fa9fde62cc8
popId
stringRequired

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.

ExamplePOPS269J5C16H8N4
executionId
stringRequired

Execution ID for Workflow. You can extract it from the Get Observability Summary API.

Example0192a1b2-c3d4-7890-abcd-ef1234567890
Responses
200

Success

discovery_detail

Discovery flow activity timeline

{
  "data": {
    "name": "discovery",
    "startTime": "2024-06-14T08:15:00Z",
    "endTime": "2024-06-14T08:18:42Z",
    "status": "Completed",
    "summary": "Discovery summary from Snowflake: 12 policies were discovered from Credit Risk Control Center",
    "requestId": "req-7f3a9c2e-4b1d-4e8a-9f0c-1a2b3c4d5e6f",
    "events": [
      {
        "executionId": "0192a1b2-c3d4-7890-abcd-ef1234567890",
        "flowType": "discovery",
        "status": "Completed",
        "startTime": "2024-06-14T08:15:00Z",
        "endTime": "2024-06-14T08:18:42Z",
        "durationMs": 222000,
        "summary": "Discovery summary from Snowflake: 12 policies were discovered from Credit Risk Control Center"
      }
    ]
  }
}
Expand All
object
data
object (ObservabilityDetailedEventsParent)
name
string

Flow type for the initial detailed event

startTime
string

Detailed event start time in UTC

endTime
string | null

Detailed event end time in UTC. This is omitted if it is still running or has no end time.

status
string

Parent status for the detailed event

summary
string

Summary for detailed event

requestId
string

Request ID

events
Array of object (ObservabilityDetailedEventsFlowEvent)

Detailed event execution list

object
executionId
string

Flow Execution ID

flowType
string

Operation Type

Valid values[ "discovery", "single-policy-discovery", "accept-all-vendor-changes", "accept-vendor-changes", "accept-platform-changes", "accept-all-platform-changes", "other" ]
status
string

Flow status.

startTime
string

Flow start time in UTC (RFC3339).

endTime
string | null

Time when the flow workflow ended in UTC (RFC3339).

durationMs
integer (int64) | null

Wall-clock style duration in milliseconds when the flow has ended.

summary
string

Summary with failure details when available

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

© 2024 PlainID LTD. All rights reserved.