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

# List custom metrics the current organisation has access to

> Lists the custom metrics granted by the organisation's plan, ordered for dashboard display.



## OpenAPI

````yaml https://api.mentionlab.io/api/docs-json get /api/analytics/custom-metrics
openapi: 3.0.0
info:
  title: MentionLab Public API v0.5.8-rc
  description: ''
  version: 0.5.8-rc
  contact: {}
servers:
  - url: https://api.mentionlab.io
security: []
tags: []
paths:
  /api/analytics/custom-metrics:
    get:
      tags:
        - Analytics - Custom Metrics
      summary: List custom metrics the current organisation has access to
      description: >-
        Lists the custom metrics granted by the organisation's plan, ordered for
        dashboard display.
      operationId: CustomMetricsController_list
      parameters:
        - name: x-project-id
          in: header
          description: Project ID to specify the project context
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomMetricsResponse'
        '400':
          description: >-
            The request failed validation — the body, query or path parameters
            are malformed or out of range.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: The request is missing valid authentication credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: >-
            The authenticated principal lacks the required permission, or access
            to the requested organisation/project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
components:
  schemas:
    ListCustomMetricsResponse:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/MetricInfoResponse'
      required:
        - metrics
    ApiErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code of the error.
          example: 400
        message:
          type: string
          description: >-
            Human-readable description of the error. Validation failures return
            an array of per-field validation errors instead of a single string.
          example: Validation failed
        error:
          type: string
          description: Short name of the HTTP error.
          example: Bad Request
      required:
        - statusCode
    MetricInfoResponse:
      type: object
      properties:
        id:
          type: string
        displayName:
          type: string
        shape:
          type: string
          enum:
            - table
            - timeseries
        slot:
          type: string
          description: >-
            Slot on a host page where this metric should be rendered. e.g.
            "overview.bottom".
      required:
        - id
        - displayName
        - shape
        - slot

````