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

# Get Developer Summary

> Generates an AI-powered natural-language summary of a developer's contributions across the specified repositories and date range. Includes PR descriptions and an overall narrative of work done. If `repositories` is omitted, all repositories under the organization are used.



## OpenAPI

````yaml /openapi.json post /api/metrics/developer/summary/get
openapi: 3.0.3
info:
  title: CodeAnt AI API
  description: >-
    API for code analysis (SAST, SCA, secrets, IaC) and developer productivity
    metrics. Supports GitHub, GitLab, Bitbucket, and Azure DevOps.
  version: 1.0.0
servers:
  - url: https://api.codeant.ai
    description: Production server
security: []
tags:
  - name: Analysis
    description: Code analysis operations
  - name: Agent Analysis
    description: >-
      AI-powered agent analysis operations. Uses LLM-based code exploration
      agents to perform deep security threat hunting, bug finding, and custom
      analysis with reflection-based false positive filtering.
  - name: Developer Metrics - Teams
    description: >-
      Manage developer teams: create, update, delete teams and manage team
      membership. Teams are used to organize developers and scope metrics.
  - name: Developer Metrics
    description: >-
      Developer productivity and activity metrics: active developers, PR
      throughput, individual comparisons, and AI-generated summaries. All
      endpoints support GitHub, GitLab, Bitbucket, and Azure DevOps.
  - name: Audit Logs
    description: >-
      Read-only access to your organization's audit trail for compliance, ETL
      and SIEM ingestion. Events are immutable, retained for 180 days, and cover
      security-relevant actions: user management, access control, credentials,
      scan triggers, configuration changes and data exports. Secrets and tokens
      are redacted and never appear in any response format.
  - name: Container Scanning
    description: >-
      Container image vulnerability scanning across AWS ECR, Azure ACR, and GCP
      GAR registries. List tracked containers with their latest scan, then fetch
      the full vulnerability findings of a scan — the same data shown on the
      Cloud Security → Container Scanning page. Authenticate with a CodeAnt API
      token (requires the `view_cloud_security: read` permission when token
      scoping is configured).
  - name: Security Hotlist
    description: >-
      The organization-wide security Hotlist: every SCA, SAST, secrets, IaC,
      cloud (CSPM) and AI-exploitation finding, deduplicated and priority-scored
      into one ranked list with live ticket, assignee and SLA state. Query it
      with filters, facets and cursor pagination, or export the full filtered
      list as an Excel workbook. Authenticate with a CodeAnt API token (requires
      the `view_code_security: read` permission when token scoping is
      configured).
