Einstein Discovery REST API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Einstein Discovery REST API Overview
Examples
Get Predictions
Manage Prediction Definitions
Manage Models
Manage Prediction Jobs
Manage Model Refresh Jobs
Query Prediction History
Resources
Requests
Responses
Einstein Discovery REST API Enums
PDF

Manage Model Refresh Jobs

The Einstein Prediction Service provides REST API endpoints to retrieve metadata for model refresh jobs.

Model refresh jobs are configured in Model Manager. To set up model refresh jobs, see Configure Automatic Model Refresh for a Prediction Definition.

Get Prediction Refresh Jobs

GET /smartdatadiscovery​/refresh-jobs
The following code shows an example Smart Data Discovery Refresh Job Collection response.
{
  "refreshJobs" : [ {
    "createdBy" : {
      "id" : "005B0000006DdetIAC",
      "name" : "YourUserName",
      "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B0000000Eqe5/T"
    },
    "createdDate" : "2020-09-09T16:16:39.000Z",
    "endTime" : "2020-09-09T16:20:02.000Z",
    "id" : "1OXB00000008OIPOA2",
    "refreshTarget" : {
      "id" : "1ORB0000000TNXyOAO"
     },
    "refreshTasksUrl" : "/services/data/v52.0/smartdatadiscovery/refresh-jobs/1OXB00000008OIPOA2/refresh-tasks",
    "startTime" : "2020-09-09T16:16:41.000Z",
    "status" : "Success", 
    "type" : "UserTriggered",        "url" : "/services/data/v52.0/smartdatadiscovery/refresh-jobs/1OXB00000008OIPOA2"
  } ],
  "totalSize" : 1,
  "url" : "/services/data/v52.0/smartdatadiscovery/refresh-jobs"
}

Get Prediction Refresh Job Details

GET /smartdatadiscovery/refresh-jobs​/<refreshJobId>
The following code shows an example response.
{
  "refreshJobs" : [ {
    "createdBy" : {
      "id" : "005B0000006DdetIAC",
      "name" : "YourUserName",
      "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B0000000Eqe5/T"
    },
    "createdDate" : "2020-09-09T16:16:39.000Z",
    "endTime" : "2020-09-09T16:20:02.000Z",
    "id" : "1OXB00000008OIPOA2",
    "refreshTarget" : {
      "id" : "1ORB0000000TNXyOAO"
    },
    "refreshTasksUrl" : "/services/data/v52.0/smartdatadiscovery/refresh-jobs/1OXB00000008OIPOA2/refresh-tasks",
    "startTime" : "2020-09-09T16:16:41.000Z",
    "status" : "Success",
    "type" : "UserTriggered",
    "url" : "/services/data/v52.0/smartdatadiscovery/refresh-jobs/1OXB00000008OIPOA2"
  }

Get Prediction Refresh Job Task Details

GET /smartdatadiscovery/refresh-jobs​/<refreshJobId>​/refresh-tasks
The following code shows an example Smart Data Discovery Refresh Job response.
{
  "refreshTasks" : [ {
    "createdBy" : {
      "id" : "005B0000006DdetIAC",
      "name" : "YourUserName",
      "profilePhotoUrl" : "https://MyDomainName.file.force.com/profilephoto/729B0000000Eqe5/T"
    },
    "createdDate" : "2020-09-09T16:16:39.000Z",
    "endTime" : "2020-09-09T16:19:54.000Z",
    "id" : "1OxB00000008OIKKA2",
    "refreshTarget" : {        
      "id" : "1OtB0000000TNdAKAW",
      "label" : "IsWon",
      "name" : "IsWon"
    },
    "refreshedAIModel" : {
      "id" : "1OTB0000000PDeBOAW" 
    },
    "source" : {   
      "story" : {
        "id" : "1Y3B00000004HOCKA2"
      },
      "storyVersion" : {
        "id" : "9B4B00000008UrEKAU"
      }
    },
    "startTime" : "2020-09-09T16:16:45.000Z",
    "status" : "Success"
  } ],
  "totalSize" : 1,
  "url" : "/services/data/v52.0/smartdatadiscovery/refresh-jobs/1OXB00000008OIPOA2/refresh-tasks"
}