Get watchlist dashboard
curl --request GET \
--url https://lens-api.tic.io/watchlists/{id}/dashboard \
--header 'x-api-key: <api-key>'import requests
url = "https://lens-api.tic.io/watchlists/{id}/dashboard"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://lens-api.tic.io/watchlists/{id}/dashboard', 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://lens-api.tic.io/watchlists/{id}/dashboard",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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"
"net/http"
"io"
)
func main() {
url := "https://lens-api.tic.io/watchlists/{id}/dashboard"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://lens-api.tic.io/watchlists/{id}/dashboard")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://lens-api.tic.io/watchlists/{id}/dashboard")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"watchListGuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"watchListName": "<string>",
"watchListDescription": "<string>",
"lastUpdatedAtUtc": "2023-11-07T05:31:56Z",
"lastEventAtUtc": "2023-11-07T05:31:56Z",
"recentEvents": [
{
"eventId": 123,
"memberGuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subType": "<string>",
"eventDate": "2023-11-07T05:31:56Z",
"isAcknowledged": true,
"entityType": "<string>",
"entityName": "<string>",
"entityId": 123
}
],
"eventBreakdown": {
"companyEvents": 123,
"personEvents": 123,
"addressEvents": 123,
"propertyEvents": 123,
"vehicleEvents": 123,
"totalEvents": 123
},
"totalMembers": 123,
"unacknowledgedEventCount": 123
}Watchlist
Get watchlist dashboard
Returns a bundled dashboard for a single watchlist: event breakdown by entity type, total/unacknowledged event counts, latest event timestamp, and the most recent events with entity details. Avoids several round-trips the UI would otherwise need.
GET
/
watchlists
/
{id}
/
dashboard
Get watchlist dashboard
curl --request GET \
--url https://lens-api.tic.io/watchlists/{id}/dashboard \
--header 'x-api-key: <api-key>'import requests
url = "https://lens-api.tic.io/watchlists/{id}/dashboard"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://lens-api.tic.io/watchlists/{id}/dashboard', 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://lens-api.tic.io/watchlists/{id}/dashboard",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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"
"net/http"
"io"
)
func main() {
url := "https://lens-api.tic.io/watchlists/{id}/dashboard"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://lens-api.tic.io/watchlists/{id}/dashboard")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://lens-api.tic.io/watchlists/{id}/dashboard")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"watchListGuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"watchListName": "<string>",
"watchListDescription": "<string>",
"lastUpdatedAtUtc": "2023-11-07T05:31:56Z",
"lastEventAtUtc": "2023-11-07T05:31:56Z",
"recentEvents": [
{
"eventId": 123,
"memberGuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subType": "<string>",
"eventDate": "2023-11-07T05:31:56Z",
"isAcknowledged": true,
"entityType": "<string>",
"entityName": "<string>",
"entityId": 123
}
],
"eventBreakdown": {
"companyEvents": 123,
"personEvents": 123,
"addressEvents": 123,
"propertyEvents": 123,
"vehicleEvents": 123,
"totalEvents": 123
},
"totalMembers": 123,
"unacknowledgedEventCount": 123
}Pro+ tier
Authorizations
Path Parameters
Watchlist GUID
Query Parameters
Number of recent events to include (1–25, default 10)
Response
Dashboard bundle
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I