Jump to

• Request
• Response
• Examples

Get General Statistics

get

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

Returns general statistics of the specified database. Additional statistics can be retrieved using the expand parameter.

Request

Path Parameters

• applicationName: string

  Application name.

• databaseName: string

  Database name.

Query Parameters

• expand(optional): string

  Use none to show only general statistics (this is the default). Other options available: storage, runtime, and all.

  Default Value: none

  Allowed Values: [ "none", "storage", "runtime", "all" ]

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

General database statistics returned successfully, with links to get expanded statistics.

Body ()

Root Schema : statistics

Type: object

Show Source

• general(optional): object GeneralStatistics
• links(optional): array links
• runtime(optional): object RuntimeStatistics
• storage(optional): object StorageStatistics

{
    "type":"object",
    "properties":{
        "general":{
            "$ref":"#/definitions/GeneralStatistics"
        },
        "storage":{
            "$ref":"#/definitions/StorageStatistics"
        },
        "runtime":{
            "$ref":"#/definitions/RuntimeStatistics"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"statistics"
    }
}

Nested Schema : GeneralStatistics

Type: object

Show Source

• databaseElapsedTime(optional): string
• databaseStartTime(optional): integer(int64)
• loadStatus(optional): string
• numberOfConnections(optional): integer(int32)
• numberOfDimensions(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "databaseStartTime":{
            "type":"integer",
            "format":"int64"
        },
        "databaseElapsedTime":{
            "type":"string"
        },
        "numberOfConnections":{
            "type":"integer",
            "format":"int32"
        },
        "numberOfDimensions":{
            "type":"integer",
            "format":"int32"
        },
        "loadStatus":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : RuntimeStatistics

Type: object

Show Source

• cacheHitRatio(optional): number(double)

  Ratio of the number of requests answered from aggregate storage cache as opposed to from the hard disk. May not be accurate when parallel data load or parallel calculation operations are in use.

• currentCacheSize(optional): number(double)

  The current size of the aggregate storage cache. See also currentCacheSizeLimit.

• currentCacheSizeLimit(optional): number(double)

  The maximum size (in kilobytes) to which the aggregate storage cache may grow.

• diskSpaceAllocatedForData(optional): number(double)

  For an aggregate storage cube, total space used by all disk files in the default tablespace.

• diskSpaceUsedByData(optional): number(double)

  For an aggregate storage cube, total space actually in use within the disk files in the default tablespace (some space within files may be free).

• hitRatioOnDataCache(optional): number(double)
• hitRatioOnDataFileCache(optional): number(double)
• hitRatioOnIndexCache(optional): number(double)
• numberOfDataBlockReads(optional): number(double)
• numberOfDataBlockWrites(optional): number(double)
• numberOfIndexPageReads(optional): number(double)
• numberOfIndexPageWrites(optional): number(double)
• pageReadsSinceLastStartup(optional): number(double)

  For an aggregate storage cube, number of data pages read from disk since the last time the application was started.

• pageSize(optional): number(double)

  For an aggregate storage cube, size of the data page in kilobytes.

• pageWritesSinceLastStartup(optional): number(double)

  For an aggregate storage cube, number of data pages written to disk since the last time the application was started.

• temporaryDiskSpaceAllocated(optional): number(double)

  For an aggregate storage cube, total space used by all disk files in the temp tablespace.

• temporaryDiskSpaceUsed(optional): number(double)

  For an aggregate storage cube, total space actually in use within the disk files in the temp tablespace (some space within files may be free).

{
    "type":"object",
    "properties":{
        "cacheHitRatio":{
            "type":"number",
            "description":"<p>Ratio of the number of requests answered from aggregate storage cache as opposed to from the hard disk. May not be accurate when parallel data load or parallel calculation operations are in use.</p>",
            "format":"double"
        },
        "currentCacheSize":{
            "type":"number",
            "description":"<p>The current size of the aggregate storage cache. See also currentCacheSizeLimit.</p>",
            "format":"double"
        },
        "currentCacheSizeLimit":{
            "type":"number",
            "description":"<p>The maximum size (in kilobytes) to which the aggregate storage cache may grow.</p>",
            "format":"double"
        },
        "pageReadsSinceLastStartup":{
            "type":"number",
            "description":"<p>For an aggregate storage cube, number of data pages read from disk since the last time the application was started.</p>",
            "format":"double"
        },
        "pageWritesSinceLastStartup":{
            "type":"number",
            "description":"<p>For an aggregate storage cube, number of data pages written to disk since the last time the application was started.</p>",
            "format":"double"
        },
        "pageSize":{
            "type":"number",
            "description":"<p>For an aggregate storage cube, size of the data page in kilobytes.</p>",
            "format":"double"
        },
        "diskSpaceAllocatedForData":{
            "type":"number",
            "description":"<p>For an aggregate storage cube, total space used by all disk files in the default tablespace.</p>",
            "format":"double"
        },
        "diskSpaceUsedByData":{
            "type":"number",
            "description":"<p>For an aggregate storage cube, total space actually in use within the disk files in the default tablespace (some space within files may be free).</p>",
            "format":"double"
        },
        "temporaryDiskSpaceAllocated":{
            "type":"number",
            "description":"<p>For an aggregate storage cube, total space used by all disk files in the temp tablespace.</p>",
            "format":"double"
        },
        "temporaryDiskSpaceUsed":{
            "type":"number",
            "description":"<p>For an aggregate storage cube, total space actually in use within the disk files in the temp tablespace (some space within files may be free).</p>",
            "format":"double"
        },
        "hitRatioOnIndexCache":{
            "type":"number",
            "format":"double"
        },
        "hitRatioOnDataCache":{
            "type":"number",
            "format":"double"
        },
        "numberOfIndexPageReads":{
            "type":"number",
            "format":"double"
        },
        "numberOfIndexPageWrites":{
            "type":"number",
            "format":"double"
        },
        "numberOfDataBlockReads":{
            "type":"number",
            "format":"double"
        },
        "numberOfDataBlockWrites":{
            "type":"number",
            "format":"double"
        },
        "hitRatioOnDataFileCache":{
            "type":"number",
            "format":"double"
        }
    }
}

Nested Schema : StorageStatistics

Type: object

Show Source

• aggregateDataSize(optional): integer(int32)

  For aggregate storage cubes, the total disk space occupied by aggregate cells

• averageClusteringRatio(optional): number(double)

  A measure of the fragmentation of the page file. A value close to 1 indicates the degree of fragmentation is low. A value close to zero indicates a high degree of fragmentation that could affect calculation and query performance.

• blockDensity(optional): number(double)

  The average block density (calculated using all currently loaded blocks)

• blockSize(optional): integer(int32)
• compressionRatio(optional): number(double)

  Average data block compression ratio

• costOfQueryingIncrementalData(optional): number(double)

  For aggregate storage cubes, the average percentage of query time spent processing incremental data slices. This is useful in deciding when slices should be merged together to improve query performance.

• dimensions(optional): array dimensions
• existingLevelZeroBlocks(optional): number(double)

  The number of non-missing leaf (lowest level) blocks in the cube

• existingUpperLevelBlocks(optional): number(double)

  The number of non-missing, non-leaf (upper level) blocks in the cube

• indexFileSize(optional): integer(int64)
• inputLevelDataSize(optional): integer(int32)

  For aggregate storage cubes, the total disk space used by input-level data

• maxKeyLengthBits(optional): integer(int32)

  For aggregate storage cubes, the sum of all the bits used by each dimension. For example, there are 20 bits in the key used for dimensions, and the first 4 are used by Year.

• maxKeyLengthBytes(optional): integer(int32)

  For aggregate storage cubes, how many bytes the key uses per cell

• numberOfAggregateCells(optional): integer(int32)

  For aggregate storage cubes, the number of cells stored in aggregate views

• numberOfAggregateViews(optional): integer(int32)

  For aggregate storage cubes, the number of aggregate views, including those automatically built on incremental slices

• numberOfExistingBlocks(optional): number(double)

  Total number of existing data blocks (not the maximum)

• numberOfIncrementalAggregateCells(optional): integer(int32)

  For aggregate storage cubes, the number of cells stored in the incremental slices' aggregate views

• numberOfIncrementalDataSlices(optional): integer(int32)

  For aggregate storage cubes, the number of data slices resulting from incremental data loads

• numberOfIncrementalInputCells(optional): integer(int32)

  For aggregate storage cubes, the number of level-0 cells in the incremental data slices

• numberOfInputLevelCells(optional): integer(int32)

  For aggregate storage cubes, the number of existing level-0 cells in the database, including incremental slices

• pageFileSize(optional): integer(int64)
• percentageOfMaximumBlocksExisting(optional): number(double)
• potentialNumberOfBlocks(optional): number(double)

{
    "type":"object",
    "properties":{
        "dimensions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StatisticsDimensions"
            }
        },
        "maxKeyLengthBits":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the sum of all the bits used by each dimension. For example, there are 20 bits in the key used for dimensions, and the first 4 are used by Year.</p>",
            "format":"int32"
        },
        "maxKeyLengthBytes":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, how many bytes the key uses per cell</p>",
            "format":"int32"
        },
        "numberOfInputLevelCells":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the number of existing level-0 cells in the database, including incremental slices</p>",
            "format":"int32"
        },
        "numberOfIncrementalDataSlices":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the number of data slices resulting from incremental data loads</p>",
            "format":"int32"
        },
        "numberOfIncrementalInputCells":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the number of level-0 cells in the incremental data slices</p>",
            "format":"int32"
        },
        "numberOfAggregateViews":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the number of aggregate views, including those automatically built on incremental slices</p>",
            "format":"int32"
        },
        "numberOfAggregateCells":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the number of cells stored in aggregate views</p>",
            "format":"int32"
        },
        "numberOfIncrementalAggregateCells":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the number of cells stored in the incremental slices' aggregate views</p>",
            "format":"int32"
        },
        "costOfQueryingIncrementalData":{
            "type":"number",
            "description":"<p>For aggregate storage cubes, the average percentage of query time spent processing incremental data slices. This is useful in deciding when slices should be merged together to improve query performance.</p>",
            "format":"double"
        },
        "inputLevelDataSize":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the total disk space used by input-level data</p>",
            "format":"int32"
        },
        "aggregateDataSize":{
            "type":"integer",
            "description":"<p>For aggregate storage cubes, the total disk space occupied by aggregate cells</p>",
            "format":"int32"
        },
        "numberOfExistingBlocks":{
            "type":"number",
            "description":"<p>Total number of existing data blocks (not the maximum)</p>",
            "format":"double"
        },
        "blockSize":{
            "type":"integer",
            "format":"int32"
        },
        "potentialNumberOfBlocks":{
            "type":"number",
            "format":"double"
        },
        "existingLevelZeroBlocks":{
            "type":"number",
            "description":"<p>The number of non-missing leaf (lowest level) blocks in the cube</p>",
            "format":"double"
        },
        "existingUpperLevelBlocks":{
            "type":"number",
            "description":"<p>The number of non-missing, non-leaf (upper level) blocks in the cube</p>",
            "format":"double"
        },
        "blockDensity":{
            "type":"number",
            "description":"<p>The average block density (calculated using all currently loaded blocks)</p>",
            "format":"double"
        },
        "percentageOfMaximumBlocksExisting":{
            "type":"number",
            "format":"double"
        },
        "compressionRatio":{
            "type":"number",
            "description":"<p>Average data block compression ratio</p>",
            "format":"double"
        },
        "averageClusteringRatio":{
            "type":"number",
            "description":"<p>A measure of the fragmentation of the page file. A value close to 1 indicates the degree of fragmentation is low. A value close to zero indicates a high degree of fragmentation that could affect calculation and query performance.</p>",
            "format":"double"
        },
        "pageFileSize":{
            "type":"integer",
            "format":"int64"
        },
        "indexFileSize":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : dimensions

