Coveo Usage Analytics Read API — Administration API - Version 15

naftiko: 1.0.0-alpha2
info:
  label: Coveo Usage Analytics Read API — Administration API - Version 15
  description: 'Coveo Usage Analytics Read API — Administration API - Version 15. 3 operations. Lead operation: Get an Account.
    Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Usage Analytics Read
  - Administration 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-administration-api-version-15
    baseUri: https://analytics.cloud.coveo.com/rest/ua
    description: Coveo Usage Analytics Read API — Administration API - Version 15 business capability. Self-contained, no
      shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: v15-admin-account
      path: /v15/admin/account
      operations:
      - name: getv15adminaccount
        method: GET
        description: Get an Account
        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: putv15adminaccount
        method: PUT
        description: Edit an Account
        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: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v15-admin-account-strictValidationTest
      path: /v15/admin/account/strictValidationTest
      operations:
      - name: getv15adminaccountstrictvalidationtest
        method: GET
        description: Get Example Values That Would Be Rejected by Strict Validation for the Specified 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: d
          in: query
          type: string
          description: The dimension to fetch.
          required: true
        - 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: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
  exposes:
  - type: rest
    namespace: usage-analytics-read-administration-api-version-15-rest
    port: 8080
    description: REST adapter for Coveo Usage Analytics Read API — Administration API - Version 15. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/v15/admin/account
      name: v15-admin-account
      description: REST surface for v15-admin-account.
      operations:
      - method: GET
        name: getv15adminaccount
        description: Get an Account
        call: usage-analytics-read-administration-api-version-15.getv15adminaccount
        with:
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putv15adminaccount
        description: Edit an Account
        call: usage-analytics-read-administration-api-version-15.putv15adminaccount
        with:
          org: rest.org
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/admin/account/strictvalidationtest
      name: v15-admin-account-strictvalidationtest
      description: REST surface for v15-admin-account-strictValidationTest.
      operations:
      - method: GET
        name: getv15adminaccountstrictvalidationtest
        description: Get Example Values That Would Be Rejected by Strict Validation for the Specified Dimension
        call: usage-analytics-read-administration-api-version-15.getv15adminaccountstrictvalidationtest
        with:
          from: rest.from
          to: rest.to
          d: rest.d
          p: rest.p
          n: rest.n
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: usage-analytics-read-administration-api-version-15-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Usage Analytics Read API — Administration API - Version 15. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: get-account
      description: Get an Account
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-administration-api-version-15.getv15adminaccount
      with:
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: edit-account
      description: Edit an Account
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: usage-analytics-read-administration-api-version-15.putv15adminaccount
      with:
        org: tools.org
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-example-values-that-would
      description: Get Example Values That Would Be Rejected by Strict Validation for the Specified Dimension
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-administration-api-version-15.getv15adminaccountstrictvalidationtest
      with:
        from: tools.from
        to: tools.to
        d: tools.d
        p: tools.p
        n: tools.n
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.