This route is used to retrieve the history data entries of comments given a set of filters such as blockchain details or comment identifiers.
The history entries will reflect the state of the comments on a particular block on the ledger.
This endpoint returns paginated data. Up to 250 can be extracted per call.
This endpoint can be called by applications with access to scope "readComments".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The block number where the action was recorded on the ledger.
350The transaction id where the action was recorded on the ledger.
456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$The name of the channel where the action was recorded on the ledger.
OG123Pattern: ^[a-zA-Z0-9-]*$The comma delimited list of comment ids to filter the comment records. Up to 250 records can be provided. Each record should not exceed 16 characters.
USCCWSF01I00,USCCWSF01I01GET /external/v1/comment/history HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"timestamp": "2024-09-12T00:00:00.000Z",
"blockNumber": 350,
"transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
"channelName": "OG123",
"event": "Created",
"update": {
"commentId": "US9QICOMMENT1",
"message": "This is a comment",
"status": "broadcast",
"viewOrgs": [
"US9QIORG1",
"US9QIORG2"
],
"fileIds": [
"US9QIFILE1",
"US9QIFILE2"
],
"associatedEntities": {
"assetIds": [
"US9QIASSET1"
]
},
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
}
},
"signerData": {
"email": "[email protected]",
"name": "John Doe"
},
"extraData": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
}
}
]