Skip to main content
POST
/
rest
/
hits
curl -X POST "https://api.hibonsai.com/rest/hits/" \
  -H "X-API-Key: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{"organization":"organization-uuid","eventDate":"2024-01-01T00:00:00Z","classification":"search"}'

Documentation Index

Fetch the complete documentation index at: https://docs.hibonsai.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

POST /rest/hits/

​
Request Body Parameters

​
organization
string
required
Organization UUID associated with the event.
​
eventDate
timestamp
required
ISO 8601 event timestamp.
​
classification
string
required
Event classification (for example, search).
​
method
string
HTTP method of the request (for example, GET, POST).
​
path
string
Request path (for example, /search).
​
url
string
Full URL of the request including query parameters.
​
userAgent
string
User agent string from the request header.
​
clientIp
string
IP address of the client making the request.
​
botScore
number
Bot detection score between 0 and 1. Higher values indicate greater likelihood of bot traffic.
​
verifiedBot
boolean
Whether the request is from a verified bot (for example, search engine crawlers).
​
headers
object
Request headers object.
​
cf
object
Cloudflare-specific metadata object.
curl -X POST "https://api.hibonsai.com/rest/hits/" \
  -H "X-API-Key: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{"organization":"organization-uuid","eventDate":"2024-01-01T00:00:00Z","classification":"search"}'

{
  "organization": "organization-uuid",
  "eventDate": "2024-01-01T00:00:00Z",
  "method": "GET",
  "path": "/search",
  "url": "https://example.com/search?q=query",
  "userAgent": "Mozilla/5.0...",
  "classification": "search",
  "clientIp": "192.168.1.1",
  "botScore": 0.95,
  "verifiedBot": false,
  "headers": {},
  "cf": {}
}

​
Response

Returns the created hit record with id, createdAt, and updatedAt fields.