Coveo Usage Analytics Read API — Reader Account API - Version 15

naftiko: 1.0.0-alpha2
info:
  label: Coveo Usage Analytics Read API — Reader Account API - Version 15
  description: 'Coveo Usage Analytics Read API — Reader Account API - Version 15. 13 operations. Lead operation: Get the Amount
    of Compute Credits Used by a Snowflake Reader Account Within a Date Range. Self-contained Naftiko capability covering
    one Coveo business surface.'
  tags:
  - Coveo
  - Usage Analytics Read
  - Reader Account 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-reader-account-api-version-15
    baseUri: https://analytics.cloud.coveo.com/rest/ua
    description: Coveo Usage Analytics Read API — Reader Account API - Version 15 business capability. Self-contained, no
      shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: v15-admin-snowflake-creditusage
      path: /v15/admin/snowflake/creditusage
      operations:
      - name: getv15adminsnowflakecreditusage
        method: GET
        description: Get the Amount of Compute Credits Used by a Snowflake Reader Account Within a Date Range
        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'
          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: v15-admin-snowflake-networkpolicy
      path: /v15/admin/snowflake/networkpolicy
      operations:
      - name: getv15adminsnowflakenetworkpolicy
        method: GET
        description: Get the Details of the Active Network Policy for a Snowflake Reader 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: putv15adminsnowflakenetworkpolicy
        method: PUT
        description: Set the Details of the Active Network Policy for a Snowflake Reader 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: true
    - name: v15-admin-snowflake-readeraccount
      path: /v15/admin/snowflake/readeraccount
      operations:
      - name: getv15adminsnowflakereaderaccount
        method: GET
        description: Retrieve Snowflake Reader Account State
        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: deletev15adminsnowflakereaderaccount
        method: DELETE
        description: Delete Snowflake Reader 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: v15-admin-snowflake-readeraccount-endpoint
      path: /v15/admin/snowflake/readeraccount/endpoint
      operations:
      - name: getv15adminsnowflakereaderaccountendpoint
        method: GET
        description: Retrieve Snowflake Reader Account Endpoint
        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: v15-admin-snowflake-readeraccounts
      path: /v15/admin/snowflake/readeraccounts
      operations:
      - name: postv15adminsnowflakereaderaccounts
        method: POST
        description: Create a Reader 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: v15-admin-snowflake-users
      path: /v15/admin/snowflake/users
      operations:
      - name: getv15adminsnowflakeusers
        method: GET
        description: Get the Details for All Users from a Snowflake Reader 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: postv15adminsnowflakeusers
        method: POST
        description: Create a New User Within a Snowflake Reader 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: true
    - name: v15-admin-snowflake-users-snowflakeUser
      path: /v15/admin/snowflake/users/{snowflakeUser}
      operations:
      - name: getv15adminsnowflakeuserssnowflakeuser
        method: GET
        description: Get the Details for a Specific User from a Snowflake Reader Account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: snowflakeUser
          in: path
          type: string
          description: The login name for the Snowflake user.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
      - name: deletev15adminsnowflakeuserssnowflakeuser
        method: DELETE
        description: Delete a User from a Snowflake Reader Account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: snowflakeUser
          in: path
          type: string
          description: The login name for the Snowflake user.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v15-admin-snowflake-users-snowflakeUser-expiration
      path: /v15/admin/snowflake/users/{snowflakeUser}/expiration
      operations:
      - name: putv15adminsnowflakeuserssnowflakeuserexpiration
        method: PUT
        description: Change the Expiration Time of a Snowflake Reader Account User
        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: snowflakeUser
          in: path
          type: string
          description: The login name for the Snowflake user.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v15-admin-snowflake-users-snowflakeUser-passwordreset
      path: /v15/admin/snowflake/users/{snowflakeUser}/passwordreset
      operations:
      - name: postv15adminsnowflakeuserssnowflakeuserpasswordreset
        method: POST
        description: Reset a User's Password in a Snowflake Reader Account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: snowflakeUser
          in: path
          type: string
          description: The login name for the Snowflake user.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
  exposes:
  - type: rest
    namespace: usage-analytics-read-reader-account-api-version-15-rest
    port: 8080
    description: REST adapter for Coveo Usage Analytics Read API — Reader Account API - Version 15. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/v15/admin/snowflake/creditusage
      name: v15-admin-snowflake-creditusage
      description: REST surface for v15-admin-snowflake-creditusage.
      operations:
      - method: GET
        name: getv15adminsnowflakecreditusage
        description: Get the Amount of Compute Credits Used by a Snowflake Reader Account Within a Date Range
        call: usage-analytics-read-reader-account-api-version-15.getv15adminsnowflakecreditusage
        with:
          org: rest.org
          from: rest.from
          to: rest.to
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/admin/snowflake/networkpolicy
      name: v15-admin-snowflake-networkpolicy
      description: REST surface for v15-admin-snowflake-networkpolicy.
      operations:
      - method: GET
        name: getv15adminsnowflakenetworkpolicy
        description: Get the Details of the Active Network Policy for a Snowflake Reader Account
        call: usage-analytics-read-reader-account-api-version-15.getv15adminsnowflakenetworkpolicy
        with:
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putv15adminsnowflakenetworkpolicy
        description: Set the Details of the Active Network Policy for a Snowflake Reader Account
        call: usage-analytics-read-reader-account-api-version-15.putv15adminsnowflakenetworkpolicy
        with:
          org: rest.org
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/admin/snowflake/readeraccount
      name: v15-admin-snowflake-readeraccount
      description: REST surface for v15-admin-snowflake-readeraccount.
      operations:
      - method: GET
        name: getv15adminsnowflakereaderaccount
        description: Retrieve Snowflake Reader Account State
        call: usage-analytics-read-reader-account-api-version-15.getv15adminsnowflakereaderaccount
        with:
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletev15adminsnowflakereaderaccount
        description: Delete Snowflake Reader Account
        call: usage-analytics-read-reader-account-api-version-15.deletev15adminsnowflakereaderaccount
        with:
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/admin/snowflake/readeraccount/endpoint
      name: v15-admin-snowflake-readeraccount-endpoint
      description: REST surface for v15-admin-snowflake-readeraccount-endpoint.
      operations:
      - method: GET
        name: getv15adminsnowflakereaderaccountendpoint
        description: Retrieve Snowflake Reader Account Endpoint
        call: usage-analytics-read-reader-account-api-version-15.getv15adminsnowflakereaderaccountendpoint
        with:
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/admin/snowflake/readeraccounts
      name: v15-admin-snowflake-readeraccounts
      description: REST surface for v15-admin-snowflake-readeraccounts.
      operations:
      - method: POST
        name: postv15adminsnowflakereaderaccounts
        description: Create a Reader Account
        call: usage-analytics-read-reader-account-api-version-15.postv15adminsnowflakereaderaccounts
        with:
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/admin/snowflake/users
      name: v15-admin-snowflake-users
      description: REST surface for v15-admin-snowflake-users.
      operations:
      - method: GET
        name: getv15adminsnowflakeusers
        description: Get the Details for All Users from a Snowflake Reader Account
        call: usage-analytics-read-reader-account-api-version-15.getv15adminsnowflakeusers
        with:
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postv15adminsnowflakeusers
        description: Create a New User Within a Snowflake Reader Account
        call: usage-analytics-read-reader-account-api-version-15.postv15adminsnowflakeusers
        with:
          org: rest.org
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/admin/snowflake/users/{snowflakeuser}
      name: v15-admin-snowflake-users-snowflakeuser
      description: REST surface for v15-admin-snowflake-users-snowflakeUser.
      operations:
      - method: GET
        name: getv15adminsnowflakeuserssnowflakeuser
        description: Get the Details for a Specific User from a Snowflake Reader Account
        call: usage-analytics-read-reader-account-api-version-15.getv15adminsnowflakeuserssnowflakeuser
        with:
          snowflakeUser: rest.snowflakeUser
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletev15adminsnowflakeuserssnowflakeuser
        description: Delete a User from a Snowflake Reader Account
        call: usage-analytics-read-reader-account-api-version-15.deletev15adminsnowflakeuserssnowflakeuser
        with:
          snowflakeUser: rest.snowflakeUser
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/admin/snowflake/users/{snowflakeuser}/expiration
      name: v15-admin-snowflake-users-snowflakeuser-expiration
      description: REST surface for v15-admin-snowflake-users-snowflakeUser-expiration.
      operations:
      - method: PUT
        name: putv15adminsnowflakeuserssnowflakeuserexpiration
        description: Change the Expiration Time of a Snowflake Reader Account User
        call: usage-analytics-read-reader-account-api-version-15.putv15adminsnowflakeuserssnowflakeuserexpiration
        with:
          org: rest.org
          snowflakeUser: rest.snowflakeUser
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/admin/snowflake/users/{snowflakeuser}/passwordreset
      name: v15-admin-snowflake-users-snowflakeuser-passwordreset
      description: REST surface for v15-admin-snowflake-users-snowflakeUser-passwordreset.
      operations:
      - method: POST
        name: postv15adminsnowflakeuserssnowflakeuserpasswordreset
        description: Reset a User's Password in a Snowflake Reader Account
        call: usage-analytics-read-reader-account-api-version-15.postv15adminsnowflakeuserssnowflakeuserpasswordreset
        with:
          snowflakeUser: rest.snowflakeUser
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: usage-analytics-read-reader-account-api-version-15-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Usage Analytics Read API — Reader Account API - Version 15. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: get-amount-compute-credits-used
      description: Get the Amount of Compute Credits Used by a Snowflake Reader Account Within a Date Range
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-reader-account-api-version-15.getv15adminsnowflakecreditusage
      with:
        org: tools.org
        from: tools.from
        to: tools.to
      outputParameters:
      - type: object
        mapping: $.
    - name: get-details-active-network-policy
      description: Get the Details of the Active Network Policy for a Snowflake Reader Account
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-reader-account-api-version-15.getv15adminsnowflakenetworkpolicy
      with:
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: set-details-active-network-policy
      description: Set the Details of the Active Network Policy for a Snowflake Reader Account
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: usage-analytics-read-reader-account-api-version-15.putv15adminsnowflakenetworkpolicy
      with:
        org: tools.org
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-snowflake-reader-account-state
      description: Retrieve Snowflake Reader Account State
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-reader-account-api-version-15.getv15adminsnowflakereaderaccount
      with:
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-snowflake-reader-account
      description: Delete Snowflake Reader Account
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: usage-analytics-read-reader-account-api-version-15.deletev15adminsnowflakereaderaccount
      with:
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-snowflake-reader-account-endpoint
      description: Retrieve Snowflake Reader Account Endpoint
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-reader-account-api-version-15.getv15adminsnowflakereaderaccountendpoint
      with:
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: create-reader-account
      description: Create a Reader Account
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: usage-analytics-read-reader-account-api-version-15.postv15adminsnowflakereaderaccounts
      with:
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: get-details-all-users-snowflake
      description: Get the Details for All Users from a Snowflake Reader Account
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-reader-account-api-version-15.getv15adminsnowflakeusers
      with:
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-user-within-snowflake
      description: Create a New User Within a Snowflake Reader Account
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: usage-analytics-read-reader-account-api-version-15.postv15adminsnowflakeusers
      with:
        org: tools.org
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-details-specific-user-snowflake
      description: Get the Details for a Specific User from a Snowflake Reader Account
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-reader-account-api-version-15.getv15adminsnowflakeuserssnowflakeuser
      with:
        snowflakeUser: tools.snowflakeUser
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-user-snowflake-reader-account
      description: Delete a User from a Snowflake Reader Account
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: usage-analytics-read-reader-account-api-version-15.deletev15adminsnowflakeuserssnowflakeuser
      with:
        snowflakeUser: tools.snowflakeUser
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: change-expiration-time-snowflake-reader
      description: Change the Expiration Time of a Snowflake Reader Account User
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: usage-analytics-read-reader-account-api-version-15.putv15adminsnowflakeuserssnowflakeuserexpiration
      with:
        org: tools.org
        snowflakeUser: tools.snowflakeUser
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: reset-user-s-password-snowflake-reader
      description: Reset a User's Password in a Snowflake Reader Account
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: usage-analytics-read-reader-account-api-version-15.postv15adminsnowflakeuserssnowflakeuserpasswordreset
      with:
        snowflakeUser: tools.snowflakeUser
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.