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

# Get organization-level activity metrics

> Returns summary counts and timeseries for agent runs, chats, and GitHub PR actions for the authenticated organization.



## OpenAPI

````yaml https://app.cotool.ai/api/docs/openapi.json get /api/org-metrics
openapi: 3.1.0
info:
  title: Cotool API
  version: 1.0.0
  description: >-
    # Cotool API Documentation


    The Cotool API allows you to interact with the Cotool platform
    programmatically, enabling you to build powerful integrations and automate
    your workflows.


    ## Getting an API Key


    Follow these steps to generate your API key:


    1. **Log in** to the Cotool web interface

    2. **Navigate** to `/settings/api-keys`

    3. **Click** "Generate Key"

    4. **Copy and store** your API key securely ⚠️ *It won't be shown again*


    ## API Key Authentication


    For programmatic access and integrations, use your API key with the
    Authorization header:


    ```http

    Authorization: Bearer your_api_key_here

    ```


    ```bash

    curl -X GET "https://app.cotool.ai/api/endpoint" \
      -H "Authorization: Bearer your_api_key_here" \
      -H "Content-Type: application/json"
    ```
servers:
  - url: https://app.cotool.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /api/org-metrics:
    get:
      tags:
        - Metrics
      summary: Get organization-level activity metrics
      description: >-
        Returns summary counts and timeseries for agent runs, chats, and GitHub
        PR actions for the authenticated organization.
      parameters:
        - in: query
          name: range
          description: Time range for metrics (7d, 30d, all)
          schema:
            type: string
            enum:
              - 7d
              - 30d
              - all
            description: Time range for metrics (7d, 30d, all)
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  summary:
                    type: object
                    properties:
                      agentRuns:
                        type: object
                        properties:
                          last7Days:
                            type: number
                          last30Days:
                            type: number
                          allTime:
                            type: number
                        required:
                          - last7Days
                          - last30Days
                          - allTime
                      chats:
                        type: object
                        properties:
                          last7Days:
                            type: number
                          last30Days:
                            type: number
                          allTime:
                            type: number
                        required:
                          - last7Days
                          - last30Days
                          - allTime
                      githubPullRequestsCreated:
                        type: object
                        properties:
                          last7Days:
                            type: number
                          last30Days:
                            type: number
                          allTime:
                            type: number
                        required:
                          - last7Days
                          - last30Days
                          - allTime
                      githubPullRequestsUpdated:
                        type: object
                        properties:
                          last7Days:
                            type: number
                          last30Days:
                            type: number
                          allTime:
                            type: number
                        required:
                          - last7Days
                          - last30Days
                          - allTime
                      linesOfCodeAdded:
                        type: object
                        properties:
                          last7Days:
                            type: number
                          last30Days:
                            type: number
                          allTime:
                            type: number
                        required:
                          - last7Days
                          - last30Days
                          - allTime
                      linesOfCodeRemoved:
                        type: object
                        properties:
                          last7Days:
                            type: number
                          last30Days:
                            type: number
                          allTime:
                            type: number
                        required:
                          - last7Days
                          - last30Days
                          - allTime
                      scannerQueries:
                        type: object
                        properties:
                          last7Days:
                            type: number
                          last30Days:
                            type: number
                          allTime:
                            type: number
                        required:
                          - last7Days
                          - last30Days
                          - allTime
                      datadogQueries:
                        type: object
                        properties:
                          last7Days:
                            type: number
                          last30Days:
                            type: number
                          allTime:
                            type: number
                        required:
                          - last7Days
                          - last30Days
                          - allTime
                      sentinelOneQueries:
                        type: object
                        properties:
                          last7Days:
                            type: number
                          last30Days:
                            type: number
                          allTime:
                            type: number
                        required:
                          - last7Days
                          - last30Days
                          - allTime
                      splunkQueries:
                        type: object
                        properties:
                          last7Days:
                            type: number
                          last30Days:
                            type: number
                          allTime:
                            type: number
                        required:
                          - last7Days
                          - last30Days
                          - allTime
                      pantherQueries:
                        type: object
                        properties:
                          last7Days:
                            type: number
                          last30Days:
                            type: number
                          allTime:
                            type: number
                        required:
                          - last7Days
                          - last30Days
                          - allTime
                    required:
                      - agentRuns
                      - chats
                      - githubPullRequestsCreated
                      - githubPullRequestsUpdated
                      - linesOfCodeAdded
                      - linesOfCodeRemoved
                      - scannerQueries
                      - datadogQueries
                      - sentinelOneQueries
                      - splunkQueries
                      - pantherQueries
                  timeseries:
                    type: object
                    properties:
                      agentRuns:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            count:
                              type: number
                          required:
                            - date
                            - count
                      chats:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            count:
                              type: number
                          required:
                            - date
                            - count
                      githubPullRequestsCreated:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            count:
                              type: number
                          required:
                            - date
                            - count
                      githubPullRequestsUpdated:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            count:
                              type: number
                          required:
                            - date
                            - count
                      linesOfCodeAdded:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            count:
                              type: number
                          required:
                            - date
                            - count
                      linesOfCodeRemoved:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            count:
                              type: number
                          required:
                            - date
                            - count
                      scannerQueries:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            count:
                              type: number
                          required:
                            - date
                            - count
                      datadogQueries:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            count:
                              type: number
                          required:
                            - date
                            - count
                      sentinelOneQueries:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            count:
                              type: number
                          required:
                            - date
                            - count
                      splunkQueries:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            count:
                              type: number
                          required:
                            - date
                            - count
                      pantherQueries:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            count:
                              type: number
                          required:
                            - date
                            - count
                    required:
                      - agentRuns
                      - chats
                      - githubPullRequestsCreated
                      - githubPullRequestsUpdated
                      - linesOfCodeAdded
                      - linesOfCodeRemoved
                      - scannerQueries
                      - datadogQueries
                      - sentinelOneQueries
                      - splunkQueries
                      - pantherQueries
                required:
                  - summary
                  - timeseries
        '400':
          description: Bad request — input validation failed or the request was malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized — missing or invalid API key / session
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden — the authenticated user lacks the required permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: shell
          label: cURL
          source: |-
            curl -X GET "https://app.cotool.ai/api/org-metrics" \
              -H "Authorization: Bearer YOUR_API_KEY" \
              -H "Content-Type: application/json"
components:
  schemas:
    ValidationError:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
        issues:
          type: array
          description: >-
            Detailed validation issues, present when request or response schema
            validation fails
          items:
            type: object
            additionalProperties: true
      required:
        - error
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
      required:
        - error
    PermissionError:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
        missingPerms:
          type: array
          description: Permissions the authenticated user is missing for this operation
          items:
            type: string
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key authentication for programmatic access. Include your API key in
        the Authorization header as: `Bearer your_api_key_here`

````