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

# Project overview

> Asset and vulnerability counts, weekly new vulnerabilities, last run and recent activity.



## OpenAPI

````yaml /api-reference/openapi.json get /api/projects/{id}/overview
openapi: 3.0.0
info:
  title: Open Attack Surface Management
  description: Open-source platform for cybersecurity Attack Surface Management (ASM)
  version: '1.0'
  contact: {}
servers:
  - url: https://{baseUrl}/api/v1
    variables:
      baseUrl:
        default: localhost:3000
        description: API server hostname with port (e.g. localhost:3000, api.example.com)
security: []
tags: []
externalDocs:
  description: Authentication Docs
  url: auth/docs
paths:
  /api/projects/{id}/overview:
    get:
      tags:
        - Projects
      summary: Project overview
      description: >-
        Asset and vulnerability counts, weekly new vulnerabilities, last run and
        recent activity.
      operationId: ProjectsController_getOverview
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
        - name: X-Workspace-Id
          in: header
          description: Workspace ID
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectOverviewDto'
                allOf:
                  - $ref: '#/components/schemas/AppResponseSerialization'
components:
  schemas:
    ProjectOverviewDto:
      type: object
      properties:
        totalAssets:
          type: number
        newAssets:
          type: number
          description: Assets that joined in the last 7 days
        workflows:
          type: number
        openVulnerabilities:
          $ref: '#/components/schemas/SeverityCountsDto'
        newVulnerabilities:
          type: number
          description: Open vulnerabilities first seen in the last 7 days
        newVulnerabilityRuns:
          description: Runs that found them
          type: array
          items:
            $ref: '#/components/schemas/ProjectRunRefDto'
        lastRun:
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/ProjectRunRefDto'
        weekly:
          type: array
          items:
            $ref: '#/components/schemas/WeeklyNewVulnerabilitiesDto'
        activity:
          type: array
          items:
            $ref: '#/components/schemas/ProjectActivityDto'
      required:
        - totalAssets
        - newAssets
        - workflows
        - openVulnerabilities
        - newVulnerabilities
        - newVulnerabilityRuns
        - weekly
        - activity
    AppResponseSerialization:
      type: object
      properties: {}
    SeverityCountsDto:
      type: object
      properties:
        critical:
          type: number
        high:
          type: number
        medium:
          type: number
        low:
          type: number
        info:
          type: number
      required:
        - critical
        - high
        - medium
        - low
        - info
    ProjectRunRefDto:
      type: object
      properties:
        id:
          type: string
        createdAt:
          format: date-time
          type: string
        workflowName:
          type: string
        status:
          allOf:
            - $ref: '#/components/schemas/JobStatus'
        jobRunType:
          allOf:
            - $ref: '#/components/schemas/JobRunType'
      required:
        - id
        - createdAt
        - workflowName
        - status
        - jobRunType
    WeeklyNewVulnerabilitiesDto:
      type: object
      properties:
        week:
          type: string
          description: Monday of the week (ISO date)
        critical:
          type: number
        high:
          type: number
        medium:
          type: number
        low:
          type: number
        info:
          type: number
      required:
        - week
        - critical
        - high
        - medium
        - low
        - info
    ProjectActivityDto:
      type: object
      properties:
        kind:
          type: string
          enum:
            - run
            - audit
            - dismissed
        at:
          format: date-time
          type: string
        ref:
          type: string
          description: Run id, audit action, or `dismissed`
        change:
          description: What a `project.updated` audit changed
          allOf:
            - $ref: '#/components/schemas/ProjectChange'
        added:
          type: number
          description: Assets that joined
        removed:
          type: number
          description: Assets that left
        count:
          type: number
          description: Vulnerabilities dismissed
        reason:
          description: Why the vulnerabilities were dismissed
          allOf:
            - $ref: '#/components/schemas/DismissReason'
        runStatus:
          type: string
        workflowName:
          type: string
        jobRunType:
          type: string
        newVulnerabilities:
          type: number
        recurringVulnerabilities:
          type: number
        scopeSize:
          type: number
        actorName:
          type: string
        changes:
          type: object
      required:
        - kind
        - at
        - ref
    JobStatus:
      type: string
      enum:
        - pending
        - in_progress
        - completed
        - failed
        - cancelled
        - skipped
    JobRunType:
      type: string
      enum:
        - manual
        - scheduled
        - event
    ProjectChange:
      type: string
      enum:
        - settings
        - assets.added
        - assets.discovered
        - assets.removed
        - scope
        - workflow.added
        - workflow.updated
        - workflow.removed
        - triggers
      description: What a `project.updated` audit changed
    DismissReason:
      type: string
      enum:
        - false_positive
        - used_in_test
        - wont_fix
      description: Why the vulnerabilities were dismissed

````

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