Get the authenticated Hyros account information including email, timezone, and currency settings.

Search and retrieve leads from Hyros. Filter by email, phone, tag, stage, join date, or last-updated date. Use this to find customers, check their tags and current funnel stage, and sync changes into another system.

Get the complete customer journey for one or more leads: sales, calls, carts, subscriptions, linked leads, and ad attribution sources. Use this to understand what ads drove a customer to convert. Accepts emails directly, so no lookup round-trip is needed.

Retrieve sales records filtered by date, email, lead ID, product tag, or recurring/refund status. Use this to check revenue, see what products sold, and track refunds.

Retrieve call records from Hyros. Useful for businesses with phone sales teams. Filter by date, email, qualification status, or call state.

Retrieve subscription records. Use this to check MRR, see active subscribers, find churned customers, and track subscription status changes.

Get click tracking data for a specific lead. Shows the ad clicks and traffic sources that led a customer to your site.

Get all available tags in your Hyros account as a flat list. Tags starting with $ are product tags, @ are source tags, ! are action tags. Deprecated by Hyros in favour of hyros_get_tags_count, which adds lead counts and pagination.

Get all lead funnel stages configured in your Hyros account (e.g., MQL, SQL, Opportunity, Customer).

Get all verified domains in your Hyros account.

Get ad sources and campaigns tracked in Hyros. Sources represent your marketing channels, campaigns, and ad sets.

Get ads from a specific advertising platform tracked in Hyros.

Get keywords for a specific ad group (mainly for Google Ads keyword tracking).

Get the Hyros tracking script to install on your website.

Get detailed attribution metrics for specific ads, campaigns, or ad sets. Use this to answer "what is my ROAS?", "how much did I earn vs spend?", "which ad has the best ROI?". Requires specifying the level (e.g., facebook_adset, google_campaign) and the IDs to query. Use hyros_get_sources to find source IDs first.

Get attribution metrics grouped by ad account. Provide the ad account ID(s) to get aggregated performance across all campaigns/ads in those accounts.

List tags along with how many leads carry each one. Use this instead of hyros_get_tags when you need sizes, pagination, or to look up one tag.

List the ad accounts connected to Hyros with their id, name, and platform. Call this first to discover the ids that hyros_get_ad_account_report and hyros_get_attribution_report need.

List products in the Hyros catalog with price, cost of goods, and category. Use this before creating a product to avoid duplicates, or to audit the pricing that feeds profit and ROAS reporting.

List custom costs (agency fees, tool subscriptions, offline spend) active in a date window. Use this to audit costs that skew profit and ROAS, especially recurring ones left without an end date.

List shopping carts filtered by purchase status, lead, or date. Set purchased=false to find abandoned carts for a recovery campaign.

List the webhook subscriptions configured on the account, with their target URL, subscribed events, and delivery state. Use this to audit which systems receive Hyros events.

Create a new lead in Hyros. At least one of email or phoneNumbers must be provided. If the email already exists, the lead will be updated with any new information provided.

Update an existing lead in Hyros. At least one search parameter (searchEmail, searchId, or searchPhone) must be provided. Can update email, name, tags, IPs, phone numbers, and funnel stage.

Register a new sale/order in Hyros. This creates a sale record attributed to a lead.

Process a refund for an existing order in Hyros.

Update one or more sale records in Hyros. Can mark sales as recurring, refunded, or update refund amounts.

Permanently delete a sale record from Hyros. This action cannot be undone.

Register a call event in Hyros. Used to track sales calls and attribute them to ad sources.

Update the qualification status or state of existing call records.

Permanently delete a call record from Hyros.

Register a new subscription in Hyros for recurring revenue tracking.

Update existing subscription records. Can change status, price, dates, and cancellation.

Create a new ad source/traffic source in Hyros for tracking custom marketing channels.

Add a custom ad cost in Hyros. Use this to track offline ad spend, influencer payments, or any cost not automatically tracked by Hyros integrations.

Create a new product in Hyros for sale attribution.

Create a new cart in Hyros to track a shopping cart before it converts to an order. Use this when a lead adds items to a cart so Hyros can attribute the eventual purchase.

Update an existing cart in Hyros. Use this to modify items or customer info on a pending cart before it converts to an order.

Manually track a click event in Hyros for attribution purposes. Use when you need to create a click record that was not automatically tracked by the Hyros tracking script.

Permanently erase a lead and its personal data, found by email or id. Use this for GDPR or CCPA right-to-erasure requests. Cannot be undone.

Update a product's price, SKU, cost of goods, or category. Cost of goods feeds profit and ROAS reporting, so correcting it changes historical margins.

Delete a product from the Hyros catalog. Use this to remove one created by mistake or by a duplicate import.

Update a custom cost. The whole cost is replaced, so send every field, not only the ones changing. Use this to fix a wrong amount or to close an open-ended recurring cost by setting endDate.

Delete a custom cost. Use this to stop a mistaken or open-ended recurring cost from skewing profit and ROAS on every report.

Update an ad source: rename it, change its category, goal or traffic source, or toggle its organic and disregarded flags. Sources are addressed by tag, not by id.

Delete an ad source by its tag. Use this to clean up sources created by mistake that clutter every attribution pull. Setting isDisregard via hyros_update_source is the reversible alternative.

Subscribe an endpoint to Hyros events. Returns a secretKey used to verify the X-Hyros-Signature header on delivered payloads; the key is shown only once, so surface it to the user immediately.

Delete a webhook subscription by its externalId. Deliveries stop immediately and the secretKey is not recoverable afterwards.

Get a complete performance summary for today (or a specific date). Returns total revenue from sales, number of new leads, call team performance, and subscription stats. Perfect for answering "how did we do today?" or "what is today's revenue?"

Get the top performing ads/campaigns ranked by revenue, ROAS, ROI, etc. for a given date range. Requires an ad account ID and the level of analysis. Use hyros_get_sources to find your ad account IDs first. Perfect for "what are my best ads this week?" or "which campaigns have the highest ROAS this month?"

Compare ad performance metrics between two date ranges using attribution data. Requires an ad account ID and level. Returns revenue, cost, ROAS, sales, leads, and percentage changes. Perfect for "compare this week vs last week".

Get a complete funnel overview showing the full customer journey from clicks to revenue for a date range. Shows: total leads, calls (with qualification rate), sales (with amounts), subscriptions, and calculates conversion rates between each stage.

Get a health report for your subscription business. Shows active count, MRR (monthly recurring revenue), trial count, churn (canceled this period), past due, and other subscription statuses. Perfect for "what is my MRR?" or "how many active subscribers do I have?"