Get tenant enrichment status

GET/v1/enrichment-status

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. When an enrichment is not enabled its counts are zero. The response contains counts only (no record identifiers or content).

Query ParametersExpand Collapse

tenant_id: string

Tenant whose enrichment status should be returned.

minLength1

maxLength255

ReturnsExpand Collapse

emotions: TypeStatus { done, eligible, enabled }

One enrichment's progress for a tenant. When enabled is false, eligible and done are zero.

done: number

Eligible records that have been enriched.

formatint64

eligible: number

Feedback records that qualify for this enrichment.

formatint64

enabled: boolean

Whether the enrichment is active for the tenant (deployment-configured and switched on / with a resolvable target language).

sentiment: TypeStatus { done, eligible, enabled }

One enrichment's progress for a tenant. When enabled is false, eligible and done are zero.

done: number

Eligible records that have been enriched.

formatint64

eligible: number

Feedback records that qualify for this enrichment.

formatint64

enabled: boolean

Whether the enrichment is active for the tenant (deployment-configured and switched on / with a resolvable target language).

tenant_id: string

translation: TypeStatus { done, eligible, enabled }

One enrichment's progress for a tenant. When enabled is false, eligible and done are zero.

done: number

Eligible records that have been enriched.

formatint64

eligible: number

Feedback records that qualify for this enrichment.

formatint64

enabled: boolean

Whether the enrichment is active for the tenant (deployment-configured and switched on / with a resolvable target language).

Get tenant enrichment status

curl http://localhost:8080/v1/enrichment-status \
    -H "Authorization: Bearer $HUB_API_KEY"

{
  "emotions": {
    "done": 0,
    "eligible": 0,
    "enabled": true
  },
  "sentiment": {
    "done": 0,
    "eligible": 0,
    "enabled": true
  },
  "tenant_id": "tenant_id",
  "translation": {
    "done": 0,
    "eligible": 0,
    "enabled": true
  }
}

Returns Examples

{
  "emotions": {
    "done": 0,
    "eligible": 0,
    "enabled": true
  },
  "sentiment": {
    "done": 0,
    "eligible": 0,
    "enabled": true
  },
  "tenant_id": "tenant_id",
  "translation": {
    "done": 0,
    "eligible": 0,
    "enabled": true
  }
}