Hyros icon

Hyros

Interact with Hyros API - Complete coverage of all endpoints

Actions60

Click → Get

AI-generated

Summary

Retrieve click events associated with leads by filtering with exactly one of Lead ID, Lead IDs, or Emails. Pagination and date range filters optionally supported.

Inputs

  • filters — Optional filters to narrow down click events. Provide exactly one of Lead ID (single), Lead IDs (comma-separated list, max 50), or Emails (comma-separated list, max 50). Additional optional filters include From Date, To Date, Page ID for pagination, and Page Size (0-250).

Output shape

A list of click records matching the specified filters.

The API requires exactly one of leadId, leadIds, or emails filters. The 'email' filter is deprecated. Pagination is supported via Page ID and Page Size filters. Date range filters can restrict clicks to a specific timeframe. Emails are matched ignoring case and may resolve to multiple leads, returning clicks for all matched leads. Lead IDs or Emails that cannot be resolved are skipped; if none match, an empty result is returned.

Examples

Example 1: Get all clicks for a specific lead by its ID

Set 'Lead ID' filter to the desired lead's identifier.

Example 2: Get all clicks associated with a user's email

Set 'Email' filter to the specific email address.

Links

Discussion