Creator Traffic Sources

GET /api/v1/creators/analytics/traffic — 🔑 Bearer · Rate limit: 60 req / minute

Returns the top 15 referrer domains driving traffic to the creator's bio page, plus each one's share of total visits. referrerDomain was extracted at session-create time (URL.hostname.replace('www.', '')); sessions with no referrer or an unparseable one show up under 'direct'.

Request

Query parameters

Headers

Response

200 OK — ApiResponseOf<CreatorTrafficDto>

{
  "success": true,
  "data": {
    "sources": [
      { "source": "instagram.com", "visits": 600, "percentage": 35 },
      { "source": "direct",        "visits": 280, "percentage": 16 },
      { "source": "youtube.com",   "visits": 150, "percentage": 9 }
    ]
  }
}

Item fields (sources[])

Errors

Same as overview — 401 / 404 error.creator.not_found / 404 error.creator.bio_not_found / 429.

Side effects

1. JwtAuthGuard + ThrottleGuard.
2. getBioPageId(userId) (main DB → 404 if missing creator/bio page).
3. analyticsDb.$queryRaw (Analytics DB):

   SELECT COALESCE("referrerDomain", 'direct') as source,
          COUNT(*)::int as visits
   FROM "AnalyticsSession"
   WHERE "bioPageId" = $bioPageId::uuid
     AND "startedAt" >= $since
   GROUP BY "referrerDomain"
   ORDER BY visits DESC
   LIMIT 15

4. Compute total = sum(visits), then map each row to add percentage = Math.round((visits / total) * 100). 0 when total is zero.

Code samples

curl 'https://api.bio.re/api/v1/creators/analytics/traffic?days=30' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

type TrafficSource = { source: string; visits: number; percentage: number };

async function getTraffic(
  accessToken: string,
  days = 30,
): Promise<{ sources: TrafficSource[] }> {
  const res = await fetch(
    `https://api.bio.re/api/v1/creators/analytics/traffic?days=${days}`,
    { headers: { Authorization: `Bearer ${accessToken}` } },
  );
  const json = await res.json();
  if (!res.ok || !json.success) throw new Error(json?.error?.message ?? 'Failed');
  return json.data;
}

Try it

curl -X GET "https://loading/api/v1/creators/analytics/traffic"

{
  "success": true,
  "data": {
    "sources": [
      {
        "source": "instagram",
        "visits": 600
      }
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "AUTH_UNAUTHORIZED",
    "message": "Invalid credentials",
    "i18nKey": "auth.login.invalid_credentials",
    "i18nVars": {
      "field": "email"
    },
    "details": [
      {
        "message": "email must be an email"
      }
    ],
    "correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

{
  "success": false,
  "error": {
    "code": "AUTH_UNAUTHORIZED",
    "message": "Invalid credentials",
    "i18nKey": "auth.login.invalid_credentials",
    "i18nVars": {
      "field": "email"
    },
    "details": [
      {
        "message": "email must be an email"
      }
    ],
    "correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Source