API pública

La API pública de Fullmetrix devuelve tus métricas de ventas en forma de tabla, en formato JSON. Úsala para alimentar una herramienta interna, una hoja de cálculo automatizada, un almacén de datos o un panel a medida. El conector de Looker Studio funciona sobre ella.

Una API es una dirección web que consulta un programa en lugar de un navegador. Envías una petición que dice lo que quieres, por ejemplo la facturación diaria del mes pasado, y Fullmetrix responde con las cifras.

La API es de solo lectura. No puede cambiar nada en Fullmetrix ni en tu tienda.

Crea una clave APICopy Anchor Link

Cada petición debe llevar una clave API. La clave identifica la organización cuyos datos lees. No hay nada más que configurar.

La lista de claves muestra de cada clave su Nombre, su Prefijo, la fecha de creación en Creado el y último usado. Esta última columna te ayuda a detectar una clave que ya no usa nadie. Para cortar una clave, haz clic en Revocar y confirma. Cualquier integración que la use deja de funcionar al instante. Esta pantalla se explica en detalle en Claves API.

Crea una clave por herramienta. Si tienes que cortar una, las demás siguen funcionando.

AutenticaciónCopy Anchor Link

La dirección base de la API es https://app.fullmetrix.com. Cada petición lleva la clave en la cabecera Authorization, después de la palabra Bearer.

curl https://app.fullmetrix.com/api/reports/catalog \
  -H "Authorization: Bearer fmx_YOUR_KEY"

Las claves funcionan durante la prueba gratuita y durante la suscripción. Si la suscripción de la organización se detiene, las peticiones se rechazan hasta que se reanude.

Lista los campos disponiblesCopy Anchor Link

GET /api/reports/catalog devuelve las dimensiones y las métricas que puedes pedir. Una dimensión es una forma de dividir los datos, como la fecha o el país. Una métrica es una cifra calculada, como el número de pedidos.

curl https://app.fullmetrix.com/api/reports/catalog \
  -H "Authorization: Bearer fmx_YOUR_KEY"

{
  "dimensions": [
    { "id": "date", "label": "Date", "type": "date" },
    { "id": "store", "label": "Boutique", "type": "string" },
    { "id": "country", "label": "Pays", "type": "string" },
    { "id": "customer_type", "label": "Type client", "type": "string" },
    { "id": "status", "label": "Statut commande", "type": "string" }
  ],
  "metrics": [
    { "id": "orders", "label": "Commandes", "type": "number" },
    { "id": "items_sold", "label": "Produits vendus", "type": "number" },
    { "id": "gross_sales", "label": "CA brut", "type": "currency" },
    { "id": "net_revenue", "label": "CA net", "type": "currency" },
    { "id": "average_order_value", "label": "Panier moyen", "type": "currency" },
    { "id": "taxes", "label": "Taxes", "type": "currency" },
    { "id": "shipping", "label": "Livraison", "type": "currency" },
    { "id": "unique_customers", "label": "Clients uniques", "type": "number" },
    { "id": "new_customers", "label": "Nouveaux clients", "type": "number" },
    { "id": "returning_customers", "label": "Clients récurrents", "type": "number" }
  ]
}

Los valores de label se devuelven en francés. Usa los valores de id en tus peticiones.

Esta llamada también sirve para comprobar que una clave funciona. Responde con el estado 200 cuando la clave es válida.

DimensionesCopy Anchor Link

MétricasCopy Anchor Link

Los importes están en la divisa de tus tiendas y redondeados a dos decimales. Las cifras siguen tus ajustes de informes, incluidos los estados excluidos y las deducciones de ventas netas.

Consulta tus métricasCopy Anchor Link

GET /api/reports/tabular devuelve una tabla de filas. Cada fila combina las dimensiones pedidas con las métricas calculadas para esa combinación.

ParámetrosCopy Anchor Link

El periodo pedido puede abarcar hasta dos años. Más allá, la API lo acorta conservando la fecha de fin, y la respuesta muestra las fechas realmente usadas en from y to.

Las fechas from y to se leen en hora universal, de medianoche a medianoche UTC. El parámetro timezone solo cambia el día mostrado para cada pedido. Alrededor de medianoche, algunos pedidos pueden por tanto caer en un día distinto al de tus informes de Fullmetrix.

Ejemplo, facturación por díaCopy Anchor Link

curl "https://app.fullmetrix.com/api/reports/tabular?dimensions=date&metrics=orders,net_revenue&from=2026-09-01&to=2026-09-30&timezone=Europe/Paris" \
  -H "Authorization: Bearer fmx_YOUR_KEY"

{
  "dimensions": ["date"],
  "metrics": ["orders", "net_revenue"],
  "from": "2026-09-01",
  "to": "2026-09-30",
  "timezone": "Europe/Paris",
  "rows": [
    { "date": "2026-09-01", "orders": 42, "net_revenue": 2318.4 },
    { "date": "2026-09-02", "orders": 37, "net_revenue": 1975.1 }
  ],
  "rowCount": 30
}

Las filas se ordenan según el orden de las dimensiones pedidas. rowCount indica el número de filas devueltas.

Ejemplo, ventas por país y tipo de clienteCopy Anchor Link

curl "https://app.fullmetrix.com/api/reports/tabular?dimensions=country,customer_type&metrics=orders,net_revenue,average_order_value&from=2026-07-01&to=2026-09-30" \
  -H "Authorization: Bearer fmx_YOUR_KEY"

Ejemplo, totales de un periodoCopy Anchor Link

Sin dimensión, la respuesta contiene una única fila.

curl "https://app.fullmetrix.com/api/reports/tabular?metrics=orders,gross_sales,net_revenue,new_customers&from=2026-01-01&to=2026-09-30" \
  -H "Authorization: Bearer fmx_YOUR_KEY"

Ejemplo, compara tus tiendasCopy Anchor Link

curl "https://app.fullmetrix.com/api/reports/tabular?dimensions=store&metrics=orders,net_revenue&from=2026-09-01&to=2026-09-30" \
  -H "Authorization: Bearer fmx_YOUR_KEY"

Códigos de respuesta y erroresCopy Anchor Link

Los errores devuelven un objeto JSON con un campo error que describe el problema.

Ejemplo de respuesta 400 para una métrica desconocida.

{
  "error": "Dimensions ou métriques inconnues",
  "unknownDimensions": [],
  "unknownMetrics": ["revenue"]
}

Con un código 429, la respuesta lleva también las cabeceras X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset. Espacia tus llamadas y conserva los resultados que no cambian, como los días pasados.

Una respuesta correcta puede servirse desde una caché durante un minuto. Dos llamadas idénticas próximas en el tiempo devuelven por tanto el mismo resultado.

La API acepta llamadas procedentes de un navegador, pero recuerda que la clave no debe exponerse nunca en una página pública.

Preguntas frecuentesCopy Anchor Link