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

# List E2Ms

> Returns all events-to-metrics rules for the team.



## OpenAPI

````yaml openapi_v5.yaml get /events2metrics/events2metrics/v2
openapi: 3.0.0
info:
  title: ''
  version: 1.0.0
servers:
  - url: https://api.coralogix.com/mgmt/openapi/5
  - url: https://api.eu2.coralogix.com/mgmt/openapi/5
  - url: https://api.coralogix.us/mgmt/openapi/5
  - url: https://api.cx498.coralogix.com/mgmt/openapi/5
  - url: https://api.coralogix.in/mgmt/openapi/5
  - url: https://api.coralogixsg.com/mgmt/openapi/5
  - url: https://api.ap3.coralogix.com/mgmt/openapi/5
security:
  - apiKeyAuth: []
tags:
  - name: AI Applications Service
    description: Manage the catalog of AI applications discovered from spans.
    externalDocs:
      url: ''
  - name: AI Evaluations Service
    description: >-
      Manage AI evaluations and the custom evaluation catalog for AI
      applications.
    externalDocs:
      url: ''
  - name: API Keys Admin Service
    description: Administrative operations for API Keys management.
    externalDocs:
      url: ''
  - name: API Keys Service
    description: Manage your API Keys.
    externalDocs:
      url: ''
  - name: Actions Service
    description: View and manage your Actions.
    externalDocs:
      url: ''
  - name: Alert Scheduler Rule service
    description: Manage your alert scheduler rules.
    externalDocs:
      url: ''
  - name: Alert definitions service
    description: >-
      View and manage your alerts using alert definitions - data structures that
      contain the configuration required to create an alert.
    externalDocs:
      description: Learn more about alerts in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/
  - name: Alert events service
    description: >-
      Get information regarding your alert events - instances of alerts being
      triggered.
    externalDocs:
      description: Learn more about alert events and incidents in our documentation.
      url: https://coralogix.com/docs/user-guides/alerting/incidents/
  - name: Case Events service
    description: Manage case events, comments, and external thread synchronization.
    externalDocs:
      url: ''
  - name: Case Settings service
    description: Manage case settings team configurations.
    externalDocs:
      url: ''
  - name: Cases notification service
    description: Track notification adjacent data for cases.
    externalDocs:
      url: ''
  - name: Cases service
    description: >-
      Manage cases throughout their lifecycle. Create, view, assign,
      acknowledge, unacknowledge, resolve, and close cases to streamline
      investigations and follow-ups.
    externalDocs:
      description: Learn more about Cases in our documentation
      url: https://coralogix.com/docs/user-guides/cases/
  - name: Connector Schema service
    description: Retrieve connector schemas for notification center integrations
    externalDocs:
      description: Learn more about connectors in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/
  - name: Connectors service
    description: >-
      View and manage your connectors - integration instances for notification
      destinations
    externalDocs:
      description: Lean more about connectors in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/
  - name: Contextual data integration service
    description: Query for contextual data integration information.
    externalDocs:
      url: ''
  - name: Custom Enrichments Service
    description: Manage your enrichments.
    externalDocs:
      url: ''
  - name: Dashboard folders service
    description: Manage your dashboard folders.
    externalDocs:
      url: ''
  - name: Dashboard service
    description: Get information about the Coralogix Dashboard catalog.
    externalDocs:
      url: ''
  - name: Data Usage Query service
    description: >-
      Query billable data usage through the public Coralogix API using daily or
      hourly bucketed aggregations over supported labels.
    externalDocs:
      url: ''
  - name: Data Usage Service
    description: A service to manage data usage metrics.
    externalDocs:
      url: ''
  - name: Enrichments Service
    description: Manage your enrichments.
    externalDocs:
      url: ''
  - name: Entities service
    description: Query information about registered entities in the notification center
    externalDocs:
      description: Lean more about the notification center in our documentation
      url: https://coralogix.com/docs/user-guides/notification-center/introduction/
  - name: Events Service
    description: A service for querying events.
    externalDocs:
      description: Learn more about alerts in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/
  - name: Events2Metrics Service
    description: Manage your events2metrics.
    externalDocs:
      url: ''
  - name: Extension deployment service
    description: A service that enables querying for extension deployment information.
    externalDocs:
      description: Find out more about extensions in our documentation.
      url: https://coralogix.com/docs/integrations/extensions/
  - name: Extension service
    description: A service that enables querying for extension information.
    externalDocs:
      description: Learn more about extensions in our documentation.
      url: https://coralogix.com/docs/integrations/extensions/
  - name: Folders for views service
    description: Create and manage view folders.
    externalDocs:
      url: ''
  - name: Global routers service
    description: >-
      View and manage your global routers - entities that direct notifications
      to configured destinations based on conditions
    externalDocs:
      description: Lean more about global routers in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/routing/introduction/
  - name: IP access service
    description: >-
      IP access service provides the API for managing company IP access
      settings.
    externalDocs:
      url: ''
  - name: Incidents service
    description: >-
      Handle all operations related to incident management within Coralogix.
      Identify, manage, and resolve incidents efficiently through automated
      workflows and team collaboration.
    externalDocs:
      description: Find out more about incident management in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/incidents/
  - name: Integration service
    description: A service that enables querying for integration information.
    externalDocs:
      description: Find out more about integrations in our documentation.
      url: https://coralogix.com/docs/integrations/getting-started/
  - name: Metrics Data Archive Service
    description: View and manage your storage targets for metrics.
    externalDocs:
      description: Find out more about archives
      url: >-
        https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/
  - name: Notifications testing service
    description: >-
      Test your notification center configurations including connectors,
      presets, and templates
    externalDocs:
      description: Lean more about the notification center in our documentation
      url: https://coralogix.com/docs/user-guides/notification-center/introduction/
  - name: Outgoing webhooks service
    externalDocs:
      description: Find out more about outbound webhooks in our documentation.
      url: >-
        https://coralogix.com/docs/user-guides/alerting/outbound-webhooks/generic-outbound-webhooks-alert-webhooks/
  - name: Policies Service
    description: View and manage your TCO policies
    externalDocs:
      url: ''
  - name: Presets service
    description: >-
      View and manage your presets - pre-configured templates for notification
      content rendering
    externalDocs:
      description: Lean more about presets in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/presets/introduction/
  - name: Quota Allocation Rule Set service
    description: Manage quota allocation rules for different entity types.
    externalDocs:
      url: ''
  - name: Recording Rules Service
    description: A service to manage recording rules.
    externalDocs:
      url: ''
  - name: Retentions Service
    description: View and manage retentions
    externalDocs:
      url: ''
  - name: Role Management Service
    description: Service for managing system and custom roles.
    externalDocs:
      url: ''
  - name: Rule Groups Service
    description: A service to manage rule groups.
    externalDocs:
      url: ''
  - name: SAML Configuration Service
    description: Manage your SAML configuration
    externalDocs:
      url: ''
  - name: Scopes Service
    description: A service to manage scopes
    externalDocs:
      url: ''
  - name: Slos Service
    description: A service for managing Service Level Objectives (SLOs).
    externalDocs:
      url: ''
  - name: Target Service
    description: View and manage your storage targets for logs.
    externalDocs:
      description: Find out more about archives
      url: >-
        https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/
  - name: Team Groups Management Service
    description: Manage Team Groups.
    externalDocs:
      url: ''
  - name: Users Management Service
    description: >-
      Manage team members (users) including creation, updates, search, and
      status management.
    externalDocs:
      url: ''
  - name: Views service
    description: Create and manage views.
    externalDocs:
      url: ''
