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

# List telemetry setup

> Requires scopes: traces:read



## OpenAPI

````yaml /api-reference/openapi.json get /api/telemetry/setup
openapi: 3.1.2
info:
  title: EvalGate API
  version: 5.1.0
  description: EvalGate API. See docs/api-contract.md for stability commitments.
servers:
  - url: https://evalgate.com
    description: Production
  - url: http://localhost:3000
    description: Local
security: []
paths:
  /api/telemetry/setup:
    get:
      tags:
        - telemetry
      summary: List telemetry setup
      description: 'Requires scopes: traces:read'
      operationId: get_telemetry_setup
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetApiTelemetrySetupResponse200ApplicationJson
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - bearerAuth: []
components:
  schemas:
    GetApiTelemetrySetupResponse200ApplicationJson:
      type: object
      properties:
        collector:
          type: object
          properties:
            status:
              type: string
              enum:
                - configured
            otlpEndpoint:
              type: string
            collectorEndpoint:
              type: string
            auth:
              type: string
              enum:
                - session-or-bearer-api-key
          additionalProperties: false
          required:
            - status
            - otlpEndpoint
            - collectorEndpoint
            - auth
        paths:
          type: array
          items:
            type: object
            properties:
              id:
                oneOf:
                  - type: string
                    enum:
                      - manual
                  - type: string
                    enum:
                      - openinference
                  - type: string
                    enum:
                      - opentelemetry
                  - type: string
                    enum:
                      - collector
              label:
                type: string
              plainEnglish:
                type: string
              language:
                oneOf:
                  - type: string
                    enum:
                      - json
                  - type: string
                    enum:
                      - python
                  - type: string
                    enum:
                      - typescript
                  - type: string
                    enum:
                      - yaml
              code:
                type: string
              nextStep:
                type: string
              requiresCloudCredential:
                type: boolean
            additionalProperties: false
            required:
              - id
              - label
              - plainEnglish
              - language
              - code
              - nextStep
              - requiresCloudCredential
        testTrace:
          type: object
          properties:
            action:
              type: string
              enum:
                - send_deterministic_trace
            method:
              type: string
              enum:
                - POST
            path:
              type: string
              enum:
                - /api/telemetry/test-trace
            previewTraceId:
              type: string
          additionalProperties: false
          required:
            - action
            - method
            - path
            - previewTraceId
        localSetup:
          type: object
          properties:
            requiresCloudCredential:
              type: boolean
              enum:
                - false
            message:
              type: string
          additionalProperties: false
          required:
            - requiresCloudCredential
            - message
      additionalProperties: false
      required:
        - collector
        - paths
        - testTrace
        - localSetup
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - INVALID_REFERENCE
                - VALIDATION_ERROR
                - RATE_LIMITED
                - CONFLICT
                - INTERNAL_ERROR
                - SERVICE_UNAVAILABLE
                - QUOTA_EXCEEDED
                - FEATURE_LIMIT_REACHED
                - NO_ORG_MEMBERSHIP
                - SHARE_REVOKED
                - SHARE_EXPIRED
                - SHARE_UNAVAILABLE
                - PROVIDER_KEY_MISSING
                - PROVIDER_KEY_EXPIRED
                - PROVIDER_RATE_LIMITED
                - PROVIDER_UNAUTHORIZED
                - PROVIDER_UNAVAILABLE
                - AGENT_HANDOFF_INVALID
                - AGENT_HANDOFF_EXPIRED
                - AGENT_HANDOFF_DENIED
                - AGENT_HANDOFF_CONSUMED
                - PAYLOAD_TOO_LARGE
                - METHOD_NOT_ALLOWED
            message:
              type: string
            details: {}
            requestId:
              type: string
              format: uuid
            redaction:
              type: object
              properties:
                applied:
                  type: boolean
                  enum:
                    - true
                fieldCount:
                  type: integer
                  minimum: 0
                secretCount:
                  type: integer
                  minimum: 0
              required:
                - applied
                - fieldCount
                - secretCount
          required:
            - code
            - message
      required:
        - error
  responses:
    ValidationError:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        WWW-Authenticate:
          description: >-
            Bearer challenge. Agent-facing routes include the RFC 9728
            resource_metadata URL.
          schema:
            type: string
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        Retry-After:
          description: Delay in seconds before retrying when present.
          schema:
            type: integer
            minimum: 1
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ServiceUnavailable:
      description: Service unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: EvalGate API key
      description: >-
        Organization-scoped EvalGate API key. Discover the supported agent
        scopes at /.well-known/oauth-protected-resource. Per-operation grants
        are listed in x-evalgate-required-scopes; OpenAPI bearer security
        requirement arrays remain empty as required for non-OAuth schemes.
      x-evalgate-scopes-supported:
        - eval:read
        - eval:write
        - objectives:read
        - objectives:write
        - runs:read
        - runs:write
        - traces:read
        - traces:write
        - exports:download
        - reports:write
        - prompt:publish
        - scorer:publish
        - red_team:read
        - red_team:run
        - red_team:approve
        - docs:read
        - agent:read
        - agent:execute
        - admin:keys
        - admin:org
      x-evalgate-protected-resource-metadata: https://www.evalgate.com/.well-known/oauth-protected-resource

````