Skip to main content
POST
/
visit
cURL
curl --request POST \
  --url https://analytics.usehall.com/visit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "request_path": "/blog/becoming-an-ai-engineering-company",
  "request_method": "GET",
  "request_ip": "172.183.222.128",
  "request_timestamp": 1705315800,
  "request_headers": {
    "Host": "vercel.com",
    "User-Agent": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko); compatible; ChatGPT-User/1.0; +https://openai.com/bot",
    "Referer": "https://chatgpt.com"
  }
}'
This response does not have an example.
Visits are logged to the Analytics API by making a POST request to the /visit endpoint. The request body should forward the visitor’s request HTTP path, method, and headers as described below.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Visitor request to forward to the Analytics API.

​
request_path
string
required

The path of the HTTP request.

Example:

"/blog/becoming-an-ai-engineering-company"

​
request_method
enum<string>
required

The HTTP method used for the request.

Available options:
GET,
POST,
PUT,
DELETE,
PATCH
Example:

"GET"

​
request_ip
string

The IP address making the request. This is optional, but may effect the availability of some features.

Example:

"172.183.222.128"

​
request_timestamp
integer

The UNIX Epoch timestamp when the original request occurred.

Example:

1705315800

​
request_headers
object

HTTP headers sent with the request.

Response

Success.