Nodeflux Central
Face Search Logs

API Reference — Face Search Logs

Endpoint untuk mengambil log pencarian wajah, statistik keberhasilan, dan statistik akses pengguna.

Semua endpoint memerlukan header Authorization: Bearer <token> atau x-api-key: <api-key>. Basis URL mengikuti variabel lingkungan VITE_API_URL yang dikonfigurasi pada instalasi Lenz. Akses ke endpoint log memerlukan permission FACE_SEARCHING_LOGS. Jika Anda belum punya token, lihat halaman Otentikasi.


Log Pencarian Wajah

Endpoint utama untuk mengambil daftar log setiap permintaan Face Search yang tercatat di sistem. Sertakan filter[type]=face untuk membatasi hasil pada log Face Search saja.

GET
/api/log-investigate

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

page*integer

Nomor halaman yang diminta (dimulai dari 1)

Range1 <= value
limit*integer

Jumlah entri per halaman

search?string

Kata kunci pencarian teks bebas pada entri log

filter[type]?string

Filter berdasarkan tipe investigasi: face (pencarian wajah) atau plate (pencarian plat nomor)

Value in"face" | "plate"
filter[method]?string

Filter berdasarkan metode HTTP permintaan (misalnya POST)

filter[search_method]?string

Filter berdasarkan metode pencarian yang digunakan

Value in"face-search-candidates" | "match-anonymous" | "face-search-demography" | "local-nik-search"
filter[ip_address]?string

Filter berdasarkan alamat IP asal permintaan

filter[location]?string

Filter berdasarkan lokasi geografis asal permintaan

filter[path]?string

Filter berdasarkan path API yang dipanggil

filter[status_code]?string

Filter berdasarkan kode status HTTP respons (misalnya 200, 400)

filter[source]?string

Filter berdasarkan sumber permintaan: manual (pengguna interaktif) atau automatic (sistem/skrip otomatis)

Value in"manual" | "automatic"
sort[id]?string

Urutan berdasarkan ID entri

Value in"asc" | "desc"
sort[created_at]?string

Urutan berdasarkan waktu pembuatan log

Value in"asc" | "desc"
instance?string

Filter berdasarkan instance dalam mode Federation

Response Body

application/json

application/json

application/json

curl -X GET "https://lenz.example.com/api/log-investigate?page=1&limit=10&search=192.168.1.42&filter%5Btype%5D=face&filter%5Bmethod%5D=POST&filter%5Bsearch_method%5D=face-search-candidates&filter%5Bip_address%5D=192.168.1.42&filter%5Blocation%5D=Jakarta&filter%5Bpath%5D=%2Fapi%2Fv1%2Fface-search-candidates&filter%5Bstatus_code%5D=200&filter%5Bsource%5D=manual&sort%5Bid%5D=desc&sort%5Bcreated_at%5D=desc&instance=instance-jakarta"
{  "ok": true,  "message": "success",  "result": {    "limit": 10,    "current_page": 1,    "total_data": 342,    "total_page": 35,    "log_investigates": [      {        "id": 1081,        "type": "face",        "method": "POST",        "search_method": "face-search-candidates",        "ip_address": "192.168.1.42",        "location": "",        "path": "/api/v1/face-search-candidates",        "source": "manual",        "status_code": 200,        "request": {},        "request_image": "<base64-encoded-image>",        "response": {},        "user_metadata": {          "name": "John Doe",          "user_id": 15,          "auth_type": "token",          "api_key_name": ""        },        "created_at": "2025-04-30T08:22:11Z"      }    ]  }}
{  "ok": false,  "message": "page is required"}
{  "ok": false,  "message": "unauthorized"}

Statistik Keberhasilan

Endpoint untuk mengambil ringkasan jumlah permintaan Face Search yang berhasil dan gagal dalam periode tertentu. Berguna untuk tab Statistik pada dashboard Face Search Logs.

GET
/api/log-investigate/statistics

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

filter[type]?string

Filter berdasarkan tipe investigasi: face atau plate

Value in"face" | "plate"
filter[search_method]?string

Filter berdasarkan metode pencarian yang digunakan

filter[source]?string

Filter berdasarkan sumber permintaan

Value in"manual" | "automatic"
filter[method]?string

Filter berdasarkan metode HTTP

filter[ip_address]?string

Filter berdasarkan alamat IP asal permintaan

filter[location]?string

Filter berdasarkan lokasi

filter[timestamp_from]?string

Batas awal rentang waktu statistik (ISO 8601)

Formatdate-time
filter[timestamp_to]?string

Batas akhir rentang waktu statistik (ISO 8601)

Formatdate-time
instance?string

Filter berdasarkan instance dalam mode Federation

Response Body

application/json

application/json

curl -X GET "https://lenz.example.com/api/log-investigate/statistics?filter%5Btype%5D=face&filter%5Bsearch_method%5D=face-search-candidates&filter%5Bsource%5D=manual&filter%5Bmethod%5D=POST&filter%5Bip_address%5D=192.168.1.42&filter%5Blocation%5D=Jakarta&filter%5Btimestamp_from%5D=2025-04-01T00%3A00%3A00Z&filter%5Btimestamp_to%5D=2025-04-30T23%3A59%3A59Z&instance=instance-jakarta"
{  "ok": true,  "message": "success",  "result": {    "total_success": 318,    "total_failed": 24  }}
{  "ok": false,  "message": "unauthorized"}

Statistik Akses Pengguna

Endpoint untuk mengambil daftar pengguna paling aktif berdasarkan jumlah permintaan Face Search yang dilakukan. Diurutkan dari jumlah akses tertinggi.

GET
/api/log-investigate/user-access-statistics

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

filter[type]?string

Filter berdasarkan tipe investigasi: face atau plate

Value in"face" | "plate"
filter[search_method]?string

Filter berdasarkan metode pencarian yang digunakan

filter[source]?string

Filter berdasarkan sumber permintaan

Value in"manual" | "automatic"
filter[method]?string

Filter berdasarkan metode HTTP

filter[ip_address]?string

Filter berdasarkan alamat IP asal permintaan

filter[location]?string

Filter berdasarkan lokasi

filter[timestamp_from]?string

Batas awal rentang waktu statistik (ISO 8601)

Formatdate-time
filter[timestamp_to]?string

Batas akhir rentang waktu statistik (ISO 8601)

Formatdate-time
instance?string

Filter berdasarkan instance dalam mode Federation

Response Body

application/json

application/json

curl -X GET "https://lenz.example.com/api/log-investigate/user-access-statistics?filter%5Btype%5D=face&filter%5Bsearch_method%5D=face-search-candidates&filter%5Bsource%5D=manual&filter%5Bmethod%5D=POST&filter%5Bip_address%5D=192.168.1.42&filter%5Blocation%5D=Jakarta&filter%5Btimestamp_from%5D=2025-04-01T00%3A00%3A00Z&filter%5Btimestamp_to%5D=2025-04-30T23%3A59%3A59Z&instance=instance-jakarta"
{  "ok": true,  "message": "success",  "result": [    {      "name": "super admin",      "total_access": 198    },    {      "name": "John Doe",      "total_access": 85    },    {      "name": "Jane Smith",      "total_access": 59    }  ]}
{  "ok": false,  "message": "unauthorized"}

On this page