paths:
  /events2metrics/events2metrics/v2:
    get:
      tags:
        - Events2Metrics Service
      summary: List E2Ms
      description: Returns all events-to-metrics rules for the team.
      operationId: Events2MetricService_ListE2M
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListE2MResponse'
          description: ''
      externalDocs:
        url: ''
components:
  schemas:
    ListE2MResponse:
      title: List E2M Response
      required:
        - e2m
      type: object
      properties:
        e2m:
          maxItems: 10000
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/E2M'
          description: The e2m.
      description: >-
        This is the response obtained when listing all event to metric
        definitions
      externalDocs:
        description: Find out more about events2metrics
        url: >-
          https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/
    E2M:
      title: E2M
      required:
        - name
        - type
      type: object
      oneOf:
        - required:
            - spansQuery
          type: object
        - required:
            - logsQuery
          type: object
        - type: object
          not:
            anyOf:
              - required:
                  - spansQuery
                type: object
              - required:
                  - logsQuery
                type: object
      properties:
        createTime:
          minLength: 0
          type: string
          description: RFC3339 timestamp of when this E2M was created.
          example: '2022-06-30T12:30:00.000Z'
        dataSource:
          maxLength: 300
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          description: >-
            Optional data source in namespace/dataset_name format. If not set,
            defaults to the standard logs/spans stream.
          example: my_namespace/my_dataset
        description:
          maxLength: 2000
          minLength: 0
          pattern: ^[\s\S]*$
          type: string
          description: Human-readable description of this E2M.
          example: avg and max the latency of catalog service
        id:
          maxLength: 36
          minLength: 36
          pattern: >-
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          type: string
          description: Unique identifier for this E2M. Required on update requests.
          example: d6a3658e-78d2-47d0-9b81-b2c551f01b09
        isInternal:
          type: boolean
          description: Indicates whether this E2M is for internal use only.
        logsQuery:
          $ref: '#/components/schemas/v2.LogsQuery'
        metricFields:
          maxItems: 10
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/v2.MetricField'
          description: Metric fields to extract and aggregate from the events.
        metricLabels:
          maxItems: 10
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/MetricLabel'
          description: Metric labels to attach to the generated metrics.
        name:
          maxLength: 255
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          description: Human-readable name for this E2M.
          example: Service_catalog_latency
        permutations:
          $ref: '#/components/schemas/E2MPermutations'
        spansQuery:
          $ref: '#/components/schemas/v2.SpansQuery'
        type:
          $ref: '#/components/schemas/E2MType'
        updateTime:
          minLength: 0
          type: string
          description: RFC3339 timestamp of when this E2M was last updated.
          example: '2022-06-30T12:30:00.000Z'
      description: This data structure represents an Event to Metrics (E2M) object.
      externalDocs:
        description: Find out more about events2metrics
        url: >-
          https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/
    v2.LogsQuery:
      title: SpansQuery
      type: object
      properties:
        alias:
          maxLength: 255
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          description: The alias.
          example: new_query
        applicationnameFilters:
          maxItems: 1000
          minItems: 0
          type: array
          items:
            maxLength: 4096
            minLength: 0
            pattern: ^[\s\S]*$
            type: string
            description: The applicationname filters.
            example: app_name
          description: The applicationname filters.
        lucene:
          maxLength: 10000
          minLength: 0
          pattern: ^[\s\S]*$
          type: string
          description: The lucene.
          example: 'log_obj.numeric_field: [50 TO 100]'
        severityFilters:
          maxItems: 7
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/logs2metrics.v2.Severity'
          description: The severity filters.
        subsystemnameFilters:
          maxItems: 1000
          minItems: 0
          type: array
          items:
            maxLength: 4096
            minLength: 0
            pattern: ^[\s\S]*$
            type: string
            description: The subsystemname filters.
            example: sub_name
          description: The subsystemname filters.
      description: This data structure represents a query for logs.
      externalDocs:
        description: Find out more about events2metrics
        url: >-
          https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/
    v2.MetricField:
      title: Metric Field
      required:
        - targetBaseMetricName
        - sourceField
        - aggregations
      type: object
      properties:
        aggregations:
          maxItems: 7
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/v2.Aggregation'
          description: The aggregations.
        sourceField:
          maxLength: 255
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          description: The source field.
          example: log_obj.numeric_field
        targetBaseMetricName:
          maxLength: 255
          minLength: 1
          pattern: ^[\w/-]+$
          type: string
          description: The target base metric name.
          example: alias_field_name
      description: This data structure represents a metric field
      externalDocs:
        description: Find out more about events2metrics
        url: >-
          https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/
    MetricLabel:
      title: Metric Label
      required:
        - targetLabel
        - sourceField
      type: object
      properties:
        sourceField:
          maxLength: 255
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          description: The source field.
          example: log_obj.string_value
        targetLabel:
          maxLength: 255
          minLength: 1
          pattern: ^[\w/-]+$
          type: string
          description: The target label.
          example: alias_label_name
      description: This data structure represents a metric label
      externalDocs:
        description: Find out more about events2metrics
        url: >-
          https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/
    E2MPermutations:
      title: E2M Permutations
      required:
        - limit
        - hasExceededLimit
      type: object
      properties:
        hasExceededLimit:
          type: boolean
          description: The has exceeded limit.
        limit:
          maximum: 10000000
          minimum: 1
          type: integer
          description: Limit.
          format: int32
          example: 30000
      description: >-
        This data structure represents the limit of events2metrics permutations
        and if the limit was exceeded
      externalDocs:
        description: Find out more about events2metrics
        url: >-
          https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/
    v2.SpansQuery:
      title: SpansQuery
      type: object
      properties:
        actionFilters:
          maxItems: 1000
          minItems: 0
          type: array
          items:
            maxLength: 4096
            minLength: 0
            pattern: ^[\s\S]*$
            type: string
            description: The action filters.
            example: myAction
          description: The action filters.
        applicationnameFilters:
          maxItems: 1000
          minItems: 0
          type: array
          items:
            maxLength: 4096
            minLength: 0
            pattern: ^[\s\S]*$
            type: string
            description: The applicationname filters.
            example: myApp
          description: The applicationname filters.
        lucene:
          maxLength: 10000
          minLength: 0
          pattern: ^[\s\S]*$
          type: string
          description: The lucene.
          example: applicationName:myApp
        serviceFilters:
          maxItems: 1000
          minItems: 0
          type: array
          items:
            maxLength: 4096
            minLength: 0
            pattern: ^[\s\S]*$
            type: string
            description: The service filters.
            example: myService
          description: The service filters.
        subsystemnameFilters:
          maxItems: 1000
          minItems: 0
          type: array
          items:
            maxLength: 4096
            minLength: 0
            pattern: ^[\s\S]*$
            type: string
            description: The subsystemname filters.
            example: mySubsystem
          description: The subsystemname filters.
      description: This data structure represents a query for spans.
      externalDocs:
        description: Find out more about events2metrics
        url: >-
          https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/
    E2MType:
      enum:
        - E2M_TYPE_UNSPECIFIED
        - E2M_TYPE_LOGS2METRICS
        - E2M_TYPE_SPANS2METRICS
      type: string
      description: E2 m type.
    logs2metrics.v2.Severity:
      enum:
        - SEVERITY_UNSPECIFIED
        - SEVERITY_DEBUG
        - SEVERITY_VERBOSE
        - SEVERITY_INFO
        - SEVERITY_WARNING
        - SEVERITY_ERROR
        - SEVERITY_CRITICAL
      type: string
      description: Severity.
    v2.Aggregation:
      title: Aggregation
      type: object
      oneOf:
        - required:
            - none
          type: object
        - required:
            - samples
          type: object
        - required:
            - histogram
          type: object
        - type: object
          not:
            anyOf:
              - required:
                  - none
                type: object
              - required:
                  - samples
                type: object
              - required:
                  - histogram
                type: object
      properties:
        aggType:
          $ref: '#/components/schemas/AggType'
        enabled:
          type: boolean
          description: Whether this resource is enabled.
        histogram:
          $ref: '#/components/schemas/E2MAggHistogram'
        none:
          type: object
          description: >-
            Marker indicating no additional metadata is needed for this
            aggregation type.
        samples:
          $ref: '#/components/schemas/E2MAggSamples'
        targetMetricName:
          maxLength: 255
          minLength: 1
          pattern: ^[\s\S]*$
          type: string
          description: Name of the target metric produced by this aggregation.
          example: alias_field_name_agg_func
      description: This data structure represents an aggregation
      externalDocs:
        description: Find out more about events2metrics
        url: >-
          https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/
    AggType:
      enum:
        - AGG_TYPE_UNSPECIFIED
        - AGG_TYPE_MIN
        - AGG_TYPE_MAX
        - AGG_TYPE_COUNT
        - AGG_TYPE_AVG
        - AGG_TYPE_SUM
        - AGG_TYPE_HISTOGRAM
        - AGG_TYPE_SAMPLES
      type: string
      description: Agg type.
    E2MAggHistogram:
      title: E2M Aggregate Histogram
      type: object
      properties:
        buckets:
          maxItems: 64
          minItems: 0
          type: array
          items:
            type: number
            description: The buckets.
            format: float
            example: 2
          description: The buckets.
      description: This data structure represents the e2m aggregate histogram
      externalDocs:
        description: Find out more about events2metrics
        url: >-
          https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/
    E2MAggSamples:
      title: E2M Aggregate Samples
      type: object
      properties:
        sampleType:
          $ref: '#/components/schemas/SampleType'
      description: This data structure represents the e2m aggregate samples
      externalDocs:
        description: Find out more about events2metrics
        url: >-
          https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/
    SampleType:
      enum:
        - SAMPLE_TYPE_UNSPECIFIED
        - SAMPLE_TYPE_MIN
        - SAMPLE_TYPE_MAX
      type: string
      description: Sample type.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication

````