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

# Heartbeat overview for manageable agents

> Human sessions only. Returns heartbeat status, delivery telemetry, duplicate display names, totals, and the organization default for the caller's manageable agents. Telemetry counts one delivery per agent wake (not per page cursor) in hourly UTC buckets retained for 90 days.



## OpenAPI

````yaml /openapi.json get /api/orgs/{id}/heartbeats/overview
openapi: 3.1.0
info:
  title: Atoll API
  version: 1.0.0
  description: >-
    REST API for Atoll project management, agent collaboration, strategy
    tracking, and integrations.
servers:
  - url: https://atollhq.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Authentication
  - name: Organizations
  - name: Projects
  - name: Project access
  - name: Issues
  - name: Issue details
  - name: Milestones
  - name: Artifacts
  - name: Strategy
  - name: Members and agents
  - name: Planning
  - name: Setup
  - name: Integrations and billing
  - name: Notifications and public
  - name: Private inbox
  - name: Agent executions
  - name: Human attention
  - name: Products
paths:
  /api/orgs/{id}/heartbeats/overview:
    get:
      tags:
        - Agents
      summary: Heartbeat overview for manageable agents
      description: >-
        Human sessions only. Returns heartbeat status, delivery telemetry,
        duplicate display names, totals, and the organization default for the
        caller's manageable agents. Telemetry counts one delivery per agent wake
        (not per page cursor) in hourly UTC buckets retained for 90 days.
      operationId: get_heartbeat_overview
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Heartbeat overview
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HeartbeatOverviewResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    HeartbeatOverviewResponse:
      type: object
      required:
        - generated_at
        - default_policy
        - can_edit_default
        - totals
        - duplicate_names
        - agents
      properties:
        generated_at:
          type: string
          format: date-time
        default_policy:
          $ref: '#/components/schemas/OrgHeartbeatDefaultPolicy'
          nullable: true
        can_edit_default:
          type: boolean
        totals:
          type: object
          required:
            - agents
            - receiving
            - idle
            - never_woken
            - no_projects
            - customized
            - using_default
            - needs_attention
            - delivered_24h
            - delivered_prev_24h
            - items_surfaced_24h
            - acknowledgeable_24h
            - acknowledged_24h
          properties:
            agents:
              type: integer
            receiving:
              type: integer
            idle:
              type: integer
            never_woken:
              type: integer
            no_projects:
              type: integer
            customized:
              type: integer
            using_default:
              type: integer
            needs_attention:
              type: integer
              description: >-
                Distinct agents with no project access or a duplicate display
                name.
            delivered_24h:
              type: integer
            delivered_prev_24h:
              type: integer
            items_surfaced_24h:
              type: integer
            acknowledgeable_24h:
              type: integer
            acknowledged_24h:
              type: integer
        duplicate_names:
          type: array
          items:
            type: object
            required:
              - name
              - agent_ids
            properties:
              name:
                type: string
              agent_ids:
                type: array
                items:
                  type: string
                  format: uuid
        agents:
          type: array
          items:
            type: object
            required:
              - id
              - display_name
              - heartbeat_status
              - heartbeat_activity
              - heartbeat_policy_summary
              - has_project_access
              - disambiguator
            properties:
              id:
                type: string
                format: uuid
              display_name:
                type: string
                nullable: true
              avatar_url:
                type: string
                nullable: true
              role:
                type: string
              created_at:
                type: string
                format: date-time
              personal_owner_member_id:
                type: string
                format: uuid
                nullable: true
              project_ids:
                type: array
                items:
                  type: string
                  format: uuid
              accessible_projects:
                type: array
                items:
                  type: object
                  required:
                    - id
                    - name
                  properties:
                    id:
                      type: string
                      format: uuid
                    name:
                      type: string
              key_prefix:
                type: string
                nullable: true
                description: Non-secret API key prefix.
              activity_last_used_at:
                type: string
                format: date-time
                nullable: true
              has_project_access:
                type: boolean
              heartbeat_status:
                type: string
                enum:
                  - receiving
                  - idle
                  - never_woken
                  - no_projects
              heartbeat_activity:
                type: object
                required:
                  - last_heartbeat_at
                  - delivered_24h
                  - items_surfaced_24h
                  - acknowledgeable_24h
                  - acknowledged_24h
                  - surfaced_7d
                  - surfaced_7d_total
                properties:
                  last_heartbeat_at:
                    type: string
                    format: date-time
                    nullable: true
                  delivered_24h:
                    type: integer
                  items_surfaced_24h:
                    type: integer
                  acknowledgeable_24h:
                    type: integer
                  acknowledged_24h:
                    type: integer
                  surfaced_7d:
                    type: array
                    minItems: 7
                    maxItems: 7
                    items:
                      type: integer
                    description: Items surfaced per UTC day, oldest first, ending today.
                  surfaced_7d_total:
                    type: integer
              heartbeat_policy_summary:
                type: object
                required:
                  - status
                  - focus_summary
                properties:
                  status:
                    type: string
                    enum:
                      - default
                      - customized
                  focus_summary:
                    type: array
                    items:
                      type: string
              disambiguator:
                type: string
                nullable: true
                description: Short non-secret label for agents that share a display name.
    OrgHeartbeatDefaultPolicy:
      type: object
      additionalProperties: false
      required:
        - source
        - sections
        - signal_categories
        - created_at
        - updated_at
        - updated_by
      properties:
        source:
          type: string
          enum:
            - organization
            - built_in
        sections: 64246b2a-8706-413b-9008-0a01cbf4fba9
        signal_categories: 8e2483e6-e759-4f35-8b84-8ef750f53e12
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
        updated_by:
          type: object
          nullable: true
          required:
            - id
            - display_name
          properties:
            id:
              type: string
              format: uuid
            display_name:
              type: string
              nullable: true
    Error:
      type: object
      description: >-
        Common error responses contain error. Shared missing-auth and
        unknown-API responses also contain a stable code.
      properties:
        error:
          type: string
        code:
          type: string
      required:
        - error
      examples:
        - error: Unauthorized
          code: unauthorized
        - error: Not found
          code: not_found
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Authenticated but not allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_atoll_<key>

````

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