For the complete documentation index, see llms.txt. This page is also available as Markdown.

Agent Analytics

Agent analytics and execution metrics

Retrieving agent analytics bundle for last four weeks

get

Returns a single bundle of analytics for dashboards: request and session aggregates (including severity breakdowns), resolution efficiency, and per-week session error trends.

Required scopes

  • ai.agent_read

Required scopes
This endpoint requires the following scopes:
  • : Needed to read AI agents.
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

Query parameters
agentIdstringOptional

When set, metrics are scoped to this agent. When omitted, tenant-wide aggregates are returned.

Responses
200

Aggregated request and session metrics, resolution efficiency, and weekly trends.

application/json

Combined analytics payload for admin and partner dashboards.

get/ai-service/{tenant}/agentic/analytics
GET /ai-service/{tenant}/agentic/analytics HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "requests": {
    "total": 1,
    "bySeverity": {
      "info": 1,
      "warning": 1,
      "error": 1
    },
    "errorRate": 1
  },
  "sessions": {
    "total": 1,
    "bySeverity": {
      "success": 1,
      "warning": 1,
      "error": 1
    },
    "errorRate": 1
  },
  "resolutionEfficiency": {
    "requestsPerSession": 1,
    "totalRequests": 1,
    "totalSessions": 1
  },
  "requestTrend": [
    {
      "date": "2026-01-01T00:00:00.000Z",
      "total": 1,
      "errors": 1,
      "errorRate": 1
    }
  ],
  "sessionTrend": [
    {
      "date": "2026-01-01T00:00:00.000Z",
      "totalSessions": 1,
      "errorSessions": 1,
      "errorRate": 1
    }
  ]
}

Retrieving per-agent execution counts by period

get

Returns execution (session) counts per agent for each calendar period (quarter, month, or week).

Required scopes

  • ai.agent_read

Required scopes
This endpoint requires the following scopes:
  • : Needed to read AI agents.
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
tenantstringRequired

Your Emporix tenant name.

Note: The tenant name should always be provided in lowercase.

Query parameters
agentIdsstringRequired

Comma-separated list of agent IDs (no spaces). Maximum 100 IDs.

granularitystring · enumOptional

Time bucket for each period (UTC).

Default: QUARTERPossible values:
Responses
200

Per-agent execution counts aligned to the returned periods.

application/json
granularitystring · enumOptional

Time bucket used for periods and series (enum constant name).

Possible values:
get/ai-service/{tenant}/agentic/analytics/executions
GET /ai-service/{tenant}/agentic/analytics/executions?agentIds=text HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "granularity": "QUARTER",
  "periods": [
    {
      "label": "text",
      "start": "2026-01-01T00:00:00.000Z",
      "end": "2026-01-01T00:00:00.000Z"
    }
  ],
  "series": [
    {
      "agentId": "text",
      "counts": [
        1
      ]
    }
  ]
}

Last updated

Was this helpful?