Table of contents
Reporting
Download API definition:
This operation is a Technical Preview and is available for testing purposes only. Do not use in production.
GET https://api.bentley.com/insights/reporting/reports/{reportId}/datasources/aggregations[?$top][&$continuationToken]

Gets all Report Aggregations for a Report.

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 have imodels_read permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel.

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 parameters

Name
In
Required?
Description
reportId
template
Yes
$top
query
No

Optional max items to be sent in response.

$continuationToken
query
No

Optional token to retrieve next page in paginated response.

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
No

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

Response 200 OK

Fetched Report Aggregations successfully.

json
{
    "aggregations": [{
        "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "aggregationTableSetId": "5d92982f-dea0-4290-b25c-184bec2ec7d4",
        "datasourceId": "f1fe5959-35ab-467e-83b8-a679b722d80f",
        "datasourceType": "IModelMapping",
        "_links": {
            "report": {
                "href": "https://api.bentley.com/insights/reporting/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6"
            },
            "aggregationTableSet": {
                "href": "https://api.bentley.com/insights/reporting/datasources/aggregations/5d92982f-dea0-4290-b25c-184bec2ec7d4"
            },
            "datasource": {
                "href": "https://api.bentley.com/insights/reporting/datasources/imodels/70a3d6d3-5385-4bc3-87c4-b6bf106e1c0a/mappings/f1fe5959-35ab-467e-83b8-a679b722d80f"
            }
        }
    }],
    "_links": {
        "next": {
            "href": "https://api.bentley.com/insights/reporting/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6/datasources/aggregations/?$top=100&$continuationToken=ddac51e3-3d37-4407-816e-52b9fc80d70a"
        },
        "self": {
            "href": "https://api.bentley.com/insights/reporting/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6/datasources/aggregations/?$top=100"
        }
    }
}

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 404 Not Found

Specified Report was not found.

json
{
    "error": {
        "code": "ReportNotFound",
        "message": "Requested Report is not available.",
        "target": "reportId"
    }
}

Response 422 Unprocessable Entity

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax).

json
{
    "error": {
        "code": "InvalidInsightsRequest",
        "message": "Cannot retrieve ReportAggregations.",
        "details": [{
            "code": "InvalidParameter",
            "message": "Provided '$top' query parameter value is not valid. Expected a value of type 'number'.",
            "target": "$top"
        }]
    }
}

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

Name
Description
retry-after

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

Report Aggregation Collection

List of Report Aggregations.

TableSchema
Name
Type
Description
mappings

List of Report Aggregations.

_links

Contains the hyperlinks to the current and next pages of results.

Report_Aggregation

TableSchema
Name
Type
Description
reportId
String
aggregationTableSetId
String
datasourceId
String
datasourceType
String
_links.report

URL pointing to the related Report.

_links.aggregationTableSet

URL pointing to the related AggregationTableSet.

_links.datasource

URL pointing to the related Datasource.

Link

Hyperlink container.

TableSchema
Name
Type
Description
href
String

Hyperlink to the specific entity.

Paged Response Links

URLs for redoing the current request and/or getting the next page of results if applicable.

TableSchema
Name
Type
Description
next

URL to get the next page of results.

self

URL to repeat the current request.

Error

Contains error information.

TableSchema
Name
Type
Description
code
String

One of a server-defined set of error codes.

message
String

A human-readable representation of the error.

target
String

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.

TableSchema
Name
Type
Description
error

Error information.