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

# Jobs Timeline Route



## OpenAPI

````yaml /api/openapi.json get /api/jobs/timeline
openapi: 3.1.0
info:
  title: Halite
  version: 0.1.0
servers: []
security: []
paths:
  /api/jobs/timeline:
    get:
      tags:
        - jobs
      summary: Jobs Timeline Route
      operationId: jobs_timeline_route_api_jobs_timeline_get
      parameters:
        - name: window
          in: query
          required: false
          schema:
            type: string
            default: 24h
            title: Window
        - name: group_by
          in: query
          required: false
          schema:
            type: string
            default: function
            title: Group By
        - name: include_system
          in: query
          required: false
          schema:
            type: boolean
            default: false
            title: Include System
        - name: function_filter
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 128
              - type: 'null'
            title: Function Filter
        - name: user
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 255
              - type: 'null'
            title: User
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimelineOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TimelineOut:
      properties:
        window_start:
          type: string
          format: date-time
          title: Window Start
        window_end:
          type: string
          format: date-time
          title: Window End
        group_by:
          type: string
          enum:
            - function
            - user
          title: Group By
        groups:
          items:
            $ref: '#/components/schemas/TimelineGroup'
          type: array
          title: Groups
        total_bars:
          type: integer
          title: Total Bars
        last_polled_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Polled At
        active_known:
          type: boolean
          title: Active Known
      type: object
      required:
        - window_start
        - window_end
        - group_by
        - groups
        - total_bars
        - last_polled_at
        - active_known
      title: TimelineOut
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TimelineGroup:
      properties:
        key:
          type: string
          title: Key
        label:
          type: string
          title: Label
        category:
          type: string
          enum:
            - state
            - cmd
            - pkg
            - service
            - test
            - runner
            - wheel
            - manage
            - other
          title: Category
        bar_count:
          type: integer
          title: Bar Count
        bars:
          items:
            $ref: '#/components/schemas/TimelineBar'
          type: array
          title: Bars
      type: object
      required:
        - key
        - label
        - category
        - bar_count
        - bars
      title: TimelineGroup
      description: |-
        A row on the timeline. ``key`` identifies the group (function name
        or username), ``label`` is what the UI displays.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    TimelineBar:
      properties:
        jid:
          type: string
          title: Jid
        function:
          type: string
          title: Function
        target:
          anyOf:
            - type: string
            - type: 'null'
          title: Target
        user:
          anyOf:
            - type: string
            - type: 'null'
          title: User
        started_at:
          type: string
          format: date-time
          title: Started At
        completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Completed At
        status:
          type: string
          enum:
            - pass
            - changed
            - failed
            - running
            - unknown
          title: Status
        category:
          type: string
          enum:
            - state
            - cmd
            - pkg
            - service
            - test
            - runner
            - wheel
            - manage
            - other
          title: Category
        minion_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Minion Count
        failed_minion_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Failed Minion Count
      type: object
      required:
        - jid
        - function
        - target
        - user
        - started_at
        - completed_at
        - status
        - category
        - minion_count
        - failed_minion_count
      title: TimelineBar
      description: One job invocation on the timeline.

````