> For the complete documentation index, see [llms.txt](https://docs.sudoplatform.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sudoplatform.com/~/revisions/U8P5YQbTWlABRqHUlUfP/guides/privacy-interaction/analysis-results.md).

# Analysis Results

An analysis result contains a structured privacy analysis for a specific data holder. Analysis results are generated automatically as data holders are discovered.

Each analysis result summarizes how an organization collects, retains, and shares user data based on their publicly available privacy policy and other documents.

### Retrieving an Analysis Result <a href="#retrieving-an-analysis-result" id="retrieving-an-analysis-result"></a>

To retrieve a full analysis result by its unique identifier, use the `getAnalysisResult` method. This returns the analysis result if it exists, or `undefined` if not found.

{% tabs %}
{% tab title="Typescript" %}

```typescript
try {
  const analysisResult = await privacyInteractionClient.getAnalysisResult(
    analysisResultId,
  )
  if (analysisResult) {
    console.log(analysisResult.status)
    if (analysisResult.data) {
      console.log('Privacy score:', analysisResult.data.privacyScore?.score)
      console.log('Summary:', analysisResult.data.privacySummary.bulletPoints)
    }
  }
} catch (error) {
  // Handle/notify user of errors
}
```

{% endtab %}
{% endtabs %}

The `data` field is populated when the analysis result status is `COMPLETE` or `PARTIAL`. For other statuses, `data` will be undefined.

### Analysis Result Status <a href="#analysis-result-status" id="analysis-result-status"></a>

An analysis result transitions through the following statuses:

| Status        | Description                                               |
| ------------- | --------------------------------------------------------- |
| `PENDING`     | The analysis is queued but has not yet started.           |
| `COMPLETE`    | The analysis has completed successfully with full data.   |
| `PARTIAL`     | The analysis has completed with partial data available.   |
| `FAILED`      | The analysis encountered an error and could not complete. |
| `UNAVAILABLE` | The analysis data is not available for this data holder.  |

### Analysis Result Data <a href="#analysis-result-data" id="analysis-result-data"></a>

When an analysis result reaches `COMPLETE` or `PARTIAL` status, the `data` field contains the structured analysis payload:

#### Privacy Score <a href="#privacy-score" id="privacy-score"></a>

The privacy score provides an overall numeric assessment (0–100) of the organization's privacy practices. A higher score indicates better privacy practices.

{% tabs %}
{% tab title="Typescript" %}

```typescript
if (analysisResult.data?.privacyScore) {
  const { score, breakdown } = analysisResult.data.privacyScore
  console.log(`Overall score: ${score}/100`)
  for (const contribution of breakdown) {
    console.log(`  ${contribution.aspect}: ${contribution.contribution}`)
  }
}
```

{% endtab %}
{% endtabs %}

#### Privacy Summary <a href="#privacy-summary" id="privacy-summary"></a>

A concise human-readable summary of privacy findings, including up to 5 key takeaways. An example of this might be:

* Collects 13 categories of personal data including location data, biometric data, background check data and 10 other categories.
* Collects sensitive data (location data) for non-essential purposes.
* Shares location data, other data, personal identifiers and 7 more with third parties.
* Sells personal information (opt-out available).
* Uses location data, other data, personal identifiers and 4 more for advertising.

{% tabs %}
{% tab title="Typescript" %}

```typescript
const summary = analysisResult.data?.privacySummary
if (summary) {
  console.log('Source:', summary.sourceUrl)
  for (const point of summary.bulletPoints) {
    console.log(`• ${point}`)
  }
}
```

{% endtab %}
{% endtabs %}

#### Category Signals <a href="#category-signals" id="category-signals"></a>

Per-category breakdown of how specific types of personal data are handled. Each category includes signals for collection, sharing, advertising use, retention, and opt-out capability.

{% tabs %}
{% tab title="Typescript" %}

```typescript
const categories = analysisResult.data?.categories ?? []
for (const cat of categories) {
  console.log(`${cat.category}:`)
  console.log(`  Collected: ${cat.collected}`)
  console.log(`  Shared: ${cat.sharedWithThirdParties}`)
  console.log(`  Used for ads: ${cat.usedForAdvertising}`)
  console.log(`  Opt-out available: ${cat.userCanOptOut}`)
  if (cat.retention) {
    console.log(`  Retention: ${cat.retention.style}, ${cat.retention.timeInDays} days`)
  }
}
```

{% endtab %}
{% endtabs %}

**Data Categories:**

| Category            | Description                                               |
| ------------------- | --------------------------------------------------------- |
| `ACCOUNT_PROFILE`   | Account and profile information.                          |
| `AUTHENTICATION`    | Authentication credentials and tokens.                    |
| `BACKGROUND`        | Background/employment history.                            |
| `BIOMETRIC`         | Biometric data (fingerprints, face, voice).               |
| `COMMUNICATION`     | Communication content (messages, emails).                 |
| `CONTACTS`          | Contact lists and address books.                          |
| `DEMOGRAPHIC`       | Demographic information (age, gender).                    |
| `DEVICE_IDENTIFIER` | Device identifiers and hardware info.                     |
| `FINANCIAL`         | Financial data (payment methods, transactions).           |
| `GOVERNMENT_ISSUED` | Government-issued IDs (SSN, passport).                    |
| `HEALTH`            | Health and medical data.                                  |
| `INFERENCES`        | Inferred data derived from other categories.              |
| `LOCATION`          | Location and geolocation data.                            |
| `OTHER`             | Data not fitting other categories.                        |
| `PII`               | Personally identifiable information (name, email, phone). |
| `THIRD_PARTY_DATA`  | Data received from third parties.                         |
| `USAGE`             | Usage and behavioral data.                                |

**Signal Values:**

Each signal uses a tri-state value:

| Value     | Description                            |
| --------- | -------------------------------------- |
| `YES`     | The determination is affirmative.      |
| `NO`      | The determination is negative.         |
| `UNKNOWN` | Insufficient information to determine. |

#### Capability Signals <a href="#capability-signals" id="capability-signals"></a>

Action-derived signals indicating what privacy capabilities the organization supports.

{% tabs %}
{% tab title="Typescript" %}

```typescript
const caps = analysisResult.data?.capabilities
if (caps) {
  console.log('Account deletion:', caps.supportsAccountDeletion)
  console.log('Data deletion requests:', caps.supportsDataDeletionRequests)
  console.log('Data export:', caps.supportsDataExport)
  console.log('Sells personal info:', caps.sellsPersonalInformation)
  console.log('Uses cookies/tracking:', caps.usesCookiesOrTracking)
}
```

{% endtab %}
{% endtabs %}

| Signal                         | Description                                                     |
| ------------------------------ | --------------------------------------------------------------- |
| `supportsAccountDeletion`      | Whether the organization supports account deletion.             |
| `supportsDataDeletionRequests` | Whether the organization accepts data deletion requests.        |
| `supportsDataExport`           | Whether the organization allows users to export their data.     |
| `sellsPersonalInformation`     | Whether the organization sells personal information.            |
| `usesCookiesOrTracking`        | Whether the organization uses cookies or tracking technologies. |

#### Risk Indicators <a href="#risk-indicators" id="risk-indicators"></a>

Aggregated risk indicators derived from category signals and capabilities.

{% tabs %}
{% tab title="Typescript" %}

```typescript
const risk = analysisResult.data?.riskIndicators
if (risk) {
  console.log('Data categories collected:', risk.dataCollectionBreadth)
  console.log('Indefinite retention:', risk.hasIndefiniteRetention)
  console.log('Max retention (days):', risk.maxRetentionDays)
  console.log('Sells data:', risk.sellsPersonalInformation)
  console.log('Breach risk:', risk.breachRisk)
}
```

{% endtab %}
{% endtabs %}

| Indicator                                      | Type                | Description                                                            |
| ---------------------------------------------- | ------------------- | ---------------------------------------------------------------------- |
| `dataCollectionBreadth`                        | number              | Total number of data categories collected.                             |
| `collectsSensitiveDataForNonEssentialPurposes` | SignalValue         | Whether sensitive categories are collected for non-essential purposes. |
| `sellsPersonalInformation`                     | SignalValue         | Whether data selling is indicated.                                     |
| `maxRetentionDays`                             | number \| undefined | Longest known retention period in days.                                |
| `hasIndefiniteRetention`                       | SignalValue         | Whether any category has indefinite retention.                         |
| `encryptionPractices`                          | SignalValue         | Whether strong encryption practices are in place.                      |
| `breachRisk`                                   | SignalValue         | Whether there is an elevated risk of data breach.                      |

#### Retention Styles <a href="#retention-styles" id="retention-styles"></a>

When retention information is available for a category, the `style` field indicates how the retention period is expressed:

| Style                              | Description                                             |
| ---------------------------------- | ------------------------------------------------------- |
| `INDEFINITE`                       | Data is retained indefinitely with no defined end date. |
| `RELATIVE_TO_ACCOUNT_CLOSURE_TIME` | Retention period starts when the account is closed.     |
| `RELATIVE_TO_DATA_STORAGE_TIME`    | Retention period starts when the data is stored.        |
| `OTHER`                            | Retention policy does not fit standard categories.      |

### Analysis Result Object <a href="#analysis-result-object" id="analysis-result-object"></a>

| Property               | Type                            | Description                                                                  |
| ---------------------- | ------------------------------- | ---------------------------------------------------------------------------- |
| `id`                   | string                          | Unique identifier for the analysis result.                                   |
| `owner`                | string                          | Unique identifier of the user.                                               |
| `virtualPresenceId`    | string                          | The virtual presence this analysis is associated with.                       |
| `dataHolderIdentifier` | string                          | The data holder domain this analysis is about.                               |
| `status`               | AnalysisResultStatus            | Current status of the analysis.                                              |
| `lastAnalyzedAt`       | Date                            | When the analysis was last performed.                                        |
| `data`                 | AnalysisResultData \| undefined | Structured analysis data (populated when status is `COMPLETE` or `PARTIAL`). |
| `version`              | number                          | Entity version, increments on update.                                        |
| `createdAt`            | Date                            | When the analysis result was created.                                        |
| `updatedAt`            | Date                            | When the analysis result was last updated.                                   |

### Subscribing to Analysis Result Updates <a href="#subscribing-to-analysis-result-updates" id="subscribing-to-analysis-result-updates"></a>

To receive real-time notifications when analysis results are created, change status or are updated, see [Subscriptions](file:///Users/jkowald/source/repos/sudo-privacy-interaction-js/docs/guides/privacy-interaction/subscriptions.md).