Guides
Guides

Events Endpoint

Query and export event data via REST API

Events Endpoint

Query and export custom event data from your UXCam account.

Endpoints

EndpointDescription
GET /v2/eventList events (qualitative data)
GET /v2/event/analyticsAggregate event analytics (quantitative data)

List Events

Returns detailed event data including session context, user properties, and custom event properties.

Request

curl "https://api.uxcam.com/v2/event" \
  -H "X-App-Id: YOUR_APP_ID" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -G \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=50' \
  --data-urlencode 'filters=[{"attribute":"event_name","operator":"equal","value":"purchase"}]'

Response

{
  "success": true,
  "data": [
    {
      "eventId": "9d0cb696-65e2-4783-9556-352bfd71009f",
      "eventName": "purchase",
      "eventScreen": "CheckoutActivity",
      "eventDate": "2023-01-22T17:31:57Z",
      "url": "https://app.uxcam.com/app/.../sessions/...",
      "sessionProperty": {
        "sessionId": "60f7dd4d46c872001188eb3f",
        "hasVideo": true,
        "durationSec": 98.77
      },
      "userProperty": {
        "kUXCam_UserIdentity": "user_123",
        "subscription": "premium"
      },
      "eventProperty": {
        "amount": 29.99,
        "currency": "USD"
      },
      "device": {
        "model": "SM-A525F",
        "platform": 1
      }
    }
  ]
}

Event Analytics

Returns aggregated statistics for events matching your query.

Request

curl "https://api.uxcam.com/v2/event/analytics" \
  -H "X-App-Id: YOUR_APP_ID" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -G \
  --data-urlencode 'filters=[{"attribute":"event_name","operator":"equal","value":"purchase"}]' \
  --data-urlencode 'group_by=[{"attribute":"event_uploadedon_day"}]'

Response

{
  "success": true,
  "data": [
    {
      "event_count": 165159,
      "event_unique_user_count": 2993,
      "event_unique_session_count": 12137
    }
  ]
}

Event Attributes

AttributeTypeDescription
event_nameStringName of the event
event_screen_nameStringScreen where event occurred
event_custom_propertyJSONProperties sent with event
event_uploadedon_dayDateTimeDay event was recorded
device_platformString"android" or "ios"
session_idStringSession containing event
uxcamuseridStringUser who triggered event

For the complete attribute list, see the full Events documentation.

Use Cases

Funnel Analysis

Count users who completed each step:

# Step 1: Viewed product
curl "https://api.uxcam.com/v2/event/analytics?..." \
  --data-urlencode 'filters=[{"attribute":"event_name","operator":"equal","value":"view_product"}]'

# Step 2: Added to cart
curl "https://api.uxcam.com/v2/event/analytics?..." \
  --data-urlencode 'filters=[{"attribute":"event_name","operator":"equal","value":"add_to_cart"}]'

# Step 3: Purchased
curl "https://api.uxcam.com/v2/event/analytics?..." \
  --data-urlencode 'filters=[{"attribute":"event_name","operator":"equal","value":"purchase"}]'

See Also