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

# Get Transform Details



## OpenAPI

````yaml /openapi/openapi.json get /transforms/details
openapi: 3.1.0
info:
  title: Streamkap REST API
  description: >-
    The Streamkap REST API allows you to programmatically manage your CDC
    pipelines, sources, destinations, transforms, and more.


    Authenticate using a bearer token obtained from the [Access
    Token](/api-reference/auth/access-token) endpoint with your API client
    credentials.
  contact:
    name: Streamkap Support
    url: https://streamkap.com/
    email: support@streamkap.com
  license:
    name: Proprietary
  version: 2.0.0
servers:
  - url: https://api.streamkap.com
    description: Production
security: []
tags:
  - name: Alerts
    description: Manage alert subscribers, preferences, and notification credentials.
  - name: Authentication
    description: Obtain and refresh access tokens, manage client credentials and roles.
  - name: Billing
    description: Retrieve usage metrics, summaries, and export billing data.
  - name: Consumer Groups
    description: List, inspect, and reset Kafka consumer group offsets.
  - name: Dashboard
    description: Retrieve organisation-level statistics and overview data.
  - name: Destinations
    description: Create, configure, and manage data destinations and their lifecycle.
  - name: Kafka Access
    description: Manage Kafka users and their access permissions.
  - name: Logs
    description: Query and summarise system logs.
  - name: Pipelines
    description: Create, configure, and manage CDC pipelines and their lifecycle.
  - name: Project Keys
    description: Manage project keys that bundle API credentials and optional Kafka access.
  - name: Schema Registry
    description: Browse schema subjects, versions, and retrieve schema definitions.
  - name: Services
    description: View and switch service metadata.
  - name: Sources
    description: >-
      Create, configure, and manage data sources, snapshots, and their
      lifecycle.
  - name: Tags
    description: Create, update, and manage resource tags for organisation.
  - name: Topics
    description: Browse topic details, statistics, configurations, metrics, and messages.
  - name: Transforms
    description: >-
      Create, deploy, and manage data transforms, unit tests, and implementation
      details.
paths:
  /transforms/details:
    get:
      tags:
        - Transforms
      summary: Get Transform Details
      operationId: listTransformDetails
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransformDetailsRes'
      security:
        - FronteggHTTPAuthentication: []
components:
  schemas:
    TransformDetailsRes:
      properties:
        page:
          type: integer
          title: Page
          description: Current page number
          default: 1
        page_size:
          type: integer
          title: Page Size
          description: Results per page
          default: 10
        total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total
          description: Total number of results
        has_next:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Next
          description: Whether more pages exist
        result:
          items:
            $ref: '#/components/schemas/TransformDetailsEntity'
          type: array
          title: Result
      additionalProperties: true
      type: object
      required:
        - result
      title: TransformDetailsRes
    TransformDetailsEntity:
      properties:
        metrics:
          $ref: '#/components/schemas/TransformMetric'
        config:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Config
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        transform_type:
          anyOf:
            - $ref: '#/components/schemas/TransformsLibraryEnum'
            - type: string
            - type: 'null'
          title: Transform Type
        sql_query:
          anyOf:
            - type: string
            - type: 'null'
          title: Sql Query
        topic:
          anyOf:
            - type: string
            - type: 'null'
          title: Topic
        topic_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Topic Id
        topics:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Topics
        topic_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Topic Ids
      additionalProperties: true
      type: object
      required:
        - metrics
        - config
        - id
        - name
      title: TransformDetailsEntity
    TransformMetric:
      properties:
        tasks:
          anyOf:
            - type: integer
            - type: 'null'
          title: Tasks
        latency:
          anyOf:
            - type: integer
            - type: 'null'
          title: Latency
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        duration:
          anyOf:
            - type: integer
            - type: 'null'
          title: Duration
        start_time:
          anyOf:
            - type: integer
            - type: string
            - type: string
              format: date-time
            - type: 'null'
          title: Start Time
        end_time:
          anyOf:
            - type: string
            - type: string
              format: date-time
            - type: 'null'
          title: End Time
        checkpoints:
          anyOf:
            - $ref: '#/components/schemas/TransformCheckpointsInfo'
            - type: 'null'
      additionalProperties: true
      type: object
      title: TransformMetric
    TransformsLibraryEnum:
      type: string
      enum:
        - fan_out
        - sql_join
        - enrich
        - enrich_async
        - map_filter
        - toast_handling
        - un_nesting
        - rollup
        - topic_router
      title: TransformsLibraryEnum
    TransformCheckpointsInfo:
      properties:
        job_id:
          type: string
          title: Job Id
        counts:
          additionalProperties: true
          type: object
          title: Counts
        summary:
          additionalProperties: true
          type: object
          title: Summary
        latest:
          anyOf:
            - $ref: '#/components/schemas/TransformCheckpointHistory'
            - type: 'null'
        history:
          items:
            $ref: '#/components/schemas/TransformCheckpointHistory'
          type: array
          title: History
          default: []
        operator_breakdown:
          items:
            $ref: '#/components/schemas/TransformOperatorState'
          type: array
          title: Operator Breakdown
          default: []
      additionalProperties: true
      type: object
      required:
        - job_id
        - counts
        - summary
      title: TransformCheckpointsInfo
      description: Checkpoint statistics and latest checkpoint information for a transform.
    TransformCheckpointHistory:
      properties:
        id:
          type: integer
          title: Id
        status:
          type: string
          title: Status
        is_savepoint:
          type: boolean
          title: Is Savepoint
        trigger_timestamp:
          type: integer
          title: Trigger Timestamp
        latest_ack_timestamp:
          type: integer
          title: Latest Ack Timestamp
        state_size:
          type: integer
          title: State Size
        end_to_end_duration:
          type: integer
          title: End To End Duration
        alignment_buffered:
          type: integer
          title: Alignment Buffered
        num_subtasks:
          type: integer
          title: Num Subtasks
        num_acknowledged_subtasks:
          type: integer
          title: Num Acknowledged Subtasks
      additionalProperties: true
      type: object
      required:
        - id
        - status
        - is_savepoint
        - trigger_timestamp
        - latest_ack_timestamp
        - state_size
        - end_to_end_duration
        - alignment_buffered
        - num_subtasks
        - num_acknowledged_subtasks
      title: TransformCheckpointHistory
      description: Individual checkpoint history entry.
    TransformOperatorState:
      properties:
        operator_id:
          type: string
          title: Operator Id
        operator_name:
          type: string
          title: Operator Name
        state_size:
          type: integer
          title: State Size
        checkpointed_size:
          type: integer
          title: Checkpointed Size
        end_to_end_duration:
          type: integer
          title: End To End Duration
        parallelism:
          type: integer
          title: Parallelism
      additionalProperties: true
      type: object
      required:
        - operator_id
        - operator_name
        - state_size
        - checkpointed_size
        - end_to_end_duration
        - parallelism
      title: TransformOperatorState
      description: Per-operator state size breakdown.
  securitySchemes:
    FronteggHTTPAuthentication:
      type: http
      scheme: bearer

````