> 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-indexer/analytics.md).

# Analytics

## Search policy

> Returns search policy result

```json
{"openapi":"3.2.0","info":{"title":"Guardian","version":"3.7.1-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/analytics/search/policy":{"post":{"description":"Returns search policy result","operationId":"AnalyticsApi_search","parameters":[],"requestBody":{"required":true,"description":"Search policy parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPolicyParamsDTO"}}}},"responses":{"200":{"description":"Search policy result","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchPolicyResultDTO"}}}}},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Search policy","tags":["analytics"]}}},"components":{"schemas":{"SearchPolicyParamsDTO":{"type":"object","properties":{"text":{"type":"string","description":"Text"},"minVcCount":{"type":"number","description":"Mint VC count"},"minVpCount":{"type":"number","description":"Mint VP count"},"minTokensCount":{"type":"number","description":"Mint tokens count"},"threshold":{"type":"number","description":"Threshold"},"owner":{"type":"string","description":"Owner"},"blocks":{"$ref":"#/components/schemas/SearchPolicyBlocksDTO"}},"required":["text","minVcCount","minVpCount","minTokensCount","threshold","owner","blocks"]},"SearchPolicyBlocksDTO":{"type":"object","properties":{"hash":{"type":"string","description":"Hash"},"hashMap":{"type":"object","description":"Hash map","additionalProperties":true},"threshold":{"type":"number","description":"Threshold"}},"required":["hash","hashMap","threshold"]},"SearchPolicyResultDTO":{"type":"object","properties":{"type":{"type":"string","description":"Type"},"topicId":{"type":"string","description":"Topic identifier"},"uuid":{"type":"string","description":"UUID"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"version":{"type":"string","description":"Version"},"status":{"type":"string","description":"Status"},"messageId":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"textSearch":{"type":"string","description":"Text search"},"registryId":{"type":"string","description":"Registry identifier"},"vcCount":{"type":"number","description":"VC count"},"vpCount":{"type":"number","description":"VP count"},"tokensCount":{"type":"number","description":"Token count"},"rate":{"type":"number","description":"Rate","minimum":0,"maximum":100},"tags":{"description":"tags","type":"array","items":{"type":"string"}}},"required":["type","topicId","uuid","name","description","version","status","messageId","owner","textSearch","registryId","vcCount","vpCount","tokensCount","rate","tags"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Search contract retirements

> Returns contract retirements result

```json
{"openapi":"3.2.0","info":{"title":"Guardian","version":"3.7.1-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/analytics/search/retire":{"post":{"description":"Returns contract retirements result","operationId":"AnalyticsApi_getRetireDocuments","parameters":[],"requestBody":{"required":true,"description":"Search policy parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RawMessageDTO"}}}},"responses":{"200":{"description":"Search policy result","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MessageDTO"}}}}},"422":{"description":"Unprocessable entity"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Search contract retirements","tags":["analytics"]}}},"components":{"schemas":{"RawMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"topicId":{"type":"string","description":"Topic identifier"},"status":{"type":"string","description":"Status"},"lastUpdate":{"type":"number","description":"Last update"},"message":{"type":"string","description":"Message"},"sequenceNumber":{"type":"number","description":"Sequence number"},"owner":{"type":"string","description":"Owner"},"chunkId":{"type":"string","description":"Chunk identifier"},"chunkNumber":{"type":"number","description":"Chunk number"},"chunkTotal":{"type":"number","description":"Chunk total"},"type":{"type":"string","description":"Type"},"data":{"type":"string","description":"Data"}},"required":["id","consensusTimestamp","topicId","status","lastUpdate","message","sequenceNumber","owner","chunkId","chunkNumber","chunkTotal","type","data"]},"MessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"topicId":{"type":"string","description":"Topic identifier"},"consensusTimestamp":{"type":"string","description":"Message identifier"},"owner":{"type":"string","description":"Owner"},"uuid":{"type":"string","description":"UUID"},"status":{"type":"string","description":"Status"},"statusReason":{"type":"string","description":"Status"},"lang":{"type":"string","description":"Lang"},"responseType":{"type":"string","description":"Response type"},"statusMessage":{"type":"string","description":"Status message"},"statusOwner":{"type":"string","description":"Status owner"},"files":{"description":"Files","type":"array","items":{"type":"string"}},"topics":{"description":"Topics","type":"array","items":{"type":"string"}},"tokens":{"description":"Tokens","type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number","description":"SequenceNumber"}},"required":["id","topicId","consensusTimestamp","owner","uuid","status","statusReason","lang","responseType","statusMessage","statusOwner","files","topics","tokens","sequenceNumber"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## Get indexer availability

> Returns indexer availability

```json
{"openapi":"3.2.0","info":{"title":"Guardian","version":"3.7.1-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/analytics/checkAvailability":{"get":{"description":"Returns indexer availability","operationId":"AnalyticsApi_getIndexerAvailability","parameters":[],"responses":{"200":{"description":"Indexer availability result","content":{"application/json":{"schema":{"type":"boolean"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Get indexer availability","tags":["analytics"]}}},"components":{"schemas":{"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

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

>

```json
{"openapi":"3.2.0","info":{"title":"Guardian","version":"3.7.1-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/analytics/compare/policy/original/{messageId}":{"post":{"operationId":"AnalyticsApi_compareOriginalPolicy","parameters":[{"name":"messageId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyFiltersDTO"}}}},"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComparePoliciesDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"tags":["analytics"]}}},"components":{"schemas":{"PolicyFiltersDTO":{"type":"object","properties":{"idLvl":{"oneOf":[{"type":"string"},{"type":"number"}],"enum":[0,1]},"eventsLvl":{"oneOf":[{"type":"string"},{"type":"number"}],"enum":[0,1]},"propLvl":{"oneOf":[{"type":"string"},{"type":"number"}],"enum":[0,1,2]},"childrenLvl":{"oneOf":[{"type":"string"},{"type":"number"}],"enum":[0,1,2]}}},"ComparePoliciesDTO":{"type":"object","properties":{"blocks":{"type":"object"},"groups":{"type":"object"},"left":{"type":"object"},"right":{"type":"object"},"roles":{"type":"object"},"tokens":{"type":"object"},"topics":{"type":"object"},"total":{"type":"object"}},"required":["blocks","groups","left","right","roles","tokens","topics","total"]},"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```

## GET /analytics/derivations/{messageId}

>

```json
{"openapi":"3.2.0","info":{"title":"Guardian","version":"3.7.1-rc"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"paths":{"/analytics/derivations/{messageId}":{"get":{"operationId":"AnalyticsApi_getDerivations","parameters":[{"name":"messageId","required":true,"in":"path","schema":{"type":"string"}},{"name":"pageIndex","required":true,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"string"}},{"name":"orderField","required":true,"in":"query","schema":{"type":"string"}},{"name":"orderDir","required":true,"in":"query","schema":{"type":"string"}},{"name":"keywords","required":true,"in":"query","schema":{"type":"string"}},{"name":"topicId","required":true,"in":"query","schema":{"type":"string"}},{"name":"options.owner","required":true,"in":"query","schema":{"type":"string"}},{"name":"analytics.tools","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"tags":["analytics"]}}},"components":{"schemas":{"InternalServerErrorDTO":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}}}
```