Coveo Usage Analytics Read API — Statistics API - Version 14

naftiko: 1.0.0-alpha2
info:
  label: Coveo Usage Analytics Read API — Statistics API - Version 14
  description: 'Coveo Usage Analytics Read API — Statistics API - Version 14. 8 operations. Lead operation: Get Metrics Combined
    with Dimensions for a Date Range. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Usage Analytics Read
  - Statistics API - Version 14
  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-statistics-api-version-14
    baseUri: https://analytics.cloud.coveo.com/rest/ua
    description: Coveo Usage Analytics Read API — Statistics API - Version 14 business capability. Self-contained, no shared
      references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: v14-stats-combinedData
      path: /v14/stats/combinedData
      operations:
      - name: getv14statscombineddata
        method: GET
        description: Get Metrics Combined with Dimensions for a Date Range
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: m
          in: query
          type: array
          description: The metrics to fetch.
          required: true
        - 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: d
          in: query
          type: array
          description: Timezone used for calculations.
        - 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: fm
          in: query
          type: array
          description: The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND
            operator.
        - name: s
          in: query
          type: string
          description: The field to order the results by. It must be a dimension, metric or custom dimension that was specified
            in the 'm' or the 'd' parameter.
        - 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 result to include in a page.
        - name: asc
          in: query
          type: boolean
          description: Whether to sort by ascending order.
        - name: includeMetadata
          in: query
          type: boolean
          description: Whether to include metadata regarding the results (total count and unique counts, if applicable).
        - name: format
          in: query
          type: string
          description: The format of the response. Default is JSON.
        - name: bindOnLastSearch
          in: query
          type: boolean
          description: bindOnLastSearch
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v14-stats-globalData
      path: /v14/stats/globalData
      operations:
      - name: getv14statsglobaldata
        method: GET
        description: Get Global Data for Each Metric for a Date Range
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: m
          in: query
          type: array
          description: The metrics to fetch.
          required: true
        - 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: d
          in: query
          type: array
          description: The dimensions to fetch. Required when the Activity metric is requested as it has to be based on a
            dimension.
        - 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: i
          in: query
          type: string
          description: The interval on which data will be grouped. Default value is DAY.
        - name: bindOnLastSearch
          in: query
          type: boolean
          description: bindOnLastSearch
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v14-stats-graphDataPoints
      path: /v14/stats/graphDataPoints
      operations:
      - name: getv14statsgraphdatapoints
        method: GET
        description: Get Graph Data Points for the Metrics for a Date Range
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: m
          in: query
          type: array
          description: The metrics to fetch.
          required: true
        - 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: 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: i
          in: query
          type: string
          description: The interval on which data will be grouped. Default value is DAY.
        - name: bindOnLastSearch
          in: query
          type: boolean
          description: bindOnLastSearch
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v14-stats-monitoring-health
      path: /v14/stats/monitoring/health
      operations:
      - name: getv14statsmonitoringhealth
        method: GET
        description: Health Check for the Statistics Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v14-stats-status
      path: /v14/stats/status
      operations:
      - name: getv14statsstatus
        method: GET
        description: Get the Statistics Service Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v14-stats-trends
      path: /v14/stats/trends
      operations:
      - name: getv14statstrends
        method: GET
        description: Get Trends of a Metric Combined with Dimensions for a Date Range
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: m
          in: query
          type: array
          description: The metrics to fetch.
          required: true
        - 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: previousFrom
          in: query
          type: string
          description: The beginning date of the previous date range, when reporting trends. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'.
            If not specified, it will be the 'from' date mi
        - name: previousTo
          in: query
          type: string
          description: 'The end date of the previous date range, when reporting trends. ISO8601 format ''YYYY-MM-DDThh:mm:ss.sssZ''.
            If not specified, it will be the ''to'' date minus the '
        - name: tz
          in: query
          type: string
          description: Timezone used for calculations.
        - name: d
          in: query
          type: array
          description: Timezone used for calculations.
        - 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: fm
          in: query
          type: array
          description: The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND
            operator.
        - name: s
          in: query
          type: string
          description: The field to order the results by. It must be a dimension, metric or custom dimension that was specified
            in the 'm' or the 'd' parameter.
        - 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 result to include in a page.
        - name: asc
          in: query
          type: boolean
          description: Whether to sort by ascending order.
        - name: includeMetadata
          in: query
          type: boolean
          description: Whether to include metadata regarding the results (total count and unique counts, if applicable).
        - name: format
          in: query
          type: string
          description: The format of the response. Default is JSON.
        - name: bindOnLastSearch
          in: query
          type: boolean
          description: bindOnLastSearch
        - name: t
          in: query
          type: array
          description: The trends to caculate.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v14-stats-visits
      path: /v14/stats/visits
      operations:
      - name: getv14statsvisits
        method: GET
        description: Get the Details of the Visits Matching the Specified Criteria
        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: d
          in: query
          type: array
          description: The dimensions to fetch.
        - 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: fn
          in: query
          type: array
          description: The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters
            are joined with the AND operator.
        - name: s
          in: query
          type: string
          description: The field to order the results by. It must be a dimension, metric or custom dimension that was specified
            in the 'm' or the 'd' parameter.
        - 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 result to include in a page.
        - name: asc
          in: query
          type: boolean
          description: Whether to sort by ascending order.
        - name: includeMetadata
          in: query
          type: boolean
          description: Whether to include metadata regarding the results (total count and unique counts, if applicable).
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
      - name: postv14statsvisits
        method: POST
        description: Force a Visit View Update
        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)
  exposes:
  - type: rest
    namespace: usage-analytics-read-statistics-api-version-14-rest
    port: 8080
    description: REST adapter for Coveo Usage Analytics Read API — Statistics API - Version 14. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/v14/stats/combineddata
      name: v14-stats-combineddata
      description: REST surface for v14-stats-combinedData.
      operations:
      - method: GET
        name: getv14statscombineddata
        description: Get Metrics Combined with Dimensions for a Date Range
        call: usage-analytics-read-statistics-api-version-14.getv14statscombineddata
        with:
          m: rest.m
          from: rest.from
          to: rest.to
          tz: rest.tz
          d: rest.d
          f: rest.f
          fm: rest.fm
          s: rest.s
          p: rest.p
          n: rest.n
          asc: rest.asc
          includeMetadata: rest.includeMetadata
          format: rest.format
          bindOnLastSearch: rest.bindOnLastSearch
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/stats/globaldata
      name: v14-stats-globaldata
      description: REST surface for v14-stats-globalData.
      operations:
      - method: GET
        name: getv14statsglobaldata
        description: Get Global Data for Each Metric for a Date Range
        call: usage-analytics-read-statistics-api-version-14.getv14statsglobaldata
        with:
          m: rest.m
          from: rest.from
          to: rest.to
          tz: rest.tz
          d: rest.d
          f: rest.f
          i: rest.i
          bindOnLastSearch: rest.bindOnLastSearch
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/stats/graphdatapoints
      name: v14-stats-graphdatapoints
      description: REST surface for v14-stats-graphDataPoints.
      operations:
      - method: GET
        name: getv14statsgraphdatapoints
        description: Get Graph Data Points for the Metrics for a Date Range
        call: usage-analytics-read-statistics-api-version-14.getv14statsgraphdatapoints
        with:
          m: rest.m
          from: rest.from
          to: rest.to
          tz: rest.tz
          f: rest.f
          i: rest.i
          bindOnLastSearch: rest.bindOnLastSearch
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/stats/monitoring/health
      name: v14-stats-monitoring-health
      description: REST surface for v14-stats-monitoring-health.
      operations:
      - method: GET
        name: getv14statsmonitoringhealth
        description: Health Check for the Statistics Service
        call: usage-analytics-read-statistics-api-version-14.getv14statsmonitoringhealth
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/stats/status
      name: v14-stats-status
      description: REST surface for v14-stats-status.
      operations:
      - method: GET
        name: getv14statsstatus
        description: Get the Statistics Service Status
        call: usage-analytics-read-statistics-api-version-14.getv14statsstatus
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/stats/trends
      name: v14-stats-trends
      description: REST surface for v14-stats-trends.
      operations:
      - method: GET
        name: getv14statstrends
        description: Get Trends of a Metric Combined with Dimensions for a Date Range
        call: usage-analytics-read-statistics-api-version-14.getv14statstrends
        with:
          m: rest.m
          from: rest.from
          to: rest.to
          previousFrom: rest.previousFrom
          previousTo: rest.previousTo
          tz: rest.tz
          d: rest.d
          f: rest.f
          fm: rest.fm
          s: rest.s
          p: rest.p
          n: rest.n
          asc: rest.asc
          includeMetadata: rest.includeMetadata
          format: rest.format
          bindOnLastSearch: rest.bindOnLastSearch
          t: rest.t
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/stats/visits
      name: v14-stats-visits
      description: REST surface for v14-stats-visits.
      operations:
      - method: GET
        name: getv14statsvisits
        description: Get the Details of the Visits Matching the Specified Criteria
        call: usage-analytics-read-statistics-api-version-14.getv14statsvisits
        with:
          from: rest.from
          to: rest.to
          tz: rest.tz
          d: rest.d
          f: rest.f
          fn: rest.fn
          s: rest.s
          p: rest.p
          n: rest.n
          asc: rest.asc
          includeMetadata: rest.includeMetadata
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postv14statsvisits
        description: Force a Visit View Update
        call: usage-analytics-read-statistics-api-version-14.postv14statsvisits
        with:
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: usage-analytics-read-statistics-api-version-14-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Usage Analytics Read API — Statistics API - Version 14. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: get-metrics-combined-dimensions-date
      description: Get Metrics Combined with Dimensions for a Date Range
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-statistics-api-version-14.getv14statscombineddata
      with:
        m: tools.m
        from: tools.from
        to: tools.to
        tz: tools.tz
        d: tools.d
        f: tools.f
        fm: tools.fm
        s: tools.s
        p: tools.p
        n: tools.n
        asc: tools.asc
        includeMetadata: tools.includeMetadata
        format: tools.format
        bindOnLastSearch: tools.bindOnLastSearch
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: get-global-data-each-metric
      description: Get Global Data for Each Metric for a Date Range
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-statistics-api-version-14.getv14statsglobaldata
      with:
        m: tools.m
        from: tools.from
        to: tools.to
        tz: tools.tz
        d: tools.d
        f: tools.f
        i: tools.i
        bindOnLastSearch: tools.bindOnLastSearch
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: get-graph-data-points-metrics
      description: Get Graph Data Points for the Metrics for a Date Range
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-statistics-api-version-14.getv14statsgraphdatapoints
      with:
        m: tools.m
        from: tools.from
        to: tools.to
        tz: tools.tz
        f: tools.f
        i: tools.i
        bindOnLastSearch: tools.bindOnLastSearch
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: health-check-statistics-service
      description: Health Check for the Statistics Service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-statistics-api-version-14.getv14statsmonitoringhealth
      outputParameters:
      - type: object
        mapping: $.
    - name: get-statistics-service-status
      description: Get the Statistics Service Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-statistics-api-version-14.getv14statsstatus
      outputParameters:
      - type: object
        mapping: $.
    - name: get-trends-metric-combined-dimensions
      description: Get Trends of a Metric Combined with Dimensions for a Date Range
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-statistics-api-version-14.getv14statstrends
      with:
        m: tools.m
        from: tools.from
        to: tools.to
        previousFrom: tools.previousFrom
        previousTo: tools.previousTo
        tz: tools.tz
        d: tools.d
        f: tools.f
        fm: tools.fm
        s: tools.s
        p: tools.p
        n: tools.n
        asc: tools.asc
        includeMetadata: tools.includeMetadata
        format: tools.format
        bindOnLastSearch: tools.bindOnLastSearch
        t: tools.t
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: get-details-visits-matching-specified
      description: Get the Details of the Visits Matching the Specified Criteria
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-statistics-api-version-14.getv14statsvisits
      with:
        from: tools.from
        to: tools.to
        tz: tools.tz
        d: tools.d
        f: tools.f
        fn: tools.fn
        s: tools.s
        p: tools.p
        n: tools.n
        asc: tools.asc
        includeMetadata: tools.includeMetadata
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: force-visit-view-update
      description: Force a Visit View Update
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: usage-analytics-read-statistics-api-version-14.postv14statsvisits
      with:
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.