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

# Get Widget

> Get one saved widget's definition, with its dashboard, for the caller's project.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/public/widgets/{widget_id}
openapi: 3.1.0
info:
  title: TraceRoot Public API
  version: 0.1.0
servers:
  - description: TraceRoot Cloud
    url: https://app.traceroot.ai
  - description: Self-hosted
    url: '{baseUrl}'
    variables:
      baseUrl:
        default: http://localhost:8000
        description: Your TraceRoot backend URL
security: []
paths:
  /api/v1/public/widgets/{widget_id}:
    get:
      tags:
        - Widgets
      summary: Get Widget
      description: >-
        Get one saved widget's definition, with its dashboard, for the caller's
        project.
      operationId: get_widget
      parameters:
        - in: path
          name: widget_id
          required: true
          schema:
            title: Widget Id
            type: string
        - description: >-
            Target project for the request. Required when authenticating with a
            user session token (a user credential is only meaningful scoped to a
            project); for an API key it is optional and, if given, must match
            the key's project.
          in: query
          name: project_id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Target project for the request. Required when authenticating with
              a user session token (a user credential is only meaningful scoped
              to a project); for an API key it is optional and, if given, must
              match the key's project.
            title: Project Id
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WidgetDetail'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Authentication failed
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Widget not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Authentication service unavailable
      security:
        - BearerAuth: []
components:
  schemas:
    WidgetDetail:
      description: >-
        One saved widget, as stored, with the dashboard it belongs to.


        ``spec`` is exactly what the create parsed (defaults filled, unknown
        keys

        stripped), so what a caller reads is what the engine runs.
        ``dashboard_id``

        and ``dashboard_name`` let a caller holding only a widget id climb to
        the

        dashboard without a second read. Widgets record no creator.
      properties:
        create_time:
          format: date-time
          title: Create Time
          type: string
        dashboard_id:
          title: Dashboard Id
          type: string
        dashboard_name:
          title: Dashboard Name
          type: string
        display_config:
          title: Display Config
        id:
          title: Id
          type: string
        spec:
          title: Spec
        title:
          title: Title
          type: string
        type:
          title: Type
          type: string
        update_time:
          format: date-time
          title: Update Time
          type: string
      required:
        - id
        - title
        - type
        - spec
        - create_time
        - dashboard_id
        - dashboard_name
        - display_config
        - update_time
      title: WidgetDetail
      type: object
    ErrorResponse:
      description: >-
        The canonical public error envelope (matches the gateway's normalized
        shape).
      properties:
        detail:
          title: Detail
          type: string
      required:
        - detail
      title: ErrorResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    BearerAuth:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.