Salesforce Sales Cloud Salesforce Analytics REST API — Dashboards

naftiko: 1.0.0-alpha2
info:
  label: Salesforce Sales Cloud Salesforce Analytics REST API — Dashboards
  description: 'Salesforce Sales Cloud Salesforce Analytics REST API — Dashboards. 5 operations. Lead operation: Salesforce
    Sales Cloud List dashboards. Self-contained Naftiko capability covering one Salesforce Sales Cloud business surface.'
  tags:
  - Salesforce Sales Cloud
  - Dashboards
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SALESFORCE_SALES_CLOUD_API_KEY: SALESFORCE_SALES_CLOUD_API_KEY
capability:
  consumes:
  - type: http
    namespace: analytics-dashboards
    baseUri: https://{instance}.salesforce.com/services/data/v59.0/analytics
    description: Salesforce Sales Cloud Salesforce Analytics REST API — Dashboards business capability. Self-contained, no
      shared references.
    resources:
    - name: dashboards
      path: /dashboards
      operations:
      - name: listdashboards
        method: GET
        description: Salesforce Sales Cloud List dashboards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: dashboards-dashboardId
      path: /dashboards/{dashboardId}
      operations:
      - name: getdashboard
        method: GET
        description: Salesforce Sales Cloud Get dashboard metadata and results
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: refreshdashboard
        method: PUT
        description: Salesforce Sales Cloud Refresh a dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletedashboard
        method: DELETE
        description: Salesforce Sales Cloud Delete a dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: dashboards-dashboardId-status
      path: /dashboards/{dashboardId}/status
      operations:
      - name: getdashboardstatus
        method: GET
        description: Salesforce Sales Cloud Get dashboard refresh status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SALESFORCE_SALES_CLOUD_API_KEY}}'
  exposes:
  - type: rest
    namespace: analytics-dashboards-rest
    port: 8080
    description: REST adapter for Salesforce Sales Cloud Salesforce 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: listdashboards
        description: Salesforce Sales Cloud List dashboards
        call: analytics-dashboards.listdashboards
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dashboards/{dashboardid}
      name: dashboards-dashboardid
      description: REST surface for dashboards-dashboardId.
      operations:
      - method: GET
        name: getdashboard
        description: Salesforce Sales Cloud Get dashboard metadata and results
        call: analytics-dashboards.getdashboard
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: refreshdashboard
        description: Salesforce Sales Cloud Refresh a dashboard
        call: analytics-dashboards.refreshdashboard
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletedashboard
        description: Salesforce Sales Cloud Delete a dashboard
        call: analytics-dashboards.deletedashboard
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dashboards/{dashboardid}/status
      name: dashboards-dashboardid-status
      description: REST surface for dashboards-dashboardId-status.
      operations:
      - method: GET
        name: getdashboardstatus
        description: Salesforce Sales Cloud Get dashboard refresh status
        call: analytics-dashboards.getdashboardstatus
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: analytics-dashboards-mcp
    port: 9090
    transport: http
    description: MCP adapter for Salesforce Sales Cloud Salesforce Analytics REST API — Dashboards. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: salesforce-sales-cloud-list-dashboards
      description: Salesforce Sales Cloud List dashboards
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: analytics-dashboards.listdashboards
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-sales-cloud-get-dashboard
      description: Salesforce Sales Cloud Get dashboard metadata and results
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: analytics-dashboards.getdashboard
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-sales-cloud-refresh-dashboard
      description: Salesforce Sales Cloud Refresh a dashboard
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: analytics-dashboards.refreshdashboard
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-sales-cloud-delete-dashboard
      description: Salesforce Sales Cloud Delete a dashboard
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: analytics-dashboards.deletedashboard
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-sales-cloud-get-dashboard-2
      description: Salesforce Sales Cloud Get dashboard refresh status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: analytics-dashboards.getdashboardstatus
      outputParameters:
      - type: object
        mapping: $.