On This Page

Overview

The stats endpoint provides insight to your transferred content through various ways to breakdown your reports. Used throughout the SkySync application user-interface, this document outlines useful calls to assist in understanding what your transferred content looks like. 

Stats 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

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

GET {{url}}v1/transfers/{{job}}/stats/by_age?age=2d (2 days)
GET {{url}}v1/transfers/{{job}}/stats/by_age?age=2w (2 weeks)
GET {{url}}v1/transfers/{{job}}/stats/by_age?age=2m (2 months)
GET {{url}}v1/transfers/{{job}}/stats/by_age?age=2y (2 years)

Stats By Category (Error Category)

List the error categories assigned to your job content.

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

Stats By Content Category (File Type)

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

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

Stats By Depth (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

Stats 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

Stats 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

Stats By Status

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

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

Processing Stats

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 the 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 Stats

List the status of your job's stop policy.

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

Job Timeline Stats

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