Parcours, marques et consommation

Trois lectures décrivent votre espace, avec la portée sessions:read : ses parcours, ses marques et sa consommation.

Parcours

Les parcours scénarisés du Mode Réalisateur, publiés dans l’espace. GET /journeys les liste par ordre alphabétique, sans leur définition, et se parcourt par pages ; GET /journeys/{journey_id} renvoie un parcours avec sa définition. Un brouillon ou un parcours archivé n’y figure pas.

Définition telle que l'éditeur du Mode Réalisateur l'enregistre, avec ses clés en français. Le parcours part de la première étape ; chaque étape mène à next, une étape branche mène à l'une de ses options, et le parcours s'arrête sur une étape recap ou sans next. Des champs peuvent s'ajouter : ignorez ceux que vous ne connaissez pas.

Type d'étape de l'éditeur. branche propose un choix (voir options), recap termine sur un récapitulatif, camera montre au conseiller l'environnement du client en vidéo à la place de la vue 360. paiement envoie au client un lien de paiement. consentement est réservé à une version future.

Les paramètres d’une étape (action) sont propres à son type, et des champs peuvent s’ajouter : ignorez ceux que vous ne connaissez pas. L’API ne lance pas une session sur un parcours et ne dit pas lequel a été joué.

Marques

À la création d’une session, brand désigne une marque de l’espace par son identifiant (brd_…) ou par son nom, quelle que soit sa casse : elle donne à la session son expéditeur SMS, son texte d’invitation et son logo. GET /brands liste les marques avec leur nom, leur expéditeur SMS (sms_sender, 11 caractères au plus) et leur langue (locale) ; le texte d’invitation et le logo ne se lisent pas par l’API. La liste n’a pas de pages : elle renvoie toutes les marques.

Consommation

GET /usage?from=2026-11-01&to=2026-11-30&group_by=day donne la consommation de l’espace sur une période, en heure de Paris : from et to sont des dates AAAA-MM-JJ, to est inclus, group_by vaut day ou month (par défaut). La réponse donne les totaux de la période, puis une entrée par jour ou par mois, même vide.

• Une période de 366 jours au plus par jour, ou de 36 mois par mois. Au-delà, ou si to précède from, l’API répond 400 invalid_request.
• Le mode de la clé : une clé de production lit la consommation de production, une clé de test celle des sessions de test.
• Chaque session compte au jour de sa création, même si l’appel a lieu plus tard.

Compteur	Contenu
sessions	Sessions créées, lien envoyé (l'unité des contrats).
opened	Sessions dont le client a ouvert le lien.
live	Sessions où la vidéo s'est établie.
video_seconds	Coprésence média cumulée.
sms_sent	SMS envoyés au client de la session, un par envoi, réouverture comprise.

Le back-office montre la même consommation, en courbe : voir l’onglet Usage.

Conseillers et agents IA

Aucune route ne liste les conseillers ni les agents IA de l’espace : demandez ces valeurs à l’administrateur de votre espace.

• advisor_email désigne le conseiller de l’espace à qui rattacher la session ; sans lui, la session va au conseiller par défaut de l’espace.
• ai_agent.scenario désigne un agent IA Vizalia publié de l’espace (offre Agent IA), par un identifiant de 40 caractères au plus : minuscules, chiffres, - et _.

Une valeur inconnue répond 422 unknown_advisor ou 422 unknown_scenario.