Backup Activity Report

View the status and details of the backup activities of configured Salesforce instances.

URL

https://apis.druva.com/platform/reporting/v1/reports/sfdcBackupActivityReport

Request type

HTTP POST

Sample cURL request

curl --location --request POST 'https://apis.druva.com/platform/reporting/v1/reports/sfdcBackupActivity' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--data-raw '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "salesforceUser",
        "operator": "EQUAL",
        "value": "sfdc2_sanity sfdc2_sanity"
      },
      {
        "fieldName": "backupType",
        "operator": "EQUAL",
        "value": "Full"
      }
    ]
  },
  "pageToken": ""
}

To try out this API, refer API reference.

📘
Note
On the API reference page, select sfdcBackupActivity as the report ID under path params to test this API endpoint.

Sample responses

{
    "data": [
        {
            "backupType": "Ful",
            "completedTime": null,
            "definitionName": "source001_definition_2023_07_19_00_29_3",
            "endTime": "2023-07-18T19:07:23.986Z",
            "organizationID": "00D1100000C9ysvEA",
            "organizationName": "source001",
            "projectName": "test Project",
            "salesforceUser": "sfdc2_sanity sfdc2_sanity",
            "startTime": null,
            "status": "Completed",
            "statusDetails": null,
            "totalBackupSize": 2200
        },
        {
            "backupType": "Full",
            "completedTime": null,
            "definitionName": "source001_definition_2022_05_29_00_43_5",
            "endTime": "2022-05-28T19:16:17.087Z",
            "organizationID": "00D1100000C9ysvEAB",
            "organizationName": "source001",
            "projectName": "test Project",
            "salesforceUser": "sfdc2_sanity sfdc2_sanity",
            "startTime": null,
            "status": "Complete",
            "statusDetail": null,
            "totalBackupSize": 2200
        } ],
    "filters": {
        "pageSize": 100,
        "filterBy": [
            {
                "fieldName": "salesforceUser",
                "value": "sfdc2_sanity sfdc2_sanity",
                "operator": "EQUA"
            },
            {
                "fieldName": "backupType",
                "value": "Full",
                "operator": "EQUA"
            }
        ]
    },
    "lastSyncTimestamp": "2025-01-28T06:23:46Z",
    "nextPageToken": "ZGE4ZWYwYzctNDEwZi00MTVjLWJhNzgtMTFiYzQzMzA2ODMy"
}

Filed	Table	Description
backupType	string	Backup type of activity. Example - Incremental, Full
completedTime	date-time	Backup job completion time. The time is in the UTC zone. Example: For Jan 28, 2025 10 PM: 2025-01-28T22:00:00Z
definitionName	string	The name of the backup definition to which the activity belongs
endTime	date-time	End time in UTC format until record changes captured in each backup job must be identified. Example: For Jan 29, 2025 10 PM: 2025-01-29T22:00:00Z
organizationID	string	Salesforce organization ID
projectName	string	The name of the project to which the activity belongs
salesforceUser	string	The name of the salesforce user who initiated the activity
startTime	date-time	Start time in UTC format from where record changes captured in each backup job needs to be identified. Example: For Jan 28, 2025 10 PM: 2025-01-28T22:00:00Z
organizationName	string	The name of the salesforce organization to which the activity belongs
status	string	Backup job status of the activity
statusDetails	string	Error details if any
totalBackupSize	integer	Total backup data size of the activity in bytes
filters	object	Filters applied on the report
nextPageToken	string	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

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code
data	object	Data of the error
message	string	Error message
retryable	boolean	Can retry the API call (true for yes and false for no.)

Data Restore Activity Report

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

URL

https://apis.druva.com/platform/reporting/v1/reports/sfdcDataRestoreActivityReport

Request type

HTTP POST

Sample cURL request

"curl --location --request POST 'https://apis.druva.com/platform/reporting/v1/reports/sfdcDataRestoreActivity' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--data-raw '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "salesforceUser",
        "operator": "EQUAL",
        "value": "sfdc2_sanity sfdc2_sanity"
      },
      {
        "fieldName": "dataTemplateName",
        "operator": "EQUAL",
        "value": "DR_TC06_Template"
      }
    ]
  },
  "pageToken":""
}

To try out this API, refer API reference.