paths:
  /api/metrics/developer/summary/get:
    post:
      tags:
        - Developer Metrics
      summary: Get Developer Summary
      description: >-
        Generates an AI-powered natural-language summary of a developer's
        contributions across the specified repositories and date range. Includes
        PR descriptions and an overall narrative of work done. If `repositories`
        is omitted, all repositories under the organization are used.
      operationId: getDevSummary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DevSummaryRequest'
            examples:
              github:
                summary: GitHub
                value:
                  platform: github
                  org: my-org
                  author: janedoe
                  repositories:
                    - my-org/backend-api
                  start_date: '2025-01-01'
                  end_date: '2025-03-01'
              gitlab:
                summary: GitLab
                value:
                  platform: gitlab
                  org: my-group
                  author: janedoe
                  repositories:
                    - my-group/backend-api
                  start_date: '2025-01-01'
                  end_date: '2025-03-01'
              bitbucket:
                summary: Bitbucket
                value:
                  platform: bitbucket
                  org: my-workspace
                  author: janedoe
                  repositories:
                    - my-workspace/backend-api
                  start_date: '2025-01-01'
                  end_date: '2025-03-01'
              azure_devops:
                summary: Azure DevOps
                value:
                  platform: azure_devops
                  org: my-org
                  author: janedoe
                  repositories:
                    - my-org/backend-api
                  start_date: '2025-01-01'
                  end_date: '2025-03-01'
      responses:
        '200':
          description: Developer summary
          content:
            application/json:
              schema:
                type: object
                properties:
                  metric:
                    type: string
                    example: dev_summary
                  platform:
                    type: string
                  org:
                    type: string
                  author:
                    type: string
                  repositories:
                    type: array
                    items:
                      type: string
                  start_date:
                    type: string
                    format: date
                  end_date:
                    type: string
                    format: date
                  summary:
                    type: string
                    description: >-
                      AI-generated natural-language summary of the developer's
                      work
                  pr_descriptions:
                    type: array
                    items:
                      type: string
                    description: Descriptions of PRs included in the analysis
                  execution_time:
                    type: number
                    description: Time taken to generate the summary (seconds)
        '400':
          description: Bad request - missing or invalid parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DevMetricsErrorResponse'
              example:
                error: 'Missing required parameters: author, start_date, end_date'
        '401':
          description: Unauthorized - missing, invalid, or insufficient access token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DevMetricsErrorResponse'
              examples:
                missing_token:
                  summary: Missing Authorization header
                  value:
                    error: Missing Authorization header. Use 'Bearer <access_token>'
                invalid_token:
                  summary: Invalid or insufficient token
                  value:
                    error: >-
                      Access token invalid or does not have access to this
                      organization
        '404':
          description: >-
            No repositories found for the organization (when `repositories` is
            omitted)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DevMetricsErrorResponse'
              example:
                error: No repositories found for this organization
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DevMetricsStatusResponse'
              example:
                status: error
                message: Internal server error
      security:
        - BearerAuth: []
components:
  schemas:
    DevSummaryRequest:
      allOf:
        - $ref: '#/components/schemas/DateRangeRequest'
        - type: object
          required:
            - author
          properties:
            author:
              type: string
              description: Git author login/email to analyze
              example: janedoe
            repositories:
              type: array
              items:
                type: string
              description: >-
                List of repository names to scope the summary. If omitted, all
                repositories under the organization are used.
              example:
                - my-org/backend-api
    DevMetricsErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
    DevMetricsStatusResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
            - error
        message:
          type: string
          description: Human-readable status message
    DateRangeRequest:
      allOf:
        - $ref: '#/components/schemas/DevMetricsBaseRequest'
        - type: object
          required:
            - start_date
            - end_date
          properties:
            start_date:
              type: string
              format: date
              description: Start of the date range (YYYY-MM-DD)
              example: '2025-01-01'
            end_date:
              type: string
              format: date
              description: End of the date range (YYYY-MM-DD)
              example: '2025-03-01'
    DevMetricsBaseRequest:
      type: object
      required:
        - platform
        - org
      properties:
        platform:
          type: string
          description: Version control platform
          enum:
            - github
            - gitlab
            - bitbucket
            - azure_devops
            - azuredevops
          example: github
        org:
          type: string
          description: Organization, workspace, or group name on the platform
          example: my-org
        github_base_url:
          type: string
          description: Base URL for GitHub (use for GitHub Enterprise Server)
          default: https://github.com
          example: https://github.com
        gitlab_base_url:
          type: string
          description: Base URL for GitLab (use for self-hosted GitLab instances)
          default: https://gitlab.com
          example: https://gitlab.com
        azure_devops_base_url:
          type: string
          description: Base URL for Azure DevOps (use for Azure DevOps Server)
          default: https://dev.azure.com
          example: https://dev.azure.com
        bitbucket_base_url:
          type: string
          description: Base URL for Bitbucket (use for Bitbucket Data Center/Server)
          default: https://api.bitbucket.org/2.0
          example: https://api.bitbucket.org/2.0
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        CodeAnt API token (`cdt_...`), created on the Settings → API Tokens
        page. Pass via `Authorization: Bearer <token>` header.

````

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