Hyros icon

Hyros

Interact with Hyros API - Complete coverage of all endpoints

Actions60

Conversion Path → Get Many

AI-generated

Summary

Retrieve conversion paths from Hyros, optionally filtered by conversion type, date range, and attribution window. Results can be paginated or fetched up to a specified limit.

Inputs

  • Conversion Type (required) — Choose Call, Lead, or Sale. This determines which conversion date is used for the date range; Sale is the default. Call and Sale paths run up to the conversion date, while Lead returns the lead’s full touch list.
  • Return All — When enabled, fetch all available results using pagination. Otherwise, return up to the Limit.
  • Limit — Maximum number of results when Return All is disabled; defaults to 50 and accepts values from 1 to 250.
  • Attribution Window (Days) — Exclude touches that occurred more than this many days before the conversion. Defaults to 0, which leaves the stored path unbounded; the window can only narrow it. Values range from 0 to 365.
  • From Date — Filter for conversions more recent than this date. Future months are not allowed.
  • To Date — Filter for conversions older than this date. Future months are not allowed.
  • Page ID — ID of the next page to retrieve.

Output shape

A list of conversion path results.

Return All uses pagination; otherwise the list is capped by Limit. Each path’s contents depend on the selected conversion type.

Links

Discussion