📘
Note
On the API reference page, select sfdcBackupActivity as the report ID under path params to test this API.

Sample responses

{
    "data": [
        {
            "backupDefinitionName": "DR_TC06_Backup",
            "dataTemplateName": "DR_TC06_Template",
            "destinationOrganization": "source001",
            "endTime": "2024-04-03T12:26:46.311Z",
            "isDeleted": null,
            "projectName": "DataRestoreRegression",
            "recordsRestored": 10,
            "restoreState": "Completed",
            "salesforceUser": "sfdc2_sanity sfdc2_sanity",
            "snapshotTimestamp": "2024-04-03T12:25:29.983Z",
            "startTime": "2024-04-03T12:26:43.594Z",
            "statusDetails": "",
            "totalRecordCount": 10
        },
        {
            "backupDefinitionName": "DR_TC06_Backup",
            "dataTemplateName": "DR_TC06_Template",
            "destinationOrganization": "source001",
            "endTime": "2024-06-10T17:50:39.904Z",
            "isDeleted": null,
            "projectName": "DataRestoreRegression",
            "recordsRestored": 10,
            "restoreState": "Completed",
            "salesforceUser": "sfdc2_sanity sfdc2_sanity",
            "snapshotTimestamp": "2024-06-10T17:49:35.096Z",
            "startTime": "2024-06-10T17:50:36.424Z",
            "statusDetails": "",
            "totalRecordCount": 10
        }, ],
    "filters": {
        "pageSize": 100,
        "filterBy": [
            {
                "fieldName": "salesforceUser",
                "value": "sfdc2_sanity sfdc2_sanity",
                "operator": "EQUAL"
            },
            {
                "fieldName": "dataTemplateName",
                "value": "DR_TC06_Template",
                "operator": "EQUAL"
            }
        ]
    },
    "lastSyncTimestamp": "2025-01-28T09:20:01Z",
    "nextPageToken":""
}

Filed	Table	Description
dataTemplateName	string	Data template name of the Activity
isDeleted	integer	Flag to filter out deleted data template
salesforceUser	string	The name of the salesforce user who has initiated the activity
projectName	string	The name of the project to which the activity belongs
restoreState	string	Restore the status of the activity
startTime	date-time	Start time of the data restore task. The time is in the UTC zone. Example: For Jan 28, 2025 10 PM: 2025-01-28T22:00:00Z
endTime	date-time	End time of the data restore task. The time is in the UTC zone. Example: For Jan 28, 2025 10 PM: 2025-01-28T22:00:00Z
totalRecordCount	integer	The total number of records identified for restore as part of the activity
recordsRestored	integer	Count of the records restored as part of the activity
destinationOrganization	string	The Name of the destination organization selected for restore as part of the activity.
statusDetails	string	Error details if any
backupDefinitionName	string	The name of the backup definition from which data is being restored
snapshotTimestamp	date-time	Backup snapshot timestamp. The time is in the UTC zone. Example: For Jan 28, 2025 10 PM: 2025-01-28T22:00:00Z
filters	object	Filters applied on the report
nextPageToken	string	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

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code
data	object	Data of the error
message	string	Error message
retryable	boolean	Can retry the API call (true for yes and false for no.)

Archival Activity Report

View the details of all the data Archival activities for configured Salesforce instances.

URL

https://apis.druva.com/platform/reporting/v1/reports/sfdcArchivalActivityReport

Request type

HTTP POST

Sample cURL request

"curl --location --request POST 'https://apis.druva.com/platform/reporting/v1/reports/sfdcArchivalActivity' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--data-raw '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "salesforceUser",
        "operator": "EQUAL",
        "value": "sfdc2_sanity sfdc2_sanity"
      }
    ]
  },
  "pageToken": ""
}

To try out this API, refer API reference.

📘
Note
On the API reference page, select sfdcArchivalActivity as the report ID under path params to test this API.

Sample responses

