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

# Get threats over time metric

> Returns the count of threats grouped by day for the specified time period.



## OpenAPI

````yaml get /api/v1/metrics/threats_over_time
openapi: 3.0.0
info:
  contact: {}
  title: Ocean Security API
  version: 1.0.0
  description: Ocean Security API for threat detection and security metrics
servers:
  - url: https://api.ocean.security
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Threats
    description: Operations for retrieving threat information
  - name: Metrics
    description: Security metrics and analytics endpoints
paths:
  /api/v1/metrics/threats_over_time:
    get:
      tags:
        - Metrics
      summary: Get threats over time metric
      description: >-
        Returns the count of threats grouped by day for the specified time
        period.
      parameters:
        - description: Authentication API Key
          in: header
          name: X-Api-Key
          required: true
          schema:
            type: string
        - description: Number of days to look back (default 7)
          in: query
          name: days_ago
          schema:
            type: integer
        - description: Page number for pagination (default 1)
          in: query
          name: page
          schema:
            type: integer
      responses:
        '200':
          description: A paginated list of daily threat counts
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/common.PaginatedResponse'
                  - properties:
                      results:
                        $ref: >-
                          #/components/schemas/controllers_metrics.threatsOverTimeResult
                    type: object
        '400':
          description: Invalid input parameters (e.g., invalid days_ago)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.ErrorResponse'
        '401':
          description: Unauthorized (invalid or missing API Key)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.ErrorResponse'
components:
  schemas:
    common.PaginatedResponse:
      properties:
        pagination:
          allOf:
            - $ref: '#/components/schemas/common.PaginationParams'
          description: Pagination information
        results:
          description: The actual data
        status:
          description: HTTP status code
          type: integer
      type: object
    controllers_metrics.threatsOverTimeResult:
      properties:
        items:
          items:
            $ref: '#/components/schemas/controllers_metrics.ThreatsOverTimeRow'
          type: array
      type: object
    types.ErrorResponse:
      properties:
        error:
          type: string
      type: object
    common.PaginationParams:
      properties:
        page:
          description: Current page number (1-based)
          type: integer
        page_size:
          description: Number of items on this page (max 100)
          type: integer
        total:
          description: Total number of items
          type: integer
      type: object
    controllers_metrics.ThreatsOverTimeRow:
      properties:
        count_threats:
          type: number
        date:
          example: '1970-01-01T00:00:00.000Z'
          format: date
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: API key for authentication

````