BioFlow / API docs / getAnalyticsSummary

Get analytics summary.

GET /v1/analytics/summary

scope: analytics:readCreator & Pro plansquota cost: 1

Workspace analytics for the last 7/30/90 days: views, clicks, unique visitors, CTR, top links, top referrers, and tip revenue.

Requires scope: analytics:read. Plan entitlement: public_api (Creator and Pro).

Open in Claude ↗Open in ChatGPT ↗

Try it

Request.

curl "https://app.getbioflow.com/v1/analytics/summary" \
  -H "Authorization: Bearer bf_live_YOUR_KEY"

Parameters

Path & query parameters.

Parameters accepted by getAnalyticsSummary
Name	In	Type	Required	Description
`range_days`	query	integer	no	—

Response

200 — The analytics summary.

Fields of the 200 response for getAnalyticsSummary
Field	Type	Description
`range_days`	integer	—
`totals`	object	—
`top_links`	array<object>	—
`top_referrers`	array<object>	—
`tips`	object	—

Every response also carries X-Request-Id plus the IETF draft-11 RateLimit / RateLimit-Policy headers.

Errors

What can go wrong here.

Problem codes this operation can return
Code	Status	Meaning
`invalid_request`	400	The request body or parameters failed validation
`invalid_api_key`	401	Missing, malformed, unknown, disabled, or expired API key
`insufficient_scope`	403	The API key was not granted the required scope
`feature_not_enabled`	403	The workspace plan does not include public API access
`test_key_read_only`	403	Test-mode keys are restricted to read operations
`rate_limited`	429	Per-key rate limit exceeded
`quota_exhausted`	429	Monthly API quota exhausted
`internal_error`	500	Something went wrong on our side

All errors are RFC 9457 application/problem+json — branch on code, quote request_id to support. Full registry on the API docs hub; interactive playground in the API reference.