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

# Get organization-wide compliance overview for CISO dashboard

> Returns a comprehensive overview of all projects within the organization with their compliance status, violation statistics, breakdown by rule type, and trend data for the last 30 days.



## OpenAPI

````yaml get /organization/{organizationId}/compliance-overview
openapi: 3.0.0
info:
  title: Cybedefend API
  description: >-
    CybeDefend is an advanced API for application security analysis. Key
    features include OAuth 2.0 authentication, user/organization/project
    management, and REBAC-based permissions. It excels in static, dynamic, and
    IaC security analyses (SAST, DAST, IaC, etc.).
  version: '1.0'
  contact: {}
servers:
  - url: https://api-eu.cybedefend.com
    description: EU
  - url: https://api-us.cybedefend.com
    description: US
security: []
tags: []
paths:
  /organization/{organizationId}/compliance-overview:
    get:
      tags:
        - Policy
      summary: Get organization-wide compliance overview for CISO dashboard
      description: >-
        Returns a comprehensive overview of all projects within the organization
        with their compliance status, violation statistics, breakdown by rule
        type, and trend data for the last 30 days.
      operationId: PolicyController_getOrganizationComplianceOverview
      parameters:
        - name: organizationId
          required: true
          in: path
          schema:
            format: uuid
            type: string
        - name: page
          required: false
          in: query
          description: 'Page number (default: 1)'
          schema:
            type: number
        - name: pageSize
          required: false
          in: query
          description: 'Page size (default: 20)'
          schema:
            type: number
        - name: startDate
          required: false
          in: query
          description: Filter start date (ISO 8601)
          schema:
            type: string
        - name: endDate
          required: false
          in: query
          description: Filter end date (ISO 8601)
          schema:
            type: string
        - name: complianceStatus
          required: false
          in: query
          description: Filter by compliance status
          schema:
            enum:
              - Compliant
              - Non-Compliant
              - Pending
            type: string
        - name: search
          required: false
          in: query
          description: Search by project name
          schema:
            type: string
        - name: sortBy
          required: false
          in: query
          description: Sort field
          schema:
            enum:
              - blockedCount
              - warnedCount
              - totalViolations
              - lastEvaluatedAt
              - projectName
            type: string
        - name: sortOrder
          required: false
          in: query
          description: 'Sort order (default: desc)'
          schema:
            enum:
              - asc
              - desc
            type: string
        - name: timeframe
          required: false
          in: query
          description: 'Timeframe for trend aggregation: day (default), week, or month'
          schema:
            enum:
              - day
              - week
              - month
            type: string
      responses:
        '200':
          description: Organization compliance overview
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationComplianceOverviewResponseDto'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      security:
        - bearer: []
