Overview

The stats endpoint provides insight into your transferred content through various ways to break down your reports. The following REST API requests help you understand what your transferred content looks like.

Statistics By Age (Modified Date)

List job content by age/modified date based on the top 5 buckets, with the remaining items captured into the "other" or "older" bucket.

Statistics by age

GET {{url}}v1/transfers/{{job}}/stats/by_age

Statistics by age Using Date Range

You can pull statistics by days (d), weeks (w), months (m), or years (y).

GET {{url}}v1/transfers/{{job}}/stats/by_age?age={{range}}

Examples

Days

GET {{url}}v1/transfers/{{job}}/stats/by_age?age=2d

Weeks

GET {{url}}v1/transfers/{{job}}/stats/by_age?age=2w

Months

GET {{url}}v1/transfers/{{job}}/stats/by_age?age=2m

Years

GET {{url}}v1/transfers/{{job}}/stats/by_age?age=2y

Statistics by Error Category

List the error categories assigned to your job content.

GET {{url}}v1/transfers/{{job}}/stats/by_category

Statistics by Content Category (File Type)

List your job content by content category/file type based on the top five buckets, with the remaining items captured into the "other" or "older" bucket.

GET {{url}}v1/transfers/{{job}}/stats/by_content_category

Statistics by Folder Depth

List your job content by folder depth, where each value is the number of subfolders contained within the parent folder. The response will display the following for both the source and destination:

• Bytes
• Files
• Folders

GET {{url}}v1/transfers/{{job}}/stats/by_depth

Statistics by Extension

List your job content by file extension based on the top 5 buckets, with the remaining items captured into the "other" or "older" bucket.

GET {{url}}v1/transfers/{{job}}/stats/by_ext

Statistics by Size

List your job content by file size based on the top 5 buckets, with the remaining items captured into the "other" or "older" bucket.

GET {{url}}v1/transfers/{{job}}/stats/by_size

Statistics by Status

List your job content by its transferred status: success, processed, or retry.

GET {{url}}v1/transfers/{{job}}/stats/by_status

Processing Statistics

List your job content by items that were processed during transfer, such as content that was sanitized or truncated.

GET {{url}}v1/transfers/{{job}}/stats/processing

Get List of Items by Revision

List items with a given processing status. Processing statuses include: none, filtered, skipped, truncated, converted, conflict_copy, access_rules, or metadata.

{{url}}v1/transfers/items?jobs={{job}}&fields=all&processing_status=converted

Job Stop Policy Statistics 

List the status of your job's stop policy.

GET {{url}}v1/jobs/{{job}}?fields=stop_policy

Job Timeline Statistics 

List your job content by its transferred status (success, processed, or retry) for the timeline of your job (from creation to completion).

GET {{url}}v1/transfers/{{job}}/stats/timeline