Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Analytics

Query and export usage analytics across the platform.

Search policies.

post

Search policies. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
typestring · enumOptionalExample: LocalPossible values:
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
minVcCountnumberOptionalExample: 0
minVpCountnumberOptionalExample: 0
minTokensCountnumberOptionalExample: 0
textstringOptionalExample: Policy name
thresholdnumber · max: 100OptionalExample: 0
toolMessageIdsstring[]OptionalExample: ["69aeb71ef8c5b278e3bab4e5","69aeb71ef8c5b278e3bab4e5"]
toolNamestringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
toolVersionstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
Responses
200

Successful operation.

application/json
post/analytics/search/policies
POST /api/v1/analytics/search/policies HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "policyId": "69aeb71ef8c5b278e3bab4e5"
}
{
  "target": {
    "type": "Local",
    "id": "69b7cd37a48bb15eb7afb308",
    "topicId": "0.0.8245828",
    "messageId": "1773653426.428090343",
    "uuid": "9d948508-4cc4-49f3-9c1e-c9fb9976c602",
    "name": "Remote Work GHG Policy",
    "description": "Remote_Work_GHG_Policy",
    "version": "1",
    "status": "PUBLISH",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8145348",
    "vcCount": 1,
    "vpCount": 0,
    "tokensCount": 0,
    "rate": 100,
    "tags": []
  },
  "result": [
    {
      "type": "Local",
      "id": "69b7da996d2f71c7a55b1fa3",
      "topicId": "0.0.8246509",
      "messageId": "1773662571.607239000",
      "uuid": "df23e461-c3ba-48d5-9bf6-db1f96a2f2b7",
      "name": "CDM AMS-III.AR Policy",
      "description": "Substituting fossil fuel-based lighting with LED/CFL lighting systems",
      "version": "1",
      "status": "PUBLISH",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8145348",
      "vcCount": 1,
      "vpCount": 0,
      "tokensCount": 0,
      "rate": 9,
      "tags": []
    },
    {
      "type": "Local",
      "id": "69b9727c3ac44dc8f6b50a8b",
      "topicId": "0.0.8264658",
      "messageId": "1773763808.323660342",
      "uuid": "e8e70f1c-fc6f-48cd-a0f1-6de39f6efb02",
      "name": "CDM AMS-II.G Policy",
      "description": "Energy efficiency measures in thermal applications of non-renewable biomass",
      "version": "1",
      "status": "PUBLISH",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8145348",
      "vcCount": 1,
      "vpCount": 0,
      "tokensCount": 0,
      "rate": 9,
      "tags": []
    },
    {
      "type": "Local",
      "id": "69b9719c3ac44dc8f6b5096a",
      "topicId": "0.0.8264592",
      "messageId": "1773761007.292762801",
      "uuid": "a57b4e28-2b81-4d43-83a6-8c85d7983b0f",
      "name": "CDM AMS-III.BB",
      "description": "CDM AMS-III.BB. policy",
      "version": "1",
      "status": "PUBLISH",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8145348",
      "vcCount": 1,
      "vpCount": 0,
      "tokensCount": 0,
      "rate": 8,
      "tags": []
    }
  ]
}

Compare policies.

post

Compare policies. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
eventsLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
propLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
childrenLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
policyId1stringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyId2stringOptionalExample: 69b8115f3dc0fa022156fb89
policyIdsstring[]OptionalExample: ["69aeb71ef8c5b278e3bab4e5","69b8115f3dc0fa022156fb89"]
Responses
200

Successful operation.

application/json
or
post/analytics/compare/policies
POST /api/v1/analytics/compare/policies HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "policies": [
    {
      "type": "id",
      "value": "69aeb71ef8c5b278e3bab4e5"
    },
    {
      "type": "message",
      "value": "1773670900.819264517"
    },
    {
      "type": "file",
      "value": {
        "id": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
        "name": "File Name",
        "value": "base65..."
      }
    }
  ],
  "eventsLvl": "0",
  "propLvl": "0",
  "childrenLvl": "0",
  "idLvl": "0"
}
{
  "left": {},
  "right": {},
  "total": 24,
  "blocks": {
    "columns": [],
    "report": []
  },
  "roles": {
    "columns": [],
    "report": []
  },
  "groups": {
    "columns": [],
    "report": []
  },
  "topics": {
    "columns": [],
    "report": []
  },
  "tokens": {
    "columns": [],
    "report": []
  },
  "tools": {
    "columns": [],
    "report": []
  }
}

Compare policies with original state.

post

Compare policies with original state. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
policyIdstringRequired

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Body
idLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
eventsLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
propLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
childrenLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
Responses
200