Type: array

Show Source

• Array of: object StatisticsDimensions

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/StatisticsDimensions"
    }
}

Nested Schema : StatisticsDimensions

Type: object

Show Source

• bits(optional): number(double)
• levels(optional): string
• name(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "levels":{
            "type":"string"
        },
        "bits":{
            "type":"number",
            "format":"double"
        }
    }
}

400 Response

Bad Request

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

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how to get general statistics for a cube.

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/databases/Basic/statistics?expand=all" -H "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "general": {
    "databaseStartTime": 1586308012000,
    "databaseElapsedTime": "0:0:3:34",
    "numberOfConnections": 1,
    "numberOfDimensions": 10,
    "loadStatus": "Loaded"
  },
  "storage": {
    "maxKeyLengthBits": 0,
    "maxKeyLengthBytes": 0,
    "numberOfInputLevelCells": 0,
    "numberOfIncrementalDataSlices": 0,
    "numberOfIncrementalInputCells": 0,
    "numberOfAggregateViews": 0,
    "numberOfAggregateCells": 0,
    "numberOfIncrementalAggregateCells": 0,
    "costOfQueryingIncrementalData": 0,
    "inputLevelDataSize": 0,
    "aggregateDataSize": 0,
    "numberOfExistingBlocks": 354,
    "blockSize": 672,
    "potentialNumberOfBlocks": 1900,
    "existingLevelZeroBlocks": 354,
    "existingUpperLevelBlocks": 0,
    "blockDensity": 83.61904761904762,
    "percentageOfMaximumBlocksExisting": 18.63157894736842,
    "compressionRatio": 0.9943010752688172,
    "averageClusteringRatio": 0.33334593787222777,
    "pageFileSize": 294969,
    "indexFileSize": 8216576
  },
  "runtime": {
    "cacheHitRatio": 0,
    "currentCacheSize": 0,
    "currentCacheSizeLimit": 0,
    "pageReadsSinceLastStartup": 0,
    "pageWritesSinceLastStartup": 0,
    "pageSize": 0,
    "diskSpaceAllocatedForData": 0,
    "diskSpaceUsedByData": 0,
    "temporaryDiskSpaceAllocated": 0,
    "temporaryDiskSpaceUsed": 0,
    "hitRatioOnIndexCache": 0,
    "hitRatioOnDataCache": 0,
    "numberOfIndexPageReads": 0,
    "numberOfIndexPageWrites": 0,
    "numberOfDataBlockReads": 0,
    "numberOfDataBlockWrites": 0,
    "hitRatioOnDataFileCache": 0
  }
}

Back to Top