GET /session/<id>

Reads the session with the ID <id>. The properties below are always present in the response but some may be null.

Example

curl https://app.hitprobe.com/api/v1/session/EGe9niUZEATtPwHyicyUGT/event \
  -H 'Authorization: Bearer 4d5d94e5f2e9-7408-4fee-9e42-3748eaee'

{
  "site_id": "6vszS94NU23SNujTB8dfio",
  "site_name": "Example Site",
  "session_id": "EGe9niUZEATtPwHyicyUGT",
  "created_at": "2024-09-12T16:43:12.169713",
  "updated_at": "2024-09-12T17:51:57.370522",
  "duration": 216, // Seconds
  "page_views": 4,
  "entry_hostname": "example.com",
  "entry_path": "/page/path/at/entry",
  "exit_hostname": "example.com",
  "exit_path": "/page/path/at/exit",
  "fingerprint": "7hYxPx8qhV9liGCDMdHnTd",
  "returned": true,
  "allowed": false,
  "risk_level": "suspicious",
  "engagement_level": "normal",
  "risks": ["suspect_device", "anonymous"],
  "actions": ["blocked_ip"],
  "custom_events": ["my_event"],
  "value": 0.00,
  "source_type": "google",
  "source_name": null,
  "source_id": null,
  "source_medium": null,
  "source_campaign": "21472235747",
  "source_group": null,
  "source_content": null,
  "source_term": null,
  "source_placement": null,
  "source_session_id": null,
  "referrer": null,
  "referrer_domain": null,
  "ip": "145.167.77.16",
  "ip_network": "145.167.77",
  "isp": "Space Exploration Technologies Corporation",
  "country_code": "GB",
  "city": "London",
  "device_type": "computer",
  "browser_name": "Chrome",
  "browser_family": "Chrome",
  "browser_version": "130.0.0",
  "os_family": "Mac OS X",
  "os_version": "10.14.8",
  "language": "en-GB",
  "timezone": "Europe/London",
  "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_8)..."
}

Possible property values

risk_level

• normal
• unwanted
• suspicious
• invalid

engagement_level

• bounced
• normal
• engaged
• converted

source_type

• google
• meta
• microsoft
• other (any other tagged source)
• or may be also be null (organic)

country_code

Two-letter (ISO 3166-1 alpha-2) country code, or null.

language

An IETF language tag identifying the client locale language, or null.

timezone

The timezone in the tz database format, in the form "Area/Location", e.g. "America/New_York", or null.

device_type

• mobile
• tablet
• computer
• or may be also be null (indeterminate)