REST API for Oracle Blockchain Platform Enterprise Edition

Get the Number of Blocks

get

/console/admin/api/v2/dashboard/statistics/blocks

This endpoint is used to get the number of blocks on a specified channel or on all channels in a specified time range.

Request

Supported Media Types

application/json

Query Parameters

channel: string

Channel name
endTime: string

The end time of a time range in the format 'yyyyMMddhhmmss'
startTime: string

The start time of a time range in the format 'yyyyMMddhhmmss'

Response

Supported Media Types

application/json

200 Response

Response with a series of blocks by restriction

Root Schema : schema

Type: object

Show Source

data: object StatsBlocks

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/StatsBlocks"
        }
    }
}

Nested Schema : StatsBlocks

Type: object

Show Source

blocks: array blocks

{
    "type":"object",
    "properties":{
        "blocks":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StatsTransInfo"
            }
        }
    }
}

Nested Schema : blocks

Type: array

Show Source

Array of: object StatsTransInfo

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

Nested Schema : StatsTransInfo

Type: object

Show Source

channelName: string
endTime: string
startTime: string
trans: number

{
    "type":"object",
    "properties":{
        "channelName":{
            "type":"string"
        },
        "startTime":{
            "type":"string"
        },
        "endTime":{
            "type":"string"
        },
        "trans":{
            "type":"number"
        }
    }
}

400 Response

Invalid arguments

Root Schema : 400errorModels

Type: object

Show Source

key: string
value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

Example:

{
    "respMesg":"invalid argument"
}

Default Response

Unexpected error

Root Schema : errorModel

Type: object

Show Source

code(required): integer(int32)
message(required): string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

Examples

This endpoint is used to get the number of commits on a specified channel or on all channels in a specified time range. The result is a JSON file including the total number of the specified scope in the specified time range. This API is only applicable for a founder instance.

The following example shows how to generate the block metrics by submitting a GET request on the REST resource using cURL.

curl -X GET -u username:password -k 
"http://<rest_server_url>:port/console/admin/api/v2/dashboard/statistics/blocks?channel=<channel>&startTime=<yyyymmddhhmmss>&endTime=<yyyymmddhhmmss>"

For example,

curl -X GET -u myname@oracle.com:mypswd -k 
"http://server.oracle.com:10000/console/admin/api/v2/dashboard/blocks?channel=tfzch01&startTime=20210224030000&endTime=20210224050000"

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "data": {
    "blocks": [
      {
        "channelName": "tfzch01",
        "startTime": "Sun, 24 Feb 2021 03:00:00 GMT",
        "endTime": "Sun, 24 Feb 2021 05:00:00 GMT",
        "trans": 2
      }
    ]
  }
}