⚡ Event API

Create/Push Event

Creates a new event associated with your project in the system.

Endpoint

POST api/v1/event

Authentication

This endpoint requires API key authentication. Include your public key and project ID in the request body.

🙋‍♂️ Note:

• You can get project id from your Project page.
• You can get public key from your API Key page.

Request Body

The request body should be in JSON format and include the following fields:

Field Name	Type	Required	Description	Validation
PublicKey	string	Yes	Your API public key for authentication	Must be a valid key associated with a user account
ProjectID	string	Yes	Unique identifier for the project	Must be a valid UUID
EventType	string	Yes	Type of the event	Maximum length: 100 characters
EventLabel	string	No	Label for the event	Maximum length: 100 characters
PageURL	string	No	URL of the page where the event occurred	Must be a valid URL
ElementPath	string	No	Path to the element that triggered the event	Maximum length: 255 characters
ElementType	string	No	Type of the element that triggered the event	Maximum length: 255 characters
UserAgent	string	No	User agent string of the browser	Maximum length: 255 characters
BrowserName	string	No	Name of the browser	Maximum length: 100 characters
SessionID	string	No	Unique identifier for the user session	Maximum length: 100 characters
DeviceType	string	No	Type of device used	Maximum length: 100 characters
TimeOnPage	integer	No	Time spent on the page in seconds
ScreenResolution	string	No	Screen resolution of the device	Maximum length: 100 characters
FiredAt	string	Yes	Timestamp when the event was fired	Must be a valid timestamp

Example Request

{
  "PublicKey": "your-public-key-here", // required
  "ProjectID": "your-project-id-here", // required
  "EventType": "click", // required
  "EventLabel": "Product A Click",
  "PageURL": "https://example.com/product/a",
  "ElementPath": "button[#button-id]",
  "ElementType": "button",
  "UserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36",
  "BrowserName": "Microsoft Edge",
  "SessionID": "sess_123456789",
  "DeviceType": "Windows 10",
  "TimeOnPage": 120,
  "ScreenResolution": "1920x1080",
  "FiredAt": "2023-06-15T14:30:00Z" // required
}

Response

Success Response

• Code: 200 OK
• Content: NO RETURNED CONTENT

Error Responses

• Code: 400 Bad Request

  • Content: Raw error message (unprocessable entity)
  • Reason: Invalid request body format

• Code: 401 Unauthorized

  • Content:

    {
      "error": "valid PublicKey is required"
    }
  • Reason: Missing or invalid PublicKey

• Code: 404 Not Found

  • Content:

    {
      "error": "project not found"
    }
  • Reason: Invalid Project ID