openapi: 3.1.0
info:
  title: Salesforce Sales Cloud Salesforce Analytics REST Change Events Dashboards API
  description: Access Salesforce reports, dashboards, and analytics data programmatically. Enables embedding analytics into custom applications, automating report generation, running reports synchronously or asynchronously, and managing dashboard components and filters.
  version: 59.0.0
  termsOfService: https://www.salesforce.com/company/legal/agreements/
  contact:
    name: Salesforce Developer Support
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Master Subscription Agreement
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v59.0/analytics
  description: Salesforce Production or Developer Edition
  variables:
    instance:
      default: yourInstance
      description: Your Salesforce instance identifier
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Dashboards
  description: Operations for listing, describing, and refreshing dashboards
paths:
  /dashboards:
    get:
      operationId: listDashboards
      summary: Salesforce Sales Cloud List dashboards
      description: Returns a list of recently used dashboards. Each dashboard in the list includes the dashboard ID, name, URL, and folder information.
      tags:
      - Dashboards
      responses:
        '200':
          description: Successfully retrieved list of dashboards
          content:
            application/json:
              schema:
                type: object
                properties:
                  dashboards:
                    type: array
                    items:
                      $ref: '#/components/schemas/DashboardListItem'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /dashboards/{dashboardId}:
    get:
      operationId: getDashboard
      summary: Salesforce Sales Cloud Get dashboard metadata and results
      description: Returns the metadata and cached results for the specified dashboard, including component data, status, and filter information.
      tags:
      - Dashboards
      parameters:
      - $ref: '#/components/parameters/dashboardId'
      responses:
        '200':
          description: Successfully retrieved dashboard
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: refreshDashboard
      summary: Salesforce Sales Cloud Refresh a dashboard
      description: Refreshes the specified dashboard by re-running all component reports. Dashboard refresh requests are limited to 200 per hour.
      tags:
      - Dashboards
      parameters:
      - $ref: '#/components/parameters/dashboardId'
      responses:
        '200':
          description: Dashboard refreshed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteDashboard
      summary: Salesforce Sales Cloud Delete a dashboard
      description: Deletes the specified dashboard.
      tags:
      - Dashboards
      parameters:
      - $ref: '#/components/parameters/dashboardId'
      responses:
        '204':
          description: Dashboard deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /dashboards/{dashboardId}/status:
    get:
      operationId: getDashboardStatus
      summary: Salesforce Sales Cloud Get dashboard refresh status
      description: Returns the status of the most recent refresh for the specified dashboard, including component-level status information.
      tags:
      - Dashboards
      parameters:
      - $ref: '#/components/parameters/dashboardId'
      responses:
        '200':
          description: Successfully retrieved dashboard status
          content:
            application/json:
              schema:
                type: object
                properties:
                  componentStatus:
                    type: array
                    items:
                      type: object
                      properties:
                        componentId:
                          type: string
                        refreshDate:
                          type: string
                          format: date-time
                        refreshStatus:
                          type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    DashboardListItem:
      type: object
      description: Summary information about a dashboard
      properties:
        id:
          type: string
        name:
          type: string
        statusUrl:
          type: string
        url:
          type: string
        folderId:
          type: string
        folderName:
          type: string
    ErrorResponse:
      type: array
      items:
        $ref: '#/components/schemas/ApiError'
    Dashboard:
      type: object
      description: Full dashboard representation with components and data
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
          nullable: true
        folderId:
          type: string
        folderName:
          type: string
        runningUser:
          type: object
          properties:
            displayName:
              type: string
            id:
              type: string
        components:
          type: array
          items:
            type: object
            properties:
              componentData:
                type: object
              footer:
                type: string
                nullable: true
              header:
                type: string
                nullable: true
              id:
                type: string
              reportId:
                type: string
              type:
                type: string
    ApiError:
      type: object
      properties:
        errorCode:
          type: string
        message:
          type: string
  responses:
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    dashboardId:
      name: dashboardId
      in: path
      required: true
      description: The 15 or 18 character Salesforce dashboard ID
      schema:
        type: string
  securitySchemes:
    oauth2:
      type: oauth2
      description: Salesforce OAuth 2.0 authentication
      flows:
        authorizationCode:
          authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
          tokenUrl: https://login.salesforce.com/services/oauth2/token
          scopes:
            api: Access and manage your Salesforce data
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth 2.0 Access Token
externalDocs:
  description: Salesforce Reports and Dashboards REST API Developer Guide
  url: https://developer.salesforce.com/docs/atlas.en-us.api_analytics.meta/api_analytics/sforce_analytics_rest_api_intro.htm