Analytics

Returns the status of the current report.

get

Returns the status of the current report.

Responses

200

Successful operation.

application/json

uuidstringRequired

rootstringRequired

statusstringRequired

steepstringRequired

typestringRequired

progressnumberRequired

maxProgressnumberRequired

errorstringRequired

500

Internal server error.

application/json

get

/analytics/report

HTTPcURLJavaScriptPython

GET /analytics/report HTTP/1.1
Accept: */*

{
  "uuid": "text",
  "root": "text",
  "status": "text",
  "steep": "text",
  "type": "text",
  "progress": 1,
  "maxProgress": 1,
  "error": "text"
}

Update current report.

get

Update current report.

Responses

200

Successful operation.

application/json

uuidstringRequired

rootstringRequired

statusstringRequired

steepstringRequired

typestringRequired

progressnumberRequired

maxProgressnumberRequired

errorstringRequired

500

Internal server error.

application/json

get

/analytics/report/update

HTTPcURLJavaScriptPython

GET /analytics/report/update HTTP/1.1
Accept: */*

{
  "uuid": "text",
  "root": "text",
  "status": "text",
  "steep": "text",
  "type": "text",
  "progress": 1,
  "maxProgress": 1,
  "error": "text"
}

Returns all reports.

get

Returns all reports.

Responses

200

Successful operation.

application/json

uuidstringRequired

rootstringRequired

statusstringRequired

steepstringRequired

typestringRequired

progressnumberRequired

maxProgressnumberRequired

errorstringRequired

500

Internal server error.

application/json

get

/analytics/reports

HTTPcURLJavaScriptPython

GET /analytics/reports HTTP/1.1
Accept: */*

[
  {
    "uuid": "text",
    "root": "text",
    "status": "text",
    "steep": "text",
    "type": "text",
    "progress": 1,
    "maxProgress": 1,
    "error": "text"
  }
]

Returns report data by report uuid.

get

Returns report data by report uuid.

Path parameters

uuidstringRequired

Report identifier

Responses

200

Successful operation.

application/json

uuidstringRequired

rootstringRequired

500

Internal server error.

application/json

get

/analytics/reports/{uuid}

HTTPcURLJavaScriptPython

GET /analytics/reports/{uuid} HTTP/1.1
Accept: */*

{
  "uuid": "text",
  "root": "text",
  "report": {
    "messages": 1,
    "topics": 1,
    "standardRegistries": 1,
    "users": 1,
    "policies": 1,
    "instances": 1,
    "modules": 1,
    "documents": 1,
    "vcDocuments": 1,
    "vpDocuments": 1,
    "didDocuments": 1,
    "userTopic": 1,
    "tokens": 1,
    "fTokens": 1,
    "nfTokens": 1,
    "tags": 1,
    "schemas": 1,
    "systemSchemas": 1,
    "revokeDocuments": 1,
    "fTotalBalances": 1,
    "nfTotalBalances": 1,
    "topSize": 1,
    "topSRByUsers": {
      "name": "text",
      "value": 1
    },
    "topSRByPolicies": {
      "name": "text",
      "value": 1
    },
    "topTagsByLabel": {
      "name": "text",
      "value": 1
    },
    "topAllSchemasByName": {
      "name": "text",
      "value": 1
    },
    "topSystemSchemasByName": {
      "name": "text",
      "value": 1
    },
    "topSchemasByName": {
      "name": "text",
      "value": 1
    },
    "topModulesByName": {
      "name": "text",
      "value": 1
    },
    "topPoliciesByName": {
      "name": "text",
      "value": 1
    },
    "topVersionsByName": {
      "name": "text",
      "value": 1
    },
    "topPoliciesByDocuments": {
      "name": "text",
      "value": 1
    },
    "topPoliciesByDID": {
      "name": "text",
      "value": 1
    },
    "topPoliciesByVC": {
      "name": "text",
      "value": 1
    },
    "topPoliciesByVP": {
      "name": "text",
      "value": 1
    },
    "topPoliciesByRevoked": {
      "name": "text",
      "value": 1
    },
    "topTokensByName": {
      "name": "text",
      "value": 1
    },
    "topFTokensByName": {
      "name": "text",
      "value": 1
    },
    "topNFTokensByName": {
      "name": "text",
      "value": 1
    },
    "topFTokensByBalance": {
      "name": "text",
      "value": 1
    },
    "topNFTokensByBalance": {
      "name": "text",
      "value": 1
    }
  }
}

