Okareo Traces API

openapi: 3.2.0
info:
  title: Okareo Traces API
  version: 0.1.0
  description: Ingest and query traces from live agent runs.
servers:
- url: https://api.okareo.com
tags:
- name: Traces
  description: Ingest and query traces from live agent runs.
paths:
  /v0/find_traces:
    post:
      tags:
      - Traces
      summary: Find Traces
      operationId: find_traces_v0_find_traces_post
      parameters:
      - name: api-key
        in: header
        required: true
        schema:
          type: string
          title: Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FindTracesRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FindTracesResponse'
                title: Response Find Traces V0 Find Traces Post
        '400':
          description: Input data is incorrect
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Okareo API token has failed authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Data is not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Input data is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/traces:
    post:
      tags:
      - Traces
      summary: Receive Traces
      operationId: receive_traces_v1_traces_post
      parameters:
      - name: api-key
        in: header
        required: true
        schema:
          type: string
          title: Api-Key
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReceiveTracesResponse'
        '400':
          description: Input data is incorrect
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Okareo API token has failed authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Data is not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Input data is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
      type: object
      required:
      - detail
      title: ErrorResponse
    FindTracesResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Trace UUID
        otel_trace_id:
          type: string
          title: Otel Trace Id
          description: Trace ID from OpenTelemetry
        datapoint_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Datapoint Ids
          description: List of associated datapoint IDs
        span_ids:
          items:
            type: string
          type: array
          title: Span Ids
          description: List of associated span OpenTelemetry IDs
        spans:
          items:
            $ref: '#/components/schemas/SpanResponse'
          type: array
          title: Spans
          description: List of spans associated with the trace
        start_time:
          type: string
          format: date-time
          title: Start Time
          description: Trace start time
        end_time:
          type: string
          format: date-time
          title: End Time
          description: Trace end time
        time_created:
          type: string
          format: date-time
          title: Time Created
          description: Trace creation time
      type: object
      required:
      - id
      - otel_trace_id
      - datapoint_ids
      - span_ids
      - spans
      - start_time
      - end_time
      - time_created
      title: FindTracesResponse
    SpanResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        span_name:
          type: string
          title: Span Name
          description: Name of the span
        span_kind:
          type: string
          title: Span Kind
          description: Kind of the span
        otel_span_id:
          type: string
          title: Otel Span Id
          description: OpenTelemetry Span ID
        otel_trace_id:
          type: string
          title: Otel Trace Id
          description: OpenTelemetry Trace ID
        otel_trace_depth:
          anyOf:
          - type: integer
          - type: 'null'
          title: Otel Trace Depth
          description: Depth of the span in the trace hierarchy
        start_time:
          type: integer
          title: Start Time
          description: Span start time in epoch nanoseconds
        end_time:
          type: integer
          title: End Time
          description: Span end time in epoch nanoseconds
        datapoint_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Datapoint Id
          description: Associated Datapoint ID
        attributes:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Attributes
          description: Span attributes
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Metadata
          description: Span metadata
      type: object
      required:
      - id
      - span_name
      - span_kind
      - otel_span_id
      - otel_trace_id
      - start_time
      - end_time
      title: SpanResponse
    ReceiveTracesResponse:
      properties:
        status:
          type: string
          title: Status
          description: Processing status
        message:
          type: string
          title: Message
          description: Human-readable result message
        summary:
          $ref: '#/components/schemas/IngestionSummary'
          description: Ingestion summary counts
      type: object
      required:
      - status
      - message
      - summary
      title: ReceiveTracesResponse
    IngestionSummary:
      properties:
        datapoints_created:
          type: integer
          title: Datapoints Created
          description: Number of datapoints created
        spans_processed:
          type: integer
          title: Spans Processed
          description: Number of spans processed
        checks_executed:
          type: integer
          title: Checks Executed
          description: Number of checks executed
        issues_found:
          type: integer
          title: Issues Found
          description: Number of issues found
      type: object
      required:
      - datapoints_created
      - spans_processed
      - checks_executed
      - issues_found
      title: IngestionSummary
    FindTracesRequest:
      properties:
        project_id:
          type: string
          format: uuid
          title: Project Id
          description: Project UUID to fetch traces from
        otel_trace_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Otel Trace Id
          description: Trace ID to fetch
        context_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Context Token
          description: Context token to look up traces for a conversation (alternative to otel_trace_id)
      type: object
      required:
      - project_id
      title: FindTracesRequest