General request format:
POST http://IP-address:port/firserver/GetAnalitycByTime
Request parameters:
| Parameter | Required | Parameter description |
|---|
| server_id | Yes | Identifier of the Face Recognition Server in Face Intellect |
| minAge | No | Minimum age of persons |
| maxAge | No | Maximum age of persons |
| dateTimeFrom | Yes | Time in UTC format, starting from which the data should be obtained |
| dateTimeTo | Yes | Time in UTC format, up to which the data should be obtained |
| cameraIds | No | Camera IDs in Face Intellect |
| genders | Yes | Gender of persons whose data should be obtained: 0 - Unknown, 1 - Males, 2 - Females |
| returnLocalTime | No | Time format of the face capture: 0 - time in UTC format, 1- local time of the Server |
| timePeriod | No | Type of grouping the analytic data: 0 - by hour, 1 - by day, 2 - by month, 3 - by year |
Request example:
POST http://localhost:10000/firserver/GetAnalitycByTimeJSON parameters:
| Expand |
|---|
| Code Block |
|---|
{
"server_id": "1",
"minAge": |
54530,
"dateTimeFrom": "2019- |
0117T2125T21:00:00.000",
"dateTimeTo": " |
20200118T2029T20:59:59.000",
"cameraIds": [
"1"
],
"genders": [
0
1,
2
],
"returnLocalTime" : 0,
"timePeriod" : 0
} |
|
where:
- server_id is the identifier of the Face Recognition Server in Face Intellect (see Configuring the Face Recognition Server object);
- minAge is the minimum age of persons whose data should be obtained;
- maxAge is the maximum age of persons whose data should be obtained;
- dateTimeFrom is the time in UTC format, starting from which the data should be obtained;
- dateTimeTo is the time in UTC format, up to which the data should be obtained;
- cameraIds is the camera IDs in Face Intellect (see Creating and configuring the Camera object);
- genders is the gender of persons whose data should be obtained: 0 - Unknown, 1 - Males, 2 - Females;
- returnLocalTime is the time format of the face capture: 0 - time in UTC format, 1- local time of the Server;
- timePeriod is the type of grouping the analytic data: 0 - by hour, 1 - by day, 2 - by month, 3 - by year.
Response example:
Response example:
| Expand |
|---|
| Code Block |
|---|
{
"Rows": [
{
"timestamp": "2019-02-27T180000.000",
"value": [
{
"age": 27,
"gender": {
"males": 10,
"females": 9,
"unknown": 0
|
},
},
},
},
}
ResponceResponse": {
"Status": "SUCCESS"
}
} |
|
| Info |
|---|
|
age = 0 means that age is not defined.
|
Response parameters:
| Parameter | Parameter description |
|---|
| Rows | List of unique faces |
| timestamp | First pass time in UTC format |
| value | List of additional face characteristics (for more details, see Getting the recognition protocol) |
| Response | Response |
| Status | Completed request status: SUCCESS - successful |
