canonical: https://jentic.com/apis/hyros.com/hyros

# Hyros API

Jentic publishes the only available OpenAPI specification for Hyros API, keeping it validated and agent-ready. Hyros is an ad attribution and tracking platform used by direct-response advertisers to tie ad spend to revenue across paid channels. The API exposes three core write endpoints that let you submit lead records, log sales transactions, and record custom user events so Hyros can stitch them into multi-touch attribution reports. It is suited for ingesting first-party conversion data from checkout pages, CRMs, and call centres into the Hyros tracking model.

## For AI agents

Send leads, sales, and custom user events into Hyros for ad attribution and conversion tracking. Useful for piping CRM and checkout data into paid-media reporting.

## Scope

Does not handle ad campaign creation, audience management, or reporting reads - use for submitting leads, sales, and custom events into Hyros only.

## Capabilities

- Submit a new lead record with email, phone, and tracking identifiers to `/v1/leads`
- Log a completed sale transaction with amount, currency, and customer identifiers to `/v1/sales`
- Record a custom user event such as a webinar registration or upsell click to `/v1/events`
- Tie offline conversions back to ad clicks by including Hyros tracking IDs on submitted records
- Stream checkout and CRM events into Hyros for multi-touch attribution reporting

## Use cases

### Offline Conversion Import

Push closed-won deals from a CRM into Hyros so phone and field sales are attributed to the ad click that generated the lead. Records sent to `/v1/sales` include the original tracking ID, currency, and amount so Hyros can credit the right ad source. Typical setup wires a CRM webhook to a Jentic toolkit and runs in under a day.

Example prompt: Post a sale of 1499.00 USD with the lead email and Hyros tracking ID to `/v1/sales` when a CRM deal moves to Closed Won.

### Checkout Lead Capture

Submit lead records from a checkout or opt-in form to Hyros via `/v1/leads` as soon as the visitor enters contact details, before payment completes. This lets Hyros track the visitor across devices and attribute the eventual sale to the original ad. Useful for funnels with a two-step checkout or a high-ticket offer that closes by phone.

Example prompt: Send a lead with email, first name, and the visitor's Hyros click ID to `/v1/leads` when an opt-in form is submitted.

### Custom Event Logging

Record arbitrary funnel events such as webinar registrations, demo bookings, or upsell views to `/v1/events` so they appear alongside leads and sales in Hyros reports. Each event carries a name, a timestamp, and the user identifier needed to link it to an existing tracked visitor. This makes it possible to optimise paid campaigns against intermediate funnel signals, not only purchases.

Example prompt: Send a custom event named webinar_registered with the user email and timestamp to `/v1/events` when a registration is confirmed.

### AI Agent Conversion Sync

An AI agent triggered by a CRM or e-commerce platform searches Jentic for the Hyros operation that submits a sale, loads its schema, and posts the conversion. Because Hyros has only a handful of endpoints, an agent can cover the full reporting surface with three operations and reliably reconcile conversion data without hand-rolled integration code. Typical end-to-end agent integration is under one hour through Jentic.

Example prompt: Use Jentic search for 'log a sale in Hyros', load the `/v1/sales` schema, and post the order with tracking ID, amount, and currency.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/leads` | Submit a new lead record |
| POST | `/v1/sales` | Log a sale transaction |
| POST | `/v1/events` | Record a custom user event |

## Key resources

- **Leads** — Submit new lead records with tracking identifiers
- **Sales** — Log sales transactions with amount and currency
- **Events** — Record custom user events for funnel tracking

## Why Jentic

- **Setup:** Wiring the Hyros API by hand means setting up bearer-token auth and shaping each lead, sale, and event payload to its ingestion contract yourself. Through Jentic you install once, import the Hyros API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Hyros takes the target lead, sale, or event in the request body rather than a URL path, so limit the agent to the operations it needs, such as submitting leads or logging events. You choose that allowed set, so an agent that only records events cannot post sales unless you add that operation.
- **Credential handling:** Your Hyros token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'submit a new lead to Hyros' or 'record a sale event', and Jentic returns the matching Hyros operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mixpanel API** — Mixpanel tracks product events for behavioural analytics; Hyros tracks ad-attributed conversions for paid-media reporting.
- **Segment API** — Segment fans out a single event stream to multiple destinations, including ad-tracking tools like Hyros.
- **Amplitude API** — Amplitude focuses on product analytics and cohort behaviour; Hyros focuses on ad-channel attribution.

## FAQ

### Why is there no official OpenAPI spec for Hyros API?

Hyros does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Hyros API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Hyros API use?

The Hyros API uses HTTP bearer token authentication. Through Jentic, the Hyros bearer token is stored in your Jentic One instance and never enters the agent's prompt context - agents call Hyros operations using a scoped Jentic credential instead of the raw token.

### Can I submit offline sales to Hyros through this API?

Yes. POST a record to `/v1/sales` with the customer email, the original Hyros tracking ID, the sale amount, and the currency. Hyros uses the tracking ID to attribute the offline sale back to the ad click that generated the lead.

### How many endpoints does the Hyros API expose?

The current spec covers three POST endpoints: `/v1/leads`, `/v1/sales`, and `/v1/events.` These are the write operations Hyros uses to ingest funnel data - read-side reporting is done in the Hyros dashboard, not via this API.

### How do I send a custom event to Hyros through Jentic?

Search Jentic for 'log a custom event in Hyros', load the `/v1/events` schema, and execute the call with the event name, timestamp, and user identifier. Install the SDK with pip install jentic and run the search, load, and execute steps with await.

### What are the rate limits for the Hyros API?

The published spec does not declare rate limits. Hyros enforces account-level limits documented in their developer portal at hyros.com - start with conservative batching (a few requests per second) and back off on 429 responses.

### Can I limit what my agent is allowed to do with the Hyros API?

Yes. Because you run Jentic One yourself and set its rules, you decide which of the three Hyros write operations the agent may call: submitting leads to `/v1/leads`, logging sales to `/v1/sales`, or recording custom events to `/v1/events.` Hyros takes the target lead, sale, or event in the request body rather than a URL path, so you scope access at the operation level. An agent granted only event logging cannot post a sale unless you add that operation to its allowed set.