Skip to main content
GET
/
api
/
export.userEvents
Export user events
curl --request GET \
  --url https://your-instance.example.com/api/export.userEvents
{
  "data": [
    {
      "id": "019412ab-1234-7def-8000-abcdef123456",
      "session_id": "019412ab-5678-7abc-8000-123456abcdef",
      "user_id": "user_12345",
      "name": "screen_view",
      "path": "/pricing",
      "created_at": "2025-01-20T14:30:00.000Z",
      "updated_at": "2025-01-20T14:32:15.000Z",
      "referrer": "https://www.google.com/search?q=analytics",
      "referrer_domain": "www.google.com",
      "is_direct": false,
      "landing_page": "https://example.com/",
      "landing_domain": "example.com",
      "landing_path": "/",
      "utm_source": "google",
      "utm_medium": "cpc",
      "utm_campaign": "brand_2025",
      "utm_term": "",
      "utm_content": "",
      "utm_id": "",
      "utm_id_from": "",
      "channel": "Google Ads",
      "channel_group": "Paid Search",
      "stm_1": "premium",
      "stm_2": "",
      "stm_3": "",
      "stm_4": "",
      "stm_5": "",
      "stm_6": "",
      "stm_7": "",
      "stm_8": "",
      "stm_9": "",
      "stm_10": "",
      "device": "Desktop",
      "browser": "Chrome",
      "browser_type": "standard",
      "os": "macOS",
      "country": "US",
      "region": "California",
      "city": "San Francisco",
      "language": "en-US",
      "timezone": "America/Los_Angeles",
      "goal_name": "",
      "goal_value": 0,
      "goal_timestamp": null,
      "page_number": 2,
      "duration": 135,
      "max_scroll": 75
    }
  ],
  "next_cursor": "eyJ0IjoxNzA1NzYwMjAwMDAwLCJpIjoiMDE5NDEyYWItMTIzNC03ZGVmLTgwMDAtYWJjZGVmMTIzNDU2In0=",
  "has_more": true
}

Query Parameters

workspace_id
string
required
cursor
string
since
string
until
string
required
user_id
string
limit
number
default:100
Required range: 1 <= x <= 1000

Response

200 - application/json

List of user events with pagination cursor

data
object[]
next_cursor
string | null
has_more
boolean