{
    "data": [
        {
            "archivalSetName": "source001 archival_set_2024_08_27_00_59_59",
            "endTime": "2024-08-26T19:30:25.000Z",
            "fileSize": 0,
            "organizationID": "00D1100000C9ysvEAB",
            "organizationName": "source001",
            "projectName": "My First Project",
            "salesforceUser": "sfdc2_sanity sfdc2_sanity",
            "startTime": "2024-08-26T19:30:16.000Z",
            "status": "Completed",
            "statusDetails": null,
            "totalRecords": 100
        },
        {
            "archivalSetName": "source001 archival_set_2024_08_27_01_02_06",
            "endTime": "2024-08-26T19:32:31.000Z",
            "fileSize": 0,
            "organizationID": "00D1100000C9ysvEAB",
            "organizationName": "source001",
            "projectName": "My First Project",
            "salesforceUser": "sfdc2_sanity sfdc2_sanity",
            "startTime": "2024-08-26T19:32:21.000Z",
            "status": "Completed",
            "statusDetails": null,
           "totalRecords": 30
        }, ],
    "filters": {
        "pageSize": 100,
        "filterBy": [
            {
                "fieldName": "salesforceUser",
                "value": "sfdc2_sanity sfdc2_sanity",
                "operator"": "EQUAL"
            }
        ]
    },
    "lastSyncTimestamp": "2025-01-28T09:29:30Z",
    "nextPageToken": "NGVhY2I4M2YtZjA2Ni00NmFjLWFmYWYtN2E3YTkwNTI5NDNl"
}

Filed	Table	Description
startTime	date-time	Start Time of the archival task. The time is in the UTC zone. Example: For Jan 28, 2025 10 PM: 2025-01-28T22:00:00Z
endTime	date-time	End Time of the archival task. The time is in the UTC zone. Example: For Jan 28, 2025, 10 PM: 2025-01-28T22:00:00Z
status	string	Archival status of the activity
totalRecords	integer	Count of records archived as part of the activity
archivalSetName	string	The name of the archival definition set to which the activity belongs
salesforceUser	string	The name of the salesforce user who has initiated the activity
projectName	string	The name of the project to which the activity belongs
organizationID	string	Salesforce organization ID
organizationName	string	The name of the salesforce organization to which the activity belongs
statusDetails	string	Error details if any
fileSize	integer	Total size(in KB) of all archived object files of the activity.
filters	object	Filters applied on the report
nextPageToken	string	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

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code
data	object	Data of the error
message	string	Error message
retryable	boolean	Can retry the API call (true for yes and false for no.)

Archival Restore Activity Report

View the details of Archival restore activities of configured Salesforce instances.

URL

https://apis.druva.com/platform/reporting/v1/reports/sfdcArchivalRestoreActivityReport

Request type

HTTP POST

Sample cURL request

"curl --location --request POST 'https://apis.druva.com/platform/reporting/v1/reports/sfdcArchivalRestoreActivity' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--data-raw '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "salesforceUser",
        "operator": "EQUAL",
        "value": "sfdc2_sanity sfdc2_sanity"
      }
    ]
  },
  "pageToken": ""
}

To try out this API, refer API reference.

📘
Note
On the API reference page, select sfdcArchivalRestoreActivity as the report ID under path params to test this API.

Sample responses

{
    "data": [
        {
            "archivalSetName": "source001 archival_set_2024_06_11_14_53_02",
            "dataTemplateName": "archival_restore_templatedhr5kuv0ao",
            "destinationOrganization": "source001",
            "endTime": "2024-06-11T09:24:37.000Z",
            "projectName": "My First Project",
            "recordsRestored": 100,
            "restoreState": "Completed",
            "salesforceUser": "sfdc2_sanity sfdc2_sanity",
            "startTime": "2024-06-11T09:24:33.000Z",
            "statusDetails": null,
            "totalRecordCount": 100
        },
        {
            "archivalSetName": "source001 archival_set_2024_06_11_15_04_16",
            "dataTemplateName": "archival_restore_templatemck9jykarp",
            "destinationOrganization": "source001",
            "endTime": "2024-06-11T09:35:55.000Z",
            "projectName": "My First Project",
            "recordsRestored": 20,
            "restoreState": "Completed",
            "salesforceUser": "sfdc2_sanity sfdc2_sanity",
            "startTime": "2024-06-11T09:35:50.000Z",
            "statusDetails": null,
            "totalRecordCount": 20
        }, ],
    "filters": {
        "pageSize": 100,
        "filterBy": [
            {
                "fieldName":"salesforceUser",
                "value": "sfdc2_sanity sfdc2_sanity",
                "operator": "EQUAL"
            }
        ]
    },
    "lastSyncTimestamp": "2025-01-28T09:31:26Z",
    "nextPageToken": ""
}

