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

# List tag keys

> Lists the custom tag keys the project has received, with the number of distinct values per key,
the time series each key is a filter dimension of, and the project's tag limits. Classification
drops a tag whose key is new to the project once the project holds `maxKeys` keys, and a new value
of a key that holds `maxValuesPerKey` values; keys and values the project already holds are kept.
Every key ever received counts toward the limits.

Required API key permission: `observe:catalog:read`.



## OpenAPI

````yaml /api-reference/openapi/observe.yaml get /observe/tagKeys
openapi: 3.1.1
info:
  version: 1.0.0
  title: Corbado API
  description: >
    # Introduction

    This documentation gives an overview of all Corbado API calls to implement
    authentication observe.
  contact:
    name: Corbado team
    email: support@corbado.com
    url: https://www.corbado.com
servers:
  - url: https://api.cloud.corbado.io/v1
security:
  - bearerAuth: []
tags:
  - name: ObserveFlow
    description: Flow search and related APIs
    x-group: Journeys and users
  - name: ObserveSubFlow
    description: Subflow search and related APIs
    x-group: Journeys and users
  - name: ObserveUser
    description: User search and related APIs
    x-group: Journeys and users
  - name: ObserveIdentifier
    description: Identifier search over submitted identifiers
    x-group: Journeys and users
  - name: ObservePasskeyIntelligence
    description: Passkey login predictions and support diagnosis
    x-group: Passkey Intelligence
  - name: ObserveClientEnv
    description: Client environment search APIs
    x-group: Journeys and users
  - name: ObserveTimeSeries
    description: Time series query APIs
    x-group: Metrics and funnels
  - name: ObserveFunnel
    description: Historical funnel metrics, dictionaries and coverage.
    x-group: Metrics and funnels
  - name: ObserveEvent
    description: Event ingestion and event feed APIs
    x-group: Events
  - name: ObserveError
    description: Named authentication errors and recommendations.
    x-group: Error management
  - name: ObserveErrorFlavour
    description: Error variants and their impact on authentication outcomes.
    x-group: Error management
  - name: ObserveErrorCode
    description: The Observe error dictionary (Corbado internal)
  - name: ObserveErrorModel
    description: >-
      The Observe error model, imported as one bundle file per version (Corbado
      internal)
  - name: ObserveFinding
    description: Curated findings that explain errors, their impact and who has to act.
    x-group: Error management
  - name: ObserveAlert
    description: Authentication alert rules, instances and history.
    x-group: Alert management
  - name: ObserveAnnotation
    description: >-
      Annotations, the project's memory (what is true about the data and how to
      read it)
    x-group: Annotations
  - name: ObserveTableExport
    description: Table export file listing and download APIs
    x-group: Data exports
  - name: ObserveTimeSeriesExport
    description: Time-series export generation and downloads.
    x-group: Data exports
  - name: ObserveDataExport
    description: Data export APIs
    x-group: User data
  - name: ObserveDataDeletionJob
    description: Data deletion job APIs
    x-group: User data
  - name: ObserveFlowTypeDefinition
    description: Flow type definitions used in authentication journeys.
    x-group: Catalogs and labels
  - name: ObserveCatalog
    description: Catalog APIs
    x-group: Catalogs and labels
  - name: ObserveSavedFilter
    description: >-
      Saved filters, named flow filters a project stores once and applies by
      reference
    x-group: Saved filters
  - name: OpenAPI
    description: Downloadable API specification
  - name: ProjectOperationExecution
    description: Project-scoped operation history and pipeline health
  - name: ObserveClassification
    description: Flow and subflow classification APIs
  - name: ObserveIntegrationStats
    description: Integration stats APIs
  - name: ObserveTimeSeriesPrecalculation
    description: Time series precalculation APIs
  - name: ObserveIDList
    x-group: Saved ID lists
    description: Stored ID-list selection APIs
  - name: ObserveDataContext
    description: Schema-loose data context APIs for agent and debugging tooling
  - name: ObserveData
    description: Observe data administration APIs
  - name: ObserveTrackingStats
    description: Tracking ingestion stats APIs
  - name: ObserveProbe
    description: Raw probe capture items (internal autocapture diagnostics)
  - name: ObserveTelemetry
    description: Raw SDK/integration diagnostic telemetry
  - name: ObserveExperiment
    x-group: Experiments
    description: Experiment catalog and run APIs
  - name: ObserveDataPolicy
    description: >-
      Project data policy catalogue (retention selected by the SDK's
      meta.dataPolicy code)
  - name: ObserveMetadata
    x-group: Metadata
    description: Authenticator metadata APIs
  - name: ObserveSri
    description: Subresource Integrity hashes of the scripts Corbado hosts for a project
  - name: ObserveAutocapture
    description: >-
      Autocapture builds, candidates and releases, registered by Corbado's
      delivery pipeline
  - name: ObserveNotification
    description: >-
      Who is notified about what happens in a project, e.g. autocapture
      releases, and how it was delivered
  - name: ObservePasskey
    x-group: Passkey analysis
    description: Observed passkey search and cohort analysis.
