Search history
shieldlabs_search_historyRetrieve individual ShieldLabs identifications by user, device, visitor, IP, session, or cookie, newest first, with paging for account and device investigations.
Instructions
List identifications for one identifier from the ShieldLabs History API, newest first, with paging.
Use it to see individual identifications of an account (user_hid), a device (device_id), a browser visitor (visitor_id), a cookie (cookie_id), a visit (session_id) or an IPv4 address (ip). For counts and aggregates over many identifications, prefer shieldlabs_summarize_entity.
Args:
type ('request_id' | 'user_hid' | 'device_id' | 'visitor_id' | 'ip' | 'session_id' | 'cookie_id')
value (string): UUID for the ID types, dotted IPv4 for ip, exact User HID for user_hid
limit (number): 1-100, default 20
offset (number): default 0
response_format ('markdown' | 'json'): default 'markdown'
Returns (json): { "lookup": { type, value }, "total": number, "count": number, "offset": number, "limit": number, "has_more": boolean, "next_offset": number (only when has_more), "identifications": [same shape as shieldlabs_get_identification], "untrusted_data_note": string, "truncated"?: boolean, "truncation_message"?: string }
Examples:
Every identification of one account: type="user_hid", value=""
Which accounts used this device: type="device_id", value=""
Next page: repeat with offset=next_offset
Errors: invalid values are refused before any request (UUID or IPv4 expected; IPv6 is not searchable; a User HID that contains "/" cannot be searched). 401 means a wrong key; 429 means the History API rate limit (about 15 requests per second per domain) was reached.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | Identifier to search by: request_id (one identification), user_hid (one of your accounts, exact and case-sensitive), device_id (one device), visitor_id (one browser visitor), ip (IPv4 only), session_id (one visit) or cookie_id (one browser profile) | |
| limit | No | Identifications per page, from 1 to 100 (default 20) | |
| value | Yes | Identifier value: a UUID for request_id, device_id, visitor_id, session_id and cookie_id; a dotted IPv4 address such as 203.0.113.24 for ip; the exact User HID string for user_hid ("anonymous" lists anonymous checks; a User HID that contains "/" cannot be searched) | |
| offset | No | Number of identifications to skip, for paging (default 0). Use next_offset from the previous page. | |
| response_format | No | Output format: 'markdown' (default) for readable text, 'json' for structured data | markdown |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | Identifications in this response | |
| limit | Yes | ||
| total | Yes | Identifications matching the lookup | |
| lookup | Yes | ||
| offset | Yes | ||
| has_more | Yes | ||
| truncated | No | ||
| next_offset | No | ||
| identifications | Yes | ||
| truncation_message | No | ||
| untrusted_data_note | Yes |