Class Fleet

Example

// Body
const link = await createShareLink({
    delegateTeleop: false
    message: "See bot in action",
    scope: {
      deviceIds: ["d64520a6-a308-4a59-9267-b7f8a7bfc7ab"],
      start: "2023-04-04T19:51:47.125Z",
      end: "2023-04-04T20:51:47.125Z"
     },
     time: "2023-04-04T20:21:47.125Z",
     userName: "User",
  });
Copy

retrieves a list of all available data streams that can be used for running analytics. This function takes no arguments and returns a list of stream names that can be used for analyzing data.

Example

// Returns
 [
   {
     streamName:  "$.agent.health",
         streamType :  "health"
       },
{
     streamName:  "up.hours",
         streamType :  "numeric"
       }
]
Copy

Retrieves all rows sqlQuery is required

Example

// Body
const tasks = await getTaskReports({
    taskColumns: [
      {
        columns: [
          {
            dataType: "string",
            isNullable: true,
            name: "TYPE",
            tableName: "custom",
          },
        ],
        name: "DURATION_SECONDS",
        tableName: "TASK_REPORTS_CLEANING_MODE",
        yAxis: "DURATION_SECONDS",
      },
    ],
  });
Copy

retrieves a list of all available tables that can be used to create task reports. This function takes no arguments and returns a list of table names that can be used for creating task reports.

Example

// Returns
[
   {
      name: "",
      tableName: "TASK_REPORTS_CLEANING_MODE",
      columns: [
                {
                   name: "TYPE",
                   isNullable: true,
                   dataType: "string",
                   tableName: "custom"
                }
               ]
   }
]
Copy

Retrieves all stream rows

Example

// Body
const analytics = await queryAnalytics({
    aggregateLevel: "day",
    orderByColumn: "TIMESTAMP",
    streamColumns: [
      {
        streamName: "consumables_residual_percentage",
        streamType: "numeric set",
      },
    ],
  });
//Returns
{
   aggregates: [],
   columns: [
             {
               name: 'TIMESTAMP',
               isNullable: true,
               dataType: 'string',
               tableName: 'NUMERIC_SET_MAIN'
              }
],
   items: [
             {
               axisLabel: "suction_blade",
               name: "consumables_residual_percentage",
               tableName: "NUMERIC_SET_TEST",
               time: "2020-04-20T08:00:00.000Z",
               type: "numeric set",
               unitLabel: "percent"
               }
],
   rowCount: 14,
   rows: []
   sqlText: "SELECT dateadd(day, dayofweek(TIMESTAMP), to_timestamp_tz('4/20/2020')) AS TIMESTAMP, SUM(VALUE)"
}
Copy