Export Creator Analytics (CSV)

GET /api/v1/creators/analytics/export — 🔑 Bearer · Rate limit: 60 req / minute · Content-Type: text/csv

Returns a CSV file derived from one of three other endpoints — pick via ?type=overview / ?type=traffic / ?type=links. The body is the raw CSV (not JSON-wrapped) and the response carries Content-Disposition: attachment; filename=biore-analytics-<type>-<YYYY-MM-DD>.csv so a browser will download it.

Request

Query parameters

Headers

Response

200 OK — text/csv

Important: this endpoint does NOT return the JSON envelope. The body is raw CSV bytes. Use res.text() (not res.json()).

CSV shapes

?type=overview — 5 rows, two columns:

metric,value
total_views,4200
unique_visitors,1800
total_clicks,320
ctr,7.62
days,30

?type=traffic — header + one row per traffic source:

source,visits,percentage
instagram.com,600,35
direct,280,16
youtube.com,150,9

?type=links — header + one row per link with clicks:

id,title,url,clicks,ctr
link-uuid-1,My Portfolio,https://example.com,120,4.8
link-uuid-deleted,Unknown,,6,0.24

Invalid type — single error row, still 200 OK:

error
Invalid export type. Use: overview, traffic, or links.

Errors

There is no 400 for invalid type — instead the body becomes the error CSV described above.

Side effects

1. JwtAuthGuard + ThrottleGuard.
2. Compute d = Math.min(parseInt(days ?? '30'), 365).
3. Switch on type:
   • overview → call this.overview(userId, String(d)) → 5-row metric/value CSV.
   • traffic → call this.traffic(userId, String(d)) → header + per-source rows.
   • links → call this.links(userId, String(d)) → header + per-link rows.
   • Anything else → static error\nInvalid export type. ...\n body.
4. Run every value through sanitizeCSVValue (formula-prefix, quote-escape, comma/newline-wrap).
5. res.setHeader('Content-Disposition', ...); res.send(csv) (raw text body).

Code samples

# Saves the file using the server-suggested filename
curl -OJ \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  'https://api.bio.re/api/v1/creators/analytics/export?type=overview&days=30'

async function exportCsv(
  accessToken: string,
  type: 'overview' | 'traffic' | 'links',
  days = 30,
): Promise<{ csv: string; filename: string }> {
  const res = await fetch(
    `https://api.bio.re/api/v1/creators/analytics/export?type=${type}&days=${days}`,
    { headers: { Authorization: `Bearer ${accessToken}` } },
  );
  if (!res.ok) throw new Error(`Export failed: ${res.status}`);

  const csv = await res.text(); // NOT .json() — body is raw CSV
  const dispo = res.headers.get('Content-Disposition') ?? '';
  const match = /filename=([^;]+)/.exec(dispo);
  const filename = match?.[1]?.trim() ?? `biore-analytics-${type}.csv`;
  return { csv, filename };
}

async function downloadExport(
  type: 'overview' | 'traffic' | 'links',
  days = 30,
) {
  const res = await fetch(
    `/api/v1/creators/analytics/export?type=${type}&days=${days}`,
  );
  if (!res.ok) return;

  const blob = await res.blob();
  const url = URL.createObjectURL(blob);
  const a = document.createElement('a');
  a.href = url;
  a.download = `biore-analytics-${type}-${new Date().toISOString().slice(0, 10)}.csv`;
  a.click();
  URL.revokeObjectURL(url);
}

Try it

curl -X GET "https://loading/api/v1/creators/analytics/export?type=overview"

{
  "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