Mejores clientes del periodo

Scope requerido: reportes:read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Mejores clientes del periodo

Scope requeridoreportes:read
MétodoGET /ext/v3/reportes/clientes/mejores

Query

ParámetroTipoRequeridoDescripción
iniciodatesíFecha inicial YYYY-MM-DD (dia completo en la zona del negocio)
findatesíFecha final YYYY-MM-DD inclusiva
minimonumbernoMinimo de compras (tipo=cantidad) o de monto (tipo=monto) para entrar al ranking
tipoenum: cantidad | montonoRanking por cantidad de compras o por monto gastado Default "cantidad".
tiendastringnoLimitar a una tienda (id de sucursal)
etiquetas_incluirstringno
etiquetas_excluirstringno

Ejemplo

curl -X GET 'https://api3.clau.io/ext/v3/reportes/clientes/mejores' \
  -H 'apikey: ck_1_...'

Respuesta 200

{
  "codigoRespuesta": 0,
  "msj": "Exito",
  "data": "…",
  "meta": {
    "requestId": "5f1c…",
    "appId": 1,
    "scope": "reportes:read"
  }
}

Errores: 401 key inválida (9501), 403 sin scope (9503, meta.requiredScope), 400 parámetros (details), 429 límite de tasa. Agregue ?help=true para la ayuda en texto plano.

Query Params
date
required

Fecha inicial YYYY-MM-DD (dia completo en la zona del negocio)

date
required

Fecha final YYYY-MM-DD inclusiva

number
≥ 0

Minimo de compras (tipo=cantidad) o de monto (tipo=monto) para entrar al ranking

string
enum
Defaults to cantidad

Ranking por cantidad de compras o por monto gastado

Allowed:
string
length ≤ 120

Limitar a una tienda (id de sucursal)

string
length ≤ 500
string
length ≤ 500
boolean

Con true devuelve la ayuda del endpoint en texto plano.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json