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

# Read metric points

> Returns the workspace's recent OpenTelemetry metric points in a time window, newest first, across gauges, sums, histograms, and summaries. Gauge and sum points carry a `value`; histogram and summary points carry `count` and `sum` instead.



## OpenAPI

````yaml /api-reference/openapi.json post /telemetry/metrics/search
openapi: 3.1.0
info:
  description: >-
    Manage a Superlog workspace's automations, runs, tag mode, model access, and
    secrets, read its telemetry, build dashboards and alerts over it, run
    synthetic checks, and export them to Terraform. Every request acts as the
    member who created the API key.
  title: Superlog management API
  version: 1.0.0
servers:
  - url: https://superlog.sh/api/v1
security:
  - bearerAuth: []
tags:
  - description: Connected integrations and the IDs automations and tag mode use.
    name: Integrations
  - description: The workspace and its members.
    name: Workspace
  - description: Keys that authenticate the management API and MCP server.
    name: API keys
  - description: Create and change automations.
    name: Automations
  - description: Start, follow, and cancel automation runs.
    name: Runs
  - description: What Superlog can use and change when someone mentions it in Slack.
    name: Tag mode
  - description: Model API keys, subscriptions, and available models.
    name: Models
  - description: Credentials agents can use without seeing them.
    name: Secrets
  - description: Read the workspace's logs, traces, and metrics.
    name: Telemetry
  - description: >-
      Exceptions in the workspace's telemetry, grouped into issues by
      fingerprint.
    name: Errors
  - description: Create and change dashboards over the workspace's telemetry.
    name: Dashboards
  - description: Threshold alerts on the workspace's telemetry that post to Slack.
    name: Alerts
  - description: HTTP checks that request a URL on a schedule and post failures to Slack.
    name: Synthetics
  - description: Configuration for the superloglabs/superlog Terraform provider.
    name: Terraform
paths:
  /telemetry/metrics/search:
    post:
      tags:
        - Telemetry
      summary: Read metric points
      description: >-
        Returns the workspace's recent OpenTelemetry metric points in a time
        window, newest first, across gauges, sums, histograms, and summaries.
        Gauge and sum points carry a `value`; histogram and summary points carry
        `count` and `sum` instead.
      operationId: query_metrics
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                range:
                  default: 1h
                  description: How far back from now to read, when `since` is not given.
                  type: string
                  enum:
                    - 15m
                    - 1h
                    - 6h
                    - 24h
                    - 7d
                since:
                  description: Start of the window. Overrides `range`.
                  type: string
                  format: date-time
                until:
                  description: >-
                    End of the window. Defaults to now. Windows are at most 30
                    days.
                  type: string
                  format: date-time
                limit:
                  default: 100
                  description: Most rows to return.
                  type: integer
                  minimum: 1
                  maximum: 500
                name:
                  description: Only this metric.
                  type: string
                  minLength: 1
                  maxLength: 500
                resourceAttributes:
                  description: >-
                    Filters on resource attributes of the service that sent the
                    data, such as `deployment.environment`.
                  maxItems: 20
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                        minLength: 1
                        maxLength: 200
                      value:
                        type: string
                        maxLength: 500
                      op:
                        description: Defaults to `eq`.
                        type: string
                        enum:
                          - eq
                          - neq
                          - not_contains
                    required:
                      - key
                      - value
                service:
                  description: Only this `service.name`.
                  type: string
                  minLength: 1
                  maxLength: 200
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  points:
                    type: array
                    items:
                      type: object
                      properties:
                        aggregationTemporality:
                          anyOf:
                            - type: number
                            - type: 'null'
                        attributes:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type: string
                          description: The point's dimensions, such as route or status.
                        count:
                          anyOf:
                            - type: number
                            - type: 'null'
                          description: Observations, for histograms and summaries.
                        isMonotonic:
                          anyOf:
                            - type: boolean
                            - type: 'null'
                        kind:
                          type: string
                          enum:
                            - gauge
                            - sum
                            - histogram
                            - exponential_histogram
                            - summary
                        max:
                          anyOf:
                            - type: number
                            - type: 'null'
                        min:
                          anyOf:
                            - type: number
                            - type: 'null'
                        name:
                          type: string
                        resourceAttributes:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type: string
                        service:
                          type: string
                        startTime:
                          type: string
                          description: UTC.
                        sum:
                          anyOf:
                            - type: number
                            - type: 'null'
                          description: Sum of observations, for histograms and summaries.
                        timestamp:
                          type: string
                          description: UTC.
                        unit:
                          type: string
                        value:
                          anyOf:
                            - type: number
                            - type: 'null'
                          description: The value of a gauge or sum point.
                      required:
                        - aggregationTemporality
                        - attributes
                        - count
                        - isMonotonic
                        - kind
                        - max
                        - min
                        - name
                        - resourceAttributes
                        - service
                        - startTime
                        - sum
                        - timestamp
                        - unit
                        - value
                      additionalProperties: false
                  since:
                    type: string
                  until:
                    type: string
                required:
                  - points
                  - since
                  - until
                additionalProperties: false
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: The request is invalid. `issues` lists each invalid field.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: The API key is missing, revoked, or its creator left the workspace.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            The resource does not exist in this workspace, or the feature it
            belongs to is not enabled.
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          description: A stable machine-readable error code, when there is one.
          type: string
        error:
          type: string
          description: What went wrong.
        issues:
          description: Validation problems, one per invalid field.
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
            required:
              - message
              - path
            additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      description: A workspace API key, created in Superlog under Settings → API keys.
      scheme: bearer
      type: http

````

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