Send a web analytics beacon for an organization
Public and unauthenticated: takes one beacon as a text/plain JSON body from the SDK or script tag and buffers it for ingestion, answering 202.
POST/api/v1/public/orgId/e
- Sign-in
- None at the router: the operation is public, or checks its own proof (a signature, a token in the body, a signed link).
- Rate limit
- Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted); up to 300 requests a minute per IP address.
Public and unauthenticated: takes one beacon as a text/plain JSON body from the SDK or script tag and buffers it for ingestion, answering 202. Answers 404 for a tenant key this server does not serve or one whose collection is turned off, which tells the sender to stop, and 400 for a body that is not a JSON object. Rate limited by IP.
Request
Path parameters
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
orgId | string | Yes | - | - |
Send the body as text/plain. Its fields are not described yet.
Example request
Replace each YOUR_... value with your own.
curl -X POST "https://api.console.buildbase.app/api/v1/public/YOUR_ORG_ID/e" \
-H "Content-Type: text/plain" \
-d '"string"'const response = await fetch(
'https://api.console.buildbase.app/api/v1/public/YOUR_ORG_ID/e',
{
method: 'POST',
headers: {
'Content-Type': 'text/plain',
},
body: JSON.stringify('string'),
}
);
if (!response.ok) {
throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();import json
import requests
response = requests.post(
"https://api.console.buildbase.app/api/v1/public/YOUR_ORG_ID/e",
headers={
"Content-Type": "text/plain",
},
data=json.dumps("string"),
timeout=30,
)
response.raise_for_status()
data = response.json()Responses
202 Accepted
Accepted
{
"c": "denied"
}Any other status
Any other answer the handler sends itself (its own refusals). Not described yet.
Errors
Each refusal, what it means, and what to do. The request changed nothing.
400 Bad Request
What it means: The request failed a validate() schema, or an id in the path is not a valid id. path names the field.
What to do: Fix the field the body names in path (or read message) and send the request again. Nothing was changed.
{
"error": true,
"success": false,
"path": "string",
"message": "string"
}429 Too Many Requests
What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.
What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.
{
"success": false,
"message": "string",
"reason": "rate_limited",
"retryAfter": 1
}Related
- Web analytics beacon guide: how this part of BuildBase works
- All Web analytics beacon operations
- API reference: every operation, by tag
- Sign-in and credentials for the HTTP API
- How the HTTP API reports errors
- Make your first call
- Error codes: every
codethe API returns - OpenAPI: operation
e.createin public-v1.json