Counting API
Health
health
GET
https://counting.traces.cloud/api/v1/health
This endpoint allows to test that service is up
Path Parameters
Name | Type | Description |
---|---|---|
X-Traces-API-Key | string | Authorization API key to access Traces Counting API |
Example
Operations
For a successful usage of Traces Counting API, it is required to do the following step:
Register a camera by providing coordinates of counting triangles. It should be done only once for every unique camera. Read more about counting triangles here.
If the placement of a camera or areas of interest has changed, just update the coordinates of counting triangles by sending a new POST request with the same 'camera id'.
object-counting-settings
POST
https://counting.traces.cloud/api/v1/object-counting-settings
Defines areas of interest (counting triangles) for a given camera. Counting triangles are used to calculate the number of objects that passed by.
Headers
Name | Type | Description |
---|---|---|
X-Traces-API-Key* | string | Authorization API key to access Traces Counting API |
Request Body
Name | Type | Description |
---|---|---|
counting_options* | object | Dictionary with a |
Example
object-counting
POST
https://counting.traces.cloud/api/v1/object-counting
Calculates the number of objects that passed every area of interest in a given video. Returns a detailed report about how many objects of each type entered and exited every area of interest.
Headers
Name | Type | Description |
---|---|---|
X-Traces-API-Key* | string | Authorization API key to access Traces Counting API |
Request Body
Name | Type | Description |
---|---|---|
counting_options* | object | Dictionary with " |
video* | string | video file ($binary) |
metadata* | object | Dictionary with a " |
Example
dwell-time-settings
POST
https://counting.traces.cloud/api/v1/dwell-time-settings
Defines spaces for dwell time calculation for a given camera.
Headers
Name | Type | Description |
---|---|---|
X-Traces-API-Key* | string | Authorization API key to access Traces Counting API |
Request Body
Name | Type | Description |
---|---|---|
counting_options* | object | Dictionary with a list of spaces where a dwell time should be calculated. See example |
Example
dwell-time-summary
POST
https://counting.traces.cloud/api/v1/dwell-time-summary
Calculates statistics about customer's dwell time in the defined spaces. Returns the number of people who entered a perimeter of every space; average, median, total, maximum, and minimum of dwell time in the given video.
Path Parameters
Name | Type | Description |
---|---|---|
X-Traces-API-Key* | string | Authorization API key to access Traces Counting API |
Request Body
Name | Type | Description |
---|---|---|
video* | string | video file ($binary) |
metadata* | object | Dictionary with |
Example
dwell-time-detailed
POST
https://counting.traces.cloud/api/v1/dwell-time-detailed
Calculates dwell-time for every customer who entered the perimeter. It provides detailed information about every customer who entered any space, that includes every frame where the customer appeared, their coordinates in each frame for correct localization, and a total dwell time.
Path Parameters
Name | Type | Description |
---|---|---|
X-Traces-API-Key* | string | Authorization API key to access Traces Counting API |
Request Body
Name | Type | Description |
---|---|---|
video* | string | video file ($binary) |
metadata* | object | Dictionary with |
Example
Last updated