Export report data in a csv file format.

get

Returns a csv file.

Path parameters

uuidstringRequired

Report identifier

Responses

200

Successful operation.

application/json

string · binaryOptional

500

Internal server error.

application/json

get

/analytics/reports/{uuid}/export/csv

HTTPcURLJavaScriptPython

GET /analytics/reports/{uuid}/export/csv HTTP/1.1
Accept: */*

binary

Export report data in a xlsx file format.

get

Returns a xlsx file.

Path parameters

uuidstringRequired

Report identifier

Responses

200

Successful operation.

application/json

string · binaryOptional

500

Internal server error.

application/json

get

/analytics/reports/{uuid}/export/xlsx

HTTPcURLJavaScriptPython

GET /analytics/reports/{uuid}/export/xlsx HTTP/1.1
Accept: */*

binary

Returns all dashboards.

get

Returns all dashboards.

Responses

200

Successful operation.

application/json

uuidstringRequired

rootstringRequired

datestringRequired

500

Internal server error.

application/json

get

/analytics/dashboards

HTTPcURLJavaScriptPython

GET /analytics/dashboards HTTP/1.1
Accept: */*

[
  {
    "uuid": "text",
    "root": "text",
    "date": "text"
  }
]

Returns dashboard by uuid.

get

Returns dashboard by uuid.

Path parameters

idstringRequired

Dashboard identifier

Responses

200

Successful operation.

application/json

uuidstringRequired

rootstringRequired

500

Internal server error.

application/json

get

/analytics/dashboards/{id}

HTTPcURLJavaScriptPython

GET /analytics/dashboards/{id} HTTP/1.1
Accept: */*

{
  "uuid": "text",
  "root": "text",
  "report": {
    "messages": 1,
    "topics": 1,
    "standardRegistries": 1,
    "users": 1,
    "policies": 1,
    "instances": 1,
    "modules": 1,
    "documents": 1,
    "vcDocuments": 1,
    "vpDocuments": 1,
    "didDocuments": 1,
    "userTopic": 1,
    "tokens": 1,
    "fTokens": 1,
    "nfTokens": 1,
    "tags": 1,
    "schemas": 1,
    "systemSchemas": 1,
    "revokeDocuments": 1,
    "fTotalBalances": 1,
    "nfTotalBalances": 1,
    "topSize": 1,
    "topSRByUsers": {
      "name": "text",
      "value": 1
    },
    "topSRByPolicies": {
      "name": "text",
      "value": 1
    },
    "topTagsByLabel": {
      "name": "text",
      "value": 1
    },
    "topAllSchemasByName": {
      "name": "text",
      "value": 1
    },
    "topSystemSchemasByName": {
      "name": "text",
      "value": 1
    },
    "topSchemasByName": {
      "name": "text",
      "value": 1
    },
    "topModulesByName": {
      "name": "text",
      "value": 1
    },
    "topPoliciesByName": {
      "name": "text",
      "value": 1
    },
    "topVersionsByName": {
      "name": "text",
      "value": 1
    },
    "topPoliciesByDocuments": {
      "name": "text",
      "value": 1
    },
    "topPoliciesByDID": {
      "name": "text",
      "value": 1
    },
    "topPoliciesByVC": {
      "name": "text",
      "value": 1
    },
    "topPoliciesByVP": {
      "name": "text",
      "value": 1
    },
    "topPoliciesByRevoked": {
      "name": "text",
      "value": 1
    },
    "topTokensByName": {
      "name": "text",
      "value": 1
    },
    "topFTokensByName": {
      "name": "text",
      "value": 1
    },
    "topNFTokensByName": {
      "name": "text",
      "value": 1
    },
    "topFTokensByBalance": {
      "name": "text",
      "value": 1
    },
    "topNFTokensByBalance": {
      "name": "text",
      "value": 1
    }
  }
}