Coveo Usage Analytics Read API — Dimensions API - Version 15

naftiko: 1.0.0-alpha2
info:
  label: Coveo Usage Analytics Read API — Dimensions API - Version 15
  description: 'Coveo Usage Analytics Read API — Dimensions API - Version 15. 15 operations. Lead operation: Get All the Dimensions.
    Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Usage Analytics Read
  - Dimensions API - Version 15
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: usage-analytics-read-dimensions-api-version-15
    baseUri: https://analytics.cloud.coveo.com/rest/ua
    description: Coveo Usage Analytics Read API — Dimensions API - Version 15 business capability. Self-contained, no shared
      references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: v15-dimensions
      path: /v15/dimensions
      operations:
      - name: getv15dimensions
        method: GET
        description: Get All the Dimensions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: includeOnlyParents
          in: query
          type: boolean
          description: This will filter out dimensions which are covered by others. Only parent/master dimensions will be
            output
        - name: includeCustom
          in: query
          type: boolean
          description: Whether to include custom dimensions within the results.
    - name: v15-dimensions-custom
      path: /v15/dimensions/custom
      operations:
      - name: getv15dimensionscustom
        method: GET
        description: Get All the Custom Dimensions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: includeOnlyParents
          in: query
          type: boolean
          description: This will filter out dimensions which are covered by others. Only parent/master dimensions will be
            output
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
      - name: postv15dimensionscustom
        method: POST
        description: Create a Custom Dimension
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: name
          in: query
          type: string
          description: The name of the custom dimension. It should start with the 'c_' prefix. If not present, the prefix
            will be added automatically.
        - name: event
          in: query
          type: array
          description: The types of event where this dimension will be added.
          required: true
        - name: updatePastEvents
          in: query
          type: boolean
          description: Whether to update the custom dimension in past events.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v15-dimensions-custom-monitoring-health
      path: /v15/dimensions/custom/monitoring/health
      operations:
      - name: getv15dimensionscustommonitoringhealth
        method: GET
        description: Health Check for the Custom Dimensions Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v15-dimensions-custom-status
      path: /v15/dimensions/custom/status
      operations:
      - name: getv15dimensionscustomstatus
        method: GET
        description: Get the Custom Dimensions Service Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v15-dimensions-custom-apiName
      path: /v15/dimensions/custom/{apiName}
      operations:
      - name: getv15dimensionscustomapiname
        method: GET
        description: Get a Custom Dimension
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: apiName
          in: path
          type: string
          description: Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
          required: true
      - name: putv15dimensionscustomapiname
        method: PUT
        description: Create or Edit a Custom Dimension
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: apiName
          in: path
          type: string
          description: Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
          required: true
        - name: updatePastEvents
          in: query
          type: boolean
          description: Whether to update the custom dimension in past events.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletev15dimensionscustomapiname
        method: DELETE
        description: Delete a Custom Dimension
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: apiName
          in: path
          type: string
          description: Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
          required: true
    - name: v15-dimensions-custom-dimension-values
      path: /v15/dimensions/custom/{dimension}/values
      operations:
      - name: getv15dimensionscustomdimensionvalues
        method: GET
        description: Get the Values for a Custom Dimension
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: from
          in: query
          type: string
          description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: to
          in: query
          type: string
          description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: tz
          in: query
          type: string
          description: Timezone used for calculations.
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: dimension
          in: path
          type: string
          description: The dimensions to fetch.
          required: true
        - name: f
          in: query
          type: array
          description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with
            the AND operator.
        - name: p
          in: query
          type: integer
          description: The response's page to access, starting at 1.
        - name: n
          in: query
          type: integer
          description: The number of results to include in a page.
    - name: v15-dimensions-custom-event-suggestions
      path: /v15/dimensions/custom/{event}/suggestions
      operations:
      - name: getv15dimensionscustomeventsuggestions
        method: GET
        description: Get a List of Dimensions That Have Data but Are Not Created Yet
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: from
          in: query
          type: string
          description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
        - name: to
          in: query
          type: string
          description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
        - name: event
          in: path
          type: string
          description: The type of event for which to look for suggestions.
          required: true
        - name: includeValueSamples
          in: query
          type: boolean
          description: Whether value samples should be included in the response.
        - name: depth
          in: query
          type: integer
          description: The number of events to look at when getting suggestions. A larger depth means more suggestions but
            also slower performance.
    - name: v15-dimensions-exportables
      path: /v15/dimensions/exportables
      operations:
      - name: getv15dimensionsexportables
        method: GET
        description: Get All the Exportable Dimensions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: includeOnlyParents
          in: query
          type: boolean
          description: This will filter out dimensions which are covered by others. Only parent/master dimensions will be
            output
        - name: includeCustom
          in: query
          type: boolean
          description: Whether to include custom dimensions within the results.
    - name: v15-dimensions-monitoring-health
      path: /v15/dimensions/monitoring/health
      operations:
      - name: getv15dimensionsmonitoringhealth
        method: GET
        description: Health Check for the Dimensions Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v15-dimensions-status
      path: /v15/dimensions/status
      operations:
      - name: getv15dimensionsstatus
        method: GET
        description: Get the Dimensions Service Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v15-dimensions-apiName
      path: /v15/dimensions/{apiName}
      operations:
      - name: getv15dimensionsapiname
        method: GET
        description: Get a Dimension
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: apiName
          in: path
          type: string
          description: Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension.
          required: true
    - name: v15-dimensions-dimension-values
      path: /v15/dimensions/{dimension}/values
      operations:
      - name: getv15dimensionsdimensionvalues
        method: GET
        description: Get the Values for a Dimension
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: from
          in: query
          type: string
          description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: to
          in: query
          type: string
          description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'
          required: true
        - name: tz
          in: query
          type: string
          description: Timezone used for calculations.
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: dimension
          in: path
          type: string
          description: The dimensions to fetch.
          required: true
        - name: f
          in: query
          type: array
          description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with
            the AND operator.
        - name: p
          in: query
          type: integer
          description: The response's page to access, starting at 1.
        - name: n
          in: query
          type: integer
          description: The number of results to include in a page.
        - name: cached
          in: query
          type: string
          description: cached
  exposes:
  - type: rest
    namespace: usage-analytics-read-dimensions-api-version-15-rest
    port: 8080
    description: REST adapter for Coveo Usage Analytics Read API — Dimensions API - Version 15. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/v15/dimensions
      name: v15-dimensions
      description: REST surface for v15-dimensions.
      operations:
      - method: GET
        name: getv15dimensions
        description: Get All the Dimensions
        call: usage-analytics-read-dimensions-api-version-15.getv15dimensions
        with:
          org: rest.org
          includeOnlyParents: rest.includeOnlyParents
          includeCustom: rest.includeCustom
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/dimensions/custom
      name: v15-dimensions-custom
      description: REST surface for v15-dimensions-custom.
      operations:
      - method: GET
        name: getv15dimensionscustom
        description: Get All the Custom Dimensions
        call: usage-analytics-read-dimensions-api-version-15.getv15dimensionscustom
        with:
          includeOnlyParents: rest.includeOnlyParents
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postv15dimensionscustom
        description: Create a Custom Dimension
        call: usage-analytics-read-dimensions-api-version-15.postv15dimensionscustom
        with:
          org: rest.org
          name: rest.name
          event: rest.event
          updatePastEvents: rest.updatePastEvents
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/dimensions/custom/monitoring/health
      name: v15-dimensions-custom-monitoring-health
      description: REST surface for v15-dimensions-custom-monitoring-health.
      operations:
      - method: GET
        name: getv15dimensionscustommonitoringhealth
        description: Health Check for the Custom Dimensions Service
        call: usage-analytics-read-dimensions-api-version-15.getv15dimensionscustommonitoringhealth
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/dimensions/custom/status
      name: v15-dimensions-custom-status
      description: REST surface for v15-dimensions-custom-status.
      operations:
      - method: GET
        name: getv15dimensionscustomstatus
        description: Get the Custom Dimensions Service Status
        call: usage-analytics-read-dimensions-api-version-15.getv15dimensionscustomstatus
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/dimensions/custom/{apiname}
      name: v15-dimensions-custom-apiname
      description: REST surface for v15-dimensions-custom-apiName.
      operations:
      - method: GET
        name: getv15dimensionscustomapiname
        description: Get a Custom Dimension
        call: usage-analytics-read-dimensions-api-version-15.getv15dimensionscustomapiname
        with:
          org: rest.org
          apiName: rest.apiName
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putv15dimensionscustomapiname
        description: Create or Edit a Custom Dimension
        call: usage-analytics-read-dimensions-api-version-15.putv15dimensionscustomapiname
        with:
          org: rest.org
          apiName: rest.apiName
          updatePastEvents: rest.updatePastEvents
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletev15dimensionscustomapiname
        description: Delete a Custom Dimension
        call: usage-analytics-read-dimensions-api-version-15.deletev15dimensionscustomapiname
        with:
          org: rest.org
          apiName: rest.apiName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/dimensions/custom/{dimension}/values
      name: v15-dimensions-custom-dimension-values
      description: REST surface for v15-dimensions-custom-dimension-values.
      operations:
      - method: GET
        name: getv15dimensionscustomdimensionvalues
        description: Get the Values for a Custom Dimension
        call: usage-analytics-read-dimensions-api-version-15.getv15dimensionscustomdimensionvalues
        with:
          from: rest.from
          to: rest.to
          tz: rest.tz
          org: rest.org
          dimension: rest.dimension
          f: rest.f
          p: rest.p
          n: rest.n
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/dimensions/custom/{event}/suggestions
      name: v15-dimensions-custom-event-suggestions
      description: REST surface for v15-dimensions-custom-event-suggestions.
      operations:
      - method: GET
        name: getv15dimensionscustomeventsuggestions
        description: Get a List of Dimensions That Have Data but Are Not Created Yet
        call: usage-analytics-read-dimensions-api-version-15.getv15dimensionscustomeventsuggestions
        with:
          org: rest.org
          from: rest.from
          to: rest.to
          event: rest.event
          includeValueSamples: rest.includeValueSamples
          depth: rest.depth
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/dimensions/exportables
      name: v15-dimensions-exportables
      description: REST surface for v15-dimensions-exportables.
      operations:
      - method: GET
        name: getv15dimensionsexportables
        description: Get All the Exportable Dimensions
        call: usage-analytics-read-dimensions-api-version-15.getv15dimensionsexportables
        with:
          org: rest.org
          includeOnlyParents: rest.includeOnlyParents
          includeCustom: rest.includeCustom
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/dimensions/monitoring/health
      name: v15-dimensions-monitoring-health
      description: REST surface for v15-dimensions-monitoring-health.
      operations:
      - method: GET
        name: getv15dimensionsmonitoringhealth
        description: Health Check for the Dimensions Service
        call: usage-analytics-read-dimensions-api-version-15.getv15dimensionsmonitoringhealth
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/dimensions/status
      name: v15-dimensions-status
      description: REST surface for v15-dimensions-status.
      operations:
      - method: GET
        name: getv15dimensionsstatus
        description: Get the Dimensions Service Status
        call: usage-analytics-read-dimensions-api-version-15.getv15dimensionsstatus
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/dimensions/{apiname}
      name: v15-dimensions-apiname
      description: REST surface for v15-dimensions-apiName.
      operations:
      - method: GET
        name: getv15dimensionsapiname
        description: Get a Dimension
        call: usage-analytics-read-dimensions-api-version-15.getv15dimensionsapiname
        with:
          org: rest.org
          apiName: rest.apiName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/dimensions/{dimension}/values
      name: v15-dimensions-dimension-values
      description: REST surface for v15-dimensions-dimension-values.
      operations:
      - method: GET
        name: getv15dimensionsdimensionvalues
        description: Get the Values for a Dimension
        call: usage-analytics-read-dimensions-api-version-15.getv15dimensionsdimensionvalues
        with:
          from: rest.from
          to: rest.to
          tz: rest.tz
          org: rest.org
          dimension: rest.dimension
          f: rest.f
          p: rest.p
          n: rest.n
          cached: rest.cached
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: usage-analytics-read-dimensions-api-version-15-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Usage Analytics Read API — Dimensions API - Version 15. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: get-all-dimensions
      description: Get All the Dimensions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-dimensions-api-version-15.getv15dimensions
      with:
        org: tools.org
        includeOnlyParents: tools.includeOnlyParents
        includeCustom: tools.includeCustom
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-custom-dimensions
      description: Get All the Custom Dimensions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-dimensions-api-version-15.getv15dimensionscustom
      with:
        includeOnlyParents: tools.includeOnlyParents
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: create-custom-dimension
      description: Create a Custom Dimension
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: usage-analytics-read-dimensions-api-version-15.postv15dimensionscustom
      with:
        org: tools.org
        name: tools.name
        event: tools.event
        updatePastEvents: tools.updatePastEvents
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: health-check-custom-dimensions-service
      description: Health Check for the Custom Dimensions Service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-dimensions-api-version-15.getv15dimensionscustommonitoringhealth
      outputParameters:
      - type: object
        mapping: $.
    - name: get-custom-dimensions-service-status
      description: Get the Custom Dimensions Service Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-dimensions-api-version-15.getv15dimensionscustomstatus
      outputParameters:
      - type: object
        mapping: $.
    - name: get-custom-dimension
      description: Get a Custom Dimension
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-dimensions-api-version-15.getv15dimensionscustomapiname
      with:
        org: tools.org
        apiName: tools.apiName
      outputParameters:
      - type: object
        mapping: $.
    - name: create-edit-custom-dimension
      description: Create or Edit a Custom Dimension
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: usage-analytics-read-dimensions-api-version-15.putv15dimensionscustomapiname
      with:
        org: tools.org
        apiName: tools.apiName
        updatePastEvents: tools.updatePastEvents
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-custom-dimension
      description: Delete a Custom Dimension
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: usage-analytics-read-dimensions-api-version-15.deletev15dimensionscustomapiname
      with:
        org: tools.org
        apiName: tools.apiName
      outputParameters:
      - type: object
        mapping: $.
    - name: get-values-custom-dimension
      description: Get the Values for a Custom Dimension
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-dimensions-api-version-15.getv15dimensionscustomdimensionvalues
      with:
        from: tools.from
        to: tools.to
        tz: tools.tz
        org: tools.org
        dimension: tools.dimension
        f: tools.f
        p: tools.p
        n: tools.n
      outputParameters:
      - type: object
        mapping: $.
    - name: get-list-dimensions-that-have
      description: Get a List of Dimensions That Have Data but Are Not Created Yet
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-dimensions-api-version-15.getv15dimensionscustomeventsuggestions
      with:
        org: tools.org
        from: tools.from
        to: tools.to
        event: tools.event
        includeValueSamples: tools.includeValueSamples
        depth: tools.depth
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-exportable-dimensions
      description: Get All the Exportable Dimensions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-dimensions-api-version-15.getv15dimensionsexportables
      with:
        org: tools.org
        includeOnlyParents: tools.includeOnlyParents
        includeCustom: tools.includeCustom
      outputParameters:
      - type: object
        mapping: $.
    - name: health-check-dimensions-service
      description: Health Check for the Dimensions Service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-dimensions-api-version-15.getv15dimensionsmonitoringhealth
      outputParameters:
      - type: object
        mapping: $.
    - name: get-dimensions-service-status
      description: Get the Dimensions Service Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-dimensions-api-version-15.getv15dimensionsstatus
      outputParameters:
      - type: object
        mapping: $.
    - name: get-dimension
      description: Get a Dimension
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-dimensions-api-version-15.getv15dimensionsapiname
      with:
        org: tools.org
        apiName: tools.apiName
      outputParameters:
      - type: object
        mapping: $.
    - name: get-values-dimension
      description: Get the Values for a Dimension
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-dimensions-api-version-15.getv15dimensionsdimensionvalues
      with:
        from: tools.from
        to: tools.to
        tz: tools.tz
        org: tools.org
        dimension: tools.dimension
        f: tools.f
        p: tools.p
        n: tools.n
        cached: tools.cached
      outputParameters:
      - type: object
        mapping: $.