For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
Skip to content

Statistics

Usage and execution statistics for policies.

Return a list of all statistic definitions.

get

Returns a paginated list of statistic definitions owned by the current user. Optionally filter by policy instance topic ID.

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

The number of pages to skip before starting to collect the result set

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
policyInstanceTopicIdstringOptional

Policy Instance Topic Id

Example: 0.0.6046379
Responses
200

Successful operation. Returns statistic definitions array and total count in X-Total-Count header.

application/json
get/policy-statistics
GET /api/v1/policy-statistics HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "name": "Carbon Emission Statistics",
    "description": "Tracks carbon emission reductions across policy documents",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "topicId": "0.0.6046379",
    "messageId": "1773670900.819264517",
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "status": "DRAFT",
    "config": {}
  }
]

Creates a new statistic definition.

post

Creates a new statistic definition linked to a policy. Defines metrics and rules for collecting and aggregating policy document data.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
Responses
201

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
post/policy-statistics
POST /api/v1/policy-statistics HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "name": "Carbon Stats",
  "description": "Track emissions reductions",
  "policyId": "69aeb71ef8c5b278e3bab4e5"
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Carbon Statistics",
  "description": "Description",
  "creator": "string",
  "owner": "string",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "69aeb71ef8c5b278e3bab4e5",
  "policyInstanceTopicId": "69aeb71ef8c5b278e3bab4e5",
  "status": "string",
  "config": {}
}

Retrieves statistic definition.

get

Retrieves statistic definition for the specified ID.

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

Statistic Definition Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
get/policy-statistics/{definitionId}
GET /api/v1/policy-statistics/{definitionId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Carbon Statistics",
  "description": "Description",
  "creator": "string",
  "owner": "string",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "69aeb71ef8c5b278e3bab4e5",
  "policyInstanceTopicId": "69aeb71ef8c5b278e3bab4e5",
  "status": "string",
  "config": {}
}

Updates statistic definition.

put

Updates statistic definition configuration for the specified statistic ID.

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

Statistic Definition Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Body
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
Responses
200

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
put/policy-statistics/{definitionId}
PUT /api/v1/policy-statistics/{definitionId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "name": "Updated Carbon Stats",
  "description": "Updated description for emissions tracking",
  "policyId": "69aeb71ef8c5b278e3bab4e5"
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Carbon Statistics",
  "description": "Description",
  "creator": "string",
  "owner": "string",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "69aeb71ef8c5b278e3bab4e5",
  "policyInstanceTopicId": "69aeb71ef8c5b278e3bab4e5",
  "status": "string",
  "config": {}
}

Deletes the statistic definition.

delete

Deletes the statistic definition with the provided ID.

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

Statistic Definition Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
booleanOptional
delete/policy-statistics/{definitionId}
DELETE /api/v1/policy-statistics/{definitionId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true

Publishes statistic definition.

put

Publishes statistic definition for the specified statistic ID.

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

Statistic Definition Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
put/policy-statistics/{definitionId}/publish
PUT /api/v1/policy-statistics/{definitionId}/publish HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Carbon Statistics",
  "description": "Description",
  "creator": "string",
  "owner": "string",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "69aeb71ef8c5b278e3bab4e5",
  "policyInstanceTopicId": "69aeb71ef8c5b278e3bab4e5",
  "status": "string",
  "config": {}
}

Retrieves statistic relationships.

get

Retrieves statistic relationships for the specified ID.

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

