Skip to main content
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>'
{
  "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",
      "eventType": "companyAddress",
      "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

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Watchlist GUID

Query Parameters

recentEventCount
integer<int32>
default:10

Number of recent events to include (1–25, default 10)

Response

Dashboard bundle

watchListGuid
string<uuid>
watchListName
null | string
watchListDescription
null | string
lastUpdatedAtUtc
string<date-time>
lastEventAtUtc
null | string<date-time>
recentEvents
null | object[]
eventBreakdown
object
totalMembers
integer<int32>
unacknowledgedEventCount
integer<int32>