Skip to content

Latest commit

 

History

History
59 lines (47 loc) · 1.83 KB

README.md

File metadata and controls

59 lines (47 loc) · 1.83 KB

Tinybird Data Project

Project description

├── datasources
│   └── analytics_events.datasource
├── endpoints
│   ├── analytics_hits.pipe
│   ├── kpis.pipe
│   ├── top_browsers.pipe
│   ├── top_devices.pipe
│   ├── top_locations.pipe
│   ├── top_pages.pipe
│   └── top_sources.pipe
├── pipes
│   ├── analytics_pages.pipe
│   ├── analytics_sessions.pipe
│   └── analytics_sources.pipe

In the /datasources folder:

  • analytics_events.datasource:

In the /endpoints folder:

  • analytics_hits: Parse page_hit events and publish them, so they can be used in multiple use cases.
  • kpis: Summary including general KPIs per date
  • top_browsers: Browser level metrics
  • top_devices: Device level metrics
  • top_locations: Location (country) level metrics
  • top_pages: Path and browser level metrics
  • top_sources: Referral and browser level metrics

In the /pipes folder, including materialized views:

  • analytics_pages: Aggregate by pathname and calculate session and hits
  • analytics_sessions: Aggregate by session_id and calculate session metrics
  • analytics_sources: Aggregate by referral and calculate session and hits

Note: Typically, in big projects, we split the .pipe files across two folders: /pipes and /endpoints

  • /pipes where we store the pipes ending in a datasource, that is, materialized views
  • /endpoints for the pipes that end in API endpoints.

Local development

# install the tinybird CLI
curl https://tinybird.co | sh

tb local start

# select or create a new workspace
tb login

tb dev
tb token ls  # copy the local admin token

Use http://localhost:7181 as NEXT_PUBLIC_TINYBIRD_HOST and the admin token in the dashboard.