Salesforce Analytics (CRM Analytics) REST API — Dashboards

naftiko: 1.0.0-alpha2
info:
  label: Salesforce Analytics (CRM Analytics) REST API — Dashboards
  description: 'Salesforce Analytics (CRM Analytics) REST API — Dashboards. 2 operations. Lead operation: List dashboards.
    Self-contained Naftiko capability covering one Salesforce Automation business surface.'
  tags:
  - Salesforce Automation
  - Dashboards
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SALESFORCE_AUTOMATION_API_KEY: SALESFORCE_AUTOMATION_API_KEY
capability:
  consumes:
  - type: http
    namespace: salesforce-analytics-dashboards
    baseUri: https://{instance}.salesforce.com/services/data/v63.0/wave
    description: Salesforce Analytics (CRM Analytics) REST API — Dashboards business capability. Self-contained, no shared
      references.
    resources:
    - name: dashboards
      path: /dashboards
      operations:
      - name: getdashboards
        method: GET
        description: List dashboards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: q
          in: query
          type: string
          description: Search term to filter dashboards
        - name: folderId
          in: query
          type: string
        - name: page
          in: query
          type: string
        - name: pageSize
          in: query
          type: integer
    - name: dashboards-dashboardId
      path: /dashboards/{dashboardId}
      operations:
      - name: getdashboard
        method: GET
        description: Get a dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboardId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.SALESFORCE_AUTOMATION_API_KEY}}'
  exposes:
  - type: rest
    namespace: salesforce-analytics-dashboards-rest
    port: 8080
    description: REST adapter for Salesforce Analytics (CRM Analytics) REST API — Dashboards. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/dashboards
      name: dashboards
      description: REST surface for dashboards.
      operations:
      - method: GET
        name: getdashboards
        description: List dashboards
        call: salesforce-analytics-dashboards.getdashboards
        with:
          q: rest.q
          folderId: rest.folderId
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dashboards/{dashboardid}
      name: dashboards-dashboardid
      description: REST surface for dashboards-dashboardId.
      operations:
      - method: GET
        name: getdashboard
        description: Get a dashboard
        call: salesforce-analytics-dashboards.getdashboard
        with:
          dashboardId: rest.dashboardId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: salesforce-analytics-dashboards-mcp
    port: 9090
    transport: http
    description: MCP adapter for Salesforce Analytics (CRM Analytics) REST API — Dashboards. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: list-dashboards
      description: List dashboards
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: salesforce-analytics-dashboards.getdashboards
      with:
        q: tools.q
        folderId: tools.folderId
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: get-dashboard
      description: Get a dashboard
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: salesforce-analytics-dashboards.getdashboard
      with:
        dashboardId: tools.dashboardId
      outputParameters:
      - type: object
        mapping: $.