Skip to main content
Microsoft Foundry
Sign in
View as Markdown
View as Markdown
Agent Insight Monitors

Start an Agent Insights run for a monitor

POST
/agent_insight_monitors/{monitor_id}/runs
Path Parameters
monitor_idstringrequired
The identifier of the monitor.
Query Parameters
api-versionstringrequired
The API version to use for this operation.
Header Parameters
Foundry-Featuresstringrequired
A feature flag opt-in required when using preview operations or modifying persisted preview resources.
AgentInsights=V1Preview
Operation-Idstringoptional
Client-generated unique ID for idempotent retries. When absent, the server creates the job unconditionally.
Request BodyRun inputs. Send an empty object to use the default 168-hour lookback window.Content-Type: application/json
lookback_hoursnumber
Optional finite positive number of hours of trace history to analyze, up to 2,160. Defaults to 168.
Responses
idstringrequired
Server-assigned unique identifier.
inputsAgentInsightRunCreate
Inputs used when creating an agent insight run.
lookback_hoursnumber
Optional finite positive number of hours of trace history to analyze, up to 2,160. Defaults to 168.
resultAgentInsightRunResult
Result statistics produced when an agent insight run succeeds.
traces_in_windowintegerrequired
The number of traces in the analyzed time window.
traces_analyzedintegerrequired
The number of traces analyzed by the run.
insights_createdintegerrequired
The number of insights created by the run.
insights_updatedintegerrequired
The number of insights updated by the run.
insights_reopenedintegerrequired
The number of insights reopened by the run.
token_usageAgentInsightTokenUsagerequired
Token usage for an Agent Insights run.
statusenumrequired
Extensible status values shared by Foundry jobs.
queuedin_progresssucceededfailedcancelled
errorOpenAI.Error
codestring | nullrequired
messagestringrequired
paramstring | null
typestring
misalignmentOpenAI.MisalignmentErrorDetailsResource
detailsOpenAI.Error[]
additionalInfoobject
debugInfoobject
monitor_idstringrequired
The Agent Insights monitor this run belongs to.
agent_namestringrequired
The agent whose traces are analyzed by this run.
triggerenumrequired
The trigger that started an agent insight run.
on_demandscheduled
created_atintegerrequired
updated_atintegerrequired
window_startintegerrequired
window_endintegerrequired
started_atinteger
completed_atinteger
model_deployment_namestringrequired
The model deployment used to analyze traces for this run.