Reference · 3 operations

vision

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

Descriptions come from the contract, which is written in French without accents. They are reproduced as is so that the contract remains the source of truth.

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`.

Operation identifier visionCatalog

Authentication and permissions

The contract does not declare authentication per operation. General rule: a bearer token in the Authorization header. Permissions: the contract does not declare them per operation. Read the authentication rule

Request body

No request body.

Responses

200Successful responseapplication/jsonVisionCatalogOut
Fields of the 200 response
- can_exportbooleanrequired
  L'appelant detient `analytics.export`.
- indicatorsarray<IndicatorDefinitionOut>required
- max_monthsintegerrequired
  Etendue maximale d'une periode, en mois.
- min_segment_sizeintegerrequired
  Seuil k : aucun segment de 1 a k-1 dossiers n'est restitue.
- score_bandsintegerrequired
  Bandes de la repartition des scores par grille.
- unavailablearray<UnavailableIndicatorOut>required

Requestbash

# Bearer token if the operation requires one
curl -X GET "$NEXCLARA_API_URL/api/v1/vision/catalog" \
  -H "Authorization: Bearer $NEXCLARA_TOKEN"

Response 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"
    }
  ]
}

Synthetic example generated from the contract and validated against its schema. Free “exemple” keys are illustrative.

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`.

Operation identifier visionExport

Authentication and permissions

Query parameters

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

Request body

No request body.

Responses

200Successful responsetext/csvstring (binary)
422Validation errorapplication/jsonHTTPValidationError

Requestbash

# Bearer token if the operation requires one
curl -X POST "$NEXCLARA_API_URL/api/v1/vision/export?from=2026-09&to=2026-09" \
  -H "Authorization: Bearer $NEXCLARA_TOKEN"

Response 200 · text/csv body: no JSON example.

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`.

Operation identifier visionRead

Authentication and permissions

Query parameters

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

Request body

No request body.

Responses

200Successful responseapplication/jsonVisionReadingOut
Fields of the 200 response
- computed_atstring (date-time)required
- indicatorsarray<IndicatorValueOut>required
- min_segment_sizeintegerrequired
- periodReadingPeriodOutrequired
- policiesarray<PolicyReferenceOut>required
- policy_idstring (uuid) | nullrequired
- product_idstring (uuid) | nullrequired
- productsarray<ProductReferenceOut>required
- unavailablearray<UnavailableIndicatorOut>required
422Validation errorapplication/jsonHTTPValidationError

Requestbash

# Bearer token if the operation requires one
curl -X GET "$NEXCLARA_API_URL/api/v1/vision/indicators?from=2026-09&to=2026-09" \
  -H "Authorization: Bearer $NEXCLARA_TOKEN"

Response 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"
    }
  ]
}

Synthetic example generated from the contract and validated against its schema. Free “exemple” keys are illustrative.