Analytics

Search policy

post

Returns search policy result

Body

application/json

textstringRequired

Text

minVcCountnumberRequired

Mint VC count

Example: 10

minVpCountnumberRequired

Mint VP count

Example: 10

minTokensCountnumberRequired

Mint tokens count

Example: 10

thresholdnumberRequired

Threshold

Example: 10

ownerstringRequired

Owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

Responses

200

Search policy result

application/json

typestringRequired

Type

Example: Global

topicIdstringRequired

Topic identifier

Example: 0.0.4481265

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

namestringRequired

Name

Example: Verra REDD

descriptionstringRequired

Description

Example: Verra REDD Policy

versionstringRequired

Version

Example: 1.0.0

statusstringRequired

Status

Example: PUBLISH

messageIdstringRequired

Message identifier

Example: 1706823227.586179534

ownerstringRequired

Owner

Example: did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265

textSearchstringRequired

Text search

registryIdstringRequired

Registry identifier

Example: 1706823227.586179534

vcCountnumberRequired

VC count

Example: 10

vpCountnumberRequired

VP count

Example: 10

tokensCountnumberRequired

Token count

Example: 10

ratenumber · max: 100Required

Rate

Example: 50

tagsstring[]Required

tags

Example: ["iRec"]

422

Unprocessable entity

500

Internal server error

application/json

post

/analytics/search/policy

HTTPcURLJavaScriptPython

POST /api/v1/analytics/search/policy HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "text": "text",
  "minVcCount": 10,
  "minVpCount": 10,
  "minTokensCount": 10,
  "threshold": 10,
  "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
  "blocks": {
    "hash": "DdQweGpEqbWgQUZcQjySQn2qYPd3yACGnSoRXiuLt5or",
    "hashMap": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "threshold": 10
  }
}

[
  {
    "type": "Global",
    "topicId": "0.0.4481265",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "name": "Verra REDD",
    "description": "Verra REDD Policy",
    "version": "1.0.0",
    "status": "PUBLISH",
    "messageId": "1706823227.586179534",
    "owner": "did:hedera:testnet:8Go53QCUXZ4nzSQMyoWovWCxseogGTMLDiHg14Fkz4VN_0.0.4481265",
    "textSearch": "text",
    "registryId": "1706823227.586179534",
    "vcCount": 10,
    "vpCount": 10,
    "tokensCount": 10,
    "rate": 50,
    "tags": [
      "iRec"
    ]
  }
]

Search contract retirements

post

Returns contract retirements result

Body

application/json

idstringRequired

Identifier

Example: 667c240639282050117a1985

consensusTimestampstringRequired

Message identifier

Example: 1706823227.586179534

topicIdstringRequired

Topic identifier

Example: 0.0.4481265

statusstringRequired

Status

Example: LOADED

lastUpdatenumberRequired

Last update

Example: 1716755852055

messagestringRequired

Message

Example: eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ

sequenceNumbernumberRequired

Sequence number

Example: 2

ownerstringRequired

Owner

Example: 0.0.1914

chunkIdstringRequired

Chunk identifier

Example: 1706817694.014944860

chunkNumbernumberRequired

Chunk number

Example: 1

chunkTotalnumberRequired

Chunk total

Example: 1

typestringRequired

Type

Example: Message

datastringRequired

Data

Example: `{"id":"eaa629ff-c86b-412e-bc60-c849692d00bb","status":"ISSUE","type":"Standard Registry","action":"Init","lang":"en-US","did":"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176","topicId":"0.0.2176","attributes":{"geography":"test","law":"testtes","tags":"test"}}`

Responses

200

Search policy result

application/json

idstringRequired

Identifier

Example: 667c240639282050117a1985

topicIdstringRequired

Topic identifier

Example: 0.0.4481265

consensusTimestampstringRequired

Message identifier

Example: 1706823227.586179534

ownerstringRequired

Owner

Example: 0.0.1

uuidstringRequired

UUID

Example: 93938a10-d032-4a9b-9425-092e58bffbf7

statusstringRequired

Status

Example: NEW

statusReasonstringRequired

Status

Example: Revoked

langstringRequired

Lang

Example: en-US

responseTypestringRequired

Response type

Example: str

statusMessagestringRequired

Status message

statusOwnerstringRequired

Status owner

filesstring[]Required

Files

Example: ["QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"]

topicsstring[]Required

Topics

Example: ["0.0.4481265"]

tokensstring[]Required

Tokens

Example: ["0.0.4481265"]

sequenceNumbernumberRequired

SequenceNumber

Example: 0

422

Unprocessable entity

500

Internal server error

application/json

post

/analytics/search/retire

HTTPcURLJavaScriptPython

POST /api/v1/analytics/search/retire HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 1000

