Skip to main content
GET
/
api
/
v1
/
public
/
nfce
/
metrics
Métricas de NFC-e
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/nfce/metrics \
  --header 'X-API-Key: <x-api-key>'
{
  "avg_ticket_value": 123,
  "clients_never_scanned": 0,
  "duplicate_scans": 0,
  "invalid_scans": 0,
  "period_days": 30,
  "points_issued_via_nfce": 0,
  "scans_by_period": [
    {
      "period": "<string>",
      "scans": 0,
      "valid": 0,
      "value": 0
    }
  ],
  "top_clients": [
    {
      "client_id": "<string>",
      "name": "<string>",
      "points_earned": 0,
      "scans": 0,
      "total_value": 0,
      "valid_scans": 0
    }
  ],
  "top_products_by_value": [
    {
      "product_name": "<string>",
      "occurrences": 0,
      "total_value": 0
    }
  ],
  "total_purchase_value": 0,
  "total_scans": 0,
  "unique_clients_scanned": 0,
  "valid_scans": 0
}

Documentation Index

Fetch the complete documentation index at: https://docs.indiqai.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Métricas de NFC-e

Retorna métricas da mecânica de leitura de NFC-e da empresa. Aceita filtros por período, granularidade e cliente.

Headers

​
X-API-Key
string
required

Chave de API

Query Parameters

​
days
integer
default:30
Required range: 1 <= x <= 365
​
group_by
string
default:day

"day", "week" ou "month"

​
client_id
string<uuid> | null

Filtrar por cliente específico

Response

Successful Response

Métricas da mecânica de leitura de NFC-e.

​
avg_ticket_value
number | null
​
clients_never_scanned
integer
default:0
​
duplicate_scans
integer
default:0
​
invalid_scans
integer
default:0
​
period_days
integer
default:30
​
points_issued_via_nfce
integer
default:0
​
scans_by_period
NfceScanByPeriod · object[]
​
top_clients
NfceTopClient · object[]
​
top_products_by_value
NfceTopProduct · object[]
​
total_purchase_value
number
default:0
​
total_scans
integer
default:0
​
unique_clients_scanned
integer
default:0
​
valid_scans
integer
default:0