Download API definition:

GET https://sampleHostName/library/components/analytics/download?startDate={startDate}&endDate={endDate}

Retrieves components analytics information as csv downloadable file from user's organization context. Response contains 'Content-Disposition' header containing name of the file to be downloaded. Query parameters 'startDate' and 'endDate' specify the period for which analytics should be downloaded, these are required parameters and must be in this format yyyy-MM-dd'T'HH:mm:ss.fff'Z'.


Requires Authorization header with valid Bearer token for scope library:read.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.


User must be an Organization Administrator for the Organization or have View Analytics permission assigned at the organization level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.