Statistic Definition Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
get/policy-statistics/{definitionId}/relationships
GET /api/v1/policy-statistics/{definitionId}/relationships HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "policy": {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "name": "Policy name",
    "description": "Description",
    "topicDescription": "Description",
    "policyTag": "Tag",
    "status": "DRAFT",
    "creator": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "topicId": "0.0.6046379",
    "messageId": "1773670900.819264517",
    "codeVersion": "1.0.0",
    "createDate": "2026-03-03T17:25:53.312Z",
    "version": "1.0.0",
    "originalChanged": true,
    "config": {},
    "userRole": "Installer",
    "userRoles": [
      "Installer"
    ],
    "userGroup": {
      "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
      "role": "Installer",
      "groupLabel": "Label",
      "groupName": "Name",
      "active": true
    },
    "userGroups": [
      {
        "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
        "role": "Installer",
        "groupLabel": "Label",
        "groupName": "Name",
        "active": true
      }
    ],
    "policyRoles": [
      "Registrant"
    ],
    "policyNavigation": [
      {
        "role": "Registrant",
        "steps": [
          {
            "block": "Block tag",
            "level": 1,
            "name": "Step name"
          }
        ]
      }
    ],
    "policyTopics": [
      {
        "name": "Project",
        "description": "Project",
        "memoObj": "topic",
        "static": false,
        "type": "any"
      }
    ],
    "policyTokens": [
      {
        "tokenName": "Token name",
        "tokenSymbol": "Token symbol",
        "tokenType": "non-fungible",
        "decimals": "",
        "changeSupply": true,
        "enableAdmin": true,
        "enableFreeze": true,
        "enableKYC": true,
        "enableWipe": true,
        "templateTokenTag": "token_template_0"
      }
    ],
    "policyGroups": [
      {
        "name": "Group name",
        "creator": "Registrant",
        "groupAccessType": "Private",
        "groupRelationshipType": "Multiple",
        "members": [
          "Registrant"
        ]
      }
    ],
    "categories": [
      "string"
    ],
    "projectSchema": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "tests": [
      {
        "id": "69aeb71ef8c5b278e3bab4e5",
        "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
        "name": "Test Name",
        "policyId": "69aeb71ef8c5b278e3bab4e5",
        "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
        "status": "NEW",
        "date": "2026-03-03T17:25:53.312Z",
        "duration": 0,
        "progress": 0,
        "resultId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
        "result": {}
      }
    ],
    "ignoreRules": [
      {
        "code": "string",
        "blockType": "string",
        "property": "string",
        "contains": "string",
        "severity": "warning"
      }
    ]
  },
  "schemas": [
    {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
      "name": "Schema name",
      "description": "Description",
      "entity": "POLICY",
      "iri": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
      "status": "DRAFT",
      "topicId": "0.0.6046379",
      "version": "1.0.0",
      "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
      "messageId": "1773670900.819264517",
      "category": "POLICY",
      "documentURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "contextURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "document": {},
      "context": {}
    }
  ],
  "schema": {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "name": "Schema name",
    "description": "Description",
    "entity": "POLICY",
    "iri": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "status": "DRAFT",
    "topicId": "0.0.6046379",
    "version": "1.0.0",
    "owner": "did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599",
    "messageId": "1773670900.819264517",
    "category": "POLICY",
    "documentURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "contextURL": "ipfs://AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "document": {},
    "context": {}
  }
}

Return a list of all documents.

get

Returns all documents.

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

Statistic Definition Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Query parameters
pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
Responses
200

Successful operation.

application/json
get/policy-statistics/{definitionId}/documents
GET /api/v1/policy-statistics/{definitionId}/documents HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "hash": "hash",
    "signature": 0,
    "status": "NEW",
    "tag": "Block tag",
    "type": "Document type",
    "createDate": "string",
    "updateDate": "string",
    "owner": "string",
    "document": {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "type": [
        "string"
      ],
      "credentialSubject": {},
      "issuer": {},
      "issuanceDate": "string",
      "proof": {
        "type": "string",
        "created": "string",
        "verificationMethod": "string",
        "proofPurpose": "string",
        "jws": "string"
      }
    }
  }
]

Return a list of all statistic assessment.

get

Returns all statistic assessment.

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

Statistic Definition Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Query parameters
pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
Responses
200

Successful operation.

application/json
get/policy-statistics/{definitionId}/assessment
GET /api/v1/policy-statistics/{definitionId}/assessment HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "definitionId": "69aeb71ef8c5b278e3bab4e5",
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "policyTopicId": "69aeb71ef8c5b278e3bab4e5",
    "policyInstanceTopicId": "69aeb71ef8c5b278e3bab4e5",
    "topicId": "0.0.6046379",
    "creator": "string",
    "owner": "string",
    "messageId": "1773670900.819264517",
    "target": "string",
    "relationships": [
      "1773670900.819264517"
    ],
    "document": {}
  }
]

Creates a new statistic assessment.

post

Creates a new statistic assessment.

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

Statistic Definition Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Body
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
definitionIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
topicIdstringOptionalExample: 0.0.6046379
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstringOptionalExample: 1773670900.819264517
targetstringOptionalExample: 1773670900.819264517
relationshipsstring[]OptionalExample: ["1773670900.819264517"]
Responses
201

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
definitionIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
topicIdstringOptionalExample: 0.0.6046379
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstringOptionalExample: 1773670900.819264517
targetstringOptionalExample: 1773670900.819264517
relationshipsstring[]OptionalExample: ["1773670900.819264517"]
post/policy-statistics/{definitionId}/assessment
POST /api/v1/policy-statistics/{definitionId}/assessment HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "definitionId": "69aeb71ef8c5b278e3bab4e5",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "target": "69aeb71ef8c5b278e3bab4e5",
  "document": {}
}
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "definitionId": "69aeb71ef8c5b278e3bab4e5",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "69aeb71ef8c5b278e3bab4e5",
  "policyInstanceTopicId": "69aeb71ef8c5b278e3bab4e5",
  "topicId": "0.0.6046379",
  "creator": "string",
  "owner": "string",
  "messageId": "1773670900.819264517",
  "target": "string",
  "relationships": [
    "message-id"
  ],
  "document": {}
}

Retrieves statistic assessment.

get

Retrieves statistic assessment for the specified ID.

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

Statistic Definition Identifier

Example: 69aeb71ef8c5b278e3bab4e5
assessmentIdstringRequired