{
  "id": "667c240639282050117a1985",
  "consensusTimestamp": "1706823227.586179534",
  "topicId": "0.0.4481265",
  "status": "LOADED",
  "lastUpdate": 1716755852055,
  "message": "eyJpZCI6ImVhYTYyOWZmLWM4NmItNDEyZS1iYzYwLWM4NDk2OTJkMDBiYiIsInN0YXR1cyI6IklTU1VFIiwidHlwZSI6IlN0YW5kYXJkIFJlZ2lzdHJ5IiwiYWN0aW9uIjoiSW5pdCIsImxhbmciOiJlbi1VUyIsImRpZCI6ImRpZDpoZWRlcmE6dGVzdG5ldDpBYkd6Q3hpRzRlZ0xibldCUERpaHdMUVIza0tLcnNGNmJnSDdUdmVGYjI3bl8wLjAuMjE3NiIsInRvcGljSWQiOiIwLjAuMjE3NiIsImF0dHJpYnV0ZXMiOnsiZ2VvZ3JhcGh5IjoidGVzdCIsImxhdyI6InRlc3R0ZXMiLCJ0YWdzIjoidGVzdCJ9fQ",
  "sequenceNumber": 2,
  "owner": "0.0.1914",
  "chunkId": "1706817694.014944860",
  "chunkNumber": 1,
  "chunkTotal": 1,
  "type": "Message",
  "data": "`{\"id\":\"eaa629ff-c86b-412e-bc60-c849692d00bb\",\"status\":\"ISSUE\",\"type\":\"Standard Registry\",\"action\":\"Init\",\"lang\":\"en-US\",\"did\":\"did:hedera:testnet:AbGzCxiG4egLbnWBPDihwLQR3kKKrsF6bgH7TveFb27n_0.0.2176\",\"topicId\":\"0.0.2176\",\"attributes\":{\"geography\":\"test\",\"law\":\"testtes\",\"tags\":\"test\"}}`"
}

[
  {
    "id": "667c240639282050117a1985",
    "topicId": "0.0.4481265",
    "consensusTimestamp": "1706823227.586179534",
    "owner": "0.0.1",
    "uuid": "93938a10-d032-4a9b-9425-092e58bffbf7",
    "status": "NEW",
    "statusReason": "Revoked",
    "lang": "en-US",
    "responseType": "str",
    "statusMessage": "text",
    "statusOwner": "text",
    "files": [
      "QmYtKEVfpbDwn7XLHjnjap224ESi3vLiYpkbWoabnxs6cX"
    ],
    "topics": [
      "0.0.4481265"
    ],
    "tokens": [
      "0.0.4481265"
    ],
    "sequenceNumber": 0
  }
]

Get indexer availability

get

Returns indexer availability

Responses

200

Indexer availability result

application/json

booleanOptional

500

Internal server error

application/json

get

/analytics/checkAvailability

HTTPcURLJavaScriptPython

GET /api/v1/analytics/checkAvailability HTTP/1.1
Accept: */*

true

post

Path parameters

messageIdstringRequired

Body

application/json

idLvlone ofOptionalExample: 0Possible values:

stringOptional

or

numberOptional

eventsLvlone ofOptionalExample: 0Possible values:

stringOptional

or

numberOptional

propLvlone ofOptionalExample: 0Possible values:

stringOptional

or

numberOptional

childrenLvlone ofOptionalExample: 0Possible values:

stringOptional

or

numberOptional

Responses

200

Successful operation.

application/json

blocksobjectRequired

groupsobjectRequired

leftobjectRequired

rightobjectRequired

rolesobjectRequired

tokensobjectRequired

topicsobjectRequired

totalobjectRequired

500

Internal server error.

application/json

post

/analytics/compare/policy/original/{messageId}

HTTPcURLJavaScriptPython

POST /api/v1/analytics/compare/policy/original/{messageId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "idLvl": 0,
  "eventsLvl": 0,
  "propLvl": 0,
  "childrenLvl": 0
}

{
  "blocks": {},
  "groups": {},
  "left": {},
  "right": {},
  "roles": {},
  "tokens": {},
  "topics": {},
  "total": {}
}

get

Path parameters

messageIdstringRequired

Query parameters

pageIndexstringRequired

pageSizestringRequired

orderFieldstringRequired

orderDirstringRequired

keywordsstringRequired

topicIdstringRequired

options.ownerstringRequired

analytics.toolsstringRequired

Responses

500

Internal server error.

application/json

get

/analytics/derivations/{messageId}

HTTPcURLJavaScriptPython

GET /api/v1/analytics/derivations/{messageId}?pageIndex=text&pageSize=text&orderField=text&orderDir=text&keywords=text&topicId=text&options.owner=text&analytics.tools=text HTTP/1.1
Accept: */*

500

Internal server error.

{
  "code": 500,
  "message": "Error message"
}