## Retrieve

`client.enrichmentStatus.retrieve(EnrichmentStatusRetrieveParamsquery, RequestOptionsoptions?): EnrichmentStatusRetrieveResponse`

**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).

### Parameters

- `query: EnrichmentStatusRetrieveParams`

  - `tenant_id: string`

    Tenant whose enrichment status should be returned.

### Returns

- `EnrichmentStatusRetrieveResponse`

  A tenant's enrichment progress across the record-level enrichments. Counts are directory-level totals.

  - `emotions: TypeStatus`

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

    - `done: number`

      Eligible records that have been enriched.

    - `eligible: number`

      Feedback records that qualify for this enrichment.

    - `enabled: boolean`

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

  - `sentiment: TypeStatus`

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

    - `done: number`

      Eligible records that have been enriched.

    - `eligible: number`

      Feedback records that qualify for this enrichment.

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

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

    - `done: number`

      Eligible records that have been enriched.

    - `eligible: number`

      Feedback records that qualify for this enrichment.

    - `enabled: boolean`

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

### Example

```typescript
import FormbricksHub from '@formbricks/hub';

const client = new FormbricksHub({
  apiKey: process.env['HUB_API_KEY'], // This is the default and can be omitted
});

const enrichmentStatus = await client.enrichmentStatus.retrieve({ tenant_id: 'org-123' });

console.log(enrichmentStatus.tenant_id);
```