Auric User Guide
v3.0.0Getting Started
Welcome to Auric! This guide will walk you through all the features and functionality of your event tracking platform.
What is Auric?
Auric is a multi-tenant event tracking platform that helps you track customer interactions, manage contacts, and analyze user journeys across your applications.
Your Auric URL
Your Auric instance is accessible at: https://YOUR-APP-ID.auriccloud.com
Each tenant gets their own subdomain for complete data isolation and security.
First Login
- Navigate to your Auric URL
- Enter your email and password
- You'll be taken to the Dashboard overview
Dashboard Overview
The Dashboard provides a high-level overview of your tracking data and key metrics.
Key Metrics
- Total Contacts: Number of unique contacts in your system
- Total Events: All events tracked across all contacts
- Avg Events/Contact: Average number of events per contact
- New-to-File (30d): New contacts acquired in the last 30 days
- Reactivations (30d): Contacts that returned after your reactivation window
Top Event Types
See which events are most commonly triggered in your application.
Recent Events
View the latest 10 events with contact details, event types, and timing.
Duration Calculator
Quickly calculate average time between any two event types to understand your customer journey.
Managing Contacts
Contacts are the people interacting with your application. Each contact has a unique email address and can have multiple events associated with them.
Adding Contacts
Contacts can be added in several ways:
- Automatically: When events are tracked with new email addresses
- Manually: Using the form on the Contacts page
- CSV Import: Bulk import via the Import page
- API: Via the /api/contacts endpoint
Contact Information
- Email: Unique identifier (required)
- Name: Display name (optional)
- Lead Source: How they were acquired (optional)
- Custom Fields: Additional data based on your configuration
First Touch Events
Viewing Contact Details
Click on any contact's email to view:
- Complete contact information
- Full event history in chronological order
- Duration between events
- Edit contact information
- Add new events manually
Editing and Deleting Contacts
- Edit: Click "Edit" to modify contact details
- Delete: Click "Delete" with confirmation dialog (removes all associated events)
Event Tracking
Events represent actions or interactions in your application. Each event is linked to a contact and has a specific event type.
Event Properties
- Event Type: Categorizes the event (e.g., "Purchase", "Signup")
- Contact: Who performed the action
- Timestamp: When the event occurred
- Lead Source: Attribution source
- UTM Parameters: Marketing campaign tracking
- Custom Data: Additional event-specific information
Special Event Flags
- New-to-File: First event for this contact
- Reactivation: Contact returned after the reactivation window
Manual Event Creation
Create events manually from the Events page:
- Enter the contact's email address
- Select an event type
- Set the date/time (defaults to now)
- Add lead source and UTM data as needed
- Include any custom field data
- Click "Record" to save
Filtering Events
Use the filter options to find specific events:
- By Email: Show events for specific contacts
- By Type: Filter by event type
- By Lead Source: Filter by attribution source
Event Types
Event Types categorize the different actions users can take in your application.
Creating Event Types
- Go to the Event Types page
- Enter a descriptive name (e.g., "Webinar Signup")
- Click "Add" - a URL-friendly slug is automatically generated
System Event Types
Event Type Limits
Each tenant can have up to 100 custom event types plus system event types.
Naming Best Practices
- Use clear, descriptive names
- Be consistent with naming conventions
- Consider your customer journey stages
- Examples: "Email Signup", "Demo Request", "Purchase", "Cancellation"
Reports & Analytics
Auric provides several reporting tools to analyze your customer journeys and event data.
Duration Reports
Calculate the average time between any two event types:
- Go to Duration Report
- Select your "From" event type (e.g., "First Touch")
- Select your "To" event type (e.g., "Purchase")
- Optionally filter by lead source
- Click "Calculate" to see results
Results show:
- Average days between events
- Number of completed journeys
- Individual contact journey details
- Min/max duration times
Dashboard Metrics
The dashboard provides real-time metrics updated as new data comes in:
- Contact and event totals
- New-to-file trends
- Reactivation patterns
- Top performing event types
Data Import
Import existing data using CSV files for both contacts and events.
CSV Format Requirements
Events CSV
Required columns:
email
- Contact email addressevent_type
- Event type name or slug
Optional columns:
name
- Contact nameoccurred_at
- Event timestamp (ISO format)lead_source
- Attribution sourceutm_source, utm_medium, utm_campaign, utm_term, utm_content
- UTM parameters- Custom field keys as defined in your settings
x_*
- Any column starting with "x_" becomes custom data
Contacts CSV
Required columns:
email
- Unique email address
Optional columns:
name
- Contact namelead_source
- Attribution source- Custom contact field keys
Import Process
- Go to the Import page
- Select import type (Events or Contacts)
- Choose your CSV file
- Click "Upload & Import"
- Review the import results and any errors
Download Templates
Use the "Events Template" and "Contacts Template" buttons to download CSV templates with the correct column headers.
Custom Fields
Extend contacts and events with additional data fields specific to your business needs.
Creating Custom Fields
- Go to Settings
- In the "Add Custom Field" section:
- Select scope (Event or Contact)
- Enter a display name
- Enter a key (used in APIs and imports)
- Mark as required if needed
- Click "Add"
Using Custom Fields
Custom fields appear in:
- Manual data entry forms
- CSV import templates
- API payloads
- Contact and event detail views
Custom Field Types
- Contact Fields: Store information about the person (company, role, etc.)
- Event Fields: Store action-specific data (purchase amount, plan type, etc.)
Settings
Configure your Auric instance behavior and features.
Reactivation Window
Set how many days of inactivity before a returning contact is marked as a "reactivation" (1-3650 days).
API Keys
Generate API keys for server-to-server integrations:
- Enter a descriptive name for the key
- Click "Create API Key"
- Copy the key immediately (shown only once)
- Use in your API requests as Bearer authentication
Custom Fields Management
View and manage all your custom fields for both contacts and events.
Tracking Setup
Configure automated event tracking for your website or application.
Allowed Origins
For security, only requests from approved domains are accepted:
- Add your domain(s) to the allowed origins list
- Support for wildcards (*.example.com)
- Maximum of 5 allowed origins per tenant
JavaScript Tracker
The Ingest page provides code snippets for:
- Hosted JavaScript tracker
- Configuration options
- Manual tracking examples
- cURL examples for testing
Event Configuration
Set your default event type that will be used for automated tracking (like form submissions).