Successful operation.

application/json
totalnumberRequiredExample: 66
post/analytics/compare/policy/original/{policyId}
POST /api/v1/analytics/compare/policy/original/{policyId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "eventsLvl": "1",
  "propLvl": "1",
  "childrenLvl": "0",
  "idLvl": "0"
}
{
  "left": {},
  "right": {},
  "total": 24,
  "blocks": {
    "columns": [],
    "report": []
  },
  "roles": {
    "columns": [],
    "report": []
  },
  "groups": {
    "columns": [],
    "report": []
  },
  "topics": {
    "columns": [],
    "report": []
  },
  "tokens": {
    "columns": [],
    "report": []
  },
  "tools": {
    "columns": [],
    "report": []
  }
}

Compare modules.

post

Compare modules. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
eventsLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
propLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
childrenLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
moduleId1stringRequiredExample: 69aeb71ef8c5b278e3bab4e5
moduleId2stringRequiredExample: 69b8115f3dc0fa022156fb89
Responses
200

Successful operation.

application/json
totalnumberRequiredExample: 22
post/analytics/compare/modules
POST /api/v1/analytics/compare/modules HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "eventsLvl": "2",
  "propLvl": "2",
  "childrenLvl": "2",
  "idLvl": "0",
  "moduleId1": "69baa4cf63637d350db5b59c",
  "moduleId2": "69baa4b563637d350db5b594"
}
{
  "left": {
    "id": "69baa4cf63637d350db5b59c",
    "name": "Module_1",
    "description": "Description"
  },
  "right": {
    "id": "69baa4b563637d350db5b594",
    "name": "Module_2",
    "description": ""
  },
  "total": 22,
  "blocks": {
    "columns": [],
    "report": []
  },
  "inputEvents": {
    "columns": [],
    "report": []
  },
  "outputEvents": {
    "columns": [],
    "report": []
  },
  "variables": {
    "columns": [],
    "report": []
  }
}

Compare schemas.

post

Compare schemas. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
or
Responses
200

Successful operation.

application/json
totalnumberRequiredExample: 44
post/analytics/compare/schemas
POST /api/v1/analytics/compare/schemas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "schemaId1": "69aeb71ef8c5b278e3bab4e5",
  "schemaId2": "69b8115f3dc0fa022156fb89",
  "idLvl": "0"
}
{
  "left": {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "name": "Schema_1",
    "description": "Description_1",
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "topicId": "0.0.6046379",
    "version": "1.0.0",
    "iri": "#20e0202f-bbf6-441e-97e8-b2c9af9a3a4d&1.0.0",
    "policy": "CDM AMS-II.J Policy"
  },
  "right": {
    "id": "69b8115f3dc0fa022156fb89",
    "name": "Schema_2",
    "description": "Description_2",
    "uuid": "3ec235e9-fffc-42ff-b1c3-f3ba712b8a5b",
    "topicId": "0.0.8264622",
    "version": "1.0.0",
    "iri": "#e998578c-ef14-4c4b-96a8-3158c5a0f9ab&1.0.0",
    "policy": "VM0042 V2.1"
  },
  "total": 44,
  "fields": {
    "columns": [],
    "report": []
  }
}

Compare documents.

post

Compare documents. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
or
Responses
200

Successful operation.

application/json
or
post/analytics/compare/documents
POST /api/v1/analytics/compare/documents HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "eventsLvl": "0",
  "propLvl": "0",
  "childrenLvl": "0",
  "idLvl": "0",
  "documentId1": "69aeb71ef8c5b278e3bab4e5",
  "documentId2": "69b8115f3dc0fa022156fb89"
}
{
  "left": {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "type": "VerifiableCredential",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "policy": "69b9727c3ac44dc8f6b50a8b"
  },
  "right": {
    "id": "69b8115f3dc0fa022156fb89",
    "type": "VerifiableCredential",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "policy": "69b7da996d2f71c7a55b1fa3"
  },
  "total": 68,
  "documents": {
    "columns": [],
    "report": []
  }
}

Compare tools.

post

Compare tools. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
or
Responses
200

Successful operation.

