> ## Documentation Index
> Fetch the complete documentation index at: https://docs.prisme.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get analytics (series + summary) for an agent

> Returns metrics series and an aggregated summary for a single agent.
Series is read from Mongo; summary is cached and recomputed from
Elasticsearch on miss/stale (custom date ranges always recompute).




## OpenAPI

````yaml /api-reference/agent-factory/swagger.yml get /v1/agents/{agentId}/analytics
openapi: 3.0.3
info:
  version: 1.0.0
  title: Agent Factory API
  description: |
    Public REST API for the Agent Factory workspace - agents, conversations,
    messages, tools, artifacts, sharing, ratings, and discovery.
    Powered by Prisme.ai's runtime; all endpoints are exposed under each
    workspace's webhook namespace.
  contact:
    name: Prisme.ai
    url: https://prisme.ai
servers:
  - url: https://{host}/v2/workspaces/slug:agent-factory/webhooks
    description: Prisme.ai workspace webhooks
    variables:
      host:
        default: api.studio.prisme.ai
        description: API host (override for self-hosted or sandbox)
security:
  - BearerAuth: []
  - OrgApiKeyAuth: []
tags:
  - name: Agents
    description: Agent CRUD, discovery, AGENTS.md import/export.
  - name: Access
    description: Agent access bindings, sharing, and access requests.
  - name: ApiKeys
    description: Agent-scoped API key management (mint, revoke, rotate).
  - name: Publishing
    description: Publish or discard draft changes on an agent.
  - name: Ratings
    description: User ratings on published agents.
  - name: Profiles
    description: >-
      Agent profiles/presets catalog (simple, workflow, agent_light, agent_full,
      orchestrator).
  - name: Activity
    description: Activity feed for agents (events, errors, lifecycle changes).
  - name: Analytics
    description: Agent usage analytics (series + summary).
  - name: Conversations
    description: Conversations on an agent (CRUD, archive, star).
  - name: Messages
    description: Send messages to an agent (synchronous send + SSE stream).
  - name: Tasks
    description: Async task lifecycle (list, fetch, cancel, resolve, subscribe).
  - name: Artifacts
    description: Generated artifacts (files, code, content) attached to a task.
  - name: Shares
    description: Conversation, message, and artifact share-link snapshots.
  - name: A2A
    description: Agent-to-agent JSON-RPC 2.0 gateway (well-known agent.json + RPC).
  - name: Tools
    description: Per-agent tool catalogue (system tools, MCP servers, function tools).
  - name: Retention
    description: Per-agent and org-wide conversation retention policies.
  - name: Evaluations
    description: Agent evaluation runs and results.
paths:
  /v1/agents/{agentId}/analytics:
    get:
      tags:
        - Analytics
      summary: Get analytics (series + summary) for an agent
      description: |
        Returns metrics series and an aggregated summary for a single agent.
        Series is read from Mongo; summary is cached and recomputed from
        Elasticsearch on miss/stale (custom date ranges always recompute).
      operationId: getAgentAnalytics
      parameters:
        - name: agentId
          in: path
          required: true
          schema:
            type: string
            maxLength: 64
        - name: period
          in: query
          required: false
          schema:
            type: string
            maxLength: 16
            enum:
              - 15m
              - 30m
              - 1h
              - 1d
              - 7d
              - 30d
              - 90d
          description: Preset period. Default `30d`.
        - name: start
          in: query
          required: false
          schema:
            type: string
            maxLength: 64
          description: ISO start (custom range). Overrides `period`.
        - name: end
          in: query
          required: false
          schema:
            type: string
            maxLength: 64
          description: ISO end (custom range, exclusive).
        - name: granularity
          in: query
          required: false
          schema:
            type: string
            maxLength: 16
            enum:
              - 5m
              - hourly
              - daily
          description: Override granularity (auto-picked from period otherwise).
      responses:
        '200':
          description: Analytics payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentAnalytics'
        '400':
          description: Invalid arguments.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Agent not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    AgentAnalytics:
      type: object
      description: Analytics payload (series + summary) for a single agent.
      properties:
        agent_id:
          type: string
        agent_name:
          type: string
        period:
          $ref: '#/components/schemas/AnalyticsPeriod'
        summary:
          type: object
          additionalProperties: true
          description: >-
            Aggregated KPIs (users, engagement, quality, performance, cost,
            models, tools).
        series:
          type: array
          items:
            $ref: '#/components/schemas/AnalyticsSeriesPoint'
        meta:
          $ref: '#/components/schemas/AnalyticsMeta'
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          description: >-
            Stable PascalCase or SNAKE_CASE error code (e.g. AgentNotFound,
            VALIDATION_ERROR, FORBIDDEN, METHOD_NOT_ALLOWED).
        message:
          type: string
          description: Human-readable error message.
        details:
          type: object
          description: Optional structured context for the error.
          additionalProperties: true
    AnalyticsPeriod:
      type: object
      properties:
        type:
          type: string
        start:
          type: string
        end:
          type: string
        granularity:
          type: string
    AnalyticsSeriesPoint:
      type: object
      properties:
        date:
          type: string
        users:
          type: integer
        conversations:
          type: integer
        messages:
          type: integer
        rating:
          type: number
        cost:
          type: number
        status:
          type: string
          enum:
            - incomplete
            - complete
    AnalyticsMeta:
      type: object
      properties:
        generated_at:
          type: string
        data_points:
          type: integer
        includes_current_interval:
          type: boolean
        summary_cached:
          type: boolean
        data_computed_at:
          type: string
        next_refresh_at:
          type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |
        User-bound credential carrying an identity: either a session JWT
        or a user access token (`at:*`) generated from the user settings UI.
        Send as `Authorization: Bearer <token>`.
        Org API keys (`iak_*`) are **not** accepted here - they carry
        no user identity. Use the `x-prismeai-api-key` header instead
        (see `OrgApiKeyAuth`).
    OrgApiKeyAuth:
      type: apiKey
      in: header
      name: x-prismeai-api-key
      description: |
        Organization API key (`iak_{orgSlug}_{uuid}`). Unlike
        `Authorization: Bearer`, this credential is **not** tied to a user
        identity - it is bound to the org and its effective access is
        defined by the scopes / permission rules attached to it (it can
        be restricted to a single project, or kept broader).
        For Agent Factory, these keys can be generated directly from
        the Agent Factory UI (in addition to the AI Governance settings).
        Send as `x-prismeai-api-key: iak_...`.

````