Table of contents

Summary API

The Summary API provides high-level stats about the GrayMeta Platform and your data.

Getting platform data

GET /api/data/summary/platform

You will receive the following response:

{
	"company_name": "mycompany",
	"build_version": "2.0.123",
	"git_hash": "137c411"
}
  • company_name - (string) Customer key (usually the name in name.cust.graymeta.com)
  • build_version - (string) System build version
  • git_hash - (string) Git hash at build time

Getting a summary of your data

GET /api/data/summary/data

You will receive the following response:

{
	"last_harvest": "2018-04-30T19:41:27.843Z",
	"total_files": 1625,
	"video_runtime_seconds": 105521.296,
	"duplicate_files": 276
}
  • last_harvest - (datetime) Last date/time a file was harvested
  • total_files - (int) The total number of files that have been harvested
  • video_runtime_seconds - (float) Total number of video seconds that have been harvested
  • duplicate_files - (int) Total number of known duplicate files

Item Summary

Item summary is predominantly designed for items with videos.

Get the summary of an item

GET /api/data/v3/summary/items/{id}
  • {id} - (string) 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
			},
		]
    }
}

This documentation is generated from the latest version of GrayMeta Platform. For documentation relevant to your own deployed version, please use the documentation inside the application.