frigate/docs/docs/integrations/api/review-summary-review-summary-get.api.mdx
Victor Tramontina 759c94cb34 att
2025-08-05 15:00:44 -03:00

70 lines
4.1 KiB
Plaintext

---
id: review-summary-review-summary-get
title: "Review Summary"
description: "Review Summary"
sidebar_label: "Review Summary"
hide_title: true
hide_table_of_contents: true
api: eJztVk1v00AQ/SvRnE2cRuXiW0UrigSiagMHqqia2JNky9rr7o4DJvJ/R+N1/JGkagT0ximx/WbezLy3H1tgXDmI7uGWNop+wDwAk5NFVib7kEAEtn7/4Io0RVs+7D2uiCGAHC2mxGQl0xYyTAkiiDEliw4CUBlE8FSQLSEAS0+FspRAtETtKAAXrylFiLbAZS6Bjq3KVhBAQkssNEMEqDUEwIq1AN41masqaNk0Lki/BtlHn7jP9ctk9BpU3+q8fSZWKQnbPyErOO6RzXapq2ouCV1uMkdOUkwnE/lJyMVW5WIFiOCuiGNyblno0W0DhgBikzFlLHDMc63i2jnho5OYba+s3IqvWHkGjY6n59emsO7wo/cYJQ+oyXKvJ5Uxrcj2mrhtoKOLGloFXXBCTLGv/ZQEly28CoANoz6Bfia4jtuHnUbsQ3usEu/BZvFIMQ9Uvt8fytFGh4Uf1jPvu7oVoFn5MjtjvJJJoiQA9c1AmKFMCZbH/LY0NkWxW4JMb8TAva4vsRyI9F/hTmGZ58Fo/lbnSyw7fffZ2xGJ7i+V11+yjVXm+1O+88dCuz9UlWQ9n04Pt5OvqFVSbxajK2uN/fO9JCFGpeWfYkqPGFWbePAVs/Lzsj6pht6VfXdPzWreTQWtrRVql5DxBcpkU7c6thZ20E/kHK6o0+B5aD2M0Uy+vqiIkf1cqBtcT49uvH66z7dx6cd3jGwHuZ7Nbg4Sem2HonoXjBobSHHEayPXiN1FgdcQQeg9HboW58hudteHwmqIYM2cuygME0rNeGnVCpnGG5WQCTFXtVYdMApDbWLUa+M4ejuZnHnMXE7NpanH3bQCAQiRL3cyPhtPZDS5cZxi7bLm4D3oZNBoKx/TTw5zjap2QV3Qtulyt2VLd02WeQBSoXzbbhfo6IvVVSWv/bku3SfK4UL3TvbvVA4uUxvURd2JjOAZdHsZOgW8u82cgu3dRzr4XB6sEjxE97Ji1oQJ2bofH3cRx5RzL+pggUuW1i3vr2ZQVb8B3yilZw==
sidebar_class_name: "get api-method"
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Review Summary"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/review/summary"}
context={"endpoint"}
>
</MethodEndpoint>
Review Summary
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"name":"cameras","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Cameras"}},{"name":"labels","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Labels"}},{"name":"zones","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Zones"}},{"name":"timezone","in":"query","required":false,"schema":{"type":"string","default":"utc","title":"Timezone"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"last24Hours":{"properties":{"reviewed_alert":{"type":"integer","title":"Reviewed Alert"},"reviewed_detection":{"type":"integer","title":"Reviewed Detection"},"total_alert":{"type":"integer","title":"Total Alert"},"total_detection":{"type":"integer","title":"Total Detection"}},"type":"object","required":["reviewed_alert","reviewed_detection","total_alert","total_detection"],"title":"Last24HoursReview"},"root":{"additionalProperties":{"properties":{"day":{"type":"string","format":"date-time","title":"Day"},"reviewed_alert":{"type":"integer","title":"Reviewed Alert"},"reviewed_detection":{"type":"integer","title":"Reviewed Detection"},"total_alert":{"type":"integer","title":"Total Alert"},"total_detection":{"type":"integer","title":"Total Detection"}},"type":"object","required":["day","reviewed_alert","reviewed_detection","total_alert","total_detection"],"title":"DayReview"},"type":"object","title":"Root"}},"type":"object","required":["last24Hours","root"],"title":"ReviewSummaryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
>
</StatusCodes>