# Telemetry Data Collection

## Overview
In order to further improve our product and for billing purposes, we have introduced telemetry data collection (in line with our contractual agreements)— a new feature that supports telemetry data exported from client insights. This enhancement allows for more detailed analytics and a better understanding of how our clients interact with our applications, enabling us to improve performance, user experience, feature development, and accurately manage billing processes.

**Important**: All data collected is aggregated, and no customer-specific data or Personally Identifiable Information (PII) is being collected. This ensures that individual user privacy is fully protected while allowing us to gain valuable insights.

## Data Collection
The telemetry data is collected from client applications and includes insights such as user counts, application versions, and environment details. This data is instrumental in:

- Monitoring application usage
- Identifying trends and patterns
- Enhancing product features based on user interaction
- Ensuring compatibility across different environments

## Insights Collected
The following is a list of insights currently being collected:

- **Count of Users per Company**: Aggregated number of active users within each company.
- **Count of File Folders Created per Company**: Total number of file folders (projects, domains, etc.) created by each company.
- **Count of Groups Created per Company**: Number of user groups established within each company.
- **Count of Chats Created per Company**: Total chats initiated by users in each company.
- **Count of Spaces Created per Company**: Number of collaborative spaces or environments set up per company.
- **Count of User Messages Created per Company**: Total messages sent by users in each company.
- **Count of Assistant Messages Created per Company**: Number of automated messages or replies generated by the assistant per company.
- **Daily/Weekly/Monthly Active Users (DAU/WAU/MAU)**: Metrics indicating user engagement over daily, weekly, and monthly periods.
- **Count of Positive and Negative Feedback**: Aggregated feedback metrics to gauge user satisfaction and areas for improvement.
- **Count of Prompts per assistant per company**: Number of User prompts per assistant per module

These insights help us understand usage patterns and engagement levels across different features of our applications, enabling targeted improvements and accurate billing.

## Data Structure
The collected telemetry data follows a structured JSON format. Below is an example of the data being collected:

```json
[
  {
    "companyName": "Olé Olé 1",
    "companyReferenceId": "237521044380848186",
    "insightType": "countOfUsers",
    "insightValue": 36,
    "insightUnit": null,
    "timestamp": "2024-10-01T10:21:37.131Z",
    "environmentDetails": {
      "appVersion": "2024.40-a259a"
    },
    "cluster": "oleole.unique.app"
  }
]
```

### Field Definitions
- **companyName**: The name of the client company.
- **companyReferenceId**: A unique identifier for the company.
- **insightType**: The type of insight collected (e.g., "countOfUsers").
- **insightValue**: The value associated with the insight type.
- **insightUnit**: The unit of the insight value (if applicable).
- **timestamp**: The date and time when the data was collected.
- **environmentDetails**: An object containing details about the environment.
  - **appVersion**: The version of the application.
- **cluster**: The cluster or environment identifier.

## Use Cases
- **User Engagement Analysis**: Determine how many users are actively using the application.
- **Version Adoption Tracking**: Monitor the adoption rate of new application versions.
- **Performance Monitoring**: Identify performance issues in specific clusters or environments.
- **Feature Utilization**: Understand which features are most used by clients.

## Security and Privacy
We are committed to maintaining the highest standards of data security and user privacy.
- **Data Encryption**: All telemetry data is encrypted in transit and at rest.
- **Access Control**: Only authorized personnel have access to the telemetry data.
- **Compliance**: Our data collection practices comply with GDPR and other relevant regulations.
- **Anonymization**: Personal identifiable information (PII) is anonymized to protect user identity.

## Conclusion
The introduction of telemetry data support from client insights marks a significant step forward in our ability to serve our clients better. By leveraging this data, we can make informed decisions that enhance our products and services.

## Frequently Asked Questions (FAQ)
### 1. **Can clients opt out of telemetry data collection?**
Yes, clients can opt out by adjusting their settings in the application preferences.

### 2. **How often is the telemetry data updated?**
The data is collected and updated every day.

### 3. **Is the telemetry data shared with third parties?**
No, the telemetry data is used internally and is not shared with any third parties.