application/json
or
post/analytics/compare/tools
POST /api/v1/analytics/compare/tools HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "eventsLvl": "0",
  "propLvl": "0",
  "childrenLvl": "0",
  "idLvl": "0",
  "toolId1": "69aeb71ef8c5b278e3bab4e5",
  "toolId2": "69b8115f3dc0fa022156fb89"
}
{
  "left": {
    "id": "69b9727a3ac44dc8f6b50a44",
    "name": "Tool 30",
    "description": "",
    "hash": "4r7i6SXuDxDrk8dkwomzgkfFp8FqMuWSCsuWqZhhYLZ4",
    "messageId": "1707417996.173398196"
  },
  "right": {
    "id": "69b7da936d2f71c7a55b1e99",
    "name": "Tool 21",
    "description": "",
    "hash": "71ZWDSX2cUPsye4AuMUqXUhgk1XBDnpi4Ky1mtjYqYom",
    "messageId": "1706873385.455822873"
  },
  "total": 74,
  "blocks": {
    "columns": [],
    "report": []
  },
  "inputEvents": {
    "columns": [],
    "report": []
  },
  "outputEvents": {
    "columns": [],
    "report": []
  },
  "variables": {
    "columns": [],
    "report": []
  }
}

Compare policies.

post

Compare policies. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
typestringRequired

File type

Example: csv
Body
idLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
eventsLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
propLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
childrenLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
policyId1stringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyId2stringOptionalExample: 69b8115f3dc0fa022156fb89
policyIdsstring[]OptionalExample: ["69aeb71ef8c5b278e3bab4e5","69b8115f3dc0fa022156fb89"]
Responses
200

Successful operation.

text/csv
stringOptional
post/analytics/compare/policies/export
POST /api/v1/analytics/compare/policies/export?type=csv HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "policies": [
    {
      "type": "id",
      "value": "69aeb71ef8c5b278e3bab4e5"
    },
    {
      "type": "message",
      "value": "1773670900.819264517"
    },
    {
      "type": "file",
      "value": {
        "id": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
        "name": "File Name",
        "value": "base65..."
      }
    }
  ],
  "eventsLvl": "0",
  "propLvl": "0",
  "childrenLvl": "0",
  "idLvl": "0"
}
data:text/csv;charset=utf-8;"Policy 1"
"Policy ID","Policy Name","Policy Description","Policy Topic","Policy Version"
"69b98f573ac44dc8f6b50b66","Test_Policy_2","","",""

"Policy 2"
"Policy ID","Policy Name","Policy Description","Policy Topic","Policy Version"
"69b98d6a3ac44dc8f6b50b03","Test_Policy_1","","",""

"Policy Roles"
"Name","Name","Total Rate"

"Policy Groups"
"Name","Name","Total Rate"

"Policy Topics"
"Name","Name","Total Rate"

"Policy Tokens"
"Name","Name","Total Rate"

"Policy Tools"
"Name","Name","Total Rate"

"Policy Blocks"
"Offset","Index","Type","Tag","Index","Type","Tag","Index Rate","Permission Rate","Prop Rate","Event Rate","Artifact Rate","Total Rate"
"1","1","interfaceContainerBlock","","1","interfaceContainerBlock","","100%","100%","80%","100%","100%","95%"
"2","1","interfaceContainerBlock","Block_1","1","interfaceContainerBlock","Block_1","100%","100%","83%","0%","100%","70%"
"2","","","","2","interfaceContainerBlock","Block_2","-","-","-","-","-","-"

"Total","66%"

Compare modules.

post

Compare modules. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
typestringRequired

File type

Example: csv
Body
idLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
eventsLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
propLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
childrenLvlone ofOptionalExample: 0
string · enumOptionalPossible values:
or
number · enumOptionalPossible values:
moduleId1stringRequiredExample: 69aeb71ef8c5b278e3bab4e5
moduleId2stringRequiredExample: 69b8115f3dc0fa022156fb89
Responses
200

Successful operation.

text/csv
stringOptional
post/analytics/compare/modules/export
POST /api/v1/analytics/compare/modules/export?type=csv HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "eventsLvl": "2",
  "propLvl": "2",
  "childrenLvl": "2",
  "idLvl": "0",
  "moduleId1": "69baa4cf63637d350db5b59c",
  "moduleId2": "69baa4b563637d350db5b594"
}
data:text/csv;charset=utf-8;"Module 1"
"Module ID","Module Name","Module Description"
"69baa4cf63637d350db5b59c","Module_1","Some specific module for test purposes"

"Module 2"
"Module ID","Module Name","Module Description"
"69baa4b563637d350db5b594","test",""

"Module Input Events"
"Name","Name","Total Rate"

"Module Output Events"
"Name","Name","Total Rate"
"","VC","-"

"Module Variables"
"Name","Name","Total Rate"
"","schema","-"

