Coveo Usage Analytics Read API — Secure Data Sharing API - Version 15

naftiko: 1.0.0-alpha2
info:
  label: Coveo Usage Analytics Read API — Secure Data Sharing API - Version 15
  description: 'Coveo Usage Analytics Read API — Secure Data Sharing API - Version 15. 4 operations. Lead operation: Retrieve
    Snowflake Accounts Currently Associated in Secure Data Sharing. Self-contained Naftiko capability covering one Coveo business
    surface.'
  tags:
  - Coveo
  - Usage Analytics Read
  - Secure Data Sharing 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-secure-data-sharing-api-version-15
    baseUri: https://analytics.cloud.coveo.com/rest/ua
    description: Coveo Usage Analytics Read API — Secure Data Sharing API - Version 15 business capability. Self-contained,
      no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: v15-admin-snowflake-securedatasharing-accounts
      path: /v15/admin/snowflake/securedatasharing/accounts
      operations:
      - name: getv15adminsnowflakesecuredatasharingaccounts
        method: GET
        description: Retrieve Snowflake Accounts Currently Associated in Secure Data Sharing
        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: postv15adminsnowflakesecuredatasharingaccounts
        method: POST
        description: Add a Snowflake Account to Secure Data Sharing
        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: deletev15adminsnowflakesecuredatasharingaccounts
        method: DELETE
        description: Removes a Snowflake Account from Secure Data Sharing
        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: accountLocator
          in: query
          type: string
          description: The Snowflake account locator.
          required: true
        - name: snowflakeRegion
          in: query
          type: string
          description: The Snowflake region.
          required: true
    - name: v15-admin-snowflake-securedatasharing-regions
      path: /v15/admin/snowflake/securedatasharing/regions
      operations:
      - name: getv15adminsnowflakesecuredatasharingregions
        method: GET
        description: Retrieve Allowed Snowflake Regions for Secure Data Sharing
        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-secure-data-sharing-api-version-15-rest
    port: 8080
    description: REST adapter for Coveo Usage Analytics Read API — Secure Data Sharing API - Version 15. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/v15/admin/snowflake/securedatasharing/accounts
      name: v15-admin-snowflake-securedatasharing-accounts
      description: REST surface for v15-admin-snowflake-securedatasharing-accounts.
      operations:
      - method: GET
        name: getv15adminsnowflakesecuredatasharingaccounts
        description: Retrieve Snowflake Accounts Currently Associated in Secure Data Sharing
        call: usage-analytics-read-secure-data-sharing-api-version-15.getv15adminsnowflakesecuredatasharingaccounts
        with:
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postv15adminsnowflakesecuredatasharingaccounts
        description: Add a Snowflake Account to Secure Data Sharing
        call: usage-analytics-read-secure-data-sharing-api-version-15.postv15adminsnowflakesecuredatasharingaccounts
        with:
          org: rest.org
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletev15adminsnowflakesecuredatasharingaccounts
        description: Removes a Snowflake Account from Secure Data Sharing
        call: usage-analytics-read-secure-data-sharing-api-version-15.deletev15adminsnowflakesecuredatasharingaccounts
        with:
          org: rest.org
          accountLocator: rest.accountLocator
          snowflakeRegion: rest.snowflakeRegion
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/admin/snowflake/securedatasharing/regions
      name: v15-admin-snowflake-securedatasharing-regions
      description: REST surface for v15-admin-snowflake-securedatasharing-regions.
      operations:
      - method: GET
        name: getv15adminsnowflakesecuredatasharingregions
        description: Retrieve Allowed Snowflake Regions for Secure Data Sharing
        call: usage-analytics-read-secure-data-sharing-api-version-15.getv15adminsnowflakesecuredatasharingregions
        with:
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: usage-analytics-read-secure-data-sharing-api-version-15-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Usage Analytics Read API — Secure Data Sharing API - Version 15. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: retrieve-snowflake-accounts-currently-associated
      description: Retrieve Snowflake Accounts Currently Associated in Secure Data Sharing
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-secure-data-sharing-api-version-15.getv15adminsnowflakesecuredatasharingaccounts
      with:
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: add-snowflake-account-secure-data
      description: Add a Snowflake Account to Secure Data Sharing
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: usage-analytics-read-secure-data-sharing-api-version-15.postv15adminsnowflakesecuredatasharingaccounts
      with:
        org: tools.org
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: removes-snowflake-account-secure-data
      description: Removes a Snowflake Account from Secure Data Sharing
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: usage-analytics-read-secure-data-sharing-api-version-15.deletev15adminsnowflakesecuredatasharingaccounts
      with:
        org: tools.org
        accountLocator: tools.accountLocator
        snowflakeRegion: tools.snowflakeRegion
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-allowed-snowflake-regions-secure
      description: Retrieve Allowed Snowflake Regions for Secure Data Sharing
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-secure-data-sharing-api-version-15.getv15adminsnowflakesecuredatasharingregions
      with:
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.