> ## Documentation Index > Fetch the complete documentation index at: https://docs.cortex.io/llms.txt > Use this file to discover all available pages before exploring further. # List available engineering metric definitions > Discover all available engineering metrics and their metadata. Use this before querying metrics to understand what data is available and how to query it effectively. ## OpenAPI ````yaml /openapi/cortex_swagger.json get /api/v1/eng-intel/registry/metrics/definitions openapi: 3.0.1 info: description: >- The Cortex REST API provides programmatic access to the data in the catalog, Scorecards, and more. title: Cortex API version: v1 servers: - url: https://api.getcortexapp.com description: Cortex Cloud API host security: - bearerAuth: [] tags: - name: API Keys - name: Audit Logs - name: Catalog Entities - name: Catalogs - name: Custom Data - name: Custom Data [Advanced] - name: Custom Events - name: Custom Metrics - name: Dependencies - name: Deploys - name: Discovery Audit - name: Docs - name: 'Eng Intel: 1-Registry' - name: 'Eng Intel: 2-Metrics' - name: 'Eng Intel: 3-Trace' - name: 'Eng Intel: User Labels' - name: Entity Relationship Types - name: Entity Relationships - name: Entity Types - name: GitOps Logs - name: Groups - name: IP Allowlist - name: Initiatives - name: My Workspace - name: Notification Logs - name: On-call - name: Packages - name: Plugins - name: Queries - name: SCIM - name: Scaffolder - name: Scorecards - name: Secrets - name: Team Roles - name: Teams - name: Teams Hierarchies - name: Teams [Advanced] - name: Teams [Departments] (legacy) - name: Users - name: Verifications - name: Workflows - name: '[Integrations] AWS' - name: '[Integrations] Anthropic' - name: '[Integrations] Apiiro' - name: '[Integrations] ArgoCD' - name: '[Integrations] Azure Active Directory' - name: '[Integrations] Azure Devops' - name: '[Integrations] Azure Resources' - name: '[Integrations] BambooHR' - name: '[Integrations] Bitbucket' - name: '[Integrations] Bugsnag' - name: '[Integrations] Buildkite' - name: '[Integrations] Checkmarx SAST' - name: '[Integrations] CircleCI' - name: '[Integrations] ClickUp' - name: '[Integrations] Codecov' - name: '[Integrations] Coralogix' - name: '[Integrations] Datadog' - name: '[Integrations] Dynatrace' - name: '[Integrations] Firehydrant' - name: '[Integrations] GitHub' - name: '[Integrations] GitLab' - name: '[Integrations] Harness' - name: '[Integrations] Incident.io' - name: '[Integrations] Instana' - name: '[Integrations] Jenkins' - name: '[Integrations] Jira' - name: '[Integrations] Kubernetes' - name: '[Integrations] LaunchDarkly' - name: '[Integrations] Lightstep' - name: '[Integrations] Mend SAST' - name: '[Integrations] Mend SCA' - name: '[Integrations] New Relic' - name: '[Integrations] Okta' - name: '[Integrations] Opsgenie' - name: '[Integrations] PagerDuty' - name: '[Integrations] Prometheus' - name: '[Integrations] Rollbar' - name: '[Integrations] Rootly' - name: '[Integrations] Semgrep' - name: '[Integrations] Sentry' - name: '[Integrations] ServiceNow' - name: '[Integrations] SignalFx' - name: '[Integrations] Snyk' - name: '[Integrations] SonarQube' - name: '[Integrations] SumoLogic' - name: '[Integrations] Veracode' - name: '[Integrations] VictorOps' - name: '[Integrations] Wiz' - name: '[Integrations] Workday' - name: '[Integrations] xMatters' - name: dev-login-controller - name: public-scim-schema-controller paths: /api/v1/eng-intel/registry/metrics/definitions: get: tags: - Eng Intel Metrics summary: List available engineering metric definitions description: >- Discover all available engineering metrics and their metadata. Use this before querying metrics to understand what data is available and how to query it effectively. operationId: listMetricDefinitions parameters: - in: query name: view required: false schema: type: string default: basic - in: query name: key required: false schema: type: array items: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/MetricDefinitionsResponse' description: Successfully retrieved metric definitions '400': content: application/json: schema: oneOf: - $ref: '#/components/schemas/BasicMetricDefinitionsResponse' - $ref: '#/components/schemas/FullMetricDefinitionsResponse' description: Invalid query parameters or filters '403': content: application/json: schema: oneOf: - $ref: '#/components/schemas/BasicMetricDefinitionsResponse' - $ref: '#/components/schemas/FullMetricDefinitionsResponse' description: Forbidden '429': $ref: '#/components/responses/TooManyRequests' components: schemas: MetricDefinitionsResponse: required: - metrics - view type: object properties: metrics: type: array items: $ref: '#/components/schemas/MetricDefinition' view: type: string discriminator: propertyName: view BasicMetricDefinitionsResponse: type: object allOf: - $ref: '#/components/schemas/MetricDefinitionsResponse' - required: - metrics type: object properties: metrics: type: array description: List of available metric definitions with basic metadata items: $ref: '#/components/schemas/BasicMetricDefinition' - $ref: '#/components/schemas/MetricDefinitionsResponseObject' FullMetricDefinitionsResponse: type: object allOf: - $ref: '#/components/schemas/MetricDefinitionsResponse' - required: - metrics - sources type: object properties: metrics: type: array description: List of available metric definitions with full metadata items: $ref: '#/components/schemas/FullMetricDefinition' sources: type: object additionalProperties: $ref: '#/components/schemas/Source' description: Map of source names to source metadata for query construction - $ref: '#/components/schemas/MetricDefinitionsResponseObject' MetricDefinition: required: - displayName - key - readiness type: object properties: description: type: string displayName: type: string key: type: string readiness: oneOf: - $ref: '#/components/schemas/NotReady' - $ref: '#/components/schemas/Ready' BasicMetricDefinition: required: - displayName - key - readiness type: object properties: description: type: string description: Description of what this metric measures displayName: type: string description: Human-readable name key: type: string description: Unique identifier for the metric (used in queries) readiness: oneOf: - $ref: '#/components/schemas/NotReady' - $ref: '#/components/schemas/Ready' description: List of available metric definitions with basic metadata MetricDefinitionsResponseObject: required: - metrics - view type: object properties: metrics: type: array items: type: object view: type: string discriminator: propertyName: view FullMetricDefinition: required: - displayName - key - readiness type: object properties: description: type: string description: Description of what this metric measures displayName: type: string description: Human-readable name key: type: string description: Unique identifier for the metric (used in queries) orderByAttribute: type: string description: The attribute used for ordering/sorting metric results readiness: oneOf: - $ref: '#/components/schemas/NotReady' - $ref: '#/components/schemas/Ready' sourceRef: type: string description: >- Reference to the data source in the sources map - indicates which integration provides this metric supportedAggregations: type: array description: >- Available aggregation functions for this metric (e.g., SUM, AVG, COUNT) items: type: string description: Type of aggregation function applied to the attribute enum: - SUM - AVG - COUNT - RATIO - MIN - MAX - P50 - P95 - RANKING - COLLECT - COLLECT_UNIQUE - COUNT_UNIQUE timeAttribute: $ref: '#/components/schemas/Attribute' type: type: string description: >- Type of metric: COUNT (discrete values), DURATION (time-based), RATIO/RATE (percentages), VALUE (continuous) enum: - DURATION - COUNT - VALUE - RATE units: type: string description: Units of measurement (e.g., 'seconds', 'count', 'percentage') valence: type: string description: >- Whether higher values are better (POSITIVE) or worse (NEGATIVE) for this metric enum: - POSITIVE - NEGATIVE - NEUTRAL description: List of available metric definitions with full metadata Source: required: - attributes - category - description - dimensions - filterOptions - groupByOptions - name type: object properties: attributes: type: array description: Queryable fields available directly on this source items: $ref: '#/components/schemas/Attribute' category: type: string description: >- Category this source belongs to (e.g. 'Version Control', 'CI-CD') -- the axis the product groups metrics by in its selector description: type: string description: Human-readable description of what data this source provides dimensions: type: array description: Related entities that can be joined for additional context items: $ref: '#/components/schemas/Dimension' filterOptions: type: array description: Available filtering options for querying metrics items: $ref: '#/components/schemas/FilterOption' groupByOptions: type: array description: Available grouping options for aggregating metrics items: $ref: '#/components/schemas/GroupByOption' name: type: string description: Unique identifier for the source description: Map of source names to source metadata for query construction TooManyRequestsProblemDetail: required: - type - title - status type: object properties: detail: type: string instance: type: string format: uri-reference retryAfter: minimum: 0 type: integer description: The number of seconds until the rate limiting resets. format: int32 status: maximum: 599 minimum: 100 type: integer format: int32 enum: - 429 title: type: string type: type: string format: uri-reference NotReady: type: object allOf: - $ref: '#/components/schemas/Readiness' - type: object properties: docsUrl: type: string hint: type: string providerDocsUrls: type: array items: $ref: '#/components/schemas/ProviderDocLink' Ready: type: object allOf: - $ref: '#/components/schemas/Readiness' Attribute: required: - name - type type: object properties: description: type: string description: Human-readable description of what this field contains name: type: string description: Field name for use in queries type: type: string description: Type of the produced cell rather than of the underlying attribute enum: - STRING - BOOLEAN - INTEGER - DECIMAL - DOUBLE - DATE - TREE - DATETIME - JSON - ARRAY - ENUM - UNSUPPORTED description: Queryable fields available on this dimension Dimension: required: - attributes - description - dimensionKey - displayName - name type: object properties: attributes: type: array description: Queryable fields available on this dimension items: $ref: '#/components/schemas/Attribute' description: type: string description: Description of the relationship this dimension represents dimensionKey: type: string description: Unprefixed base name identifying the dimension type across sources displayName: type: string description: >- Human-readable role of this dimension in the source context (e.g., Author, Reviewer) name: type: string description: Dimension identifier for use in queries description: Related entities that can be joined for additional context FilterOption: required: - displayName - filter - key type: object properties: canonicalName: type: string description: >- Canonical dimension name before source-specific overrides (e.g. 'User' instead of 'Author') dimensionRole: type: string description: >- Role of this dimension in the source context (e.g. 'Authors', 'Reviewers', 'Assignees') dimensionRoleGroup: type: string description: >- Optional grouping key for dimensions that share a canonical concept across roles (e.g. 'User' groups Author / Reviewer / Assignee) displayName: type: string description: Human-readable label for this filter filter: type: string description: Specific attribute to filter on key: type: string description: Field key to reference in queries description: Available filtering options for querying metrics GroupByOption: required: - displayName - key type: object properties: canonicalName: type: string description: >- Canonical dimension name before source-specific overrides (e.g. 'User' instead of 'Author') dimensionRole: type: string description: >- Role of this dimension in the source context (e.g. 'Authors', 'Reviewers', 'Assignees') dimensionRoleGroup: type: string description: >- Optional grouping key for dimensions that share a canonical concept across roles (e.g. 'User' groups Author / Reviewer / Assignee) displayName: type: string description: Human-readable label for this grouping key: type: string description: Field key to use in GROUP BY clause description: Available grouping options for aggregating metrics Readiness: required: - type type: object properties: type: type: string description: >- Whether this metric is ready to use - includes hints if configuration is needed discriminator: propertyName: type ProviderDocLink: required: - provider - url type: object properties: provider: type: string url: type: string responses: TooManyRequests: content: application/problem+json: schema: $ref: '#/components/schemas/TooManyRequestsProblemDetail' description: >- The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay. headers: Retry-After: description: The number of seconds until the rate limiting resets. schema: minimum: 0 type: integer format: int32 securitySchemes: bearerAuth: bearerFormat: JWT description: >- All requests to the Cortex API need to provide an `Authorization: Bearer ` header, where `` is an API key created in the Settings page of your workspace. scheme: bearer type: http ```` ## Related topics - [Eng Intelligence: Metrics](/api/rest/eng-intel-metrics.md) - [Using the integration for Slack](/ingesting-data-into-cortex/integrations/slack/using-the-integration-for-slack-ai-assistant.md) - [Using the Cortex MCP](/get-started/cortex-ai-assistant/mcp/using-cortex-mcp.md)