Report data REST API reference
- Last UpdatedMar 04, 2025
- 2 minute read
This topic shows the syntax of various REST API calls to retrieve report data.
All times for DateTime parameters are UTC.
The response data is in JSON format. The response is limited to a maximum of 20,000 records. If your query exceeds this limit, change the fromDate and toDate parameters to reduce the number of records returned.
Get credit transactions report
Endpoint: https://services.connect.aveva.com/reports/v1/integration/creditsTransaction
HTTP Method: POST
Mandatory parameters:
|
Parameter name |
Data type |
Example |
|
fromDate |
DateTime |
2023-09-15T13:30:00 |
|
toDate |
DateTime |
2023-09-15T13:30:00 |
Optional parameters:
|
Parameter name |
Data type |
Example |
|
hostingType |
String |
Cloud |
|
productName |
String |
Product 1 |
|
productCode |
String |
Prod-001 |
|
user |
String |
test-user@example.com |
|
folder |
String |
Folder 1 |
|
service |
String |
Service 1 |
|
creditsAgreementId |
String |
0001 |
Get user usage report
Endpoint: https://services.connect.aveva.com/reports/v1/integration/userUsage
HTTP method: POST
Mandatory parameters:
|
Parameter name |
Data type |
Example |
|
fromDate |
DateTime |
2023-09-15T13:30:00 |
|
toDate |
DateTime |
2023-09-15T13:30:00 |
Optional parameters:
|
Parameter name |
Data type |
Example |
|
user |
String |
test-user@example.com |
|
folder |
String |
Folder 2 |
|
service |
String |
Service 2 |
Get service usage report
Endpoint: https://services.connect.aveva.com/reports/v1/integration/serviceUsage
Method: POST
Mandatory parameters:
|
Parameter name |
Data type |
Example |
|
fromDate |
DateTime |
2023-09-15T13:30:00 |
|
toDate |
DateTime |
2023-09-15T13:30:00 |
Optional parameters:
|
Parameter name |
Data type |
Example |
|
folder |
String |
Folder 3 |
|
service |
String |
Service 3 |
Get resource usage report
Endpoint: https://services.connect.aveva.com/reports/v1/integration/resourceUsage
Method: POST
Mandatory parameters:
|
Parameter name |
Data type |
Example |
|
fromDate |
DateTime |
2023-09-15T13:30:00 |
|
toDate |
DateTime |
2023-09-15T13:30:00 |
Optional parameters:
|
Parameter name |
Data type |
Example |
|
folder |
String |
Folder 4 |
|
service |
String |
Service 4 |
|
resourceId |
String |
RES-004 |
Get audit data
Endpoint: https://services.connect.aveva.com/reports/v1/audit
Method: GET
Mandatory parameters:
|
Parameter name |
Data type |
Example |
|
range |
String |
Custom |
|
from |
DateTime |
2023-09-15T13:30:00 |
|
to |
DateTime |
2023-09-15T13:30:00 |
Optional parameters:
|
Parameter name |
Data type |
Example |
|
locale |
String |
en-US |
|
offset |
String |
-330 |
|
user |
String |
test-user@example.com |
|
operation |
String |
add |
|
folder |
String |
Folder 5 |
|
service |
String |
Service 5 |
|
function |
String |
authm |
The locale parameter is the regional setting of your computer, where the API is expected to format the DateTime fields.
The offset parameter is the difference between UTC and your time zone, in minutes. For example, -330 correspond to IST (India Standard Time).
Because the audit endpoint uses the GET method, you must always include the mandatory parameters. Using the endpoint without parameters, such as https://services.connect.aveva.com/reports/v1/audit, will return an error.
Example of audit endpoint including mandatory parameters:
https://services.connect.aveva.com/reports/v1/audit?range=Custom&from=2023-12-13&to=2023-12-14
Example of audit endpoint including mandatory and optional parameters:
https://services.connect.aveva.com/reports/v1/audit?range=Custom&from=2023-12-13&to=2023-12-14&locale=en-US&offset=-330