The Analytics API uses the Bearer token authentication scheme for secure access to endpoints.

Each API key is unique to the domain you are tracking. If you configure multiple domains, you will have to manage multiple API keys.

You can create, view, and manage your domains and associated API keys in the settings section of the Analytics feature within your workspace.

All API requests must be made over HTTPS to ensure secure transmission of your credentials.

​
Usage

Include your API key in the Authorization header of your requests using the Bearer token format:

curl 'https://analytics.usehall.com/visit' \
  -H 'Authorization: Bearer <HALL_API_KEY>'
  -H "Content-Type: application/json" \
  -d '{
      "request_path": "<REQUEST_PATH>",
      "request_method": "<REQUEST_METHOD>",
      "request_headers": "<REQUEST_HEADERS>",
      "request_ip": "<REQUEST_IP>",
      "request_timestamp": "<REQUEST_TIMESTAMP>"
  }'

​
Security best practices

  • Keep your API keys secure and never expose them in client-side code
  • Regenerate your API keys periodically for enhanced security
  • Use environment variables to store API keys in your applications
  • Revoke unused or compromised API keys immediately