Metrics

Métriques Olist via l'API

Votre client connecte son compte Olist et votre produit interroge 7 métriques par le même endpoint que les autres plateformes. Chaque métrique a un identifiant (reference_key) qui figure dans l'appel.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "comparison_start": "2026-09-01",
  "comparison_end": "2026-09-30",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "olist:total_orders",
      "component": "number_v1",
      "metrics": [
        "orders"
      ],
      "dimensions": [
        "summary"
      ]
    }
  ]
}
Exemple : « Total des commandes » en octobre, comparé à septembre.

Plus d'exemples d'appels Olist

Le même endpoint pour chaque type de métrique. Les champs metrics et dimensions de chaque élément viennent du catalogue de la plateforme (GET /api/metrics/{integration_slug}).

Graphique

Commandes au fil du temps

Évolution quotidienne des commandes. Exclut par défaut les commandes ouvertes, annulées et avec des données incomplètes.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "olist:orders_over_time",
      "component": "chart_v1",
      "metrics": [
        "orders"
      ],
      "dimensions": [
        "date"
      ]
    }
  ]
}

Tableau

Commandes par situation

Distribution des commandes et valeur des ventes regroupées par situation de la commande. Montre toutes les situations, y compris ouvertes, annulées et avec des données incomplètes.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "olist:orders_by_status",
      "component": "datatable_v1",
      "metrics": [
        "orders",
        "total_value"
      ],
      "dimensions": [
        "status"
      ]
    }
  ]
}

Chiffre

Ventes Totales

Somme des totaux des commandes pour la période sélectionnée. Exclut par défaut les commandes ouvertes, annulées et avec des données incomplètes, suivant le modèle du tableau de bord Olist.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "olist:total_sales",
      "component": "number_v1",
      "metrics": [
        "total_value"
      ],
      "dimensions": [
        "summary"
      ]
    }
  ]
}

Chiffres

4 métriques

  • Total des commandes

    Nombre total de commandes pour la période sélectionnée. Exclut par défaut les commandes ouvertes, annulées et avec des données incomplètes, suivant le modèle du tableau de bord Olist.

    olist:total_orders
  • Ventes Totales

    Somme des totaux des commandes pour la période sélectionnée. Exclut par défaut les commandes ouvertes, annulées et avec des données incomplètes, suivant le modèle du tableau de bord Olist.

    olist:total_sales
  • Billet moyen

    Valeur moyenne des ventes par commande pour la période sélectionnée. Exclut par défaut les commandes ouvertes, annulées et avec des données incomplètes.

    olist:average_ticket
  • Commandes annulées

    Nombre total de commandes annulées pour la période sélectionnée.

    olist:canceled_orders

Graphiques

2 métriques

  • Commandes au fil du temps

    Évolution quotidienne des commandes. Exclut par défaut les commandes ouvertes, annulées et avec des données incomplètes.

    olist:orders_over_time
  • Ventes dans le temps

    Évolution quotidienne de la valeur totale des ventes. Exclut par défaut les commandes ouvertes, annulées et avec des données incomplètes.

    olist:sales_over_time

Tableaux

1 métrique

  • Commandes par situation

    Distribution des commandes et valeur des ventes regroupées par situation de la commande. Montre toutes les situations, y compris ouvertes, annulées et avec des données incomplètes.

    olist:orders_by_status

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.