> ## 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 a cross-organization platform observability summary

> Aggregated view of platform health, performance, infrastructure,
and cost across every active workspace in the requested window.
Discovers active workspaces first, then runs the bulk aggregator
in `summary_only` mode.

Requires `observability_platform:read` permission. Rate-limited
to 100 calls per minute.




## OpenAPI

````yaml /api-reference/ai-governance-v2/swagger.yml get /v1/observability/platform/summary
openapi: 3.0.3
info:
  version: 1.0.0
  title: AI Governance API
  description: |
    Public REST API for the Prisme.ai AI Governance workspace -
    announcements, legal documents, notifications, observability
    dashboards, audit logs, and active-org listing.
  contact:
    name: Prisme.ai
    url: https://prisme.ai
servers:
  - url: https://{host}/v2/workspaces/slug:ai-governance-v2/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: Announcements
    description: Platform announcements (CRUD + audience targeting).
  - name: Legal
    description: Versioned legal documents (terms, privacy, etc.).
  - name: Notifications
    description: Per-user notifications derived from announcements.
  - name: Observability
    description: >-
      Cross-workspace and per-workspace observability dashboards, traces, and
      feeds.
  - name: Orgs
    description: Organization listing and audit logs.
paths:
  /v1/observability/platform/summary:
    get:
      tags:
        - Observability
      summary: Get a cross-organization platform observability summary
      description: |
        Aggregated view of platform health, performance, infrastructure,
        and cost across every active workspace in the requested window.
        Discovers active workspaces first, then runs the bulk aggregator
        in `summary_only` mode.

        Requires `observability_platform:read` permission. Rate-limited
        to 100 calls per minute.
      operationId: getPlatformObservabilitySummary
      parameters:
        - in: query
          name: period
          schema:
            type: string
            maxLength: 10
            enum:
              - 1h
              - 24h
              - 7d
              - 30d
          description: Preset window (default `24h`).
        - in: query
          name: start
          schema:
            type: string
            format: date-time
          description: Custom range start (overrides `period`; never cached).
        - in: query
          name: end
          schema:
            type: string
            format: date-time
          description: Custom range end (overrides `period`; never cached).
        - in: query
          name: granularity
          schema:
            type: string
            enum:
              - 5m
              - hourly
              - daily
          description: Granularity override.
      responses:
        '200':
          description: Platform summary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformObservabilitySummary'
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden - missing `observability_platform:read` permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    PlatformObservabilitySummary:
      type: object
      properties:
        meta:
          type: object
          properties:
            period:
              type: string
            period_start:
              type: string
              format: date-time
            generated_at:
              type: string
              format: date-time
            workspaces_discovered:
              type: integer
        health:
          type: object
          properties:
            score:
              type: number
            status:
              type: string
            uptime:
              type: number
        performance:
          type: object
          properties:
            total_interactions:
              type: integer
            total_executions:
              type: integer
            p50_ms:
              type: number
            p95_ms:
              type: number
            p99_ms:
              type: number
            error_rate:
              type: number
        infrastructure:
          type: object
          properties:
            by_provider:
              type: object
              additionalProperties: true
        cost:
          type: object
          properties:
            total:
              type: number
            total_tokens:
              type: integer
            total_carbon_kgco2:
              type: number
            by_model:
              type: object
              additionalProperties: true
            forecast_monthly:
              type: number
        alerts:
          type: array
          items:
            type: object
            additionalProperties: true
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          description: >-
            Stable PascalCase error code (e.g. AnnouncementNotFound,
            ValidationError).
        message:
          type: string
          description: Human-readable error message.
        details:
          type: object
          description: Optional structured context.
          additionalProperties: true
  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}`), managed from the
        AI Governance UI. 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 - e.g. usable across AI Governance, Agent Factory and
        LLM Gateway).
        Send as `x-prismeai-api-key: iak_...`.

````