"Module Blocks"
"Offset","Index","Type","Tag","Index","Type","Tag","Index Rate","Permission Rate","Prop Rate","Event Rate","Artifact Rate","Total Rate"
"1","1","module","Module","1","module","Module","100%","100%","20%","100%","100%","80%"
"2","1","interfaceContainerBlock","Block_1","","","","-","-","-","-","-","-"
"2","","","","1","requestVcDocumentBlock","Block_1","-","-","-","-","-","-"
"2","","","","2","sendToGuardianBlock","Block_2","-","-","-","-","-","-"

"Total","22%"

Compare schemas.

post

Compare schemas. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
typestringRequired

File type

Example: csv
Body
or
Responses
200

Successful operation.

text/csv
stringOptional
post/analytics/compare/schemas/export
POST /api/v1/analytics/compare/schemas/export?type=csv HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "schemaId1": "69aeb71ef8c5b278e3bab4e5",
  "schemaId2": "69b8115f3dc0fa022156fb89",
  "idLvl": "0"
}
data:text/csv;charset=utf-8;"Schema 1"
"Schema ID","Schema Name","Schema Description","Schema Topic","Schema Version"
"#99b759f6-462d-4d85-97bf-afeb2eedae3d","Date Range","","0.0.8275392","1.0.0"

"Schema 2"
"Schema ID","Schema Name","Schema Description","Schema Topic","Schema Version"
"#32281127-d22c-4997-8821-50b33b3dbf81&1.0.0","Date Range","","0.0.8264592","1.0.0"

"Schema Fields"
"Offset","Index","Field Name","Index","Field Name","Index Rate","Prop Rate","Total Rate"
"1","-1","id","-1","id","100%","100%","100%"
"1","0","field0","0","field0","100%","88%","88%"
"1","1","field1","1","field1","100%","88%","88%"

"Total","92%"

Compare documents.

post

Compare documents. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
typestringRequired

File type

Example: csv
Body
or
Responses
200

Successful operation.

text/csv
stringOptional
post/analytics/compare/documents/export
POST /api/v1/analytics/compare/documents/export?type=csv HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "eventsLvl": "0",
  "propLvl": "0",
  "childrenLvl": "0",
  "idLvl": "0",
  "documentId1": "69aeb71ef8c5b278e3bab4e5",
  "documentId2": "69b8115f3dc0fa022156fb89"
}
data:text/csv;charset=utf-8;"Document 1"
"Document ID","Document Type","Document Owner","Policy"
"69bade1834a0e18a5386cb9c","VC","did:hedera:testnet:4FmP2iynDzSgmCLGec9xSWYEvda3MW6oSPxZPz11zSLZ_0.0.8145348","69b9727c3ac44dc8f6b50a8b"

"Document 2"
"Document ID","Document Type","Document Owner","Policy"
"69badb212b76af3f7f759084","VC","did:hedera:testnet:4FmP2iynDzSgmCLGec9xSWYEvda3MW6oSPxZPz11zSLZ_0.0.8145348","69b7da996d2f71c7a55b1fa3"

"Data"
"Offset","ID","Message","Type","Schema","Owner","ID","Message","Type","Schema","Owner","Document Rate","Options Rate","Total Rate"
"1","69bade1834a0e18a5386cb9c","1773854231.595894000","VC","PP","did:hedera:testnet:4FmP2iynDzSgmCLGec9xSWYEvda3MW6oSPxZPz11zSLZ_0.0.8145348","69badb212b76af3f7f759084","1773853471.698871273","VC","PP","did:hedera:testnet:4FmP2iynDzSgmCLGec9xSWYEvda3MW6oSPxZPz11zSLZ_0.0.8145348","95%","100%","97%"
"2","69baddfe34a0e18a5386cb8b","1773854204.523907802","VC","PP","did:hedera:testnet:4FmP2iynDzSgmCLGec9xSWYEvda3MW6oSPxZPz11zSLZ_0.0.8145348","69badb092b76af3f7f759073","1773853447.748138817","VC","PP","did:hedera:testnet:4FmP2iynDzSgmCLGec9xSWYEvda3MW6oSPxZPz11zSLZ_0.0.8145348","95%","100%","97%"

"Total","97%"

Compare tools.

post

Compare tools. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
typestringRequired

File type

Example: csv
Body
or
Responses
200

Successful operation.

text/csv
stringOptional
post/analytics/compare/tools/export
POST /api/v1/analytics/compare/tools/export?type=csv HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "eventsLvl": "0",
  "propLvl": "0",
  "childrenLvl": "0",
  "idLvl": "0",
  "toolId1": "69aeb71ef8c5b278e3bab4e5",
  "toolId2": "69b8115f3dc0fa022156fb89"
}
data:text/csv;charset=utf-8;"Tool 1"
"Tool ID","Tool Name","Tool Description","Tool Hash","Tool Message"
"69b9727a3ac44dc8f6b50a44","Tool 30","","4r7i6SXuDxDrk8dkwomzgkfFp8FqMuWSCsuWqZhhYLZ4","1707417996.173398196"

