REST API for Oracle Blockchain Platform on Oracle Cloud Infrastructure (Hyperledger Fabric v2.5)

Get the Number of User Transactions for Peer, Channel, or Network

get

/console/admin/api/v2/dashboard/statistics/userTrans

Get the number of user transactions for a peer or channel or the entire network. Note that you cannot query a node and the orderer in the same request.

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'
nodeID: string

Node ID of a specific peer. You cannot request this at the same time as the orderer.
orderer: string

The value is Y or N to indicate whether the metrics collected by orderer for whole network or the metrics for founder only needs to be returned. You cannot request this at the same time as a node.
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 user transactions by restriction

Root Schema : schema

Type: object

Show Source

data: object StatsUserTrans

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

Nested Schema : StatsUserTrans

Type: object

Show Source

nodeId: string
orderer: string
userTrans: array userTrans

{
    "type":"object",
    "properties":{
        "nodeId":{
            "type":"string"
        },
        "orderer":{
            "type":"string"
        },
        "userTrans":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StatsTransInfo"
            }
        }
    }
}

Nested Schema : userTrans

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 user transactions for peer or channel or the entire network. Parameters nodeID, channel, and orderer will impact its behavior. The result is a JSON file including the total number of user transactions for the specified scope in the specified time range.

If a peer is specified using nodeID but not channel, it returns the total number of this peer on all channels.
If a channel is specified using channel but not nodeID, it returns the total number of this channel on all peers.
If both nodeID and channel are specified, the result is applicable to only the specified peer on the specified channel.
If orderer is set to Y, and no nodeID is specified, it returns the total number of transactions of the whole network including participant organizations.
Parameters orderer and peer can't be specified at the same time.

The following example shows how to generate the user transaction 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/userTrans?nodeID=<nodeID>&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/userTrans?nodeID=peer1&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": {
    "nodeId": "peer1",
    "userTrans": [
      {
        "channelName": "tfzch01",
        "startTime": "Sun, 24 Feb 2021 03:00:00 GMT",
        "endTime": "Sun, 24 Feb 2021 05:00:00 GMT",
        "trans": 1
      }
    ]
  }
}