components:
  schemas:
    OrganizationComplianceOverviewResponseDto:
      type: object
      properties:
        stats:
          description: Organization-wide compliance statistics
          allOf:
            - $ref: '#/components/schemas/OrganizationComplianceStatsDto'
        projects:
          description: List of projects with their compliance summary
          type: array
          items:
            $ref: '#/components/schemas/ProjectComplianceSummaryDto'
        violationBreakdown:
          description: Violation breakdown by rule type
          type: array
          items:
            $ref: '#/components/schemas/ViolationBreakdownDto'
        trend:
          description: Compliance trend over time (last 30 days)
          type: array
          items:
            $ref: '#/components/schemas/ComplianceTrendPointDto'
        total:
          type: number
          description: Total count of projects (for pagination)
          example: 50
        page:
          type: number
          description: Current page
          example: 1
        pageSize:
          type: number
          description: Page size
          example: 20
      required:
        - stats
        - projects
        - violationBreakdown
        - trend
        - total
        - page
        - pageSize
    ErrorDto:
      type: object
      properties:
        timestamp:
          type: string
          example: '2025-02-18T12:31:18.491Z'
          description: Timestamp of the error
        service:
          type: string
          example: AiService
          description: Name of the service where the error occurred
        method:
          type: string
          example: startConversation
          description: Method name where the error occurred
        message:
          type: string
          example: Invalid parameters provided
          description: Error message
        code:
          type: number
          example: 400
          description: HTTP status code
          minimum: 100
          maximum: 599
      required:
        - timestamp
        - service
        - method
        - message
        - code
    OrganizationComplianceStatsDto:
      type: object
      properties:
        totalProjects:
          type: number
          description: Total number of projects in the organization
          example: 50
        compliantProjects:
          type: number
          description: Number of compliant projects
          example: 40
        nonCompliantProjects:
          type: number
          description: Number of non-compliant projects
          example: 5
        pendingProjects:
          type: number
          description: Number of pending projects (awaiting evaluation)
          example: 5
        totalViolations:
          type: number
          description: Total violations across all projects
          example: 150
        totalBlocked:
          type: number
          description: Total BLOCK violations
          example: 30
        totalWarned:
          type: number
          description: Total WARN violations
          example: 120
        activePoliciesCount:
          type: number
          description: Number of active policies in the organization
          example: 5
        complianceRate:
          type: number
          description: Compliance rate percentage (0-100)
          example: 88.89
      required:
        - totalProjects
        - compliantProjects
        - nonCompliantProjects
        - pendingProjects
        - totalViolations
        - totalBlocked
        - totalWarned
        - activePoliciesCount
        - complianceRate
    ProjectComplianceSummaryDto:
      type: object
      properties:
        projectId:
          type: string
          description: Project ID
          example: 550e8400-e29b-41d4-a716-446655440000
        projectName:
          type: string
          description: Project name
          example: My Project
        complianceStatus:
          type: string
          description: Compliance status
          example: Compliant
          enum:
            - Compliant
            - Non-Compliant
            - Pending
        totalViolations:
          type: number
          description: Total number of violations
          example: 10
        blockedCount:
          type: number
          description: Number of BLOCK violations
          example: 2
        warnedCount:
          type: number
          description: Number of WARN violations
          example: 8
        applicablePoliciesCount:
          type: number
          description: Number of applicable policies
          example: 3
        lastEvaluatedAt:
          type: string
          description: Last evaluation timestamp (ISO 8601)
          example: '2024-01-15T10:30:00Z'
        lastScanId:
          type: string
          description: Last scan ID
          example: 550e8400-e29b-41d4-a716-446655440001
        teamIds:
          description: Team IDs this project belongs to
          example:
            - 550e8400-e29b-41d4-a716-446655440002
          type: array
          items:
            type: string
      required:
        - projectId
        - projectName
        - complianceStatus
        - totalViolations
        - blockedCount
        - warnedCount
        - applicablePoliciesCount
        - teamIds
    ViolationBreakdownDto:
      type: object
      properties:
        ruleType:
          type: string
          description: Rule type/name
          example: Critical Severity Check
        count:
          type: number
          description: Total violations for this rule type
          example: 25
        blockedCount:
          type: number
          description: BLOCK violations for this rule type
          example: 10
        warnedCount:
          type: number
          description: WARN violations for this rule type
          example: 15
      required:
        - ruleType
        - count
        - blockedCount
        - warnedCount
    ComplianceTrendPointDto:
      type: object
      properties:
        date:
          type: string
          description: Date (ISO 8601)
          example: '2024-01-15T00:00:00Z'
        compliantCount:
          type: number
          description: Number of compliant projects on this day
          example: 38
        nonCompliantCount:
          type: number
          description: Number of non-compliant projects on this day
          example: 7
        pendingCount:
          type: number
          description: Number of pending projects on this day
          example: 5
        complianceRate:
          type: number
          description: Compliance rate percentage on this day
          example: 84.44
      required:
        - date
        - compliantCount
        - nonCompliantCount
        - pendingCount
        - complianceRate
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: JWT access token.

````