Vai al contenuto principale
GET
/
customerstats
/
customers
Elenco clienti
curl --request GET \
  --url https://app.xmenu.it/api/customerstats/customers \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "message": "<string>",
  "page": 123,
  "pagesize": 123,
  "total_count": 123,
  "more": true,
  "customers": [
    {
      "email": "<string>",
      "uid": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "address": "<string>",
      "number": "<string>",
      "city": "<string>",
      "province": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "orders_count": 123,
      "pickup_orders_count": 123,
      "delivery_orders_count": 123,
      "offline_orders_count": 123,
      "first_order": "<string>",
      "last_order": "<string>",
      "last_offline_order": "<string>",
      "orders_total": 123,
      "added": "<string>",
      "signedup": true,
      "signup_uid": "<string>",
      "devices_unregistered": "<string>",
      "code": "<string>",
      "subrestaurant_code": "<string>",
      "subrestaurant_uid": "<string>",
      "signup_deleted": "<string>"
    }
  ]
}

Autorizzazioni

​
X-Api-Key
string
header
obbligatorio

Chiave API del ristorante. Può essere ottenuta da Strumenti > Accesso API nella dashboard xMenu.

Parametri della query

​
restuid
string
obbligatorio

Identificativo univoco del ristorante

​
page
integer
obbligatorio

Numero di pagina da recuperare

Intervallo richiesto: x >= 1
​
pagesize
integer
predefinito:100

Numero di risultati per pagina (max: 100)

Intervallo richiesto: 1 <= x <= 100
​
added_from
string<date>

Filtra clienti aggiunti da questa data (formato YYYY-MM-dd)

​
added_to
string<date>

Filtra clienti aggiunti fino a questa data (formato YYYY-MM-dd)

​
signedup
enum<string>

Filtra per stato di registrazione

  • 0 = clienti non registrati
  • 1 = clienti registrati
Opzioni disponibili:
0,
1
​
first_order_from
string<date>

Filtra clienti con primo ordine da questa data (formato YYYY-MM-dd)

​
first_order_to
string<date>

Filtra clienti con primo ordine fino a questa data (formato YYYY-MM-dd)

​
devices_unregistered_from
string<date>

Filtra clienti con più recente disinstallazione app da questa data

​
devices_unregistered_to
string<date>

Filtra clienti con più recente disinstallazione app fino a questa data

​
signup_deleted_from
string<date>

Filtra clienti con account eliminato da questa data (formato YYYY-MM-dd)

​
signup_deleted_to
string<date>

Filtra clienti con account eliminato fino a questa data (formato YYYY-MM-dd)

Risposta

Risposta elenco clienti

​
success
boolean
obbligatorio

Stato dell'operazione:

  • false = Errore
  • true = Successo
​
error
string

Codice errore se l'operazione è fallita.

Vedi Codici di errore per i codici di errore generali che possono verificarsi.

​
message
string

Descrizione testuale dell'errore se l'operazione è fallita

​
page
integer

Numero pagina corrente

​
pagesize
integer

Numero massimo di elementi per pagina

​
total_count
integer

Numero totale di risultati

​
more
boolean

Se ci sono ulteriori risultati:

  • false = Nessun altro risultato
  • true = Altri risultati disponibili
​
customers
object[]

Array di oggetti cliente