Skip to main content

MotionSearchStatusResponse

Response containing job status and results.

successSuccess (boolean)required
messageMessage (string)required
statusStatus (string)required
results object
anyOf
  • Array [
    • timestampTimestamp (number)required

    Timestamp where change was detected

    change_percentageChange Percentage (number)required

    Percentage of ROI area that changed

  • ]
    • total_frames_processed object
    anyOf
    integer
    error_message object
    anyOf
    string
    metrics object
    anyOf
    segments_scannedSegments Scanned (integer)
    Default value: 0
    segments_processedSegments Processed (integer)
    Default value: 0
    metadata_inactive_segmentsMetadata Inactive Segments (integer)
    Default value: 0
    heatmap_roi_skip_segmentsHeatmap Roi Skip Segments (integer)
    Default value: 0
    fallback_full_range_segmentsFallback Full Range Segments (integer)
    Default value: 0
    frames_decodedFrames Decoded (integer)
    Default value: 0
    wall_time_secondsWall Time Seconds (number)
    Default value: 0
    segments_with_errorsSegments With Errors (integer)
    Default value: 0
    MotionSearchStatusResponse
    {
      "success": true,
      "message": "string",
      "status": "string",
      "results": [
        {
          "timestamp": 0,
          "change_percentage": 0
        }
      ],
      "total_frames_processed": 0,
      "error_message": "string",
      "metrics": {
        "segments_scanned": 0,
        "segments_processed": 0,
        "metadata_inactive_segments": 0,
        "heatmap_roi_skip_segments": 0,
        "fallback_full_range_segments": 0,
        "frames_decoded": 0,
        "wall_time_seconds": 0,
        "segments_with_errors": 0
      }
    }