FOformbricks
Enrichment Status

Get tenant enrichment status

Changed on

Returns a tenant's enrichment progress across the record-level enrichments (translation, sentiment, emotions). For each, enabled reports whether the enrichment is active for the tenant (deployment-configured and switched on / with a resolvable target language), and eligible/done are directory-level counts of feedback records that qualify and that have been enriched — the UI derives "in progress" as eligible - done, of which failed is retryable and failed_terminal never will be. When an enrichment is not enabled its counts are zero and disabled_reason names the gate that closed it, so the UI can explain why rather than silently hiding the enrichment. as_of is when the counts were computed, which lets a polling client derive throughput and an ETA without the Hub computing either. The response contains counts only (no record identifiers or content).

get/v1/enrichment-status

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/v1/enrichment-status
  • Auth
    HTTP bearer

Query parameters

tenant_idstring required
Example:org-123

Tenant whose enrichment status should be returned.

Response

Tenant enrichment status

tenant_idstring required
as_ofstring date-time required

When the counts were computed (UTC), not when the response was serialized. The endpoint is polled, so two responses are enough to derive throughput and an ETA client-side from the change in done over the change in as_of — the Hub computes neither.

Changes

  • 1897101721e4Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • f07a56f18a7bRevision changes
    • info

      endpoint added