Filed	Table	Description
dataTemplateName	string	Data template name of the Activity
salesforceUser	string	The name of the salesforce user who has initiated the activity
projectName	string	The name of the project to which the activity belongs
restoreState	string	Restore status of the activity
startTime	date-time	Start Time of the archival restore task. The time is in the UTC zone. Example: For Jan 28, 2025 10 PM: 2025-01-28T22:00:00Z
endTime	date-time	End Time of the archival restore task. The time is in the UTC zone. Example: For Jan 28, 2025 10 PM: 2025-01-28T22:00:00Z
totalRecordCount	integer	The total number of records identified for archival restore as part of the activity
recordRestored	integer	Count of the records restored as part of the activity
destinationOrganization	string	The name of the destination organization selected for archival restore as part of the activity
statusDetails	string	Error details if any
archivalSetName	string	The name of the archival definition set to which the activity belongs
filters	object	Filters applied on the report
nextPageToken	string	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

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code
data	object	Data of the error
message	string	Error message
retryable	boolean	Can retry the API call (true for yes and false for no.)

Sandbox Seeding Activity Report

View the status and details of Sandbox Seeding and Data copy activities of configured Salesforce instances.

URL

https://apis.druva.com/platform/reporting/v1/reports/sfdcSandboxSeedingActivityReport

Request type

HTTP POST

Sample cURL request

"curl --location --request POST 'https://apis.druva.com/platform/reporting/v1/reports/sfdcSandboxSeedingActivity' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--data-raw '
{
  "filters": {
    "pageSize": 100,
    "filterBy": [
      {
        "fieldName": "salesforceUser",
        "operator": "EQUAL",
        "value": "sfdc2_sanity sfdc2_sanity"
      }
    ]
  },
  "pageToken": ""
}

To try out this API, refer API reference.

📘
Note
On the API reference page, select sfdcSandboxSeedingActivityReport as the report ID under path params to test this API.

Sample responses

Filed	Table	Description
dataTemplateName	string	Data template name of the Activity
salesforceUser	string	The name of the salesforce user who has initiated the activity
projectName	string	The name of the project to which the activity belongs
taskState	string	Task status of the activity
startTime	date-time	Start Time of the data copy task. The time is in the UTC zone. Example: For Jan 28, 2025 10 PM: 2025-01-28T22:00:00Z
endTime	date-time	End Time of the data copy task. The time is in the UTC zone. Example: For Jan 28, 2025 10 PM: 2025-01-28T22:00:00Z
totalRecordCount	integer	The total number of records identified for data copy as part of the activity
recordRestored	integer	Count of the records restored as part of the activity
destinationOrganization	string	The name of the source organization selected for data copy as part of the activity
statusDetails	string	Error details if any
filters	object	Filters applied to the report
nextPageToken	string	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

{
  "code": "string",
  "data": {
    "additionalProp": {}
  },
  "message": "string",
  "retryable": true
}

Field	Type	Description
code	string	Error code
data	object	Data of the error
message	string	Error message
retryable	boolean	Can retry the API call (true for yes and false for no.)

Get reports on Salesforce

Backup Activity Report

URL

Request type

📘
Note

Sample responses

Data Restore Activity Report

URL

Request type

Sample cURL request

📘
Note

Sample responses

Archival Activity Report

URL

Request type

Sample cURL request

📘
Note

Sample responses

Archival Restore Activity Report

URL

Request type

📘
Note

Sample responses

Sandbox Seeding Activity Report

URL

Request type

📘
Note

Sample responses

Backup Activity Report

URL

Request type

📘Note

Sample responses

Data Restore Activity Report

URL

Request type

Sample cURL request

📘Note

Sample responses

Archival Activity Report

URL

Request type

Sample cURL request

📘Note

Sample responses

Archival Restore Activity Report

URL

Request type

📘Note

Sample responses

Sandbox Seeding Activity Report

URL

Request type

📘Note

Sample responses

📘
Note

📘
Note

📘
Note

📘
Note

📘
Note