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

# Get Log Analysis list

> Retrieves all log-analysis



## OpenAPI

````yaml get /api/v1/log-analysis
openapi: 3.1.0
info:
  title: Aegister API
  version: 1.0.3
servers: []
security: []
paths:
  /api/v1/log-analysis:
    get:
      tags:
        - log-analysis
      description: Retrieves all log-analysis
      operationId: log_analysis_retrieve
      parameters:
        - in: query
          name: limit
          schema:
            type: number
            default: 50
          description: Max number of reponse items.
        - in: query
          name: offset
          schema:
            type: number
            default: 0
          description: Offset response items.
        - in: query
          name: order
          schema:
            type: string
            default: '-id'
          description: Order results by item field
          examples:
            IdDesc:
              value: '-id'
              summary: id desc
              description: Order by id desc
            IdAsc:
              value: id
              summary: id asc
              description: Order by id asc
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: integer
                    description: |-
                      Any value different from 0 indicates an error.  
                      More details can be found in `messages`.
                    minimum: 0
                    maximum: 0
                    examples:
                      - 0
                  messages:
                    type: array
                    description: >-
                      If `error` is `1`, contains zero or more details on the
                      error.
                    examples:
                      - []
                  total:
                    type: number
                    description: >-
                      Total number of items that meet the list filter.  

                      This doesn't represent the number of items inside the
                      `data` array.
                    minimum: 0
                    examples:
                      - 20
                      - 30
                      - 40
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                          description: Unique identifier for the log-analysis.
                          examples:
                            - 11
                            - 22
                            - 33
                        state:
                          type: string
                          description: State of the log-analysis.
                          enum:
                            - pending
                            - completed
                            - failed
                        report:
                          type: object
                          description: Report of the log-analysis.
                          properties:
                            EnhancedFirewallAnalysisReport:
                              type: object
                              description: >-
                                Enhanced firewall analysis report with threat
                                intelligence.
                              properties:
                                report_id:
                                  type: string
                                  format: uuid
                                  description: Unique identifier for the analysis report.
                                generated_at:
                                  type: string
                                  format: date-time
                                  description: Timestamp when the report was generated.
                                summary_statistics:
                                  type: object
                                  description: Summary statistics from log analysis.
                                  properties:
                                    total_entries:
                                      type: number
                                      description: Total number of log entries processed.
                                      examples:
                                        - 1234
                                    parsed_entries:
                                      type: number
                                      description: >-
                                        Number of successfully parsed log
                                        entries.
                                      examples:
                                        - 1200
                                    allowed_connections:
                                      type: number
                                      description: Number of allowed connections.
                                      examples:
                                        - 800
                                    denied_connections:
                                      type: number
                                      description: Number of denied connections.
                                      examples:
                                        - 400
                                    unique_ips:
                                      type: number
                                      description: >-
                                        Number of unique IP addresses
                                        identified.
                                      examples:
                                        - 150
                                    malicious_ips:
                                      type: number
                                      description: Number of IPs identified as malicious.
                                      examples:
                                        - 25
                                    date_range:
                                      type: object
                                      properties:
                                        start_date:
                                          type: string
                                          format: date-time
                                          description: Start date of the log data.
                                        end_date:
                                          type: string
                                          format: date-time
                                          description: End date of the log data.
                                    parsing_success_rate:
                                      type: number
                                      minimum: 0
                                      maximum: 1
                                      description: >-
                                        Success rate of log parsing (0.0 to
                                        1.0).
                                      examples:
                                        - 0.97
                                threat_intelligence:
                                  type: object
                                  description: Threat intelligence analysis results.
                                  properties:
                                    total_ips_analyzed:
                                      type: number
                                      description: >-
                                        Total number of IPs analyzed for
                                        threats.
                                      examples:
                                        - 150
                                    malicious_ips_identified:
                                      type: number
                                      description: Number of IPs identified as malicious.
                                      examples:
                                        - 25
                                    events_involving_malicious_ips:
                                      type: number
                                      description: >-
                                        Number of log events involving malicious
                                        IPs.
                                      examples:
                                        - 120
                                    crime_level_distribution:
                                      type: object
                                      properties:
                                        low:
                                          type: number
                                          examples:
                                            - 5
                                        medium:
                                          type: number
                                          examples:
                                            - 8
                                        high:
                                          type: number
                                          examples:
                                            - 7
                                        critical:
                                          type: number
                                          examples:
                                            - 5
                                    top_threat_actors:
                                      type: array
                                      description: List of top threat actors identified.
                                      items:
                                        type: object
                                        properties:
                                          ip_address:
                                            type: string
                                            format: ipv4
                                            examples:
                                              - 192.168.1.100
                                          event_count:
                                            type: number
                                            examples:
                                              - 15
                                          crime_score:
                                            type: number
                                            examples:
                                              - 250
                                          country:
                                            type: string
                                            examples:
                                              - US
                                          service:
                                            type: string
                                            examples:
                                              - SSH
                                          last_seen:
                                            type: string
                                            format: date-time
                                          direction:
                                            type: string
                                            enum:
                                              - inbound
                                              - outbound
                                            examples:
                                              - inbound
                                atb_impact_analysis:
                                  type: object
                                  description: >-
                                    Analysis of how ATB threat intelligence
                                    would improve security.
                                  properties:
                                    current_blocked_events:
                                      type: number
                                      description: >-
                                        Events currently blocked by existing
                                        firewall.
                                      examples:
                                        - 400
                                    atb_would_block:
                                      type: number
                                      description: >-
                                        Additional events ATB would have
                                        blocked.
                                      examples:
                                        - 120
                                    threat_reduction_percentage:
                                      type: number
                                      minimum: 0
                                      maximum: 100
                                      description: >-
                                        Percentage improvement in threat
                                        blocking.
                                      examples:
                                        - 30
                                    unique_threats_blocked:
                                      type: number
                                      description: >-
                                        Number of unique threat actors ATB would
                                        block.
                                      examples:
                                        - 25
                                    current_security_score:
                                      type: number
                                      minimum: 0
                                      maximum: 100
                                      description: Current security effectiveness score.
                                      examples:
                                        - 67
                                    improved_security_score:
                                      type: number
                                      minimum: 0
                                      maximum: 100
                                      description: Security score with ATB implementation.
                                      examples:
                                        - 87
                                parser_statistics:
                                  type: object
                                  description: >-
                                    Statistics about parsing performance by
                                    vendor.
                                  properties:
                                    detected_vendor:
                                      type: string
                                      description: Detected firewall vendor.
                                      examples:
                                        - sonicwall
                                        - fortigate
                                        - sophos
                                    parser_used:
                                      type: string
                                      description: Parser class used for analysis.
                                      examples:
                                        - SonicWallParser
                                        - FortiGateParser
                                    parsing_errors:
                                      type: number
                                      description: Number of parsing errors encountered.
                                      examples:
                                        - 34
                                protocol_distribution:
                                  type: object
                                  description: >-
                                    Distribution of network protocols in the
                                    logs.
                                  additionalProperties:
                                    type: number
                                    description: Count of events for each protocol.
                                  examples:
                                    - TCP: 800
                                      UDP: 300
                                      ICMP: 100
                                timeline_data:
                                  type: array
                                  description: >-
                                    Threat events over time for timeline
                                    visualization.
                                  items:
                                    type: object
                                    properties:
                                      timestamp:
                                        type: string
                                        format: date-time
                                      malicious_events:
                                        type: number
                                        examples:
                                          - 5
                                      total_events:
                                        type: number
                                        examples:
                                          - 50
                                recommendations:
                                  type: array
                                  description: Security recommendations based on analysis.
                                  items:
                                    type: string
                                    examples:
                                      - >-
                                        Consider implementing ATB threat
                                        intelligence to block additional 120
                                        malicious events
                                key_findings:
                                  type: array
                                  description: Key findings from the analysis.
                                  items:
                                    type: string
                                    examples:
                                      - >-
                                        25 unique threat actors identified with
                                        crime scores above 175
                        created_at:
                          type: string
                          format: date-time
                          description: Date and time of creation of the log-analysis.
                        file:
                          type: object
                          properties:
                            name:
                              type: string
                              description: Name of the file.
                            path:
                              type: string
                              description: Path to the file.
                            size:
                              type: number
                              description: Size of the file in bytes.
                            type:
                              type: string
                              description: Type of the file.
                            stored:
                              type: string
                              description: Date and time of the file storage.
          description: ''
      security:
        - ApiKeyAuth: []
        - ApiKeyQueryParam: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Aegister-Token
    ApiKeyQueryParam:
      type: apiKey
      in: query
      name: X-Aegister-Token

````