getAiVisualReportList(params: QueryGetAiVisualReportList)

Requires:
@tuya-miniapp/cloud-api≥1.0.5

Description

Query Vision Box report list

Parameters

ParameterTypeRequiredDescription
YesRequest body

Return Value

Type: Promise<VisionBoxReport[]>
Array of VisionBoxReport (for report type, title, status, etc., see minituya response tables and type fields)

Referenced Types

interfaceVisionBoxReport
PropertyTypeDescription
visionBoxIdstringVision Cube ID
modelNamestringModel name
reportIdstringReport ID
reportTypeReportTypeReport type (daily, weekly, etc.)
reportTitleNamestringReport title
Report body (event statistics, etc.)
summaryAndSuggestionstringSummary and recommendations
detailTitlestringDetails title
totalNumTitlestringTotal count title
reportStatenumberReport status
reportStateNamestringReport status name
Associated file list
reportKeystringReport business key
enumReportType
ValueActual ValueDescription
ReportType.DAILY1Daily report
ReportType.WEEKLY2Weekly report

Valid Values

ReportType
ValueDescriptionSince
1Daily report-
2Weekly report-

Examples

Request example

import { getAiVisualReportList } from '@tuya-miniapp/cloud-api';

getAiVisualReportList({
  gid: '194137',
  visionBoxId: 'vb-1',
  offset: 0,
  limit: 10,
})
  .then((list) => console.log(list))
  .catch(console.error);

Response example

[
  {
    "visionBoxId": "vb-1",
    "modelName": "model-a",
    "reportId": "r1",
    "reportType": 1,
    "reportTitleName": "Daily Report",
    "summaryAndSuggestion": "",
    "detailTitle": "Details",
    "totalNumTitle": "Total Events",
    "reportState": 1,
    "reportStateName": "Completed"
  }
]