Jump to

• Request
• Response

Get a List of Block's Data

get

/console/admin/api/v2/channels/{channelName}/blocks

Using the channel name, a block ID range, you can get a list of the block's data for a range of blocks on a channel, including transactions, deployments, and invocations. This API returns 1000 blocks data at most. If no parameter is specified, it will return the latest 1000 blocks. If only fromId(since) is input, the toId(until) will be set as the current ledger height by default. If only toId(until) is input, the fromId(since) will be set as 0 by default. If the query range is beyond this value, an error message will be returned.

Request

Supported Media Types

• application/json

Path Parameters

• channelName: string
  Channel name

Query Parameters

• fromId(optional): number
  Begining ID of the selected block range
• toId(optional): number
  The end ID of the selected block range

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieved block statistics information successfully

Body ()

Root Schema : blockStatistic

Type: object

Show Source

• activities(optional): array activities
• blocks(optional): array blocks
• overview(optional): object overview

{
    "type":"object",
    "properties":{
        "overview":{
            "type":"object",
            "properties":{
                "blocks":{
                    "type":"number"
                },
                "blockSpeed":{
                    "type":"number"
                },
                "transactionActivity":{
                    "type":"number"
                },
                "deployment":{
                    "type":"number"
                },
                "invokes":{
                    "type":"number"
                }
            }
        },
        "activities":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "number":{
                        "type":"string"
                    },
                    "deploy":{
                        "type":"string"
                    },
                    "invoke":{
                        "type":"number"
                    }
                }
            }
        },
        "blocks":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "header":{
                        "type":"object"
                    },
                    "data":{
                        "type":"object"
                    }
                }
            }
        }
    }
}

Nested Schema : activities

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "number":{
                "type":"string"
            },
            "deploy":{
                "type":"string"
            },
            "invoke":{
                "type":"number"
            }
        }
    }
}

Nested Schema : blocks

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "header":{
                "type":"object"
            },
            "data":{
                "type":"object"
            }
        }
    }
}

Nested Schema : overview

Type: object

Show Source

• blocks(optional): number
• blockSpeed(optional): number
• deployment(optional): number
• invokes(optional): number
• transactionActivity(optional): number

{
    "type":"object",
    "properties":{
        "blocks":{
            "type":"number"
        },
        "blockSpeed":{
            "type":"number"
        },
        "transactionActivity":{
            "type":"number"
        },
        "deployment":{
            "type":"number"
        },
        "invokes":{
            "type":"number"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• deploy(optional): string
• invoke(optional): number
• number(optional): string

{
    "type":"object",
    "properties":{
        "number":{
            "type":"string"
        },
        "deploy":{
            "type":"string"
        },
        "invoke":{
            "type":"number"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• data(optional): object data
• header(optional): object header

{
    "type":"object",
    "properties":{
        "header":{
            "type":"object"
        },
        "data":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : header

Type: object

400 Response

Invalid arguments

Body ()

Root Schema : 400errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

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

Example:

{
    "respMesg":"invalid argument"
}

401 Response

Unauthorized

500 Response

Internal server error

Body ()

Root Schema : 500errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Default Response

Unexpected error

Body ()

Root Schema : errorModel

Type: object

Show Source

• code: integer(int32)
• message: string

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

Back to Top