> ## 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 topic metrics



## OpenAPI

````yaml /openapi/openapi.json get /topics/metrics
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:
  /topics/metrics:
    get:
      tags:
        - Topics
      summary: Get topic metrics
      operationId: getTopicMetrics
      parameters:
        - name: timestamp_to
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Timestamp To
        - name: timestamp_from
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Timestamp From
        - name: time_type
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Time Type
        - name: time_interval
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            title: Time Interval
        - name: time_unit
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Time Unit
        - name: entity_type
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Filter by entity type. Valid values: sources, transforms.
              Comma-separated for multiple (e.g., 'sources,transforms').
            title: Entity Type
          description: >-
            Filter by entity type. Valid values: sources, transforms.
            Comma-separated for multiple (e.g., 'sources,transforms').
        - name: entity_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by specific entity IDs (comma-separated list).
            title: Entity Id
          description: Filter by specific entity IDs (comma-separated list).
        - name: value_format
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Filter by serialization value format. Valid values: avro, json,
              json_schema, protobuf, string, bytearray. Case-insensitive.
            title: Value Format
          description: >-
            Filter by serialization value format. Valid values: avro, json,
            json_schema, protobuf, string, bytearray. Case-insensitive.
        - name: has_errors
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: >-
              Filter topics by error status. true = only topics with
              recordErrorTotal > 0.
            title: Has Errors
          description: >-
            Filter topics by error status. true = only topics with
            recordErrorTotal > 0.
        - name: partial_name
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by topic name (partial match).
            title: Partial Name
          description: Filter by topic name (partial match).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TopicMetricsRes'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - FronteggHTTPAuthentication: []
components:
  schemas:
    TopicMetricsRes:
      properties:
        timeseries:
          anyOf:
            - $ref: '#/components/schemas/TopicTimeseriesMetrics'
            - type: 'null'
        latest:
          anyOf:
            - $ref: '#/components/schemas/TopicLatestMetrics'
            - type: 'null'
      additionalProperties: true
      type: object
      title: TopicMetricsRes
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TopicTimeseriesMetrics:
      properties:
        byteTotal:
          items:
            $ref: '#/components/schemas/TimeseriesEntry'
          type: array
          title: Bytetotal
          default: []
        SnapshotTotalNumberOfEventsSeen:
          items:
            $ref: '#/components/schemas/TimeseriesEntry'
          type: array
          title: Snapshottotalnumberofeventsseen
          default: []
        StreamingTotalNumberOfCreateEventsSeen:
          items:
            $ref: '#/components/schemas/TimeseriesEntry'
          type: array
          title: Streamingtotalnumberofcreateeventsseen
          default: []
        StreamingTotalNumberOfDeleteEventsSeen:
          items:
            $ref: '#/components/schemas/TimeseriesEntry'
          type: array
          title: Streamingtotalnumberofdeleteeventsseen
          default: []
        StreamingTotalNumberOfUpdateEventsSeen:
          items:
            $ref: '#/components/schemas/TimeseriesEntry'
          type: array
          title: Streamingtotalnumberofupdateeventsseen
          default: []
        recordRetryTotal:
          items:
            $ref: '#/components/schemas/TimeseriesEntry'
          type: array
          title: Recordretrytotal
          default: []
        recordSendTotal:
          items:
            $ref: '#/components/schemas/TimeseriesEntry'
          type: array
          title: Recordsendtotal
          default: []
      additionalProperties: true
      type: object
      title: TopicTimeseriesMetrics
    TopicLatestMetrics:
      properties:
        byteTotal:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Bytetotal
        SnapshotTotalNumberOfEventsSeen:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Snapshottotalnumberofeventsseen
        StreamingTotalNumberOfCreateEventsSeen:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Streamingtotalnumberofcreateeventsseen
        StreamingTotalNumberOfDeleteEventsSeen:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Streamingtotalnumberofdeleteeventsseen
        StreamingTotalNumberOfUpdateEventsSeen:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Streamingtotalnumberofupdateeventsseen
        recordRetryTotal:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Recordretrytotal
        recordSendTotal:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Recordsendtotal
      additionalProperties: true
      type: object
      title: TopicLatestMetrics
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    TimeseriesEntry:
      properties:
        value:
          anyOf:
            - type: integer
            - type: number
          title: Value
          description: The metric value at this timestamp
        timestamp:
          type: string
          title: Timestamp
          description: ISO 8601 timestamp for this data point
      additionalProperties: true
      type: object
      required:
        - value
        - timestamp
      title: TimeseriesEntry
      description: A single data point in a time series.
  securitySchemes:
    FronteggHTTPAuthentication:
      type: http
      scheme: bearer

````