Global Filters
Global filters can be applied to all report groups.
To view the global filters
Make a GET call to /api/v1/report/global-filters.
The following filters are available:
|
Query parameter |
Data Type |
Description |
|
dateFrom |
String |
Report start date in the format YYYY-MM-DD (FlexNet Operations server time). Example: 2020-01-28 The date range, specified using dateFrom and dateTo, can span a maximum of 30 days for each request. The time period is inclusive of dates specified in dateFrom and dateTo. |
|
dateTo |
String |
Report end date in the format YYYY-MM-DD (FlexNet Operations server time) Example: 2021-01-27 The date range, specified using dateFrom and dateTo, can span a maximum of 30 days for each request. The time period is inclusive of dates specified in dateFrom and dateTo. |
|
format |
String |
Format of the resulting report. Valid values: json, csv. Default: json |
|
limitRecords |
Numeric |
Limits the number of records returned. Valid values: 1 to 2500. Default: 500 |
|
mode |
String |
In INTERACTIVE mode, the returned payload includes the count of records and the total number of pages in the header. Valid values: BATCH or INTERACTIVE. Default: BATCH. For more information and sample output, see mode. |
|
pastDays |
Numeric |
Specifies the number of historical days for which data should be returned. Valid values: 1 to 30. If a range is specified using dateFrom and dateTo, then pastDays is ignored. Default: 1 |
|
pageNumber |
Numeric |
Specifies the page of results to return. Minimum value: 1. Default: 1 |
Possible values for mode are INTERACTIVE and BATCH. The default mode is BATCH.
In INTERACTIVE mode, the count of records and the total number of pages are provided in the header of the returned payload. The header also includes URLs (in the previousPageURL and nextPageURL elements) for navigating to the next and previous pages. This enables a user to make a decision about what to do once the current page has been viewed.
The following is an example for output using mode=INTERACTIVE:
"header": {
"recordCount": 190537,
"totalPages": 1906,
"previousPageURL": "https://[HOST]/api/v1/report/account?
mode=INTERACTIVE&format=json&pastDays=1&limitRecords=100&requestID=cV9yYzoxOTA1Mzc=pageNumber=19",
"nextPageURL": "https://[HOST]/api/v1/report/account?
mode=INTERACTIVE&format=json&pastDays=1&limitRecords=100&requestID=cV9yYzoxOTA1Mzc=&pageNumber=21"
}
BATCH mode is intended to be used by a batch process which begins at the start and iterates across the complete set of available pages. It also provides URLs for navigating to the next and previous pages.
The following is an example for output using mode=BATCH:
"header": {
"recordCount": -1,
"totalPages": -1,
"previousPageURL": "https://[HOST]/api/v1/report/account?
mode=BATCH&format=json&pastDays=1&limitRecords=100&requestID=cV9yYzotMQ==&pageNumber=19",
"nextPageURL": "https://[HOST]/api/v1/report/account?
mode=INTERACTIVE&format=json&pastDays=1&limitRecords=100&requestID=cV9yYzotMQ==&pageNumber=21"
}