openapi: 3.1.0
info:
  title: Salesforce Analytics (CRM Analytics) REST Actions SOSL API
  description: REST API for accessing and managing CRM Analytics (formerly Tableau CRM / Einstein Analytics) resources including datasets, lenses, dashboards, and dataflows. Enables programmatic access to analytics metadata, query execution, and dashboard management. Uses the Wave API resource at /services/data/vXX.0/wave.
  version: '63.0'
  contact:
    name: Salesforce Developer Support
    url: https://developer.salesforce.com/support
    email: developer@salesforce.com
  license:
    name: Salesforce API Terms of Use
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v63.0/wave
  description: Salesforce production or developer instance
  variables:
    instance:
      default: yourInstance
      description: Your Salesforce instance identifier
security:
- oauth2: []
- bearerAuth: []
tags:
- name: SOSL
  description: Salesforce Object Search Language searches
paths:
  /search:
    get:
      operationId: search
      summary: Execute a SOSL search
      description: Executes a SOSL (Salesforce Object Search Language) search across multiple objects. SOSL uses the Salesforce search index to find records by text, unlike SOQL which uses the database directly.
      tags:
      - SOSL
      parameters:
      - name: q
        in: query
        required: true
        description: The SOSL search string (e.g., FIND {Acme} IN ALL FIELDS RETURNING Account(Id, Name), Contact(Id, Name, Email))
        schema:
          type: string
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResult'
components:
  schemas:
    SObjectRecord:
      type: object
      description: A Salesforce SObject record with attributes metadata and dynamic fields
      properties:
        attributes:
          type: object
          properties:
            type:
              type: string
              description: The API name of the SObject type
            url:
              type: string
              description: The relative REST API URL for this record
          required:
          - type
        Id:
          type: string
          description: The 18-character Salesforce record ID
      additionalProperties: true
    SearchResult:
      type: object
      description: Results from a SOSL search
      properties:
        searchRecords:
          type: array
          items:
            $ref: '#/components/schemas/SObjectRecord'
  securitySchemes:
    oauth2:
      type: oauth2
      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
            wave_api: Access CRM Analytics REST API resources
    bearerAuth:
      type: http
      scheme: bearer