@import url('https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&family=Montserrat:wght@600&family=Poppins:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&display=swap');
@import url('https://fonts.googleapis.com/css2?family=Fira+Code:wght@300..700&family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&family=Montserrat:wght@600&family=Poppins:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&display=swap');
.font-inter  h4{
  font-family: 'Inter';
}

.font-fira-code {
  font-family: 'Fira Code';
}

.card-icon a .fill-gray-800, .card-icon-dark a .fill-gray-800{
  height: 48px;
  width: 48px;
}
.card-icon a div h2, .card-icon-dark a div h2{
  color: #002654;
  font-size: 1.25rem;
  font-weight: 500;
  line-height: 130%;
  letter-spacing: 0%;
  font-family: 'Inter';
}
.card-icon a div .top-5, .card-icon-dark a div .top-5{
  display: none;
}
.card-icon-dark .card{
  background-color: #0C2E5C;
}

.card-icon a, .card-icon-dark a{
  height: 100%;
  width: 100%;
  margin-top: 0px;
  margin-bottom: 0px;
}

.gap-cards{
  gap: 1rem;
}


.mint-relative {
    position: relative
}
.mint-order-1 {
    order: 1
}
.mint-order-2 {
    order: 2
}
.mint-order-3 {
    order: 3
}
.mint-mb-2 {
    margin-bottom: 0.5rem
}
.mint-mb-4 {
    margin-bottom: 1rem
}
.mint-mb-\[7\.5rem\] {
    margin-bottom: 7.5rem
}
.mint-ml-auto {
    margin-left: auto
}
.mint-block {
    display: block
}
.mint-flex {
    display: flex
}
.mint-grid {
    display: grid
}
.mint-hidden {
    display: none
}
.mint-h-4 {
    height: 1rem
}
.mint-h-full {
    height: 100%
}
.mint-w-4 {
    width: 1rem
}
.mint-w-full {
    width: 100%
}
.mint-flex-1 {
    flex: 1 1 0%
}
.mint-flex-col {
    flex-direction: column
}
.mint-flex-wrap {
    flex-wrap: wrap
}
.mint-items-center {
    align-items: center
}
.mint-justify-center {
    justify-content: center
}
.mint-justify-between {
    justify-content: space-between
}
.mint-gap-2 {
    gap: 0.5rem
}
.mint-gap-3 {
    gap: 0.75rem
}
.mint-gap-4 {
    gap: 1rem
}
.mint-gap-6 {
    gap: 1.5rem
}
.mint-gap-8 {
    gap: 2rem
}
.mint-space-y-2 > :not([hidden]) ~ :not([hidden]) {
    --tw-space-y-reverse: 0;
    margin-top: calc(0.5rem * calc(1 - var(--tw-space-y-reverse)));
    margin-bottom: calc(0.5rem * var(--tw-space-y-reverse))
}
.mint-rounded-full {
    border-radius: 9999px
}
.mint-rounded-xl {
    border-radius: 0.75rem
}
.mint-border {
    border-width: 1px
}
.mint-border-\[\#CCD4DD\] {
    --tw-border-opacity: 1;
    border-color: rgb(204 212 221 / var(--tw-border-opacity))
}
.mint-border-\[\#F2FBFF1A\]\/10 {
    border-color: rgb(242 251 255 / 0.1)
}
.mint-bg-\[\#082d59\] {
    --tw-bg-opacity: 1;
    background-color: rgb(8 45 89 / var(--tw-bg-opacity))
}
.mint-bg-white {
    --tw-bg-opacity: 1;
    background-color: rgb(255 255 255 / var(--tw-bg-opacity))
}
.mint-px-6 {
    padding-left: 1.5rem;
    padding-right: 1.5rem
}
.mint-py-4 {
    padding-top: 1rem;
    padding-bottom: 1rem
}
.mint-text-2xl\/\[1\.12\] {
    font-size: 1.5rem;
    line-height: 1.12
}
.mint-text-\[0\.8125rem\]\/\[1\.1\] {
    font-size: 0.8125rem;
    line-height: 1.1
}
.mint-text-base\/\[1\.3\] {
    font-size: 1rem;
    line-height: 1.3
}
.mint-text-lg {
    font-size: 1.125rem;
    line-height: 1.75rem
}
.mint-text-xl\/\[1\.3\] {
    font-size: 1.25rem;
    line-height: 1.3
}
.mint-text-xs\/\[1\.3\] {
    font-size: 0.75rem;
    line-height: 1.3
}
.mint-font-medium {
    font-weight: 500
}
.mint-font-normal {
    font-weight: 400
}
.mint-font-semibold {
    font-weight: 600
}
.mint-text-\[\#002654\] {
    --tw-text-opacity: 1;
    color: rgb(0 38 84 / var(--tw-text-opacity))
}
.mint-text-\[\#B2BECC\] {
    --tw-text-opacity: 1;
    color: rgb(178 190 204 / var(--tw-text-opacity))
}
.mint-text-\[\#C4CFD6FD\] {
    color: #C4CFD6FD
}
.mint-text-\[\#D9EEFF\] {
    --tw-text-opacity: 1;
    color: rgb(217 238 255 / var(--tw-text-opacity))
}
.mint-text-gray-500 {
    --tw-text-opacity: 1;
    color: rgb(107 114 128 / var(--tw-text-opacity))
}
.mint-text-sky-50\/40 {
    color: rgb(240 249 255 / 0.4)
}
.mint-text-white {
    --tw-text-opacity: 1;
    color: rgb(255 255 255 / var(--tw-text-opacity))
}
.mint-shadow-sm {
    --tw-shadow: 0 1px 2px 0 rgb(0 0 0 / 0.05);
    --tw-shadow-colored: 0 1px 2px 0 var(--tw-shadow-color);
    box-shadow: var(--tw-ring-offset-shadow, 0 0 #0000), var(--tw-ring-shadow, 0 0 #0000), var(--tw-shadow)
}
.hover\:mint-text-gray-300:hover {
    --tw-text-opacity: 1;
    color: rgb(209 213 219 / var(--tw-text-opacity))
}
.dark\:mint-block:is(.dark *) {
    display: block
}
.dark\:mint-hidden:is(.dark *) {
    display: none
}
.dark\:mint-border-\[\#4f7190\]:is(.dark *) {
    --tw-border-opacity: 1;
    border-color: rgb(79 113 144 / var(--tw-border-opacity))
}
.dark\:mint-bg-transparent:is(.dark *) {
    background-color: transparent
}
.dark\:mint-text-\[\#9aabbd\]:is(.dark *) {
    --tw-text-opacity: 1;
    color: rgb(154 171 189 / var(--tw-text-opacity))
}
.dark\:mint-text-white:is(.dark *) {
    --tw-text-opacity: 1;
    color: rgb(255 255 255 / var(--tw-text-opacity))
}
@media (min-width: 640px) {
    .sm\:mint-grid-cols-3 {
        grid-template-columns: repeat(3, minmax(0, 1fr))
    }
}
@media (min-width: 768px) {
    .md\:mint-w-\[37\.5rem\] {
        width: 37.5rem
    }
    .md\:mint-max-w-\[16rem\] {
        max-width: 16rem
    }
    .md\:mint-text-nowrap {
        text-wrap: nowrap
    }
}
@media (min-width: 1024px) {
    .lg\:mint-order-none {
        order: 0
    }
    .lg\:mint-mb-0 {
        margin-bottom: 0px
    }
    .lg\:mint-flex {
        display: flex
    }
    .lg\:mint-flex-row {
        flex-direction: row
    }
    .lg\:mint-items-center {
        align-items: center
    }
    .lg\:mint-gap-16 {
        gap: 4rem
    }
    .lg\:mint-gap-6 {
        gap: 1.5rem
    }
}

StarTree Docs

What is Real-Time Analytics?

Overview

Ingest Data

Connect to Any Data Source

Learn how to configure advanced settings for table creation in the Data Portal, including ingestion behavior and time partitioning for Apache Pinot tables.

Additional Configuration

Create Table

Lookup UDF Join

Learn about off-heap upserts and how to use them in StarTree

Off-Heap Upserts

Learn about off-heap dedup and how to use them in StarTree

Off-Heap Dedup

Off-Heap Deduplication

Hybrid Tables

Tableau

Connect Tableau to StarTree Cloud

Learn how to connect Superset to StarTree Cloud.

Superset

Connect Superset to StarTree Cloud

Security Manager

Managing Access

API Token Management

Custom Policy Configuration

Actions

Using RBAC API

Using the StarTree Role-Based Access Control (RBAC) API

0.10.1 Release Version 0.10.1: February 2025

Definitions for real-time user-facing analytics, StarTree products, and platforms

Glossary

Cluster Health

StarTree Cloud Cluster Health Dashboard

Getting Started with ThirdEye

ThirdEye Architecture

ThirdEye Entities

ThirdEye Worker Management

DataFetcher

Dimension Exploration

EventFetcher

SqlExecution

TimeIndexFiller

Optimize Performance

Use Pre-Computed Time Columns

Add a Notification System

Subscription Groups and Notification Systems

Alert Tuning

Use Anomaly Filters to Tune Alerts

Root Cause Analysis

How to perform root cause analysis

Manage Holiday Effects

Manage Holiday Effects with StarTree ETS

Using ThirdEye API

How to use the ThirdEye API

Access Control in ThirdEye

Frequently Asked Questions

Observability & Monitoring

ThirdEye Observability and Monitoring

Alert Configuration

Alert Configuration and Execution

Scaling Workers

Dimensions Recommender

ThirdEye Dimensions Recommender

Aggregation Functions

Resources

Download Recipes

Clickstream Analytics Dashboard

Clickstream Analytics Dashboard with StarTree Cloud Free Tier and Streamlit

Learn about StarTree Cloud APIs for managing tables and querying data at scale.

Introduction

Run SQL queries on StarTree Cloud's real-time analytics engine.

Query Data

Simulates a preview of the table given the table config and schema

preview

Lists all tables in cluster

Creates a segment using given file and pushes it to Pinot. 
 All steps happen on the controller. This API is NOT meant for production environments/large input files. 
 Example usage (query params need encoding):
```
curl -X POST -F file=@data.json -H "Content-Type: multipart/form-data" "http://localhost:9000/ingestFromFile?tableNameWithType=foo_OFFLINE&
batchConfigMapStr={
  "inputFormat":"csv",
  "recordReader.prop.delimiter":"|"
}" 
```

Ingest a file

Creates a segment using file at the given URI and pushes it to Pinot. 
 All steps happen on the controller. This API is NOT meant for production environments/large input files. 
Example usage (query params need encoding):
```
curl -X POST "http://localhost:9000/ingestFromURI?tableNameWithType=foo_OFFLINE
&batchConfigMapStr={
  "inputFormat":"json",
  "input.fs.className":"org.apache.pinot.plugin.filesystem.S3PinotFS",
  "input.fs.prop.region":"us-central",
  "input.fs.prop.accessKey":"foo",
  "input.fs.prop.secretKey":"bar"
}
&sourceURIStr=s3://test.bucket/path/to/json/data/data.json"
```

Ingest from the given URI

Get the instance partitions

Create/update the instance partitions

Remove the instance partitions

Replace an instance in the instance partitions

Assign server instances to a table

Pause the consumption of a realtime table

Pause consumption of a realtime table

Resume the consumption for a realtime table. ConsumeFrom parameter indicates from which offsets consumption should resume. Recommended value is 'lastConsumed', which indicates consumption should continue based on the offsets in segment ZK metadata, and in case the offsets are already gone, the first available offsets are picked to minimize the data loss.

Resume consumption of a realtime table

Get status for a submitted force commit operation

Gets the segments that are in error state and segments with COMMITTING status in ZK metadata

Returns state of pauseless table

Return pause status of a realtime table along with list of consuming segments.

Return pause status of a realtime table

Force commit the current segments in consuming state and restart consumption. This should be used after schema/table config changes. Please note that this is an asynchronous operation, and 200 response does not mean it has actually been done already.If specific partitions or consuming segments are provided, only those partitions or consuming segments will be force committed.

Force commit the current consuming segments

Gets the status of consumers from all servers.Note that the partitionToOffsetMap has been deprecated and will be removed in the next release. The info is now embedded within each partition's state as currentOffsetsMap.

Returns state of consuming segments

List table instances

List tables to live brokers mappings based on EV

List tables to live brokers mappings

List live brokers of the given table based on EV

List the brokers serving a table

Recommend config

Lists the table configs

Updates table config for a table

Deletes a table

This API returns the table config that matches the one you get from 'GET /tables/{tableName}'. This allows us to validate table config before apply.

Validate table config for a table

Rebalances a table (reassign instances and segments for a table)

Cancel all rebalance jobs for the given table, and noop if no rebalance is running

Gets detailed stats of a rebalance operation

Provides status of the table including ingestion status

table status

Get current table state

Enable/disable a table

Provides metadata info/stats about the table.

table stats

Adds a table

Get the aggregate validDocIds metadata of all segments for a table

Get the aggregate metadata of all segments for a table

Get the aggregate index details of all segments for a table

Get list of controller jobs for this table

Set hybrid table query time boundary based on offline segments' metadata

Delete hybrid table query time boundary

Rebuild broker resource for table

Validate the TableConfigs

Lists all TableConfigs in cluster

Add the TableConfigs using the tableConfigsStr json

Get the TableConfigs for a given raw tableName

Update the TableConfigs provided by the tableConfigsStr json

Delete the TableConfigs

Get table size details. Table size is the size of untarred segments including replication

Read table sizes

Get segment names to segment status map

Get table ideal state

Get table external view

Get the list of servers to restart in sequence

Get cached cluster health details for all pinot entities

Enable / disable the periodic cluster health check task. Note that this setting isn't persisted across controller restarts and /cluster/configs should be used to disable it permanently

Get all available cluster health checks and their details

Get cluster properties if deployed in AZ aware mode

Browse resources in a connection. Eg list directories/files in a s3 bucket, list tables in a database, list topics in a Kafka cluster etc.

StarTree Documentation

Ingestion

Data Modeling

Query Data

Indexes

Tiered Storage

Manage Security

API Reference

Releases

Apache Pinot Recipes

Ingestion

Data Modelling

Query Data

Indexes

Tiered Storage

Manage Security

API Reference

Releases

Apache Pinot Recipes

Community

Blogs

Videos