Get Activity by ID

Retrieve the metadata details for a specific Activity ID

Get the full details of a single Activity. If this activity has finished, this call is idempotent. Activity lifecycle is reported via the activity_started, activity_updated and activity_finished Notification Events.

To get a list of Activities use Get Activities by Accessory Id.

To retrieve the media for an Activity use
To delete multiple Activity Id's at once, use Delete Activities.

Permissions

Requires a Permissions scope of: circle:activities

The request values for extraFields are impacted by the Zones Feature and Advanced Timeline Filters Feature.

Response Body

A JSON object representing an Activity. 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 following table describes each key which may be present in the object and if its present by default.

Name

Type

Default

Service Plan Feature

Description

activityId

string

yes

The Activity Id.

playbackDuration

integer (ms)

yes

The total length of this Activity in milliseconds.

relevanceLevel

integer

yes

The Relevance Level of this Activity. 0 represents gray bubbles, 1 are blue.

startTime

string

yes

Timestamp of the start of this activity. Since an Activity can be trimmed at the start, startTime may not be the same as activityId.

endTime

string

yes

Timestamp of the end of this activity. Since an Activity can be trimmed in the middle, endTime may not be the same as startTime+ playbackDuration.

activitySet

array of strings

The Activity Set for this Activity. Indicates what type of triggering events occurred.

motionZones

array of strings

Zones Feature

The list of Zone and/or Remainder Zone ids.

objectColors

array of strings

Advanced Timeline Filters Feature

The list of Object Colors detected.

objectSizes

array of strings

Advanced Timeline Filters Feature

The list of Object Sizes detected.

objectLocations

array of integer

Advanced Timeline Filters Feature

The list of Object Location grid numbers.

objectTypes

array of strings

Advanced Timeline Filters Feature

Object Type Detection Feature

The list of Object Types detected.

Examples

GET /api/accessories/70e3e6f9-70c3-45b2-62e4-ace3d027988a/activities/20160311T071226Z
{
  "activityId": "20160311T071226Z",
  "accessoryId": "70e3e6f9-70c3-45b2-62e4-ace3d027988a",
  "playbackDuration": 48843,
  "relevanceLevel": 1,
  "startTime": "2016-03-11T07:12:26.291Z",
  "endTime": "2016-03-11T07:17:33.684Z",
}
GET /api/accessories/70e3e6f9-70c3-45b2-62e4-ace3d027988a/activities/20160311T071226Z?extraFields=motionZones,objectColors,objectSizes,objectTypes,objectLocations,activitySet
{
  "activityId": "20160311T071226Z",
  "accessoryId": "70e3e6f9-70c3-45b2-62e4-ace3d027988a",
  "playbackDuration": 48843,
  "relevanceLevel": 1,
  "startTime": "2016-03-11T07:12:26.291Z",
  "endTime": "2016-03-11T07:17:33.684Z",
  "activitySet": []
}
GET /api/accessories/70e3e6f9-70c3-45b2-62e4-ace3d027988a/activities/20160311T071226Z?extraFields=motionZones,objectColors,objectSizes,objectTypes,objectLocations
{
  "activityId": "20160311T071226Z",
  "accessoryId": "70e3e6f9-70c3-45b2-62e4-ace3d027988a",
  "playbackDuration": 48843,
  "relevanceLevel": 1,
  "startTime": "2016-03-11T07:12:26.291Z",
  "endTime": "2016-03-11T07:17:33.684Z",
  "motionZones": ["z1", "zR"],
  "objectColors": ["BU"],
  "objectSizes": ["m"],
  "objectTypes": ["person"],
  "objectLocations": [35,36]
}
Language
Authentication
OAuth2