Coveo Activity API — Activities

naftiko: 1.0.0-alpha2
info:
  label: Coveo Activity API — Activities
  description: 'Coveo Activity API — Activities. 7 operations. Lead operation: List Activity Facets. Self-contained Naftiko
    capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Activity
  - Activities
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: activity-activities
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Activity API — Activities business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-activities-facets-public
      path: /rest/organizations/{organizationId}/activities/facets/public
      operations:
      - name: getpublicactivitiesfacetsfororganization
        method: POST
        description: List Activity Facets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: from
          in: query
          type: string
          description: The beginning of the date range, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format, for which
            to list [activity](https://docs.coveo.com/en/173/) facets.
        - name: to
          in: query
          type: string
          description: The end of the date range, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format, for which to
            list [activity](https://docs.coveo.com/en/173/) facets.</br>T
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-activities-latest
      path: /rest/organizations/{organizationId}/activities/latest
      operations:
      - name: getlatestactivitiesfororganization
        method: POST
        description: Get Latest Activities for a Resource ID of an Organization Based on a Facet Model.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: page
          in: query
          type: integer
          description: The 0-based index number of the page of activities to retrieve.</br>**Minimum:** `0`</br>**Default:**
            `0`
        - name: perPage
          in: query
          type: integer
          description: The maximum number of activities to list per page.</br>**Minimum:** `0`</br>**Default:** `100`
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-activities-operationtypes
      path: /rest/organizations/{organizationId}/activities/operationtypes
      operations:
      - name: getnoninternalactivityoperationtypes
        method: GET
        description: List Operation Types
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
    - name: rest-organizations-organizationId-activities-public
      path: /rest/organizations/{organizationId}/activities/public
      operations:
      - name: getallpublicactivitiesfororganization
        method: POST
        description: List Activities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: page
          in: query
          type: integer
          description: The 0-based index number of the page of activities to retrieve.</br>**Minimum:** `0`</br>**Default:**
            `0`
        - name: perPage
          in: query
          type: integer
          description: The maximum number of activities to list per page.</br>**Minimum:** `0`</br>**Default:** `100`
        - name: from
          in: query
          type: string
          description: The beginning of the date range, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format, for which
            to list activities. If not specified, the parameter will b
        - name: to
          in: query
          type: string
          description: 'The end of the date range, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format, for which to
            list activities.</br>The end range must be within 31 days of '
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-activities-resourcesandoperations
      path: /rest/organizations/{organizationId}/activities/resourcesandoperations
      operations:
      - name: getresourcetypesandcorrespondingoperations
        method: GET
        description: List Resources and Operations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
    - name: rest-organizations-organizationId-activities-resourcetypes
      path: /rest/organizations/{organizationId}/activities/resourcetypes
      operations:
      - name: getactivityresourcetypes
        method: GET
        description: List Resource Types
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
    - name: rest-organizations-organizationId-activities-activityId
      path: /rest/organizations/{organizationId}/activities/{activityId}
      operations:
      - name: getactivitybyid
        method: GET
        description: Show Activity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: activityId
          in: path
          type: string
          description: The unique identifier of the target [activity](https://docs.coveo.com/en/173/).</br>**Example:** `128a706128d54btm98df8a98015301be`
          required: true
  exposes:
  - type: rest
    namespace: activity-activities-rest
    port: 8080
    description: REST adapter for Coveo Activity API — Activities. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/activities/facets/public
      name: rest-organizations-organizationid-activities-facets-public
      description: REST surface for rest-organizations-organizationId-activities-facets-public.
      operations:
      - method: POST
        name: getpublicactivitiesfacetsfororganization
        description: List Activity Facets
        call: activity-activities.getpublicactivitiesfacetsfororganization
        with:
          organizationId: rest.organizationId
          from: rest.from
          to: rest.to
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/activities/latest
      name: rest-organizations-organizationid-activities-latest
      description: REST surface for rest-organizations-organizationId-activities-latest.
      operations:
      - method: POST
        name: getlatestactivitiesfororganization
        description: Get Latest Activities for a Resource ID of an Organization Based on a Facet Model.
        call: activity-activities.getlatestactivitiesfororganization
        with:
          organizationId: rest.organizationId
          page: rest.page
          perPage: rest.perPage
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/activities/operationtypes
      name: rest-organizations-organizationid-activities-operationtypes
      description: REST surface for rest-organizations-organizationId-activities-operationtypes.
      operations:
      - method: GET
        name: getnoninternalactivityoperationtypes
        description: List Operation Types
        call: activity-activities.getnoninternalactivityoperationtypes
        with:
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/activities/public
      name: rest-organizations-organizationid-activities-public
      description: REST surface for rest-organizations-organizationId-activities-public.
      operations:
      - method: POST
        name: getallpublicactivitiesfororganization
        description: List Activities
        call: activity-activities.getallpublicactivitiesfororganization
        with:
          organizationId: rest.organizationId
          page: rest.page
          perPage: rest.perPage
          from: rest.from
          to: rest.to
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/activities/resourcesandoperations
      name: rest-organizations-organizationid-activities-resourcesandoperations
      description: REST surface for rest-organizations-organizationId-activities-resourcesandoperations.
      operations:
      - method: GET
        name: getresourcetypesandcorrespondingoperations
        description: List Resources and Operations
        call: activity-activities.getresourcetypesandcorrespondingoperations
        with:
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/activities/resourcetypes
      name: rest-organizations-organizationid-activities-resourcetypes
      description: REST surface for rest-organizations-organizationId-activities-resourcetypes.
      operations:
      - method: GET
        name: getactivityresourcetypes
        description: List Resource Types
        call: activity-activities.getactivityresourcetypes
        with:
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/activities/{activityid}
      name: rest-organizations-organizationid-activities-activityid
      description: REST surface for rest-organizations-organizationId-activities-activityId.
      operations:
      - method: GET
        name: getactivitybyid
        description: Show Activity
        call: activity-activities.getactivitybyid
        with:
          organizationId: rest.organizationId
          activityId: rest.activityId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: activity-activities-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Activity API — Activities. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-activity-facets
      description: List Activity Facets
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: activity-activities.getpublicactivitiesfacetsfororganization
      with:
        organizationId: tools.organizationId
        from: tools.from
        to: tools.to
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-latest-activities-resource-id
      description: Get Latest Activities for a Resource ID of an Organization Based on a Facet Model.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: activity-activities.getlatestactivitiesfororganization
      with:
        organizationId: tools.organizationId
        page: tools.page
        perPage: tools.perPage
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-operation-types
      description: List Operation Types
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: activity-activities.getnoninternalactivityoperationtypes
      with:
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: list-activities
      description: List Activities
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: activity-activities.getallpublicactivitiesfororganization
      with:
        organizationId: tools.organizationId
        page: tools.page
        perPage: tools.perPage
        from: tools.from
        to: tools.to
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-resources-and-operations
      description: List Resources and Operations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: activity-activities.getresourcetypesandcorrespondingoperations
      with:
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: list-resource-types
      description: List Resource Types
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: activity-activities.getactivityresourcetypes
      with:
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: show-activity
      description: Show Activity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: activity-activities.getactivitybyid
      with:
        organizationId: tools.organizationId
        activityId: tools.activityId
      outputParameters:
      - type: object
        mapping: $.