Documentation | Claritn

Getting Started with Claritn

Quick Start Guide

Welcome to Claritn! This guide will help you set up your account and create your first dashboard in under 10 minutes.

Prerequisites

Before you begin, make sure you have:

A Claritn account (sign up for free)
Access to your data sources (CSV, SQL databases, APIs, etc.)
Basic understanding of your business metrics

Step 1: Connect Your Data Source

Claritn supports multiple data sources. Here's how to connect a CSV file:

// Example: Upload CSV via API

curl -X POST https://api.claritn.com/v1/data-sources \

  -H "Authorization: Bearer YOUR_API_KEY" \

  -F "file=@/path/to/your/data.csv" \

  -F "name=Sales Data" \

  -F "type=csv"

Step 2: Define Metrics and Dimensions

Metrics are numerical values you want to analyze (e.g., revenue, users). Dimensions are categories you want to group by (e.g., date, region, product).

// Example metric definition

{

  "name": "total_revenue",

  "type": "sum",

  "field": "amount",

  "format": "currency"

}

Step 3: Create Your First Visualization

Use our drag-and-drop interface or API to create visualizations:

// Create a line chart via API

curl -X POST https://api.claritn.com/v1/visualizations \

  -H "Authorization: Bearer YOUR_API_KEY" \

  -H "Content-Type: application/json" \

  -d '{

    "type": "line_chart",

    "title": "Monthly Revenue",

    "data_source": "sales_data",

    "metrics": ["total_revenue"],

    "dimensions": ["month"]

  }'

Authentication

Claritn uses API keys for authentication. You can generate and manage your API keys from the dashboard.

Security Best Practices

• Store API keys securely and never commit them to version control
• Use environment variables for API keys in production
• Rotate API keys regularly
• Use different keys for different environments

API Reference

Complete API documentation for developers

Authentication API

Generate and manage API keys, authenticate requests.

POST /v1/auth/api-keys

Data Sources API

Connect, manage, and query data sources.

GET /v1/data-sources

Visualizations API

Create, update, and retrieve visualizations.

POST /v1/visualizations

Claritn Documentation