Retrieve the metadata details for a specific Activity ID
Get the full details of a single ActivityActivity - An event that is represented by a start time, end time, relevance and other meta-data. Activities are used to represent videos or audio activity that is part of the same sequence of frames or content. Every Activity has a unique Activity Id. Activities will only be stored for as long your service plan dictates. An Activity belongs to an Accessory. For the full list of attributes on an Activity see Get Activity by Id.
Activities can be referred to as "clips" or "recordings" in the Logi Circle application.. 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 IdActivity Id - A unique non changing value to identify a particular Activity within an Accessory event stream. The API uses a short ISO8601 based timestamp format (YYYYMMDDTHHMMSSZ) with everything represented server side as UTC+0 or "zulu" format. Activity Id's are the short Timestamp of the initial time of Activity creation. However, the Activities startTime value may be later than the value represented by the Activity Id due to trimming and video processing. Activity Id's are not globally unique, but are unique for a given Accessory 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 ActivityActivity - An event that is represented by a start time, end time, relevance and other meta-data. Activities are used to represent videos or audio activity that is part of the same sequence of frames or content. Every Activity has a unique Activity Id. Activities will only be stored for as long your service plan dictates. An Activity belongs to an Accessory. For the full list of attributes on an Activity see Get Activity by Id. Activities can be referred to as "clips" or "recordings" in the Logi Circle application.. 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 IdActivity Id - A unique non changing value to identify a particular Activity within an Accessory event stream. The API uses a short ISO8601 based timestamp format (YYYYMMDDTHHMMSSZ) with everything represented server side as UTC+0 or "zulu" format. Activity Id's are the short Timestamp of the initial time of Activity creation. However, the Activities startTime value may be later than the value represented by the Activity Id due to trimming and video processing. Activity Id's are not globally unique, but are unique for a given Accessory Id.. | |
playbackDuration | integer (ms) | yes | The total length of this ActivityActivity - An event that is represented by a start time, end time, relevance and other meta-data. Activities are used to represent videos or audio activity that is part of the same sequence of frames or content. Every Activity has a unique Activity Id. Activities will only be stored for as long your service plan dictates. An Activity belongs to an Accessory. For the full list of attributes on an Activity see Get Activity by Id. Activities can be referred to as "clips" or "recordings" in the Logi Circle application. in milliseconds. | |
relevanceLevel | integer | yes | The Relevance Level of this ActivityActivity - An event that is represented by a start time, end time, relevance and other meta-data. Activities are used to represent videos or audio activity that is part of the same sequence of frames or content. Every Activity has a unique Activity Id. Activities will only be stored for as long your service plan dictates. An Activity belongs to an Accessory. For the full list of attributes on an Activity see Get Activity by Id. Activities can be referred to as "clips" or "recordings" in the Logi Circle application.. 0 represents gray bubbles, 1 are blue. | |
startTime | string | yes | 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 start of this activity. Since an ActivityActivity - An event that is represented by a start time, end time, relevance and other meta-data. Activities are used to represent videos or audio activity that is part of the same sequence of frames or content. Every Activity has a unique Activity Id. Activities will only be stored for as long your service plan dictates. An Activity belongs to an Accessory. For the full list of attributes on an Activity see Get Activity by Id.
Activities can be referred to as "clips" or "recordings" in the Logi Circle application. can be trimmed at the start, | |
endTime | string | yes | 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 end of this activity. Since an ActivityActivity - An event that is represented by a start time, end time, relevance and other meta-data. Activities are used to represent videos or audio activity that is part of the same sequence of frames or content. Every Activity has a unique Activity Id. Activities will only be stored for as long your service plan dictates. An Activity belongs to an Accessory. For the full list of attributes on an Activity see Get Activity by Id.
Activities can be referred to as "clips" or "recordings" in the Logi Circle application. can be trimmed in the middle, | |
activitySet | array of strings | The Activity Set for this ActivityActivity - An event that is represented by a start time, end time, relevance and other meta-data. Activities are used to represent videos or audio activity that is part of the same sequence of frames or content. Every Activity has a unique Activity Id. Activities will only be stored for as long your service plan dictates. An Activity belongs to an Accessory. For the full list of attributes on an Activity see Get Activity by Id. Activities can be referred to as "clips" or "recordings" in the Logi Circle application.. Indicates what type of triggering events occurred. | ||
motionZones | array of strings | The list of Zone and/or Remainder Zone ids. | ||
objectColors | array of strings | The list of Object Colors detected. | ||
objectSizes | array of strings | The list of Object Sizes detected. | ||
objectLocations | array of integer | The list of Object Location grid numbers. | ||
objectTypes | array of strings | 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]
}