Skip to main content
POST
Cuenta los lugares activos de una zona, agrupados por marca, institución o categoría. Los resultados vienen ordenados de mayor a menor, con un geo_context que ubica el área consultada. El área se define con geo_filter en uno de tres modos.
Empieza con group_by: "category" para ver el perfil comercial de la zona, y baja a group_by: "brand" cuando quieras nombres propios. Para obtener los lugares uno por uno, usa listado por entidad.

Autorizaciones

Authorization
string
header
requerido

Token de autenticación. Formato requerido: Token tu-token (la palabra Token, un espacio y tu token). Solicita tu token escribiendo a contacto@tukanmx.com.

Cuerpo

application/json
group_by
enum<string>
requerido

Criterio de agrupación de los resultados

Opciones disponibles:
brand,
institution,
category
geo_filter
object
requerido

Filtro geográfico. Modos disponibles: radio (latitude, longitude, radius_km), dirección (address, radius_km) o polígono (entity_type, entity_codes).

Respuesta

Conteo de lugares obtenido exitosamente

count
integer
geo_context
object | null
results
object[]

La forma de cada elemento depende de group_by

Resultado cuando group_by = brand