Download Analytics - Library

REST API Overview

Reference

Library

Download API definition:

GET https://api.bentley.com/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'.

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

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

Authorization

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.

Request

Request parameters

startDate

Yes

Start datetime of analytics to be returned, valid format is yyyy-MM-dd'T'HH:mm:ss.fff'Z'.

endDate

Yes

End datetime of analytics to be returned, valid format is yyyy-MM-dd'T'HH:mm:ss.fff'Z'.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Response

Response 200 OK

Response 401 Unauthorized

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 403 Forbidden

This response indicates that user does not have required permissions to download analytics.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 422 Unprocessable Entity

Invalid request to download analytics.

json

{
    "error": {
        "code": "InvalidDownloadAnalyticsRequest",
        "message": "Cannot perform operation.",
        "details": [{
                "code": "MissingRequiredParameter",
                "message": "Required parameter is missing.",
                "target": "startDate"
            },
            {
                "code": "MissingRequiredParameter",
                "message": "Required parameter is missing.",
                "target": "endDate"
            },
            {
                "code": "InvalidValue",
                "message": "Parameter 'startDate' format is incorrect, valid format is yyyy-MM-dd'T'HH:mm:ss.fff'Z'.",
                "target": "startDate"
            },
            {
                "code": "InvalidValue",
                "message": "Parameter 'endDate' format is incorrect, valid format is yyyy-MM-dd'T'HH:mm:ss.fff'Z'.",
                "target": "endDate"
            }
        ]
    }
}

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

error

Error

Error information.