Retrieve the metadata details for a specific Summary ID.
Get the current status and meta-data details for a SummarySummary - A video clip that is comprised of one or more Activities with filler data placed between them. Summaries are generated via API calls and have numerous options which govern their creation. A summary is referred to as a "Day Brief" in the Logi Circle application.. Do not use this call to poll the creation state of a Summary, instead listen for the summary_created
Notification Event. A Summary is only kept on the server for a short time after it has been created. If it has been purged, a 404 error will result.
To create a Summary use Create Sumary.
To access a Summaries content, use Get Summary DASH, Get Summary HLS or Get Summary MP4 File. You can only access a summary if the state
is processed
and summaryResult
is true
.
Permissions
Requires the Permissions scope of circle:summaries
Response Body Params
The GET call here, returns the below bare
wrapped inside a JSON object with a key called summary
{
"summary": {
// Bare Object Contents here
}
The Bare
JSON Object contains the following members:
Name | Type | Description |
---|---|---|
summaryId | string | The SummarySummary - A video clip that is comprised of one or more Activities with filler data placed between them. Summaries are generated via API calls and have numerous options which govern their creation. A summary is referred to as a "Day Brief" in the Logi Circle application. ID |
accessoryId | string | The Accessory IdAccessory Id - A unique non changing value to identify a particular Accessory. Accessory Id's are globally unique and are UUID v4 strings. A new Accessory Id is assigned by the servers when a device is associated to an account for the first time. If the same physical device is re-associated to the same account, it will receive the same Accessory Id again. If the same physical device is re-associated to a different account, it will receive a new Accessory Id. Example: 70e3e6f9-70c3-45b2-62e4-ace3d027988a this summary belongs too. |
state | string | Current state of the summary processing. One of:
|
summaryResult | boolean |
|
summaryError | string | If the summary was unable to be created, one of the following errors may be returned:
|
created | string | The TimestampTimestamp - An ISO8601 based format with everything represented server side as UTC+0 or "zulu" format. Takes the form of YYYY-MM-DDTHH:MM:SSZ - For example: 2015-04-04T00:43:29Z or 2016-05-28T23:12:59Z or 2016-11-04T12:00:00Z when Create Sumary was called. |
startTime | string | The TimestampTimestamp - An ISO8601 based format with everything represented server side as UTC+0 or "zulu" format. Takes the form of YYYY-MM-DDTHH:MM:SSZ - For example: 2015-04-04T00:43:29Z or 2016-05-28T23:12:59Z or 2016-11-04T12:00:00Z of the first video frame within the Summary itself. |
endTime | string | The TimestampTimestamp - An ISO8601 based format with everything represented server side as UTC+0 or "zulu" format. Takes the form of YYYY-MM-DDTHH:MM:SSZ - For example: 2015-04-04T00:43:29Z or 2016-05-28T23:12:59Z or 2016-11-04T12:00:00Z of the last video frame within the Summary itself. |
playbackDuration | integer | The number of milliseconds the resulting content is. This may be less than or equal to the value requested if not enough content was found to fill the requested length. |