Get Summary by ID

Retrieve the metadata details for a specific Summary ID.

Get the current status and meta-data details for a Summary. 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 DASHGet 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 Summary ID

accessoryId

string

The Accessory Id this summary belongs too.

state

string

Current state of the summary processing. One of:

created - The request has been created, but it is not yet queued
processable - The request has been queued.
processing - The request is currently being serviced.
processed - The request has been finished. Check the summaryResult field to see if it was ok.

summaryResult

boolean

true if this summary has finished processing correctly. If the state is processed and this value is false then the Summary was unable to be created. See summaryError field for info.

summaryError

string

If the summary was unable to be created, one of the following errors may be returned:

<empty string> - No error occured
ContentNotFound - No Activity or time-lapse content was found; or not enough content was found; for the requested period.
<All other values> - An internal error occurred.

created

string

The Timestamp when Create Sumary was called.

startTime

string

The Timestamp of the first video frame within the Summary itself.

endTime

string

The Timestamp 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. 0 in all error or in progress states.

Language
Authentication
OAuth2