Salesforce Sales Cloud Salesforce Analytics REST API — Report Instances

naftiko: 1.0.0-alpha2
info:
  label: Salesforce Sales Cloud Salesforce Analytics REST API — Report Instances
  description: 'Salesforce Sales Cloud Salesforce Analytics REST API — Report Instances. 3 operations. Lead operation: Salesforce
    Sales Cloud List report instances. Self-contained Naftiko capability covering one Salesforce Sales Cloud business surface.'
  tags:
  - Salesforce Sales Cloud
  - Report Instances
  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-report-instances
    baseUri: https://{instance}.salesforce.com/services/data/v59.0/analytics
    description: Salesforce Sales Cloud Salesforce Analytics REST API — Report Instances business capability. Self-contained,
      no shared references.
    resources:
    - name: reports-reportId-instances
      path: /reports/{reportId}/instances
      operations:
      - name: listreportinstances
        method: GET
        description: Salesforce Sales Cloud List report instances
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: executereportasync
        method: POST
        description: Salesforce Sales Cloud Run a report asynchronously
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: reports-reportId-instances-instanceId
      path: /reports/{reportId}/instances/{instanceId}
      operations:
      - name: getreportinstanceresults
        method: GET
        description: Salesforce Sales Cloud Get report instance results
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: instanceId
          in: path
          type: string
          description: The ID of the report instance
          required: true
    authentication:
      type: bearer
      token: '{{env.SALESFORCE_SALES_CLOUD_API_KEY}}'
  exposes:
  - type: rest
    namespace: analytics-report-instances-rest
    port: 8080
    description: REST adapter for Salesforce Sales Cloud Salesforce Analytics REST API — Report Instances. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/reports/{reportid}/instances
      name: reports-reportid-instances
      description: REST surface for reports-reportId-instances.
      operations:
      - method: GET
        name: listreportinstances
        description: Salesforce Sales Cloud List report instances
        call: analytics-report-instances.listreportinstances
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: executereportasync
        description: Salesforce Sales Cloud Run a report asynchronously
        call: analytics-report-instances.executereportasync
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/reports/{reportid}/instances/{instanceid}
      name: reports-reportid-instances-instanceid
      description: REST surface for reports-reportId-instances-instanceId.
      operations:
      - method: GET
        name: getreportinstanceresults
        description: Salesforce Sales Cloud Get report instance results
        call: analytics-report-instances.getreportinstanceresults
        with:
          instanceId: rest.instanceId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: analytics-report-instances-mcp
    port: 9090
    transport: http
    description: MCP adapter for Salesforce Sales Cloud Salesforce Analytics REST API — Report Instances. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: salesforce-sales-cloud-list-report
      description: Salesforce Sales Cloud List report instances
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: analytics-report-instances.listreportinstances
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-sales-cloud-run-report
      description: Salesforce Sales Cloud Run a report asynchronously
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: analytics-report-instances.executereportasync
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-sales-cloud-get-report
      description: Salesforce Sales Cloud Get report instance results
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: analytics-report-instances.getreportinstanceresults
      with:
        instanceId: tools.instanceId
      outputParameters:
      - type: object
        mapping: $.