Search website sessions
curl --request POST \
--url https://beta.getsales.io/signals/v1/api/website-sessions/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"site_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"visitor_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"person_sid": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"company_sid": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"fingerprint_sid": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"attribution": {
"in": [],
"nin": []
},
"network_type": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"referrer_type": {
"in": [],
"nin": []
},
"key_page": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"form": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"event": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"geo_country": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"device": {
"in": []
},
"browser": {
"eq": "<string>",
"in": [
"<string>"
]
},
"os": {
"eq": "<string>",
"in": [
"<string>"
]
},
"is_internal": {
"eq": true
},
"started_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"closed_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
}
},
"include": [],
"page_size": 250,
"cursor": "<string>"
}
'import requests
url = "https://beta.getsales.io/signals/v1/api/website-sessions/search"
payload = {
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"site_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"visitor_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"person_sid": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"company_sid": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"fingerprint_sid": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"attribution": {
"in": [],
"nin": []
},
"network_type": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"referrer_type": {
"in": [],
"nin": []
},
"key_page": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"form": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"event": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"geo_country": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"device": { "in": [] },
"browser": {
"eq": "<string>",
"in": ["<string>"]
},
"os": {
"eq": "<string>",
"in": ["<string>"]
},
"is_internal": { "eq": True },
"started_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"closed_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
}
},
"include": [],
"page_size": 250,
"cursor": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
filter: {
sid: {eq: '<string>', in: ['<string>']},
site_sid: {eq: '<string>', in: ['<string>']},
visitor_sid: {eq: '<string>', in: ['<string>']},
person_sid: {eq: '<string>', in: ['<string>'], is_null: true},
company_sid: {eq: '<string>', in: ['<string>'], is_null: true},
fingerprint_sid: {eq: '<string>', in: ['<string>'], is_null: true},
attribution: {in: [], nin: []},
network_type: {eq: '<string>', in: ['<string>'], is_null: true},
referrer_type: {in: [], nin: []},
key_page: {eq: '<string>', in: ['<string>'], is_null: true},
form: {eq: '<string>', in: ['<string>'], is_null: true},
event: {eq: '<string>', in: ['<string>'], is_null: true},
geo_country: {eq: '<string>', in: ['<string>'], is_null: true},
device: {in: []},
browser: {eq: '<string>', in: ['<string>']},
os: {eq: '<string>', in: ['<string>']},
is_internal: {eq: true},
started_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
closed_at: {gte: '<string>', lte: '<string>', is_null: true},
created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'}
},
include: [],
page_size: 250,
cursor: '<string>'
})
};
fetch('https://beta.getsales.io/signals/v1/api/website-sessions/search', 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://beta.getsales.io/signals/v1/api/website-sessions/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'site_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'visitor_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'person_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'company_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'fingerprint_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'attribution' => [
'in' => [
],
'nin' => [
]
],
'network_type' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'referrer_type' => [
'in' => [
],
'nin' => [
]
],
'key_page' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'form' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'event' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'geo_country' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'device' => [
'in' => [
]
],
'browser' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'os' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'is_internal' => [
'eq' => true
],
'started_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'closed_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
],
'created_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
]
],
'include' => [
],
'page_size' => 250,
'cursor' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://beta.getsales.io/signals/v1/api/website-sessions/search"
payload := strings.NewReader("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"site_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"visitor_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"person_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"company_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"fingerprint_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"attribution\": {\n \"in\": [],\n \"nin\": []\n },\n \"network_type\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"referrer_type\": {\n \"in\": [],\n \"nin\": []\n },\n \"key_page\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"form\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"event\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"geo_country\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"device\": {\n \"in\": []\n },\n \"browser\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"os\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"is_internal\": {\n \"eq\": true\n },\n \"started_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"closed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"include\": [],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://beta.getsales.io/signals/v1/api/website-sessions/search")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"site_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"visitor_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"person_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"company_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"fingerprint_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"attribution\": {\n \"in\": [],\n \"nin\": []\n },\n \"network_type\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"referrer_type\": {\n \"in\": [],\n \"nin\": []\n },\n \"key_page\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"form\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"event\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"geo_country\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"device\": {\n \"in\": []\n },\n \"browser\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"os\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"is_internal\": {\n \"eq\": true\n },\n \"started_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"closed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"include\": [],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/signals/v1/api/website-sessions/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"site_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"visitor_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"person_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"company_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"fingerprint_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"attribution\": {\n \"in\": [],\n \"nin\": []\n },\n \"network_type\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"referrer_type\": {\n \"in\": [],\n \"nin\": []\n },\n \"key_page\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"form\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"event\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"geo_country\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"device\": {\n \"in\": []\n },\n \"browser\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"os\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"is_internal\": {\n \"eq\": true\n },\n \"started_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"closed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"include\": [],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "search",
"items": [
{
"item": {
"sid": "<string>",
"team_sid": "<string>",
"site_sid": "<string>",
"visitor_sid": "<string>",
"person_sid": "<string>",
"company_sid": "<string>",
"attribution": "code",
"fingerprint_sid": "<string>",
"started_at": "<string>",
"last_seen_at": "<string>",
"closed_at": "<string>",
"pageviews_count": 1,
"engaged_seconds": 1,
"entry_path": "<string>",
"exit_path": "<string>",
"pages": [
{
"page_id": "<string>",
"path": "<string>",
"title": "<string>",
"engaged_seconds": 1,
"first_seen_at": "<string>",
"scroll_pct": 50
}
],
"events": [
{
"kind": "event",
"name": "<string>",
"at": "<string>",
"page_id": "<string>"
}
],
"key_pages": [
"<string>"
],
"referrer_type": "direct",
"referrer_host": "<string>",
"utm_source": "<string>",
"utm_medium": "<string>",
"utm_campaign": "<string>",
"utm_content": "<string>",
"utm_term": "<string>",
"landing_code": "<string>",
"browser": "<string>",
"browser_version": "<string>",
"os": "<string>",
"os_version": "<string>",
"device": "desktop",
"screen": "<string>",
"language": "<string>",
"timezone": "<string>",
"geo_country": "<string>",
"geo_region": "<string>",
"geo_city": "<string>",
"ip": "<string>",
"network_status": "pending",
"network_type": "<string>",
"network_name": "<string>",
"network_domain": "<string>",
"asn": 123,
"as_name": "<string>",
"is_internal": true,
"created_at": "<string>",
"updated_at": "<string>"
},
"included": {
"visitor": {
"sid": "<string>"
},
"person": {
"sid": "<string>"
},
"company": {
"sid": "<string>"
}
}
}
],
"pagination": {
"next_cursor": "<string>",
"has_more": true,
"total_count": 123
},
"applied_filters": {},
"includes": [
"<string>"
],
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"counts": {
"total_count": 1,
"groups": {
"attribution": {},
"network_type": {},
"referrer_type": {},
"device": {},
"key_page": {}
}
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}website_sessions
Search website sessions
The visitor feed: every visit to the team’s sites, newest first, as one session: who it belongs to when a rung named someone (person_sid, or company_sid when only a company code or the network did; attribution says which), what was seen (pages with engaged time, key_pages, events: forms and custom events), where it came from (referrer_type, the utm set, landing_code), the browser and the network (network_type business, isp, mobile, hosting, education, government or unknown; network_name, network_domain). Scope with site_sid, started_at (the period) and the sids of a person, a company or a visitor; key_page, form and event take a slug or a name (eq or in), and is_null false = any whatever the name (every session that submitted a form, anonymous ones included), true = none; person_sid is_null false = known people, closed_at is_null true = on the site now, is_internal eq true = the team’s own traffic. page_size 0 returns the counts by attribution, network type, referrer type, device and key page. “Who visited pricing this week and has not replied”: this with key_page pricing and a started_at window, then search_people or search_conversations by the signals visited_key_page and visited_not_replied. What a session saw is private context: use it to decide when to write and what to offer, never tell the lead we know.
Contract:
- MCP tool
search_website_sessions, registry packagemcp.signals/website_sessions, mountsignals.visits. - Operation
search, response envelopesearch. - Flags: read only.
POST
/
api
/
website-sessions
/
search
Search website sessions
curl --request POST \
--url https://beta.getsales.io/signals/v1/api/website-sessions/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"site_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"visitor_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"person_sid": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"company_sid": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"fingerprint_sid": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"attribution": {
"in": [],
"nin": []
},
"network_type": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"referrer_type": {
"in": [],
"nin": []
},
"key_page": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"form": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"event": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"geo_country": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"device": {
"in": []
},
"browser": {
"eq": "<string>",
"in": [
"<string>"
]
},
"os": {
"eq": "<string>",
"in": [
"<string>"
]
},
"is_internal": {
"eq": true
},
"started_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"closed_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
}
},
"include": [],
"page_size": 250,
"cursor": "<string>"
}
'import requests
url = "https://beta.getsales.io/signals/v1/api/website-sessions/search"
payload = {
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"site_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"visitor_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"person_sid": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"company_sid": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"fingerprint_sid": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"attribution": {
"in": [],
"nin": []
},
"network_type": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"referrer_type": {
"in": [],
"nin": []
},
"key_page": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"form": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"event": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"geo_country": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"device": { "in": [] },
"browser": {
"eq": "<string>",
"in": ["<string>"]
},
"os": {
"eq": "<string>",
"in": ["<string>"]
},
"is_internal": { "eq": True },
"started_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"closed_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
}
},
"include": [],
"page_size": 250,
"cursor": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
filter: {
sid: {eq: '<string>', in: ['<string>']},
site_sid: {eq: '<string>', in: ['<string>']},
visitor_sid: {eq: '<string>', in: ['<string>']},
person_sid: {eq: '<string>', in: ['<string>'], is_null: true},
company_sid: {eq: '<string>', in: ['<string>'], is_null: true},
fingerprint_sid: {eq: '<string>', in: ['<string>'], is_null: true},
attribution: {in: [], nin: []},
network_type: {eq: '<string>', in: ['<string>'], is_null: true},
referrer_type: {in: [], nin: []},
key_page: {eq: '<string>', in: ['<string>'], is_null: true},
form: {eq: '<string>', in: ['<string>'], is_null: true},
event: {eq: '<string>', in: ['<string>'], is_null: true},
geo_country: {eq: '<string>', in: ['<string>'], is_null: true},
device: {in: []},
browser: {eq: '<string>', in: ['<string>']},
os: {eq: '<string>', in: ['<string>']},
is_internal: {eq: true},
started_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
closed_at: {gte: '<string>', lte: '<string>', is_null: true},
created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'}
},
include: [],
page_size: 250,
cursor: '<string>'
})
};
fetch('https://beta.getsales.io/signals/v1/api/website-sessions/search', 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://beta.getsales.io/signals/v1/api/website-sessions/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'site_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'visitor_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'person_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'company_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'fingerprint_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'attribution' => [
'in' => [
],
'nin' => [
]
],
'network_type' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'referrer_type' => [
'in' => [
],
'nin' => [
]
],
'key_page' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'form' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'event' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'geo_country' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'device' => [
'in' => [
]
],
'browser' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'os' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'is_internal' => [
'eq' => true
],
'started_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'closed_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
],
'created_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
]
],
'include' => [
],
'page_size' => 250,
'cursor' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://beta.getsales.io/signals/v1/api/website-sessions/search"
payload := strings.NewReader("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"site_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"visitor_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"person_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"company_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"fingerprint_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"attribution\": {\n \"in\": [],\n \"nin\": []\n },\n \"network_type\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"referrer_type\": {\n \"in\": [],\n \"nin\": []\n },\n \"key_page\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"form\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"event\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"geo_country\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"device\": {\n \"in\": []\n },\n \"browser\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"os\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"is_internal\": {\n \"eq\": true\n },\n \"started_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"closed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"include\": [],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://beta.getsales.io/signals/v1/api/website-sessions/search")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"site_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"visitor_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"person_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"company_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"fingerprint_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"attribution\": {\n \"in\": [],\n \"nin\": []\n },\n \"network_type\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"referrer_type\": {\n \"in\": [],\n \"nin\": []\n },\n \"key_page\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"form\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"event\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"geo_country\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"device\": {\n \"in\": []\n },\n \"browser\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"os\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"is_internal\": {\n \"eq\": true\n },\n \"started_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"closed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"include\": [],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/signals/v1/api/website-sessions/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"site_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"visitor_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"person_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"company_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"fingerprint_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"attribution\": {\n \"in\": [],\n \"nin\": []\n },\n \"network_type\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"referrer_type\": {\n \"in\": [],\n \"nin\": []\n },\n \"key_page\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"form\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"event\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"geo_country\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"device\": {\n \"in\": []\n },\n \"browser\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"os\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"is_internal\": {\n \"eq\": true\n },\n \"started_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"closed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"include\": [],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "search",
"items": [
{
"item": {
"sid": "<string>",
"team_sid": "<string>",
"site_sid": "<string>",
"visitor_sid": "<string>",
"person_sid": "<string>",
"company_sid": "<string>",
"attribution": "code",
"fingerprint_sid": "<string>",
"started_at": "<string>",
"last_seen_at": "<string>",
"closed_at": "<string>",
"pageviews_count": 1,
"engaged_seconds": 1,
"entry_path": "<string>",
"exit_path": "<string>",
"pages": [
{
"page_id": "<string>",
"path": "<string>",
"title": "<string>",
"engaged_seconds": 1,
"first_seen_at": "<string>",
"scroll_pct": 50
}
],
"events": [
{
"kind": "event",
"name": "<string>",
"at": "<string>",
"page_id": "<string>"
}
],
"key_pages": [
"<string>"
],
"referrer_type": "direct",
"referrer_host": "<string>",
"utm_source": "<string>",
"utm_medium": "<string>",
"utm_campaign": "<string>",
"utm_content": "<string>",
"utm_term": "<string>",
"landing_code": "<string>",
"browser": "<string>",
"browser_version": "<string>",
"os": "<string>",
"os_version": "<string>",
"device": "desktop",
"screen": "<string>",
"language": "<string>",
"timezone": "<string>",
"geo_country": "<string>",
"geo_region": "<string>",
"geo_city": "<string>",
"ip": "<string>",
"network_status": "pending",
"network_type": "<string>",
"network_name": "<string>",
"network_domain": "<string>",
"asn": 123,
"as_name": "<string>",
"is_internal": true,
"created_at": "<string>",
"updated_at": "<string>"
},
"included": {
"visitor": {
"sid": "<string>"
},
"person": {
"sid": "<string>"
},
"company": {
"sid": "<string>"
}
}
}
],
"pagination": {
"next_cursor": "<string>",
"has_more": true,
"total_count": 123
},
"applied_filters": {},
"includes": [
"<string>"
],
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"counts": {
"total_count": 1,
"groups": {
"attribution": {},
"network_type": {},
"referrer_type": {},
"device": {},
"key_page": {}
}
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}Authorizations
Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.
Team scope for tokens that do not carry one. Ignored when the token already names a team.
Body
application/json
Request body of search_website_sessions.
Field filters, ANDed: {field: {eq | ne | in | nin | gte | lte | gt | lt | is_null}}; q inside it is free text. Omit for every row.
Show child attributes
Show child attributes
Relations to attach to every item; omit for the bare rows.
visitor: the browser's row; person and company: the owner's sid (the cards are owed).
Available options:
visitor, person, company One column and its direction; omit for the default order.
Show child attributes
Show child attributes
0..500, default 50; 0 = counts only, 1 = the first row.
Required range:
0 <= x <= 500pagination.next_cursor of the previous page.
Response
search success envelope.
Available options:
true Available options:
search Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes