This chapter describes REST API's that can be invoked by administrators to get the statistics for tracking and pricing. It contains the following topics:
This REST API retrieves aggregates on report generation statistics based on different input parameters.
| PATH | <server url>/ohpm/opmconfigapi/v1.0/stats/admin/report/count |
| ACCEPTS | application/json |
| RETURNS | application/json |
| METHOD | GET |
The following input parameters are optional.
If any of the parameters are not provided, the search is not limited. For example, if the status is null, then both draft and published reports are included.
| Parameter | Description | Parameter Type | Data Type (Representation) |
|---|---|---|---|
| status | Report Status (Draft or Published) | Query Parameter | String |
| user | List of users that created the report. If there is more than one user use a comma to separate the names. | Query Parameter | String |
| startdate | Date from which the search is started. Use the format YYYY/MM/DD. | Query Parameter | String |
| enddate | Date till which the search is performed. Use the format YYYY/MM/DD. | Query Parameter | String |
| includeDeleted | Indicates if deleted reports should be included. The default value is true. | Query Parameter | String |
Content-Type: application/json
X-Requested-By: OPM
HTTP GET: http://localhost:7101/ohpm/opmapiconfig/v1.0/stats/admin/report/count?status=DRAFT
| Code | Reason | Response Type | Representation (Example) |
|---|---|---|---|
| 200 | success | Number (count) | |
| 500 | error | error message object |