Salesforce

Salesforce Lightning API

The Lightning API from Salesforce — 6 operation(s) for lightning.

GitHub OpenAPI

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /data/v64.0/sobjects/LightningToggleMetrics See who switched between Classic and Lightning · Salesforce Lightning Toggle Metrics #
Ask an LLM
“Which users keep switching back from Lightning Experience to Classic?”
“Can I measure how often people toggle between Classic and Lightning?”
Tell an agent
Show the Lightning toggle metrics for my org.
List users who switched between Salesforce Classic and Lightning.
GET /data/v64.0/sobjects/LightningUsageByBrowserMetrics See the most viewed standard Lightning pages · Salesforce Lightning Usage by Page #
Ask an LLM
“Which standard pages do users view most in Lightning Experience?”
“Can I see page usage metrics for standard Lightning pages?”
Tell an agent
Show the most viewed standard pages in Lightning.
Get Lightning usage metrics for standard pages.
GET /data/v64.0/sobjects/LightningUsageByFlexiPageMetrics See the most viewed custom Lightning pages · Salesforce Lightning Usage by Flexipage #
Ask an LLM
“Which custom Lightning pages built in App Builder get the most views?”
“Can I report on FlexiPage usage?”
Tell an agent
Show the most viewed custom FlexiPages.
Get Lightning usage metrics for my App Builder pages.

Documentation

📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/get_job_info.htm
📖
Authentication
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/bulk_api_2_0_security.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started.htm
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list.htm
📖
Documentation
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/rest-api.html
📖
GettingStarted
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/get-started-spec.html
📖
APIReference
https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_overview.html
📖
Authentication
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/access-token-s2s.html
📖
Documentation
https://developer.salesforce.com/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/salesforce/openapi/salesforce-lightning-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/salesforce/json-schema/salesforce-bulk-job-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/salesforce:salesforce-lightning-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

salesforce-lightning-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Salesforce Lightning API
  description: Find the resources you need to start building.
  contact: {}
  version: '1.0'
servers:
- url: https://login.salesforce.com
  variables: {}
- url: https://id
  variables: {}
- url: https://services
  variables: {}
- url: '{{url}}{{site}}/services/oauth2'
  variables:
    url:
      default: DefaultParameterValue
    site:
      default: DefaultParameterValue
security:
- oauth2:
  - api
tags:
- name: Lightning
paths:
  /data/v64.0/sobjects/LightningToggleMetrics:
    parameters: []
    get:
      tags:
      - Lightning
      summary: Salesforce Lightning Toggle Metrics
      description: 'Return details about users who switched between Salesforce Classic and Lightning Experience.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_togglemetrics.htm'
      operationId: LightningToggleMetrics
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/sobjects/LightningUsageByBrowserMetrics:
    parameters: []
    get:
      tags:
      - Lightning
      summary: Salesforce Lightning Usage by Page
      description: 'Represents standard pages users viewed most frequently in Lightning Experience.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebypagemetrics.htm'
      operationId: LightningUsagebyPage
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/sobjects/LightningUsageByFlexiPageMetrics:
    parameters: []
    get:
      tags:
      - Lightning
      summary: Salesforce Lightning Usage by Flexipage
      description: 'Return details about the custom pages viewed most frequently in Lightning Experience.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebyflexipagemetrics.htm'
      operationId: LightningUsagebyFlexiPage
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: '{DefaultParameterValue}{DefaultParameterValue}/services/oauth2/authorize'
          scopes:
            api: ''