Get Report Aggregation - Reporting

REST API Overview

Reference

Changelog

API Keys

Reporting

Download API definition:

Get Report Aggregation

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/{aggregationTableSetId}

Gets single Report Aggregation 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 insights_view 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

Request parameters

reportId

template

Yes

The Report Id.

aggregationTableSetId

template

Yes

Id of the Aggregation Table Set to be retrieved.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

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

Response

Response 200 OK

Fetched single Report Aggregation successfully.

json

{
    "aggregation": {
        "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"
            }
        }
    }
}

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 Aggregation was not found.

json

{
    "error": {
        "code": "ReportAggregationNotFound",
        "message": "Requested ReportAggregation is not available.",
        "target": "aggregationTableSetId"
    }
}

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

Report_Aggregation_Single

TableSchema

aggregation

Report_Aggregation

Report Aggregation properties.

Report_Aggregation

TableSchema

reportId

String

aggregationTableSetId

String

datasourceId

String

datasourceType

String

_links.report

Link

URL pointing to the related Report.

_links.aggregationTableSet

Link

URL pointing to the related AggregationTableSet.

_links.datasource

Link

URL pointing to the related Datasource.

Link

Hyperlink container.

TableSchema

href

String

Hyperlink to the specific entity.

Error

Contains error information.

TableSchema

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

error

Error

Error information.