naftiko: 1.0.0-alpha2
info:
  label: Coveo Analytics Admin API — Property API
  description: 'Coveo Analytics Admin API — Property API. 6 operations. Lead operation: Get All Properties for an Organization..
    Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Analytics Admin
  - Property API
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: analytics-admin-property-api
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Analytics Admin API — Property API business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-analyticsadmin-v1-properties
      path: /rest/organizations/{organizationId}/analyticsadmin/v1/properties
      operations:
      - name: listproperties
        method: GET
        description: Get All Properties for an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: params
          in: query
          type: string
          required: true
      - name: queryproperties
        method: POST
        description: Query Properties for an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-analyticsadmin-v1-properties-trackingId
      path: /rest/organizations/{organizationId}/analyticsadmin/v1/properties/{trackingId}
      operations:
      - name: getproperty
        method: GET
        description: Get a Specific Property.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: trackingId
          in: path
          type: string
          required: true
      - name: updateproperty
        method: PUT
        description: Update All Values of a Property.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: trackingId
          in: path
          type: string
          required: true
        - name: displayName
          in: query
          type: string
          required: true
        - name: defaultTimeZone
          in: query
          type: string
        - name: defaultCurrency
          in: query
          type: string
      - name: createproperty
        method: POST
        description: Create a New Property.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: trackingId
          in: path
          type: string
          required: true
        - name: displayName
          in: query
          type: string
          required: true
        - name: defaultTimeZone
          in: query
          type: string
        - name: defaultCurrency
          in: query
          type: string
      - name: deleteproperty
        method: DELETE
        description: Delete a Property.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: trackingId
          in: path
          type: string
          required: true
  exposes:
  - type: rest
    namespace: analytics-admin-property-api-rest
    port: 8080
    description: REST adapter for Coveo Analytics Admin API — Property API. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/analyticsadmin/v1/properties
      name: rest-organizations-organizationid-analyticsadmin-v1-properties
      description: REST surface for rest-organizations-organizationId-analyticsadmin-v1-properties.
      operations:
      - method: GET
        name: listproperties
        description: Get All Properties for an Organization.
        call: analytics-admin-property-api.listproperties
        with:
          organizationId: rest.organizationId
          params: rest.params
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: queryproperties
        description: Query Properties for an Organization.
        call: analytics-admin-property-api.queryproperties
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/analyticsadmin/v1/properties/{trackingid}
      name: rest-organizations-organizationid-analyticsadmin-v1-properties-trackingid
      description: REST surface for rest-organizations-organizationId-analyticsadmin-v1-properties-trackingId.
      operations:
      - method: GET
        name: getproperty
        description: Get a Specific Property.
        call: analytics-admin-property-api.getproperty
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateproperty
        description: Update All Values of a Property.
        call: analytics-admin-property-api.updateproperty
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          displayName: rest.displayName
          defaultTimeZone: rest.defaultTimeZone
          defaultCurrency: rest.defaultCurrency
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createproperty
        description: Create a New Property.
        call: analytics-admin-property-api.createproperty
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
          displayName: rest.displayName
          defaultTimeZone: rest.defaultTimeZone
          defaultCurrency: rest.defaultCurrency
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteproperty
        description: Delete a Property.
        call: analytics-admin-property-api.deleteproperty
        with:
          organizationId: rest.organizationId
          trackingId: rest.trackingId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: analytics-admin-property-api-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Analytics Admin API — Property API. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-all-properties-organization
      description: Get All Properties for an Organization.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: analytics-admin-property-api.listproperties
      with:
        organizationId: tools.organizationId
        params: tools.params
      outputParameters:
      - type: object
        mapping: $.
    - name: query-properties-organization
      description: Query Properties for an Organization.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: analytics-admin-property-api.queryproperties
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-specific-property
      description: Get a Specific Property.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: analytics-admin-property-api.getproperty
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-all-values-property
      description: Update All Values of a Property.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: analytics-admin-property-api.updateproperty
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        displayName: tools.displayName
        defaultTimeZone: tools.defaultTimeZone
        defaultCurrency: tools.defaultCurrency
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-property
      description: Create a New Property.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: analytics-admin-property-api.createproperty
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
        displayName: tools.displayName
        defaultTimeZone: tools.defaultTimeZone
        defaultCurrency: tools.defaultCurrency
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-property
      description: Delete a Property.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: analytics-admin-property-api.deleteproperty
      with:
        organizationId: tools.organizationId
        trackingId: tools.trackingId
      outputParameters:
      - type: object
        mapping: $.