paths:
  /observe/tagKeys:
    get:
      tags:
        - ObserveCatalog
      summary: List tag keys
      description: >-
        Lists the custom tag keys the project has received, with the number of
        distinct values per key,

        the time series each key is a filter dimension of, and the project's tag
        limits. Classification

        drops a tag whose key is new to the project once the project holds
        `maxKeys` keys, and a new value

        of a key that holds `maxValuesPerKey` values; keys and values the
        project already holds are kept.

        Every key ever received counts toward the limits.


        Required API key permission: `observe:catalog:read`.
      operationId: ObserveTagKeyList
      responses:
        '200':
          description: Tag keys and limits.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observeTagKeyListRsp'
        default:
          $ref: '#/components/responses/error'
      security:
        - bearerAuth:
            - observe:catalog:read
components:
  schemas:
    observeTagKeyListRsp:
      type: object
      required:
        - keys
        - keyCount
        - valueCount
        - limits
        - keyLimitReached
        - valueLimitReached
      properties:
        keys:
          type: array
          description: >-
            The project's tag keys, sorted by key. Tags Corbado sets itself for
            internal use are not listed but

            count toward `keyCount`, `valueCount` and the limits.
          items:
            $ref: '#/components/schemas/observeTagKey'
        keyCount:
          type: integer
          description: The number of distinct tag keys received, counted against `maxKeys`.
        valueCount:
          type: integer
          description: >-
            The number of distinct values received over all keys, counted
            against `maxValues`.
        limits:
          $ref: '#/components/schemas/observeTagLimits'
        keyLimitReached:
          type: boolean
          description: >-
            The project holds `maxKeys` keys or more; tags with a new key are
            dropped.
        valueLimitReached:
          type: boolean
          description: >-
            The project holds `maxValues` values or more over all keys; new
            values are dropped.
    observeTagKey:
      type: object
      required:
        - key
        - valueCount
        - valueLimitReached
        - timeSeries
      properties:
        key:
          type: string
          description: The tag key, exactly as sent.
        valueCount:
          type: integer
          description: The number of distinct values received for the key.
        valueLimitReached:
          type: boolean
          description: >-
            The key holds `maxValuesPerKey` values or more; new values of it are
            dropped.
        timeSeries:
          type: array
          description: The time series the key is a filter dimension of.
          items:
            $ref: '#/components/schemas/observeTagKeyTimeSeries'
    observeTagLimits:
      type: object
      required:
        - maxKeys
        - maxValuesPerKey
        - maxValues
      properties:
        maxKeys:
          type: integer
          description: Maximum number of distinct tag keys.
        maxValuesPerKey:
          type: integer
          description: Maximum number of distinct values per tag key.
        maxValues:
          type: integer
          description: Maximum number of distinct values over all tag keys.
    errorRspV2:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
          properties:
            message:
              description: Error message
              type: string
              example: Validation failed
            details:
              description: Validation error details per field
              type: array
              items:
                type: object
                required:
                  - field
                  - message
                properties:
                  field:
                    description: Field name that failed validation
                    type: string
                    example: projectID
                  message:
                    description: Validation error message
                    type: string
                    example: required
    observeTagKeyTimeSeries:
      type: object
      required:
        - name
        - position
      properties:
        name:
          type: string
          description: Name of the time series, for example `login-flow-v1`.
        position:
          type: integer
          description: >-
            1-based position of the key among the time series' custom tags
            (`customTag<position>`).
  responses:
    error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorRspV2'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Use an Observe API key from the management console. The key selects the
        project and must grant the permission listed on the operation. Keep this
        key on your server.

````

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