Summary API in Wasabi AiR

The Summary API provides high-level statistics about Wasabi AiR and your data.

Getting Platform Data

GET /api/data/summary/platform

Response

{
    "harvest_refresh_time": 300,
    "offering": {
        "base_url": "http://localhost:7000",
        "saas": false,
        "saas_details": {
            "max_items": 2500,
            "plans": null
        },
        "facial_recognition_enabled": true,
        "experimental_extractors_enabled": false,
        "license": {
            "expiration": "2133-10-03T07:21:00.491778683Z",
            "base_url": "",
            "enforce_base_url_check": false,
            "license_generated_at": "0001-01-01T00:00:00Z",
            "license_generation_host": "",
            "remote_usage_enabled": false,
            "license_checks_enabled": false
        },
        "loadnstore": {
            "enabled": true,
            "limit_bytes": 0,
            "ignore_patterns": [
                ".DS_Store",
                "thumbs.db",
                "Thumbs.db",
                "__MACOSX",
                "Desktop.ini",
                ".Spotlight-V100",
                "._*",
                "~*.docx",
                "~*.pptx",
                "~*.xlsx",
                ".smbdelete*",
                "*.tmp"
            ]
        }
    },
    "password_length_minimum": 8,
    "password_length_maximum": 72,
    "google_maps_key": "",
    "rollbar_write_key_frontend": "",
    "segment_write_key": ""
}

• google_maps_key - (string) The Google Maps API key for rendering geolocation information in the user interface.
• harvest_refresh_time - (int) An indication of how often (in seconds) live harvesting occurs.
• offering - (object) Information about this deployment of the platform, including flags indicating which features may be enabled or disabled.
• password_length_minimum - (int) The minimum password length.
• password_length_maximum - (int) The maximum password length.
• rollbar_write_key_frontend - (string) A rollbar key used to write any captured frontend errors to the Rollbar service,
• segment_write_key - (string) A key used to make requests to the Segment.io service.

Getting a Summary of Your Data

GET /api/data/summary/data

Response

{
    "total_files": 5690,
    "deleted_files": 0,
    "total_pages": 0,
    "total_size": 708572608,
    "video_runtime_seconds": 45.828,
    "last_harvest": "2019-09-04T04:20:04.724949556Z"
}

• deleted_files - (int) The number of files deleted from the platform.
• last_harvest - (datetime) The last date/time a file was harvested.
• total_files - (int) The total number of files that have been harvested.
• total_pages - (int) The total number of pages of documents harvested by the platform.
• total_size - (int) The sum (in bytes) of file sizes of all files processed by the platform.
• video_runtime_seconds - (float) The total number of media seconds (video and audio) that have been harvested,

Item Summary

An item summary is primarily designed for items with videos.

Getting the Summary of an Item

GET /api/data/v3/summary/items/{id}

• {id} - (string) The ID of the Item to get.

Response

{
    "summary": {
        "title": "ToS-4k-1920.mov",
        "sentiment": [
          {
              "name": "mixed",
              "confidence": 0.022362074611656783
          },
          ...
        ],
        "technical": {
            "audio": {
                "channels": 2,
                "codec": "AAC",
                "duration_time": "00:13:14:08",
                "bit_rate": 125589,
                "format": "AAC",
                "true_peak_dbfs": -2.8
            },
            "video": {
                "resolution": "1280 x 720",
                "aspect_ratio": "16:9",
                "frame_rate": 29.97,
                "duration_time": "00:13:12.959",
                "chroma_subsampling": "4:2:0",
                "bit_rate": 1101247
            },
            "size": "122 MB",
            "file_type": "mp4"
        },
        "people": [
            {
                "appearances": 0.3,
                "person": {
                    "person_id": "824cdd01-8b1b-4df6-8fc9-fdd917fee7d2",
                    "name": "Derek de Lint",
                    "is_known": true,
                    "face_img_path": "89f4d3787249f9097f709e00f321959b/face/c9030520-2a7a-4d20-8474-e23bd622cf60.jpg",
                    "face_img_width": 80,
                    "face_img_height": 110,
                    "face_img_small_path": "",
                    "face_img_small_width": 0,
                    "face_img_small_height": 0,
                    "num_faces": 6,
                    "created_at": "2019-01-24T22:17:05.34243Z",
                    "updated_at": "2019-01-24T22:17:05.34243Z"
                }
            }
        ],
        "tags": [
            {
                "appearances": 0.94,
                "name": "person"
            }
        ],
        "logos": [
            {
                "appearances": 0.2,
                "name": "jaguar"
            }
        ],
        "locations": [
            {
                "appearances": 0.1,
                "name": "Eiffel Tower"
            },
        ],
        "key_phrases": [
            {
                "appearances": 6,
                "name": "the basement"
            },
        ],
        "entities": [
            {
                "appearances": 23,
                "name": "one"
            },
        ],
         "insights": [
            {
                "name": "Definitions",
                "ocrs": 13,
                "speech_to_texts": 37
            },
        ]
    }
}