Returns a CSV file containing usage data for the subscription over a specified time period. You can define data filters and output settings for the exported report.

Related Documentation: This API parallels the filtering and reporting features of the MyJFrog portal's Usage Explorer tab.

Security: Requires a valid token

Subscription: This feature is supported on the Cloud (SaaS) platform for all licenses.

Filter and Group Keys

The following keys are valid for the optional filter_by and group_by parameters:

• action: Valid values are upload or download
• artifact_path: you can group data in blocks of 32 days or more
• ip: you can group data in blocks of 32 days or more
• package_type
• project
• repo_type (repository type)
• repository
• server_name
• service
• username

Rate Limiting

This API request can generate significant processing loads. To retrieve a large data set, define a series of API requests with date ranges or filters.

The following limits are imposed on consecutive submissions of this request:

IP-based limits:

• 10 requests within 10 minutes
• 20 requests per hour

Token-based limits:

• 5 requests within 5 minutes
• 10 requests per hour

Note: Rate limits may vary from these defaults in response to network conditions and service priorities.

Response

The response payload contains a CSV file named JFrog-data-transfer-YYYYMMDD-yyyymmdd.csv where YYYYMMDD is the value of start_date and yyyymmdd is the value of non_inclusive_end_date. All timestamps in the CSV file are UTC.