Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General request format:

POST httpPOST http://localhostIP-address:10000port/firserver/GetAnalitycByTime

JSON parameters:

Request parameters:

ParameterRequiredParameter description
server_idYes

Identifier of the Face Recognition Server in Face-Intellect

minAgeNo

Minimum age of persons

If not specified, then age is not taken into account

maxAge No

Maximum age of persons

If not specified, then age is not taken into account

dateTimeFrom YesTime in UTC+0 format, starting from which the data should be obtained
dateTimeTo YesTime in UTC+0 format, up to which the data should be obtained
cameraIds No

Camera IDs in Face-Intellect

If not specified, then results for all cameras are displayed

genders Yes

Gender of persons whose data should be obtained: 0 Unknown, 1 Males, 2 Females

If parameter value is empty, then all results are displayed regardless of gender

returnLocalTimeNo

Time format of the face capture: 0 time in UTC+0 format, 1 — local time of the Server

If not specified, then returnLocalTime=0

timePeriodNo

Type of grouping the analytic data: 0 by hour, 1 by day, 2 by month, 3 by year

If not specified, then timePeriod=0

Request example:

POST http://127.0.0.1:10000/firserver/GetAnalitycByTime

Code Block
{
  "server_id": "1",
  "minAge": 520,
  "maxAge": 4530,
  "dateTimeFrom": "2019-0102-17T2125T21:00:00.000",
  "dateTimeTo": "20202019-0103-18T2029T20:59:59.000",
  "cameraIds": [
    "1"
  ],
  "genders": [
    0,
    1,
    2
  ],
  "returnLocalTime" : 0,
  "timePeriod" : 0
}

...

Request headlines:

...

  • 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.

Headline Headline description
AllowReturns the HTTP method used in request
Content-LengthShows the size of characters in bytes, received in the request
Content-TypeReturns the type of received request
ServerSpecifies the server from which the request comes
Access-Control-Request-MethodReturns the HTTP method that can be used in the request
Access-Control-OriginIndicates if the code that sends the request from this source can access the server response
DateShows the time of the request

Response example:

Expand
titleClick to expand...

...

age = 0 means that age is not defined.


Code Block
{
    "Rows": [
        {
            "timestamp": "2019-02-27T180000.000",
            "value": [
                {
                    "age": 27,
                    "gender": {
                        "males": 10,
                        "females": 9,
                        "unknown": 0
  
},
					},
					"smile": {
 
						"males": 3,
 
						"females": 1,
						"unknown": 0
},
					},
					"angry": {
						"males": 1,
  
						"females": 2,
  
						"unknown": 0
                
	},
					"fear": {
 
						"males": 1,
 
						"females": 2,
						"unknown": 0
},
					},
					"happiness": {
						"males": 1,
  
						"females": 1,
  
						"unknown": 0
                
	},
					"neutral": {
 
						"males": 2,
 
						"females": 1,
						"unknown": 0
},
					},
					"sadness": {
						"males": 1,
  
						"females": 1,
  
						"unknown": 0
                
	},
					"surprise": {
						"males": 1,
  
						"females": 1,
  
						"unknown": 0
                
}
	}
				}
            ]
        }
    ]
    "
Responce
Response": {
        "Status": "SUCCESS"
    }
}
Info
titleNote


Response parameters:

ParameterParameter description
RowsList of unique faces
timestampFirst pass time in UTC+0 format
valueList of additional face characteristics (for more details, see Getting the recognition protocol)
ResponseResponse
StatusCompleted request status: SUCCESS successful, if error see List of possible errors of the Face Recognition Server