Activities
Get activities
Query activities allows to get a list of activities detected by the camera.
notifications(filters: ActivityFilter order: ActivityOrdering pagination: OffsetPaginationInput): ActivityOutputCountList!
Input parameters:
filters: ActivityFilter: To get only required activities, you can adjust filtration
id: Filtration by activity ID:exact: ID: Get an exact activity object using the value of activity ID.iExact: ID: Get an exact activity object using the value of activity ID. Not case-sensitive.contains: String: Get activity objects using the value matching with activity ID.iContains: String: Get activity objects using the value matching with activity ID. Not case-sensitive.inList: [ID!]: Get certain activity objects using a list of activity IDs.gt: ID: Get activity objects which IDs are greater (>) than submitted ID. String matching is used.gte: ID: Get activity objects which IDs are greater than or equal to (>=) to submitted ID. String matching is used.lt: ID: Get activity objects which IDs are less (<) than submitted ID. String matching is used.lte: ID: Get activity objects which IDs are less than or equal to (<=) to submitted ID. String matching is used.startsWith: String: Get activity objects which IDs start with submitted value.iStartsWith: String: Get activity objects which IDs start with submitted value. Not case-sensitive.endsWith: String: Get activity objects which IDs end with submitted value.iEndsWith: String: Get activity objects which IDs end with submitted value. Not case-sensitive.range: [ID!]: Get activity objects which IDs are within the range of submitted IDs. String matching is used.isNull: Boolean: Get activity objects which IDs are equal(true) or not equal to(false)null.regex: String: Get activity objects which IDs meet a submitted regular expression.iRegex: String: Get activity objects which IDs meet a submitted regular expression. Not case-sensitive.
creationDate: DatetimeFilterLookupCustom: Filtration by activity creation date. The parameters are similar to the ones for filtration by ID.lastModified: DatetimeFilterLookupCustom: Filtration by date of the last activity modification. The parameters are similar to the ones for filtration by ID.profileId: ID: Activity filtration by profile ID.
order: ActivityOrdering: You can adjust sorting of activity list:
id: Ordering: Sorting by ID. String matching is used.(ASC: Ascending sorting,DESC: Descending sorting)creationDate: Ordering: Sorting by activity creation date.lastModified: Ordering: Sorting by date of the last activity modification.
pagination: OffsetPaginationInput:
limit: Int!: The parameter allows to get the firstnactivities from the list.offset: Int!: The parameter allows to remove the firstnactivities from the list.
Output parameters:
ActivityOutputCountList!: The query result is an activity list that contains the following parameters:
totalCount: Int!: Number of returned activities.collectionItems: [ActivityOutput!]!:id: ID!: Activity ID.data: JSON: Additional information about activity.lastModified: DateTime: Date of the last activity modification in ISO 8601 format.agentTitle: String: Name of the Agent that sent processes for the activity.creationDate: DateTime!: Activity creation date in ISO 8601 format.bestShotId: ID: ID of the best face image received from the camera that detected the activity (Missing, if the anonymous mode is enabled or the camera couldn't detect a face image).cameraId: ID!: ID assigned to the camera that detected the activity.cameraTitle: String: Name of the camera that caught the activity.locationId: String!: ID assigned to location which the camera is linked to.profileId: ID: Profile ID.status: ActivityType!:ProgressFinalizedFailed
timeStart: String!: Activity starting time.timeEnd: String!: Activity ending time.
Example Request:
{
activities(filters: {
id: {
exact: "78f7c795-0f28-42ce-a9d2-818095dd5f84"
}
}) {
totalCount
collectionItems {
id
data
cameraId
bestShotId
locationId
profileId
timeStart
creationDate
lastModified
cameraTitle
agentTitle
}
}
}
Example Response: