DOCSEARCHbyAlgolia
Submit Docs

Condee Documentation

website·Indexed 30 days ago

https://docs.condee.app

Documentation for Condee, a platform for defining data events and managing artifacts to streamline integration between product teams and analytical systems. Includes guides on creating events and products, publishing artifacts, managing team collaboration, and auditing logs.

Tokens
1.8K
Snippets
5
Records
22
Agent score
50%

What's inside Condee

  1. Understand the purpose of a Product in Condee

    A Product in Condee represents a logical grouping of related events. All defined events and generated artifacts are tagged under a specific product space, allowing for better management of project events.

  2. Use Condee to manage shared data event definitions

    Condee provides a single source of truth for data event definitions, allowing product managers and engineers to collaborate on definitions in one place. This eliminates ownership confusion and reduces the need for manual synchronization meetings between PMs, engineers, data teams, and QA.

  3. Understand and use Condee artifacts

    An artifact in Condee is a collection of generated code created after publishing a set of events. These artifacts consist of plain data object classes automatically generated based on the events defined in the dashboard, allowing developers to integrate these events into their codebase across multiple supported languages.

  4. Understand Condee's role in the data pipeline

    Condee is not a replacement for an analytical system; it serves as middleware between the data source and the existing analytical system. Its primary purpose is to enforce schema consistency and data validation at the source, preventing 'garbage data' from reaching the analytics platform and ensuring high-quality insights.
    Data Source ---> Condee ---> Your Existing Analytical System

  5. Audit workspace actions using Condee logs

    The Condee dashboard provides auditing logs that track every action performed within a workspace. These logs allow developers to identify who created or modified an event specification and the exact time the change occurred, which is primarily used for investigating development issues and tracking configuration changes.

  6. Define data event schemas in Condee

    Condee allows you to define the schema for data events via a user interface in the dashboard. A data event consists of an event name and a set of key-value properties. For each property, you can specify the data type and define validation rules, such as whether the field is mandatory. These definitions act as a skeleton that clients must follow when sending data to analytical systems.
    {
  "event_name" : "user_sign_up",
  "user_id" : "12345abcd-abcd1234",
  "signup_time" : "2025-05-29T15:40:48Z",
  "referrer" : "ad_campaign_1",
  "client" : "web-mobile",
  "consent_given" : true,
  "paid_up_amount" : 123.50
}

  7. Create a new Product in Condee

    To create a product, navigate to the 'product' tab in the side menu. In the list of existing products, click the '+' tile at the end of the list. You must provide a product name, a meaningful description, and specify its environment to complete the creation.

  9. Create and populate analytics events using the generated Builder

    Condee generates event classes using the Builder pattern to ensure data consistency. At runtime, developers should use the generated Builder to set event properties before calling the .build() method to create the final event object.
    UserSignUp event = new UserSignUp.Builder()
  .setUserId("12345abcd-abcd1234")
  .setSignupTime("2025-05-29T15:40:48Z")
  .setReferrer("ad_campaign_1")
  .setClient("web-mobile")
  .setConsentGiven(true)
  .setPaidUpAmount(123.50)
  .build();

  10. Make a subscription payment in Condee

    To purchase or renew a Condee subscription, log in to your account, navigate to the Billing section from the dashboard, select your desired subscription plan, and click 'Proceed to Payment'. After completion, a confirmation email and invoice are sent, and the transaction is recorded in your payment history within the Billing section.

  11. Create a new event in Condee

    To create a new event, navigate to the events page on the dashboard and click the plus (+) icon. This opens the event creation flow where you can name the event and define its analytics specification. Within the creation dialog, you can define multiple properties simultaneously, specify the data type for each property value, and set validation checks to determine if a property is mandatory for the client to send. Finalize the process by clicking 'Submit'.

  12. Integrate Condee artifacts into client applications

    Generated artifacts can be integrated into Android, iOS, Web, or Backend codebases. The generated event classes utilize the Builder pattern to facilitate object creation. At runtime, developers use setter methods to fill the event data. When the build() method is called, Condee performs validation based on the rules defined in the dashboard (e.g., non-null checks or format validation). If validation passes, the method returns a JSON object consistent with the dashboard definition; otherwise, it throws an exception.
    UserSignUp event = new UserSignUp.Builder()
  .setUserId("12345abcd-abcd1234")
  .setSignupTime("2025-05-29T15:40:48Z")
  .setReferrer("ad_campaign_1")
  .setClient("web-mobile")
  .setConsentGiven(true)
  .setPaidUpAmount(123.50)
  .build();