openapi: 3.1.0
info:
  title: Salesforce Sales Cloud Salesforce Analytics REST Change Events Feeds 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: Feeds
  description: Chatter feed operations
paths:
  /chatter/feeds/news/me/feed-elements:
    get:
      operationId: getNewsFeed
      summary: Salesforce Sales Cloud Get news feed for current user
      description: Returns the news feed for the current user. The news feed includes updates from people and records the user follows, groups the user belongs to, and the user's own posts.
      tags:
      - Feeds
      parameters:
      - name: pageSize
        in: query
        description: Number of items per page (default 25, max 100)
        required: false
        schema:
          type: integer
          default: 25
          maximum: 100
      - name: pageToken
        in: query
        description: Token for the next page of results
        required: false
        schema:
          type: string
      - name: sort
        in: query
        description: Sort order for feed elements
        required: false
        schema:
          type: string
          enum:
          - CreatedDateDesc
          - LastModifiedDateDesc
      responses:
        '200':
          description: Successfully retrieved news feed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeedElementPage'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /chatter/feeds/record/{recordId}/feed-elements:
    get:
      operationId: getRecordFeed
      summary: Salesforce Sales Cloud Get feed for a specific record
      description: Returns the feed associated with the specified record. The record feed includes posts, comments, and tracked changes for the record.
      tags:
      - Feeds
      parameters:
      - name: recordId
        in: path
        required: true
        description: The ID of the record
        schema:
          type: string
      - name: pageSize
        in: query
        required: false
        schema:
          type: integer
          default: 25
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved record feed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeedElementPage'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    FeedElementPage:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/FeedElement'
        nextPageUrl:
          type: string
          nullable: true
        updatesUrl:
          type: string
          nullable: true
    FeedElement:
      type: object
      properties:
        id:
          type: string
        body:
          $ref: '#/components/schemas/MessageBody'
        capabilities:
          type: object
          properties:
            comments:
              type: object
              properties:
                total:
                  type: integer
            chatterLikes:
              type: object
              properties:
                total:
                  type: integer
        createdDate:
          type: string
          format: date-time
        actor:
          $ref: '#/components/schemas/UserSummary'
        feedElementType:
          type: string
          enum:
          - FeedItem
          - Bundle
        header:
          type: object
          properties:
            text:
              type: string
        parent:
          type: object
          properties:
            id:
              type: string
            type:
              type: string
        type:
          type: string
        url:
          type: string
    ErrorResponse:
      type: array
      items:
        $ref: '#/components/schemas/ApiError'
    ApiError:
      type: object
      properties:
        errorCode:
          type: string
        message:
          type: string
    UserSummary:
      type: object
      properties:
        companyName:
          type: string
          nullable: true
        displayName:
          type: string
        id:
          type: string
        name:
          type: string
        photo:
          type: object
          properties:
            smallPhotoUrl:
              type: string
            mediumPhotoUrl:
              type: string
        title:
          type: string
          nullable: true
        type:
          type: string
        url:
          type: string
    MessageBody:
      type: object
      properties:
        messageSegments:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                - Text
                - Mention
                - Hashtag
                - Link
              text:
                type: string
              id:
                type: string
              url:
                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'
  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