Documentation

Description

Claravine is a marketing data governance platform that provides The Data Standards Cloud - a comprehensive solution for managing marketing taxonomy, campaign metadata, and data quality standards.

Key capabilities:

• Marketing Taxonomy Management: Define and enforce standardized naming conventions
• Campaign Metadata Tracking: Capture and organize campaign details and budget allocations
• Data Quality Standards: Set up validation rules and compliance checks
• Dataset Management: Create custom datasets with dynamic column structures

Prerequisites

Before connecting Claravine to Improvado, you'll need:

1. Access to The Data Standards Cloud platform
2. Administrator permissions to create API credentials
3. Your organization name for account identification

Step 1: Generate API Credentials

1. Log in to The Data Standards Cloud at https://app.claravine.com
2. Click on your profile menu in the top-right corner
3. Select Profile or Account Settings
4. Navigate to the API Access section
5. Click Create API Key
6. Copy both the API Key and API Secret immediately
7. ⚠️ Important: The API Secret is shown only once and cannot be recovered later

For detailed instructions, refer to the official Claravine API documentation.

Step 2: Connect to Improvado

1. In Improvado, navigate to Data Sources
2. Search for Claravine in the data source list
3. Click Connect or Add Data Source
4. In the authentication form, provide:
   • Organization Name: Your Claravine organization name
   • API Key: The API Key you generated
   • API Secret: The API Secret you generated
5. Click Connect to establish the connection

Step 3: Configure Data Extraction

Claravine uses a dataset-based extraction model:

1. Find Dataset UUID: Run the datasets_entity report to retrieve available datasets
2. Extract Dataset Structure: Use dataset_definition_entity to understand column structure
3. Extract Transactions: Use dataset_transactions_entity or transactions_data reports
4. Provide Dataset UUID: Required as a custom parameter for data extraction

Custom Settings

When configuring report extraction:

• dataset_uuid (required): The UUID of the Claravine dataset
  • Format: Standard UUID (e.g., a1b2c3d4-e5f6-7890-abcd-ef1234567890)
  • Find this value by running the datasets_entity report first

Available Report Types

• datasets_entity: Lists all datasets in your account with their UUIDs, names, and metadata
• dataset_definition_entity: Retrieves the schema/structure definition for a specific dataset (requires dataset_uuid)
• dataset_transactions_entity: Extracts metadata about transactions in a dataset (requires dataset_uuid)
• transactions_data: Pulls the actual transaction data from a dataset (requires dataset_uuid)

For complete field definitions and schema details, view the Claravine Data Dictionary.