trace-summary

Generated reference page for spec/v1/schemas/resources/trace-summary.json.

Metadata

• Type: JSON Schema
• Source: spec/v1/schemas/resources/trace-summary.json
• Raw: View Raw

Summary

• Schema ID: https://agent-service.spec/v1/schemas/resources/trace-summary.json
• Defs: 0
• Properties: 22
• Required: 12

Source

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://agent-service.spec/v1/schemas/resources/trace-summary.json",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "traceId",
    "orgId",
    "agentId",
    "runId",
    "runSpaceId",
    "rootSpanId",
    "status",
    "startTime",
    "updatedAt",
    "spanCount",
    "openSpanCount",
    "statusCounts"
  ],
  "properties": {
    "traceId": {
      "$ref": "../common/tracing.json#/$defs/traceId"
    },
    "orgId": {
      "$ref": "../common/identity.json#/$defs/orgId"
    },
    "agentId": {
      "$ref": "../common/identity.json#/$defs/agentId"
    },
    "contextId": {
      "$ref": "../common/identity.json#/$defs/opaqueId"
    },
    "runId": {
      "$ref": "../common/identity.json#/$defs/runId"
    },
    "runSpaceId": {
      "$ref": "../common/identity.json#/$defs/opaqueId"
    },
    "rootSpanId": {
      "$ref": "../common/tracing.json#/$defs/spanId"
    },
    "rootSpanName": {
      "type": "string",
      "minLength": 1
    },
    "status": {
      "$ref": "../common/tracing.json#/$defs/traceStatus"
    },
    "startTime": {
      "$ref": "../common/identity.json#/$defs/timestamp"
    },
    "endTime": {
      "$ref": "../common/identity.json#/$defs/timestamp"
    },
    "durationMs": {
      "type": "integer",
      "minimum": 0
    },
    "updatedAt": {
      "$ref": "../common/identity.json#/$defs/timestamp"
    },
    "spanCount": {
      "type": "integer",
      "minimum": 1
    },
    "openSpanCount": {
      "type": "integer",
      "minimum": 0
    },
    "errorSpanCount": {
      "type": "integer",
      "minimum": 0
    },
    "spanEventCount": {
      "type": "integer",
      "minimum": 0
    },
    "contentCaptureMode": {
      "$ref": "../common/otel.json#/$defs/ContentCaptureMode"
    },
    "conversationId": {
      "type": "string"
    },
    "semanticConventions": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "statusCounts": {
      "$ref": "../common/tracing.json#/$defs/TraceStatusCounts"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": true
    }
  },
  "allOf": [
    {
      "if": {
        "properties": {
          "status": {
            "enum": ["success", "failed", "cancelled", "timeout"]
          }
        },
        "required": ["status"]
      },
      "then": {
        "required": ["endTime", "durationMs"]
      }
    }
  ]
}