Référence · 3 opérations

vision

VISION, pilotage de l'institution : indicateurs agreges sous seuil de minimisation, export CSV trace. Aucune donnee de dossier.

Les descriptions viennent du contrat, rédigé en français sans accents. Elles sont reproduites telles quelles pour rester la source de vérité.

Catalogue des indicateurs de l'institution

GET/api/v1/vision/catalog

Registre ferme : formule, numerateur, denominateur, sources, periode, fraicheur ; indicateurs sans source et leur motif ; seuil de minimisation. Exige `analytics.read`.

Identifiant de l'opération visionCatalog

Authentification et permissions

Le contrat ne déclare pas d'authentification par opération. Règle générale : un jeton porteur dans l'en-tête Authorization. Permissions : le contrat ne les déclare pas par opération. Lire la règle d'authentification

Corps de la requête

Aucun corps de requête.

Réponses

200Réponse réussieapplication/jsonVisionCatalogOut
Champs de la réponse 200
- can_exportbooleanrequis
  L'appelant detient `analytics.export`.
- indicatorsarray<IndicatorDefinitionOut>requis
- max_monthsintegerrequis
  Etendue maximale d'une periode, en mois.
- min_segment_sizeintegerrequis
  Seuil k : aucun segment de 1 a k-1 dossiers n'est restitue.
- score_bandsintegerrequis
  Bandes de la repartition des scores par grille.
- unavailablearray<UnavailableIndicatorOut>requis

Requêtebash

# Jeton porteur si l'opération l'exige
curl -X GET "$NEXCLARA_API_URL/api/v1/vision/catalog" \
  -H "Authorization: Bearer $NEXCLARA_TOKEN"

Réponse 200json

{
  "can_export": false,
  "indicators": [
    {
      "categories": [],
      "denominator": "exemple",
      "dimensions": [],
      "event_time": "exemple",
      "family": "activity",
      "formula": "exemple",
      "freshness": "live",
      "key": "applications.created",
      "kind": "count",
      "missing_data": "zero_is_value",
      "numerator": null,
      "population": "dossiers",
      "sources": [],
      "unit": "applications"
    }
  ],
  "max_months": 1,
  "min_segment_size": 1,
  "score_bands": 1,
  "unavailable": [
    {
      "family": "activity",
      "key": "portfolio.default_rate_by_score_band",
      "reason": "no_observed_outcome"
    }
  ]
}

Exemple synthétique généré depuis le contrat et validé contre son schéma. Les clés libres « exemple » sont illustratives.

Exporter les indicateurs en CSV

POST/api/v1/vision/export

Meme lecture que `GET /vision/indicators`, serialisee en CSV `;` (format `nexclara-vision-export@1`) : agregats seulement, segments supprimes exportes vides, trace dans la chaine de l'institution. Exige `analytics.export`.

Identifiant de l'opération visionExport

Authentification et permissions

Paramètres de requête

fromstringrequis
Premier mois AAAA-MM.
pattern: "^\\d{4}-\\d{2}$"
tostringrequis
Dernier mois AAAA-MM.
pattern: "^\\d{4}-\\d{2}$"
product_idstring (uuid) | nullfacultatif
Restreindre a un produit.
policy_idstring (uuid) | nullfacultatif
Restreindre a une politique.

Corps de la requête

Aucun corps de requête.

Réponses

200Réponse réussietext/csvstring (binary)
422Erreur de validationapplication/jsonHTTPValidationError

Requêtebash

# Jeton porteur si l'opération l'exige
curl -X POST "$NEXCLARA_API_URL/api/v1/vision/export?from=2026-09&to=2026-09" \
  -H "Authorization: Bearer $NEXCLARA_TOKEN"

Réponse 200 · Corps text/csv : aucun exemple JSON.

Indicateurs de l'institution sur une periode

GET/api/v1/vision/indicators

Mois `from` a `to` inclus (AAAA-MM, temps universel, 24 mois au plus, aucun mois futur), par produit, politique, mois et canal ; une seule transaction, un instant de calcul. Un segment de moins de `min_segment_size` dossiers est supprime, ainsi que son complement. Exige `analytics.read`.

Identifiant de l'opération visionRead

Authentification et permissions

Paramètres de requête

fromstringrequis
Premier mois AAAA-MM.
pattern: "^\\d{4}-\\d{2}$"
tostringrequis
Dernier mois AAAA-MM.
pattern: "^\\d{4}-\\d{2}$"
product_idstring (uuid) | nullfacultatif
Restreindre a un produit.
policy_idstring (uuid) | nullfacultatif
Restreindre a une politique.

Corps de la requête

Aucun corps de requête.

Réponses

200Réponse réussieapplication/jsonVisionReadingOut
Champs de la réponse 200
- computed_atstring (date-time)requis
- indicatorsarray<IndicatorValueOut>requis
- min_segment_sizeintegerrequis
- periodReadingPeriodOutrequis
- policiesarray<PolicyReferenceOut>requis
- policy_idstring (uuid) | nullrequis
- product_idstring (uuid) | nullrequis
- productsarray<ProductReferenceOut>requis
- unavailablearray<UnavailableIndicatorOut>requis
422Erreur de validationapplication/jsonHTTPValidationError

Requêtebash

# Jeton porteur si l'opération l'exige
curl -X GET "$NEXCLARA_API_URL/api/v1/vision/indicators?from=2026-09&to=2026-09" \
  -H "Authorization: Bearer $NEXCLARA_TOKEN"

Réponse 200json

{
  "computed_at": "2026-10-15T09:30:00Z",
  "indicators": [
    {
      "key": "applications.created",
      "overall": {
        "breakdown": [],
        "items": null,
        "numerator": null,
        "p90": null,
        "population": null,
        "suppressed": false,
        "value": null
      },
      "segments": []
    }
  ],
  "min_segment_size": 1,
  "period": {
    "end": "2026-10-15T09:30:00Z",
    "first_month": "exemple",
    "last_month": "exemple",
    "months": [
      "exemple"
    ],
    "start": "2026-10-15T09:30:00Z"
  },
  "policies": [
    {
      "code": "exemple",
      "id": "00000000-0000-4000-8000-000000000001",
      "product_id": "00000000-0000-4000-8000-000000000002",
      "scale_max": null,
      "scale_min": null,
      "status": "exemple",
      "version": 1
    }
  ],
  "policy_id": null,
  "product_id": null,
  "products": [
    {
      "code": "exemple",
      "id": "00000000-0000-4000-8000-000000000003",
      "name": "Exemple",
      "name_en": null,
      "status": "exemple"
    }
  ],
  "unavailable": [
    {
      "family": "activity",
      "key": "portfolio.default_rate_by_score_band",
      "reason": "no_observed_outcome"
    }
  ]
}

Exemple synthétique généré depuis le contrat et validé contre son schéma. Les clés libres « exemple » sont illustratives.