REST API for Oracle Essbase

Get Application Statistics

get

/essbase/rest/v1/applications/{applicationName}/statistics

Returns the statistics of the specified application.

Request

Path Parameters

applicationName(required): string

Application name.

Response

Supported Media Types

application/json
application/xml

200 Response

Statistics retrieved successfully.

Root Schema : ApplicationStatistics

Type: object

Show Source

applicationElapsedTime: string
applicationStartTime: integer(int64)
loadStatus: string
numberOfConnections: integer(int32)

{
    "type":"object",
    "properties":{
        "applicationStartTime":{
            "type":"integer",
            "format":"int64"
        },
        "applicationElapsedTime":{
            "type":"string"
        },
        "numberOfConnections":{
            "type":"integer",
            "format":"int32"
        },
        "loadStatus":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Failed to get the statistics. The application name may be incorrect.

500 Response

Internal Server Error.

Examples

The following example shows how to get statistics about an Essbase application.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/statistics?links=none" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%

Example of Response Body

{
  "applicationStartTime" : 1663791016000,
  "applicationElapsedTime" : "0:1:59:56",
  "numberOfConnections" : 4,
  "loadStatus" : "Loaded"
}