Agent Insight Monitors
get
Get an Agent Insights monitor.
Header parameters
Foundry-Features
enum
required
A feature flag opt-in required when using preview operations or modifying persisted preview resources.
Path parameters
monitor_id
string
required
The identifier of the monitor.
Query parameters
api-version
string
required
The API version to use for this operation.
Responses
The request has succeeded.
Body
id
string
required
The monitor identifier.
agent_name
string
required
The agent this monitor analyzes. There can be only one monitor per agent.
enabled
boolean
required
Whether scheduled insight generation is armed for the monitor.
run_interval_hours
number
required
Interval between scheduled insight runs, in hours.
model_deployment_name
string
required
The model deployment to use for analyzing traces. Accepts either the deployment name alone or with the connection name as '{connectionName}/modelDeploymentName'.
estimated_cost
AgentInsightEstimatedCost
Estimated Agent Insights cost.
amount
number
required
Estimated cost amount.
currency
enum
required
Currency for the estimated cost amount. Agent Insights estimates are reported in US dollars.
suspension
AgentInsightSuspension | null
required
Why the system suspended scheduled generation. Null when the monitor is not suspended.
code
string
required
Stable, machine-readable suspension category.
message
string
required
Human-readable description of the suspension.
details
object
Additional reason-specific suspension details.
overview
AgentInsightsOverview | null
required
The effective overview, or null before an overview is available.
content
string
required
The overview content.
source
string | enum
required
Identifies where an Agent Insights overview came from.
enum
Request
GET /agent_insight_monitors/{monitor_id} HTTP/1.1Response
Status: 200
Content-Type: application/jsonStatus: 4XX
Content-Type: application/jsonStatus: 5XX
Content-Type: application/json