Camlytics API docs (autogenerated)

Camlytics API
Version: 1
Swagger definition: swagger.yaml
More information: REST API Help
Contact Info: camlytics.com

Methods

[ Jump to Models ]

Table of Contents

  1. get /channels
  2. get /events
Up
get /channels
Retrieve video channels

Return type

array[Channel]

Responses

200

Success a href="#Channel">Channel[]

Default

Unexpected error Error

Up
get /events
Retrieve analytics events ordered by event id

Query parameters

sinceId (optional)
Query Parameter — Exclude events that has id less or equal to sinceId
sinceTime (optional)
Query Parameter — Exclude events that occured before sinceTime
untilId (optional)
Query Parameter — Exclude events that has id greater or equal to untilId
untilTime (optional)
Query Parameter — Exclude events that occured after untilTime
limit (optional)
Query Parameter — Max number of events returned. Default value is 100 events.
timeout (required)
Query Parameter — Max number of seconds to wait for new events. If no new events occured, then an empty array is returned. 5 seconds should be fine.

Return type

array[Event]

Responses

200

Success Event[]

Default

Unexpected error Error

Up

Models

[ Jump to Methods ]

Table of Contents

  1. Channel
  2. Error
  3. Event

Channel Up

channel_id
name
type
Enum:
Unknown
Webcam
Onvif
ManualOnvif
Manual
stream_uri
login
password
uri
profile_name
profile_token

Error Up

code
message
detail

Event Up

event_id
type
Enum:
MotionStarted
MotionFinished
Sabotage
RegionJoin
RegionLeave
MotionInRegionOn
MotionInRegionOff
CrowdOn
CrowdOff
ObjectAppear
ObjectDisappear
Running
Loitering
AbandonedObject
TripwireCrossed
CameraDisconnected
time
channel_id
channel_name
object_id
rule_id
rule_name
snapshot_path