Get Activity JPG File

Retrieve the snapshot JPEG file for a specific Activity ID.

Retrieve the single jpeg thumbnail file for a given Activity Id. If this Activity has finished, this call is idempotent. You MUST include an Accept: image/jpeg header in this call.

This call usually includes Highlight zones as optional return headers if the Classifiers process found interesting content. There are two different Highlight zones and they are typically used to provide a zoomed visual preview in a push notification. The first Highlight zone is a small square and is passed as the X-Logi-Highlight-Square header. The second Highlight zone is a variable sized 16:9 rectangle and is passed as the X-Logi-Highlight-Rect header. If the named header is not present, then assume the whole image is the Highlight area. The two Highlight zones usually intersect each other, but don't have too.

Each Highlight zone is represented by a tuple of pixel space values X,Y,W,H. The first two values X and Y, represent the starting coordinates relative to the upper left corner [0,0] of the image. The second two values W and H are the width and height to complete the zone starting from X and Y.

The header passes the values with this syntax and order: X,Y,W,H

This API call will include Cache-Control headers in the response that must be honored. The cache duration is 10 sec for an activity in progress and the cache duration for a completed activity is the lifetime of that activity.

The width and height of the returned image is the video resolution used for recording. This will usually match the videoStream field from Get Accessory by Id, unless the user has subsequently changed the resolution.

Permissions

Requires the Permissions scope of: circle:activities_basic

Response Examples

X-Logi-Highlight-Square: 350,172,160,160
X-Logi-Highlight-Rect: 216,132,427,240
Cache-Control: max-age=86400
Content-Type: image/jpeg
Content-Disposition: attachment; filename="20160311T071226Z.jpg"
{binary data}
X-Logi-Highlight-Square: 350,172,160,160
X-Logi-Highlight-Rect: 216,132,427,240
Cache-Control: max-age=10
Content-Type: image/jpeg
Content-Disposition: attachment; filename="20160311T071226Z.jpg"
{binary data}
Language
Authentication
OAuth2