{ "info": { "name": "Analytics API Postman Collection", "description": "The Salesforce Platform APIs collection contains 250+ requests and example responses for the following APIs:\n\n
Auth
Bulk (v1 & v2)
Composite
Connect
CPQ
Einstein Prediction Service
Event Platform
GraphQL
Loyalty Management
Metadata
REST
Subscription Management
Tooling
UI
\n\n**⚠️ Disclaimer:** this collection is not covered by Salesforce support and SLAs.\n\n## Get Started\n\nClick the button below and follow the instructions from the following sections: \n[\"Run](https://god.gw.postman.com/run-collection/12721794-67cb9baa-e0da-4986-957e-88d8734647e2?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D12721794-67cb9baa-e0da-4986-957e-88d8734647e2%26entityType%3Dcollection%26workspaceId%3D34382471-0c97-40e5-a206-f947271665c4)\n\n### New Salesforce Users\n\nIf you are new to Salesforce, start by obtaining a free [Developer Edition Org](https://developer.salesforce.com/signup) then, follow the rest of the instructions from this documentation.\n\nYou can also watch our [Beginner's Mind YouTube series](https://www.youtube.com/playlist?list=PLgIMQe2PKPSKJ33M6CX-VLvgax7Xptcmz) for a tour of the Salesforce Platform (the last episode focuses on APIs).\n\n### New Postman Users\n\n

If you are new to Postman, complete this Trailhead project to setup the collection: Quick Start: Connect Postman to Salesforce.

\"\"

If you want to learn more about Postman in general, you can also complete this optional Trailhead badge: Postman API Client.

\"\"
\n\n### Regular Postman Users\n\nIf you are already familiar with Postman, here are the minimal getting started steps:\n\n1. If using Postman Web UI, follow these [steps to set up CORS](https://github.com/forcedotcom/postman-salesforce-apis/blob/master/install-with-web.md#enable-cors-in-salesforce) in your Salesforce Org. This is not required when working with the Postman Desktop app.\n \n2. Assign the following value to the `clientId` collection variable (this is a temporary step due to a Postman bug):\n\n```\n{{vault:salesforce-consumer-key}}\n```\n \n3. Assign a value to the `url` collection variable based on your Salesforce Org type:\n \n | URL | Org Type |\n | --- | --- |\n | `https://test.salesforce.com` | Sandboxes or Scratch orgs. |\n | `https://login.salesforce.com` | Production, Trailhead Playground and Developer Edition orgs. |\n | Custom My Domain base URL | Org with a custom domain. |\n \n4. Click **Get New Access Token** from the collection's **Authorization** tab.\n \n5. When prompted to do so, log in to your Salesforce org and allow access to \"Salesforce APIs Collection for Postman\".\n \n6. Copy the value of the `instance_url` field from the token details view.\n \n7. Click **Use Token**.\n \n8. Save the value that you copied in the `_endpoint` variable.\n \n9. Click **Save** and you're good to go!\n \n\n## Resources\n\nCheck out [the documentation](https://github.com/forcedotcom/postman-salesforce-apis) for videos and extra information on how to install, update and contribute to the collection.\n\nWe also have an [demo video](https://www.youtube.com/watch?v=W-IwW6RM4F0) on how to setup the collection.\n\n\n\nReport issues and ask questions [here](https://github.com/forcedotcom/postman-salesforce-apis/issues).\n\n## Variables Reference\n\nThe collection relies on the following variables:\n\n| Variable | Description |\n| --- | --- |\n| `_endpoint` | Your Salesforce Org's instance URL. |\n| `url` | The URL used for logging in. Either:
\\- `https://test.salesforce.com` for sandboxes or Scratch orgs
\\- `https://login.salesforce.com` for production, Trailhead Playground and Developer Edition orgs
\\- your custom My Domain base URL. |\n| `version` | The Salesforce API version (e.g.: 50.0). |\n| `username` | Your username. |\n| `password` | Your password. |\n| `secretToken` | Your personal [security token](https://help.salesforce.com/articleView?id=user_security_token.htm). |\n| `clientId` | Connected App client Id. |\n| `clientSecret` | Connected App client secret. |\n| `redirectUrl` | Connected App redirect URL for OAuth 2.0. |\n| `initAccessToken` | Initial access token for dynamic Connected App registration. |\n| `site` | Community suffix when connecting with an Experience Cloud user. |\n\nOnly a few of these variables are mandatory. The authentication requests will automatically register and set extra \"private\" variables identified with a `_` prefix (e.g.: `_accessToken`, `_orgId`, `_userId`...).\n\nExtracted from tests/contract/salesforce.postman_collection.json for analytics_api.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "3724683", "_collection_link": "https://go.postman.co/collection/3724683-db7b315f-fcf0-460f-acbc-3ceca85d09a6?source=collection_link" }, "item": [ { "name": "Einstein Prediction Service", "item": [ { "name": "Predict", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"predictionDefinition\": \"\",\n \"type\": \"RawData\",\n \"columnNames\": [\n \"Quantity\",\n \"Category\",\n \"Sub_Category\",\n \"Sales\",\n \"Profit_per_Order\"\n ],\n \"rows\": [\n [\n \"2\",\n \"Furniture\",\n \"Chairs\",\n \"300\",\n \"10\"\n ]\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predict", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "smartdatadiscovery", "predict" ] }, "description": "Get available prediction definitions." }, "response": [ { "name": "Predict", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"predictionDefinition\": \"1OR5Y0000010ws8WAA\",\n \"type\": \"RawData\",\n \"columnNames\": [\n \"Quantity\",\n \"Category\",\n \"Sub_Category\",\n \"Sales\",\n \"Profit_per_Order\"\n ],\n \"rows\": [\n [\n \"2\",\n \"Furniture\",\n \"Chairs\",\n \"300\",\n \"10\"\n ]\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predict", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "smartdatadiscovery", "predict" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 04 Mar 2021 13:53:39 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=31536002; includeSubDomains" }, { "key": "Expect-CT", "value": "max-age=86400, report-uri=\"https://a.forcesslreports.com/Expect-CT-report/00D5Y000001crJvm\"" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"predictionDefinition\": \"1OR5Y0000010ws8\",\n \"predictions\": [\n {\n \"model\": {\n \"id\": \"1Ot5Y0000010wzNSAQ\"\n },\n \"prediction\": {\n \"middleValues\": [],\n \"total\": 88.52494255547592\n },\n \"prescriptions\": [],\n \"status\": \"Success\"\n }\n ],\n \"settings\": {\n \"maxMiddleValues\": 0,\n \"maxPrescriptions\": 0,\n \"prescriptionImpactPercentage\": 0\n }\n}" } ] }, { "name": "Prediction definitions", "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "smartdatadiscovery", "predictionDefinitions" ] }, "description": "Get available prediction definitions." }, "response": [ { "name": "Prediction definitions", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "smartdatadiscovery", "predictionDefinitions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 04 Mar 2021 13:45:15 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=31536002; includeSubDomains" }, { "key": "Expect-CT", "value": "max-age=86400, report-uri=\"https://a.forcesslreports.com/Expect-CT-report/00D5Y000001crJvm\"" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"nextPageUrl\": null,\n \"predictionDefinitions\": [\n {\n \"countOfActiveModels\": 1,\n \"countOfModels\": 1,\n \"createdBy\": {\n \"id\": \"0055Y00000DWwAIQA1\",\n \"name\": \"Philippe Ozil\",\n \"profilePhotoUrl\": \"https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T\"\n },\n \"createdDate\": \"2021-03-04T13:37:02.000Z\",\n \"id\": \"1OR5Y0000010ws8WAA\",\n \"label\": \"Sales_per_Customer\",\n \"lastModifiedBy\": {\n \"id\": \"0055Y00000DWwAIQA1\",\n \"name\": \"Philippe Ozil\",\n \"profilePhotoUrl\": \"https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T\"\n },\n \"lastModifiedDate\": \"2021-03-04T13:37:02.000Z\",\n \"modelsUrl\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models\",\n \"name\": \"Sales_per_Customer\",\n \"outcome\": {\n \"goal\": \"Maximize\",\n \"label\": \"Sales per Customer\",\n \"name\": \"Sales_per_Customer\"\n },\n \"predictionType\": \"Regression\",\n \"status\": \"Enabled\",\n \"url\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA\"\n }\n ],\n \"totalSize\": 1,\n \"url\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions?pageSize=25\"\n}" } ] }, { "name": "Prediction definition metadata", "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "smartdatadiscovery", "predictionDefinitions", ":PREDICTION_DEFINITION_ID" ], "variable": [ { "key": "PREDICTION_DEFINITION_ID", "value": "" } ] }, "description": "Get available prediction definitions." }, "response": [ { "name": "Prediction definition metadata", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/1OR5Y0000010ws8WAA", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "smartdatadiscovery", "predictionDefinitions", "1OR5Y0000010ws8WAA" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 04 Mar 2021 13:45:58 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=31536002; includeSubDomains" }, { "key": "Expect-CT", "value": "max-age=86400, report-uri=\"https://a.forcesslreports.com/Expect-CT-report/00D5Y000001crJvm\"" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"countOfActiveModels\": 1,\n \"countOfModels\": 1,\n \"createdBy\": {\n \"id\": \"0055Y00000DWwAIQA1\",\n \"name\": \"Philippe Ozil\",\n \"profilePhotoUrl\": \"https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T\"\n },\n \"createdDate\": \"2021-03-04T13:37:02.000Z\",\n \"id\": \"1OR5Y0000010ws8WAA\",\n \"label\": \"Sales_per_Customer\",\n \"lastModifiedBy\": {\n \"id\": \"0055Y00000DWwAIQA1\",\n \"name\": \"Philippe Ozil\",\n \"profilePhotoUrl\": \"https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T\"\n },\n \"lastModifiedDate\": \"2021-03-04T13:37:02.000Z\",\n \"modelsUrl\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models\",\n \"name\": \"Sales_per_Customer\",\n \"outcome\": {\n \"goal\": \"Maximize\",\n \"label\": \"Sales per Customer\",\n \"name\": \"Sales_per_Customer\"\n },\n \"predictionType\": \"Regression\",\n \"status\": \"Enabled\",\n \"url\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA\"\n}" } ] }, { "name": "Prediction models", "request": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID/models", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "smartdatadiscovery", "predictionDefinitions", ":PREDICTION_DEFINITION_ID", "models" ], "variable": [ { "key": "PREDICTION_DEFINITION_ID", "value": "" } ] }, "description": "Get available prediction definitions." }, "response": [ { "name": "Prediction models", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/1OR5Y0000010ws8WAA/models", "host": [ "{{_endpoint}}" ], "path": [ "services", "data", "v{{version}}", "smartdatadiscovery", "predictionDefinitions", "1OR5Y0000010ws8WAA", "models" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 04 Mar 2021 13:48:31 GMT" }, { "key": "Strict-Transport-Security", "value": "max-age=31536002; includeSubDomains" }, { "key": "Expect-CT", "value": "max-age=86400, report-uri=\"https://a.forcesslreports.com/Expect-CT-report/00D5Y000001crJvm\"" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-XSS-Protection", "value": "1; mode=block" }, { "key": "X-Robots-Tag", "value": "none" }, { "key": "Cache-Control", "value": "no-cache,must-revalidate,max-age=0,no-store,private" }, { "key": "Content-Type", "value": "application/json;charset=UTF-8" }, { "key": "Vary", "value": "Accept-Encoding" }, { "key": "Content-Encoding", "value": "gzip" }, { "key": "Transfer-Encoding", "value": "chunked" } ], "cookie": [], "body": "{\n \"models\": [\n {\n \"createdBy\": {\n \"id\": \"0055Y00000DWwAIQA1\",\n \"name\": \"Philippe Ozil\",\n \"profilePhotoUrl\": \"https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T\"\n },\n \"createdDate\": \"2021-03-04T13:37:03.000Z\",\n \"fieldMappingList\": [\n {\n \"modelField\": {\n \"label\": \"Category\",\n \"name\": \"Category\",\n \"type\": \"Text\"\n }\n },\n {\n \"modelField\": {\n \"label\": \"Sales\",\n \"name\": \"Sales\",\n \"type\": \"Number\"\n }\n },\n {\n \"modelField\": {\n \"label\": \"Profit per Order\",\n \"name\": \"Profit_per_Order\",\n \"type\": \"Number\"\n }\n },\n {\n \"modelField\": {\n \"label\": \"Sub-Category\",\n \"name\": \"Sub_Category\",\n \"type\": \"Text\"\n }\n },\n {\n \"modelField\": {\n \"label\": \"Quantity\",\n \"name\": \"Quantity\",\n \"type\": \"Number\"\n }\n }\n ],\n \"filters\": [],\n \"historyUrl\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models/1Ot5Y0000010wzNSAQ/histories\",\n \"id\": \"1Ot5Y0000010wzNSAQ\",\n \"isRefreshEnabled\": false,\n \"label\": \"superstore-orders\",\n \"lastModifiedBy\": {\n \"id\": \"0055Y00000DWwAIQA1\",\n \"name\": \"Philippe Ozil\",\n \"profilePhotoUrl\": \"https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T\"\n },\n \"lastModifiedDate\": \"2021-03-04T13:37:03.000Z\",\n \"model\": {\n \"id\": \"1OT5Y0000010zlzWAA\"\n },\n \"modelType\": \"Regression\",\n \"name\": \"superstore_orders\",\n \"predictionDefinitionUrl\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA\",\n \"prescribableFields\": [\n {\n \"customDefinitions\": [],\n \"field\": {\n \"label\": \"Quantity\",\n \"name\": \"Quantity\",\n \"type\": \"Number\"\n }\n }\n ],\n \"sortOrder\": 0,\n \"status\": \"Enabled\",\n \"url\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models/1Ot5Y0000010wzNSAQ\"\n }\n ],\n \"totalSize\": 1,\n \"url\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models\"\n}" } ] } ], "description": "After deploying models with Einstein Discovery, use the Einstein Prediction Service API to embed your predictions into any website or application.\n\n⚠️ Einstein Discovery requires either the Einstein Analytics Plus license or the Einstein Predictions license, both of which are available for an extra cost.\n\n📚 [Einstein Prediction Service documentation](https://help.salesforce.com/articleView?id=sf.bi_edd_prediction_service.htm&type=5)." } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "grant_type", "value": "implicit", "type": "string" }, { "key": "scope", "value": "api", "type": "string" }, { "key": "addTokenTo", "value": "header", "type": "string" }, { "key": "client_authentication", "value": "body", "type": "string" }, { "key": "password", "value": "{{password}}", "type": "string" }, { "key": "username", "value": "{{username}}", "type": "string" }, { "key": "challengeAlgorithm", "value": "S256", "type": "string" }, { "key": "clientSecret", "value": "{{clientSecret}}", "type": "string" }, { "key": "clientId", "value": "{{clientId}}", "type": "string" }, { "key": "accessTokenUrl", "value": "{{url}}{{site}}/services/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "{{url}}{{site}}/services/oauth2/authorize", "type": "string" }, { "key": "tokenName", "value": "access_token", "type": "string" }, { "key": "useBrowser", "value": true, "type": "boolean" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "requests": {}, "exec": [ "// Specifying Postman as the client for Salesforce logs ", "pm.request.headers.add({key: 'Sforce-Call-Options', value: 'client=postman' });", "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "requests": {}, "exec": [ "" ] } } ], "variable": [ { "key": "url", "value": "https://login.salesforce.com" }, { "key": "version", "value": "64.0" }, { "key": "username", "value": "" }, { "key": "password", "value": "" }, { "key": "secretToken", "value": "" }, { "key": "clientId", "value": "{{vault:salesforce-consumer-key}}" }, { "key": "clientSecret", "value": "" }, { "key": "redirectUrl", "value": "" }, { "key": "initAccessToken", "value": "" }, { "key": "site", "value": "" }, { "key": "_accessToken", "value": "" }, { "key": "_endpoint", "value": "" }, { "key": "_userId", "value": "" }, { "key": "_appId", "value": "" }, { "key": "_consumerId", "value": "" }, { "key": "_tokenId", "value": "" }, { "key": "_orgId", "value": "" }, { "key": "_jobId", "value": "" }, { "key": "webstoreId", "value": "" }, { "key": "_deviceCode", "value": "" } ] }