Export user events
curl --request GET \
--url https://your-instance.example.com/api/export.userEventsimport requests
url = "https://your-instance.example.com/api/export.userEvents"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://your-instance.example.com/api/export.userEvents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/export.userEvents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/export.userEvents"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://your-instance.example.com/api/export.userEvents")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/export.userEvents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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
}Export
Export user events
Export raw events for users with a user_id set. Supports cursor-based pagination for incremental sync.
GET
/
api
/
export.userEvents
Export user events
curl --request GET \
--url https://your-instance.example.com/api/export.userEventsimport requests
url = "https://your-instance.example.com/api/export.userEvents"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://your-instance.example.com/api/export.userEvents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/export.userEvents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/export.userEvents"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://your-instance.example.com/api/export.userEvents")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/export.userEvents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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
Required range:
1 <= x <= 1000⌘I