v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB

Salesforce Reports

View Data Restore Activity Report

View the status and details of all restore jobs for configured Salesforce instances.

Note: This API is subject to continuous improvements. We recommend regularly reviewing this documentation for the latest updates and schema changes.

post/msp/reporting/v2/reports/mspSfdcDataRestoreActivity

Headers

Authorizationstring required

Specify the Bearer access token

Request body

pageTokenstring

Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.

Example request

{
  "filters": {
    "filterBy": [
      {
        "fieldName": "salesforceUser",
        "operator": "EQUAL"
      }
    ]
  }
}

Response

Success

lastSyncTimestampstring date-time

The time stamp until which the report data was returned. The time is in the UTC time zone.

filtersobject

Filters applied on the report

nextPageTokenstring

The token to access the next page of results. This parameter will be empty for the last page of the results. This token is valid for 5 minutes.

Example response

{
  "data": [
    {
      "accountName": "Customer Account Name",
      "globalCustomerId": "bde7f8c2-d063-4a4a-9a8f-c2ea5aff42f3-198",
      "customerName": "Acme Corporation",
      "backupDefinitionName": "DR_TC06_Backup",
      "dataTemplateName": "DR_TC06_Template",
      "destinationOrganization": "source001",
      "endTime": "2025-01-29T22:00:00Z",
      "projectName": "DataRestoreRegression",
      "recordsRestored": 10,
      "restoreState": "Completed",
      "salesforceUser": "sfdc2_sanity sfdc2_sanity",
      "snapshotTimestamp": "2025-01-28T22:00:00Z",
      "startTime": "2025-01-28T22:00:00Z",
      "totalRecordCount": 10,
      "dcpUniqueKey": "60d66ec60c0e061e88db0448a1bfc609c1db4cbe336b9b64bb5b0cd1113694e3"
    }
  ]
}