Skip to main content

Overview

The top_sources endpoint returns the top traffic referrers ranked by number of visits. It supports pagination and optional comparison with the previous period.

Endpoint

GET https://api.tinybird.co/v0/pipes/top_sources.json

Parameters

date_from
string
Start date (YYYY-MM-DD format). Defaults to 7 days ago.
date_to
string
End date (YYYY-MM-DD format). Defaults to today.
tenant_id
string
Filter by tenant ID
domain
string
Filter by domain
include_previous_period
string
Set to “true” to include previous period comparison and growth percentages
skip
int32
default:"0"
Skip for pagination (offset)
limit
int32
default:"50"
Limit for pagination (max results)

SQL Query

The endpoint aggregates referrer data from analytics_sources_mv:
SELECT
    domainWithoutWWW(referrer) as referrer,
    uniqMerge(visits) as current_visits,
    countMerge(hits) as current_hits
FROM analytics_sources_mv
WHERE date >= (SELECT current_start FROM date_calculations)
    AND date <= (SELECT current_end FROM date_calculations)
    {% if defined(tenant_id) %}
    AND tenant_id = {{ String(tenant_id, description="Filter by tenant ID") }}
    {% end %}
    {% if defined(domain) %}
    AND domain = {{ String(domain, description="Filter by domain") }}
    {% end %}
GROUP BY referrer

Response

referrer
string
required
The referrer domain (without www prefix)
visits
uint64
required
Number of unique visits from this source
hits
uint64
required
Total number of pageviews from this source
previous_visits
uint64
Previous period visits (only when include_previous_period=true)
previous_hits
uint64
Previous period pageviews (only when include_previous_period=true)
visits_growth_percentage
float64
Percentage change in visits (only when include_previous_period=true)
hits_growth_percentage
float64
Percentage change in pageviews (only when include_previous_period=true)

TypeScript Usage

import { createAnalyticsClient } from '@tinybirdco/analytics-client';

const tinybird = createAnalyticsClient();

// Get top 50 traffic sources (default)
const result = await tinybird.query.topSources();
result.data.forEach(source => {
  console.log(`${source.referrer}: ${source.visits} visits, ${source.hits} pageviews`);
});

// Get top sources for a specific date range
const rangeResult = await tinybird.query.topSources({
  date_from: '2024-01-01',
  date_to: '2024-01-31',
  domain: 'example.com',
  limit: 10
});

// Get top sources with previous period comparison
const comparisonResult = await tinybird.query.topSources({
  date_from: '2024-01-01',
  date_to: '2024-01-07',
  include_previous_period: 'true',
  limit: 20
});
comparisonResult.data.forEach(source => {
  console.log(`${source.referrer}: ${source.visits} visits (${source.visits_growth_percentage}% growth)`);
});

// Paginate through results
const page1 = await tinybird.query.topSources({
  skip: 0,
  limit: 10
});
const page2 = await tinybird.query.topSources({
  skip: 10,
  limit: 10
});

Example Response

Without Previous Period

{
  "data": [
    {
      "referrer": "google.com",
      "visits": 5234,
      "hits": 8921
    },
    {
      "referrer": "twitter.com",
      "visits": 2341,
      "hits": 4567
    },
    {
      "referrer": "github.com",
      "visits": 1876,
      "hits": 3245
    },
    {
      "referrer": "",
      "visits": 1234,
      "hits": 2345
    }
  ]
}

With Previous Period

{
  "data": [
    {
      "referrer": "google.com",
      "visits": 5234,
      "hits": 8921,
      "previous_visits": 4821,
      "previous_hits": 8234,
      "visits_growth_percentage": 8.57,
      "hits_growth_percentage": 8.34
    },
    {
      "referrer": "twitter.com",
      "visits": 2341,
      "hits": 4567,
      "previous_visits": 1987,
      "previous_hits": 3876,
      "visits_growth_percentage": 17.81,
      "hits_growth_percentage": 17.83
    }
  ]
}

Notes

  • Empty referrer ("") indicates direct traffic or traffic without a referrer
  • Referrers are normalized by removing the www. prefix
  • Results are ordered by visits in descending order
  • Use pagination parameters for large result sets

Build docs developers (and LLMs) love