Overview Report Using REST API
Learn how to view the migration job Overview report using the DryvIQ REST API.
Written by Andrea Harvey
Updated at May 2nd, 2025
Table of Contents
Job Information Details
Review the detailed job information, including source, destination, schedule, and current status.
GET {{url}}v1/jobs/{{job}}?fields=allExample Response
{
"status": 200,
"type": "job",
"job": {
"transfer": {
"source": {
"event_position": "8727246012870289",
"options": null,
"connection": {
"id": "2aeae932f53e430d9b96739b913afb93",
"name": "box - rlind",
"platform": {
"id": "box",
"type": "platform"
},
"group": false,
"disabled": false,
"modified_on": 1521734849,
"type": "connection"
},
"target": {
"item": {
"parent": {
"root": true,
"name": "MASTER_TESTS"
},
"name": "BOUNDARY TESTS"
}
}
},
"destination": {
"options": null,
"connection": {
"id": "5dc531df34554edd96c31272262ad950",
"name": "My Computer",
"platform": {
"id": "fs",
"type": "platform"
},
"disabled": false,
"type": "connection"
},
"target": {
"item": {
"parent": {
"parent": {
"root": true,
"name": "C"
},
"name": "fs-test"
},
"name": "destination_boundary_tests"
}
}
},
"transfer_type": "copy",
"conflict_resolution": "copy",
"delete_propagation": [
"ignore_destination"
],
"type": "transfer"
},
"kind": "transfer",
"id": "c4d8c04a69224ef0bfaa2f8e920b8792",
"name": "Boundary Tests",
"previous_execution": {
"progress": 1,
"phase": "complete",
"id": 47,
"start_time": 1521734847,
"end_time": 1521734855,
"duration": {
"value": 7.978,
"unit": "s"
},
"status": "completed",
"node_address": "10.11.8.208",
"stats": {
"destination": {
"batches_pending": 0,
"files_pending": 0,
"rate_limits": 0,
"versions_pending": 0
},
"source": {
"batches_pending": 0,
"files_pending": 0,
"rate_limits": 0,
"versions_pending": 0
}
}
},
"status": "idle",
"scheduler": {
"id": -1,
"name": "default",
"caption": "Default Scheduler",
"disabled": false
},
"category": {
"id": -1,
"name": "Default"
},
"priority": 0,
"disabled": false,
"created_on": 1521664983,
"created_by": "69a08e6a1bc5483eb0d8935036a921c5",
"schedule": {
"mode": "manual"
},
"type": "job",
"links": {
"self": {
"href": "http://localhost:9090/v1/jobs/c4d8c04a69224ef0bfaa2f8e920b8792"
},
"start": {
"href": "http://localhost:9090/v1/jobs/c4d8c04a69224ef0bfaa2f8e920b8792?start=1",
"method": "PATCH"
},
"pause": {
"href": "http://localhost:9090/v1/jobs/c4d8c04a69224ef0bfaa2f8e920b8792?pause=1",
"method": "PATCH"
}
}
}
}All Job Statistics
Review the detailed transfer information, including the total number of files, folders, and amount of data, as well as the data aggregated by categories, status, etc. In some circumstances, bytes on the destination can be higher than listed on the source. This discrepancy is caused by property promotion on Word documents.
GET {{url}}v1/transfers/{{job}}/statsExample Response
The data under transfer_stats/timeline/stats/success shows information related to objects transferred successfully without any revisions.
The data under transfer_stats/timeline/stats/processed shows information related to objects transferred successfully with modifications.
{
"status": 200,
"meta": {
"limit": 50
},
"type": "transfer_stats",
"transfer_stats": {
"id": "c4d8c04a69224ef0bfaa2f8e920b8792",
"timeline": [
{
"timestamp": 1521676800,
"stats": {
"success": {
"source": {
"bytes": 4072065980,
"files": 9028,
"folders": 498
},
"destination": {
"bytes": 4072065980,
"files": 9028,
"folders": 498
}
},
"processed": {
"source": {
"bytes": 491,
"files": 2,
"folders": 2
},
"destination": {
"bytes": 491,
"files": 2,
"folders": 2
}
}
}
},
{
"timestamp": 1521590400,
"stats": {
"success": {
"source": {
"bytes": 4072065980,
"files": 9028,
"folders": 498
},
"destination": {
"bytes": 4072065980,
"files": 9028,
"folders": 498
}
},
"processed": {
"source": {
"bytes": 491,
"files": 2,
"folders": 2
},
"destination": {
"bytes": 491,
"files": 2,
"folders": 2
}
}
}
}
],
"by_category": {},
"by_status": {
"success": {
"source": {
"bytes": 4072065980,
"files": 9028,
"folders": 498
},
"destination": {
"bytes": 4072065980,
"files": 9028,
"folders": 498
}
},
"processed": {
"source": {
"bytes": 491,
"files": 2,
"folders": 2
},
"destination": {
"bytes": 491,
"files": 2,
"folders": 2
}
}
},
"processing": {
"truncated": {
"source": {
"bytes": 491,
"files": 2,
"folders": 2
},
"destination": {
"bytes": 491,
"files": 2,
"folders": 2
}
}
}
}
}Job Statistics By Status
Review details for jobs with a specified status.
GET {{url}}v1/transfers/{{job}}/stats/by_statusExample Response
{
"status": 200,
"item": {
"success": {
"source": {
"bytes": 13193603,
"files": 8,
"folders": 14
},
"destination": {
"bytes": 13193603,
"files": 8,
"folders": 14
}
},
"processed": {
"source": {
"bytes": 684367,
"files": 6
},
"destination": {
"bytes": 684367,
"files": 6
}
},
"skipped": {
"source": {
"bytes": 41511795,
"files": 2
},
"destination": null
}
}
}Job Statistics By Category
Review details for jobs assigned to a specific category.
GET {{url}}v1/transfers/{{job}}/stats/by_categoryExample Response
{
"status": 200,
"item": {}
}Processing Statistics
Review statistics for the items being processed.
Get {{url}}v1/transfers/{{job}}/stats/processingExample Response
{
"status": 200,
"item": {
"truncated": {
"source": {
"bytes": 491,
"files": 2,
"folders": 2
},
"destination": {
"bytes": 491,
"files": 2,
"folders": 2
}
}
}
}Run Breakdown
This report allows you to review the details per run, including how long it took, the number of files and folders, the amount of data transferred, and the number of rate limits encountered. Values in the run breakdown may differ from values presented in the charts. This is because the run breakdown tracks each occurrence, whereas an item can only exist in a single chart category. For example, when an item is truncated and ignored, it would not show up in the "Revised" chart but would show up in the "Revised" run breakdown. The run breakdown also shows both file and folder values. The charts display files and folder values separately, with the "Transfer Details" dropdown available to switch between display values.
GET {{url}}v1/jobs/history?job={{job}}&fields=all&sort=start_time descExample Response
{
"status": 200,
"meta": {
"links": {
"self": {
"href": "http://localhost:9090/v1/jobs/history?offset=0&limit=100&sort=start_time+DESC&fields=all&job_id=c4d8c04a69224ef0bfaa2f8e920b8792"
},
"download": {
"href": "http://localhost:9090/v1/jobs/history.csv?sort=start_time+DESC&job_id=c4d8c04a69224ef0bfaa2f8e920b8792"
}
},
"offset": 0,
"limit": 100,
"sort": [
{
"by": "start_time",
"direction": "desc"
}
],
"fields": [
"all"
],
"job_id": [
"c4d8c04a69224ef0bfaa2f8e920b8792"
],
"total_count": 2
},
"type": "job_executions",
"job_executions": [
{
"job_id": "c4d8c04a69224ef0bfaa2f8e920b8792",
"progress": 1,
"phase": "complete",
"id": 47,
"start_time": 1521734847,
"end_time": 1521734855,
"duration": {
"value": 7.978,
"unit": "s"
},
"status": "completed",
"node_address": "10.11.8.208",
"stats": {
"destination": {
"batches_pending": 0,
"files_pending": 0,
"rate_limits": 0,
"versions_pending": 0
},
"source": {
"batches_pending": 0,
"files_pending": 0,
"rate_limits": 0,
"versions_pending": 0
}
}
},
{
"job_id": "c4d8c04a69224ef0bfaa2f8e920b8792",
"progress": 1,
"phase": "complete",
"id": 14,
"start_time": 1521664984,
"end_time": 1521669357,
"duration": {
"value": 1.2148669444444444,
"unit": "h"
},
"status": "completed",
"node_address": "192.168.7.83",
"stats": {
"destination": {
"batches_pending": 0,
"bytes": 4072066471,
"files": 9030,
"files_pending": 0,
"folders": 500,
"rate_limits": 0,
"versions": 9030,
"versions_pending": 0
},
"source": {
"batches_pending": 0,
"files_pending": 0,
"rate_limits": 0,
"versions_pending": 0
}
}
}
]
}Job Timeline
The job timeline report will populate after two days of activity have been logged. It reflects the UTC zone, and job data points that cross this time zone will appear on the timeline.
Job executions that run through a UTC date change can show part of the run statistics on the first day of the timeline, and the second half of the timeline statistics will show on the second day.
GET {{url}}v1/transfers/{{job}}/stats/timelineExample Response
{
"status": 200,
"meta": {
"limit": 50
},
"item": [
{
"timestamp": 1522886400,
"stats": {
"success": {
"source": {
"bytes": 15808923,
"files": 819,
"folders": 878
},
"destination": {
"bytes": 18836178,
"files": 819,
"folders": 878
}
},
"processed": {
"source": {
"bytes": 699410,
"files": 15,
"folders": 3
},
"destination": {
"bytes": 725561,
"files": 15,
"folders": 3
}
}
}
},
....
.......