Statistic Assessment Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
definitionIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
topicIdstringOptionalExample: 0.0.6046379
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
messageIdstringOptionalExample: 1773670900.819264517
targetstringOptionalExample: 1773670900.819264517
relationshipsstring[]OptionalExample: ["1773670900.819264517"]
get/policy-statistics/{definitionId}/assessment/{assessmentId}
GET /api/v1/policy-statistics/{definitionId}/assessment/{assessmentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "definitionId": "69aeb71ef8c5b278e3bab4e5",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "69aeb71ef8c5b278e3bab4e5",
  "policyInstanceTopicId": "69aeb71ef8c5b278e3bab4e5",
  "topicId": "0.0.6046379",
  "creator": "string",
  "owner": "string",
  "messageId": "1773670900.819264517",
  "target": "string",
  "relationships": [
    "message-id"
  ],
  "document": {}
}

Retrieves assessment relationships.

get

Retrieves assessment relationships for the specified ID.

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

Statistic Definition Identifier

Example: 69aeb71ef8c5b278e3bab4e5
assessmentIdstringRequired

Statistic Assessment Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation.

application/json
get/policy-statistics/{definitionId}/assessment/{assessmentId}/relationships
GET /api/v1/policy-statistics/{definitionId}/assessment/{assessmentId}/relationships HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "target": {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "hash": "hash",
    "signature": 0,
    "status": "NEW",
    "tag": "Block tag",
    "type": "Document type",
    "createDate": "string",
    "updateDate": "string",
    "owner": "string",
    "document": {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "type": [
        "string"
      ],
      "credentialSubject": {},
      "issuer": {},
      "issuanceDate": "string",
      "proof": {
        "type": "string",
        "created": "string",
        "verificationMethod": "string",
        "proofPurpose": "string",
        "jws": "string"
      }
    }
  },
  "relationships": [
    {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "policyId": "69aeb71ef8c5b278e3bab4e5",
      "hash": "hash",
      "signature": 0,
      "status": "NEW",
      "tag": "Block tag",
      "type": "Document type",
      "createDate": "string",
      "updateDate": "string",
      "owner": "string",
      "document": {
        "id": "69aeb71ef8c5b278e3bab4e5",
        "type": [
          {}
        ],
        "credentialSubject": {},
        "issuer": {},
        "issuanceDate": "string",
        "proof": {
          "type": {},
          "created": {},
          "verificationMethod": {},
          "proofPurpose": {},
          "jws": {}
        }
      }
    }
  ]
}

Imports new statistic definition from a zip file.

post

Imports new statistic definition from the provided zip file into the local DB.

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

Policy Id

Example: 69aeb71ef8c5b278e3bab4e5
Body
stringOptional
Responses
201

Successful operation.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
post/policy-statistics/{policyId}/import/file
POST /api/v1/policy-statistics/{policyId}/import/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Carbon Statistics",
  "description": "Description",
  "creator": "string",
  "owner": "string",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "69aeb71ef8c5b278e3bab4e5",
  "policyInstanceTopicId": "69aeb71ef8c5b278e3bab4e5",
  "status": "string",
  "config": {}
}

Returns a zip file containing statistic definition.

get

Returns a zip file containing statistic definition.

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

Statistic Definition Identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Successful operation. Response zip file.

application/zip
string · binaryOptional
get/policy-statistics/{definitionId}/export/file
GET /api/v1/policy-statistics/{definitionId}/export/file HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "result": "ok"
}

Imports a zip file containing statistic definition.

post

Imports a zip file containing statistic definition.

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

Statistic definition preview.

application/json
idstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
uuidstringOptionalExample: 9db028d2-03ad-4d49-a178-cf4b67f8c147
namestringRequiredExample: Tool name
descriptionstringOptionalExample: Description
creatorstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
ownerstringOptionalExample: did:hedera:testnet:Cvzp5kKVUuipBCQjcF54fBjdicvaKsB8zHeQ6Qq22U2Z_0.0.8200599
topicIdstringOptionalExample: 0.0.6046379
messageIdstringOptionalExample: 1773670900.819264517
policyIdstringOptionalExample: 69aeb71ef8c5b278e3bab4e5
policyTopicIdstringOptionalExample: 0.0.6046379
policyInstanceTopicIdstringOptionalExample: 0.0.6046379
statusstring · enumOptionalExample: DRAFTPossible values:
post/policy-statistics/import/file/preview
POST /api/v1/policy-statistics/import/file/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
{
  "id": "69aeb71ef8c5b278e3bab4e5",
  "uuid": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
  "name": "Carbon Statistics",
  "description": "Description",
  "creator": "string",
  "owner": "string",
  "topicId": "0.0.6046379",
  "messageId": "1773670900.819264517",
  "policyId": "69aeb71ef8c5b278e3bab4e5",
  "policyTopicId": "69aeb71ef8c5b278e3bab4e5",
  "policyInstanceTopicId": "69aeb71ef8c5b278e3bab4e5",
  "status": "string",
  "config": {}
}

Last updated

Was this helpful?