> For the complete documentation index, see [llms.txt](https://dev.guardian.hedera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.guardian.hedera.com/api-reference-analytics/analytics.md).

# Analytics

## Returns the status of the current report.

> Returns the status of the current report.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/","description":"version 1.0"}],"paths":{"/analytics/report":{"get":{"description":"Returns the status of the current report.","operationId":"AnalyticsApi_getCurrentReport","parameters":[],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Returns the status of the current report.","tags":["analytics"]}}},"components":{"schemas":{"ReportDTO":{"type":"object","properties":{"uuid":{"type":"string"},"root":{"type":"string"},"status":{"type":"string"},"steep":{"type":"string"},"type":{"type":"string"},"progress":{"type":"number"},"maxProgress":{"type":"number"},"error":{"type":"string"}},"required":["uuid","root","status","steep","type","progress","maxProgress","error"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Update current report.

> Update current report.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/","description":"version 1.0"}],"paths":{"/analytics/report/update":{"get":{"description":"Update current report.","operationId":"AnalyticsApi_updateReport","parameters":[],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Update current report.","tags":["analytics"]}}},"components":{"schemas":{"ReportDTO":{"type":"object","properties":{"uuid":{"type":"string"},"root":{"type":"string"},"status":{"type":"string"},"steep":{"type":"string"},"type":{"type":"string"},"progress":{"type":"number"},"maxProgress":{"type":"number"},"error":{"type":"string"}},"required":["uuid","root","status","steep","type","progress","maxProgress","error"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Returns all reports.

> Returns all reports.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/","description":"version 1.0"}],"paths":{"/analytics/reports":{"get":{"description":"Returns all reports.","operationId":"AnalyticsApi_getReports","parameters":[],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReportDTO"}}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Returns all reports.","tags":["analytics"]}}},"components":{"schemas":{"ReportDTO":{"type":"object","properties":{"uuid":{"type":"string"},"root":{"type":"string"},"status":{"type":"string"},"steep":{"type":"string"},"type":{"type":"string"},"progress":{"type":"number"},"maxProgress":{"type":"number"},"error":{"type":"string"}},"required":["uuid","root","status","steep","type","progress","maxProgress","error"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Returns report data by report uuid.

> Returns report data by report uuid.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/","description":"version 1.0"}],"paths":{"/analytics/reports/{uuid}":{"get":{"description":"Returns report data by report uuid.","operationId":"AnalyticsApi_getReport","parameters":[{"name":"uuid","required":true,"in":"path","description":"Report identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataContainerDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Returns report data by report uuid.","tags":["analytics"]}}},"components":{"schemas":{"DataContainerDTO":{"type":"object","properties":{"uuid":{"type":"string"},"root":{"type":"string"},"report":{"$ref":"#/components/schemas/ReportDataDTO"}},"required":["uuid","root","report"]},"ReportDataDTO":{"type":"object","properties":{"messages":{"type":"number"},"topics":{"type":"number"},"standardRegistries":{"type":"number"},"users":{"type":"number"},"policies":{"type":"number"},"instances":{"type":"number"},"modules":{"type":"number"},"documents":{"type":"number"},"vcDocuments":{"type":"number"},"vpDocuments":{"type":"number"},"didDocuments":{"type":"number"},"userTopic":{"type":"number"},"tokens":{"type":"number"},"fTokens":{"type":"number"},"nfTokens":{"type":"number"},"tags":{"type":"number"},"schemas":{"type":"number"},"systemSchemas":{"type":"number"},"revokeDocuments":{"type":"number"},"fTotalBalances":{"type":"number"},"nfTotalBalances":{"type":"number"},"topSize":{"type":"number"},"topSRByUsers":{"$ref":"#/components/schemas/RateDTO"},"topSRByPolicies":{"$ref":"#/components/schemas/RateDTO"},"topTagsByLabel":{"$ref":"#/components/schemas/RateDTO"},"topAllSchemasByName":{"$ref":"#/components/schemas/RateDTO"},"topSystemSchemasByName":{"$ref":"#/components/schemas/RateDTO"},"topSchemasByName":{"$ref":"#/components/schemas/RateDTO"},"topModulesByName":{"$ref":"#/components/schemas/RateDTO"},"topPoliciesByName":{"$ref":"#/components/schemas/RateDTO"},"topVersionsByName":{"$ref":"#/components/schemas/RateDTO"},"topPoliciesByDocuments":{"$ref":"#/components/schemas/RateDTO"},"topPoliciesByDID":{"$ref":"#/components/schemas/RateDTO"},"topPoliciesByVC":{"$ref":"#/components/schemas/RateDTO"},"topPoliciesByVP":{"$ref":"#/components/schemas/RateDTO"},"topPoliciesByRevoked":{"$ref":"#/components/schemas/RateDTO"},"topTokensByName":{"$ref":"#/components/schemas/RateDTO"},"topFTokensByName":{"$ref":"#/components/schemas/RateDTO"},"topNFTokensByName":{"$ref":"#/components/schemas/RateDTO"},"topFTokensByBalance":{"$ref":"#/components/schemas/RateDTO"},"topNFTokensByBalance":{"$ref":"#/components/schemas/RateDTO"}},"required":["messages","topics","standardRegistries","users","policies","instances","modules","documents","vcDocuments","vpDocuments","didDocuments","userTopic","tokens","fTokens","nfTokens","tags","schemas","systemSchemas","revokeDocuments","fTotalBalances","nfTotalBalances","topSize","topSRByUsers","topSRByPolicies","topTagsByLabel","topAllSchemasByName","topSystemSchemasByName","topSchemasByName","topModulesByName","topPoliciesByName","topVersionsByName","topPoliciesByDocuments","topPoliciesByDID","topPoliciesByVC","topPoliciesByVP","topPoliciesByRevoked","topTokensByName","topFTokensByName","topNFTokensByName","topFTokensByBalance","topNFTokensByBalance"]},"RateDTO":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"number"}},"required":["name","value"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Export report data in a csv file format.

> Returns a csv file.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/","description":"version 1.0"}],"paths":{"/analytics/reports/{uuid}/export/csv":{"get":{"description":"Returns a csv file.","operationId":"AnalyticsApi_exportToCsv","parameters":[{"name":"uuid","required":true,"in":"path","description":"Report identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Export report data in a csv file format.","tags":["analytics"]}}},"components":{"schemas":{"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Export report data in a xlsx file format.

> Returns a xlsx file.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/","description":"version 1.0"}],"paths":{"/analytics/reports/{uuid}/export/xlsx":{"get":{"description":"Returns a xlsx file.","operationId":"AnalyticsApi_exportToXlsx","parameters":[{"name":"uuid","required":true,"in":"path","description":"Report identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Export report data in a xlsx file format.","tags":["analytics"]}}},"components":{"schemas":{"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Returns all dashboards.

> Returns all dashboards.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/","description":"version 1.0"}],"paths":{"/analytics/dashboards":{"get":{"description":"Returns all dashboards.","operationId":"AnalyticsApi_getDashboards","parameters":[],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DashboardDTO"}}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Returns all dashboards.","tags":["analytics"]}}},"components":{"schemas":{"DashboardDTO":{"type":"object","properties":{"uuid":{"type":"string"},"root":{"type":"string"},"date":{"type":"string"}},"required":["uuid","root","date"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Returns dashboard by uuid.

> Returns dashboard by uuid.

```json
{"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/","description":"version 1.0"}],"paths":{"/analytics/dashboards/{id}":{"get":{"description":"Returns dashboard by uuid.","operationId":"AnalyticsApi_getDashboardById","parameters":[{"name":"id","required":true,"in":"path","description":"Dashboard identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataContainerDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Returns dashboard by uuid.","tags":["analytics"]}}},"components":{"schemas":{"DataContainerDTO":{"type":"object","properties":{"uuid":{"type":"string"},"root":{"type":"string"},"report":{"$ref":"#/components/schemas/ReportDataDTO"}},"required":["uuid","root","report"]},"ReportDataDTO":{"type":"object","properties":{"messages":{"type":"number"},"topics":{"type":"number"},"standardRegistries":{"type":"number"},"users":{"type":"number"},"policies":{"type":"number"},"instances":{"type":"number"},"modules":{"type":"number"},"documents":{"type":"number"},"vcDocuments":{"type":"number"},"vpDocuments":{"type":"number"},"didDocuments":{"type":"number"},"userTopic":{"type":"number"},"tokens":{"type":"number"},"fTokens":{"type":"number"},"nfTokens":{"type":"number"},"tags":{"type":"number"},"schemas":{"type":"number"},"systemSchemas":{"type":"number"},"revokeDocuments":{"type":"number"},"fTotalBalances":{"type":"number"},"nfTotalBalances":{"type":"number"},"topSize":{"type":"number"},"topSRByUsers":{"$ref":"#/components/schemas/RateDTO"},"topSRByPolicies":{"$ref":"#/components/schemas/RateDTO"},"topTagsByLabel":{"$ref":"#/components/schemas/RateDTO"},"topAllSchemasByName":{"$ref":"#/components/schemas/RateDTO"},"topSystemSchemasByName":{"$ref":"#/components/schemas/RateDTO"},"topSchemasByName":{"$ref":"#/components/schemas/RateDTO"},"topModulesByName":{"$ref":"#/components/schemas/RateDTO"},"topPoliciesByName":{"$ref":"#/components/schemas/RateDTO"},"topVersionsByName":{"$ref":"#/components/schemas/RateDTO"},"topPoliciesByDocuments":{"$ref":"#/components/schemas/RateDTO"},"topPoliciesByDID":{"$ref":"#/components/schemas/RateDTO"},"topPoliciesByVC":{"$ref":"#/components/schemas/RateDTO"},"topPoliciesByVP":{"$ref":"#/components/schemas/RateDTO"},"topPoliciesByRevoked":{"$ref":"#/components/schemas/RateDTO"},"topTokensByName":{"$ref":"#/components/schemas/RateDTO"},"topFTokensByName":{"$ref":"#/components/schemas/RateDTO"},"topNFTokensByName":{"$ref":"#/components/schemas/RateDTO"},"topFTokensByBalance":{"$ref":"#/components/schemas/RateDTO"},"topNFTokensByBalance":{"$ref":"#/components/schemas/RateDTO"}},"required":["messages","topics","standardRegistries","users","policies","instances","modules","documents","vcDocuments","vpDocuments","didDocuments","userTopic","tokens","fTokens","nfTokens","tags","schemas","systemSchemas","revokeDocuments","fTotalBalances","nfTotalBalances","topSize","topSRByUsers","topSRByPolicies","topTagsByLabel","topAllSchemasByName","topSystemSchemasByName","topSchemasByName","topModulesByName","topPoliciesByName","topVersionsByName","topPoliciesByDocuments","topPoliciesByDID","topPoliciesByVC","topPoliciesByVP","topPoliciesByRevoked","topTokensByName","topFTokensByName","topNFTokensByName","topFTokensByBalance","topNFTokensByBalance"]},"RateDTO":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"number"}},"required":["name","value"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```