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

# Get Org Insights Headline

> Get org-wide headline insight KPIs (run totals, success rate, distinct active agents and users) aggregated across every team in the organization. Requires an organization Admin, Executive, or Owner role.



## OpenAPI

````yaml https://api.duvo.ai/v2/documentation/mintlify.json get /v2/organizations/{orgId}/insights/headline
openapi: 3.0.3
info:
  title: Duvo Public API
  description: >-
    Public API for programmatic access to Duvo. Authenticate with API keys
    created in the Duvo dashboard.


    ## Rate limits


    Requests are counted per API key. Every response advertises the quota with
    the IETF RateLimit fields, so a client can self-throttle without waiting for
    a rejection:


    - `RateLimit-Policy: "default";q=<quota>;w=<window seconds>` — the policy in
    force: `q` requests per `w` seconds.

    - `RateLimit: "default";r=<remaining>;t=<seconds>` — the live state: `r`
    requests left, quota resetting in `t` seconds.

    - Read the quota from the headers rather than hard-coding it; it differs per
    environment.

    - The same numbers are also sent as `ratelimit-limit`, `ratelimit-remaining`
    and `ratelimit-reset`.


    Once the quota is exhausted the API answers `429 Too Many Requests` with
    `Retry-After` set to the seconds to wait; honor it instead of retrying
    immediately.
  version: 1.0.0
servers:
  - url: https://api.duvo.ai
    description: Production server
security: []
tags:
  - name: Runs
    description: Start, monitor, and manage agent runs (Runs in the Duvo UI)
  - name: Sandboxes
    description: Create sandboxes and upload files for agent runs
  - name: Queues
    description: Manage queues and their agent bindings
  - name: Cases
    description: Create, list, and manage cases and their labels within queues
  - name: Case Approvals
    description: Submit decisions on pending case approval requests issued by an agent run
  - name: Case Attachments
    description: Upload, list, download, and remove the files attached to a case
  - name: Automations
    description: >-
      List and manage automations — the workspace container that groups the
      agents and queues making up one end-to-end process
  - name: Agents
    description: Create and manage agents for automation workloads
  - name: Revisions
    description: Create and manage agent revisions — the underlying Setup for an Agent
  - name: Agent Folders
    description: Organize agents into folders
  - name: Agent Memory
    description: Read an agent's memory files (the Memory feature in the Duvo UI)
  - name: Suggestions
    description: >-
      List, apply, and dismiss an Agent's improvement suggestions (the
      suggestions inbox in the Duvo UI)
  - name: Notifications
    description: >-
      List, read, dismiss, and clear the authenticated user's team notifications
      (the Notification Center in the Duvo UI)
  - name: Schedules
    description: List schedules configured for an agent
  - name: Duvo Pulse
    description: >-
      Create, list, iterate on, and delete Duvo Pulse dashboards — live,
      agent-generated visualizations of your Duvo data
  - name: Case Triggers
    description: >-
      Configure case triggers that automatically dispatch agent runs (Runs in
      the Duvo UI) for cases added to a queue
  - name: Triggers
    description: >-
      Configure event triggers that start a Run automatically when an external
      event fires (e.g. an email arrives, a Linear issue is created, or a file
      changes in Google Drive)
  - name: Skills
    description: Manage team and system skills (reusable knowledge packs).
  - name: Files
    description: Manage team files.
  - name: Plugins
    description: Discover plugins that can be referenced from a revision.
  - name: Organizations
    description: Inspect organizations you belong to and the teams within them
  - name: Team
    description: Inspect the team and members associated with the API key
  - name: Invites
    description: >-
      Invite people to a team — one at a time or in bulk, scoped to a Clarity
      process or the whole team — and manage the team's shareable invite link
  - name: Integrations
    description: Browse the team's catalog of available integration types
  - name: Connections
    description: Manage your connected integrations
  - name: Credentials
    description: >-
      Manage logins (domain + username + password + TOTP) used by agents to sign
      in to websites and desktop applications, and attach them to assignment
      revisions
  - name: Secrets
    description: >-
      Manage env-var secrets injected into runs, and attach them to assignment
      revisions. Only metadata is exposed; values are never returned
  - name: Revision Integrations
    description: >-
      Attach integrations to assignment revisions, pin specific connections, and
      link queues
  - name: ClarityV2
    description: >-
      Manage Clarity v2 process snapshots, automation proposals, and the
      extra-capture-request follow-up loop
paths:
  /v2/organizations/{orgId}/insights/headline:
    get:
      tags:
        - Organizations
      summary: Get Org Insights Headline
      description: >-
        Get org-wide headline insight KPIs (run totals, success rate, distinct
        active agents and users) aggregated across every team in the
        organization. Requires an organization Admin, Executive, or Owner role.
      operationId: getOrgInsightsHeadline
      parameters:
        - schema:
            type: string
            format: date-time
          in: query
          name: startDate
          required: false
          description: >-
            Start of the aggregation window (ISO 8601 datetime). Defaults to 30
            days ago; clamped to at most 365 days ago.
        - schema:
            type: string
            format: date-time
          in: query
          name: endDate
          required: false
          description: >-
            End of the aggregation window (ISO 8601 datetime, exclusive).
            Defaults to now; clamped to now.
        - schema:
            type: string
            format: uuid
          in: path
          name: orgId
          required: true
          description: The organization's unique identifier
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  headline:
                    type: object
                    properties:
                      total_runs:
                        type: number
                        description: >-
                          Billable runs started in the window across all org
                          teams; excludes postpone re-checks, which still count
                          towards completed_runs, failed_runs and the active
                          counts
                      completed_runs:
                        type: number
                        description: Runs that finished with completed status
                      failed_runs:
                        type: number
                        description: Runs that finished with failed status
                      success_rate:
                        nullable: true
                        description: >-
                          completed_runs / (completed_runs + failed_runs), null
                          when no runs finished in the window
                        type: number
                      active_agents:
                        type: number
                        description: >-
                          Distinct agents with at least one run in the window
                          (org-wide, includes since-deleted agents so totals
                          reconcile with run counts)
                      active_users:
                        type: number
                        description: >-
                          Distinct users who started at least one run in the
                          window, deduplicated across teams
                      start_date:
                        type: string
                        description: Effective window start after clamping (ISO 8601)
                      end_date:
                        type: string
                        description: Effective window end after clamping (ISO 8601)
                      truncated:
                        type: boolean
                        description: >-
                          True when the org has more teams than the aggregation
                          limit — figures cover only the first teams up to the
                          cap
                      aggregated_teams:
                        type: number
                        description: Number of teams actually included in the aggregation
                      total_teams:
                        type: number
                        description: Actual team count on the org, even when truncated
                    required:
                      - total_runs
                      - completed_runs
                      - failed_runs
                      - success_rate
                      - active_agents
                      - active_users
                      - start_date
                      - end_date
                      - truncated
                      - aggregated_teams
                      - total_teams
                    additionalProperties: false
                required:
                  - headline
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
                additionalProperties: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key authentication. Get your API key from the Duvo dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.