"Tool 2"
"Tool ID","Tool Name","Tool Description","Tool Hash","Tool Message"
"69b7da936d2f71c7a55b1e99","Tool 21","","71ZWDSX2cUPsye4AuMUqXUhgk1XBDnpi4Ky1mtjYqYom","1706873385.455822873"

"Tool Input Events"
"Name","Name","Total Rate"
"input_tool_30","","-"
"","input_tool_21","-"

"Tool Output Events"
"Name","Name","Total Rate"
"output_tool_30","","-"
"","output_tool_21","-"

"Tool Variables"
"Name","Name","Total Rate"
"Role","Role","100%"

"Tool Blocks"
"Offset","Index","Type","Tag","Index","Type","Tag","Index Rate","Permission Rate","Prop Rate","Event Rate","Artifact Rate","Total Rate"
"1","1","tool","Tool","1","tool","Tool","100%","100%","81%","0%","100%","70%"
"2","1","extractDataBlock","get_tool_30","1","extractDataBlock","get_tool_21","100%","100%","60%","100%","100%","90%"
"2","2","customLogicBlock","calc_tool_30","","","","-","-","-","-","-","-"
"2","3","extractDataBlock","set_tool_30","2","extractDataBlock","set_tool_21","0%","100%","60%","0%","100%","65%"

"Total","35%"

Search same blocks.

post

Search same blocks. Only users with the Standard Registry role are allowed to make the request.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstringRequiredExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
Responses
200

Successful operation.

application/json
namestringRequiredExample: CDM AMS-III.AR Policy
descriptionstringRequiredExample: Substituting fossil fuel-based lighting with LED/CFL lighting systems
versionstringRequiredExample: 1
ownerstringRequiredExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringRequiredExample: 0.0.6046379
messageIdstringRequiredExample: 1773670900.819264517
hashnumberRequiredExample: 12099
post/analytics/search/blocks
POST /api/v1/analytics/search/blocks HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 606

{
  "id": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "config": {
    "id": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "blockType": "interfaceContainerBlock",
    "uiMetaData": {
      "type": "blank"
    },
    "permissions": [
      "ANY_ROLE"
    ],
    "defaultActive": true,
    "onErrorAction": "no-action",
    "tag": "",
    "children": [
      {
        "id": "e9c0d9ee-fc29-4372-89e0-0a7e08516699",
        "blockType": "policyRolesBlock",
        "defaultActive": true,
        "uiMetaData": {
          "title": "Roles",
          "description": "Choose Roles"
        },
        "roles": [
          "Project Participant",
          "VVB"
        ],
        "permissions": [
          "NO_ROLE"
        ],
        "onErrorAction": "no-action",
        "tag": "Choose_Roles1",
        "children": [],
        "events": [],
        "artifacts": []
      }
    ],
    "events": [],
    "artifacts": []
  }
}
[
  {
    "name": "CDM AMS-III.AR Policy",
    "description": "Substituting fossil fuel-based lighting with LED/CFL lighting systems",
    "version": "1",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "topicId": "0.0.6046379",
    "messageId": "1773670900.819264517",
    "hash": 12099,
    "chains": [
      {
        "hash": 12099,
        "target": {
          "id": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
          "tag": "pp_grid_sr",
          "blockType": "interfaceDocumentsSourceBlock",
          "config": {
            "id": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
            "blockType": "interfaceDocumentsSourceBlock",
            "tag": "pp_grid_sr"
          },
          "path": [
            0,
            1,
            0,
            0
          ]
        },
        "pairs": [
          {
            "hash": 100,
            "source": {
              "id": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
              "tag": "header",
              "blockType": "interfaceContainerBlock",
              "config": {
                "id": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
                "blockType": "interfaceContainerBlock",
                "tag": "header"
              },
              "path": [
                0,
                1
              ]
            },
            "filter": {
              "id": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
              "tag": "header",
              "blockType": "interfaceContainerBlock",
              "config": {
                "id": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
                "blockType": "interfaceContainerBlock",
                "tag": "header"
              },
              "path": [
                0,
                1
              ]
            }
          }
        ]
      }
    ]
  }
]

Get Indexer Availability.

get

Returns Indexer Availability (true/false).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Successful operation.

application/json
booleanOptional
get/analytics/checkIndexer
GET /api/v1/analytics/checkIndexer HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Last updated