Hyros Ontology
license: https://creativecommons.org/licenses/by/4.0/
publisher: inferal.com
preferred namespace prefix: hyros

Success Response
type: Class
comment: Acknowledgement envelope for mutating operations (POST/PUT/DELETE). `result` is the literal string `"OK"` on success.

Provider
type: Class
subclass of: Thing

Provider Integration
type: Class
comment: Integration metadata attached to a `Provider`. Distinct named model so that downstream contracts (and generated SDKs) get a stable type to reference.
subclass of: Thing

Price
type: Class
subclass of: PriceSpecification

Ad Source
type: Class
subclass of: Thing

Ad List Item Response
type: Class

Source
type: Class
subclass of: Thing

Traffic Source
type: Class
subclass of: Thing

Goal
type: Class
subclass of: Thing

Category
type: Class
subclass of: CategoryCode

Ad Inventory
type: Class
subclass of: Thing

Source Link Ad
type: Class
subclass of: Thing

Attribution
type: Class
subclass of: Thing

Attribution Report
type: Class
subclass of: Thing

Ad Account Report
type: Class
subclass of: Thing

Lead
type: Class
subclass of: Person

Lead Journey
type: Class
subclass of: Thing

Sale
type: Class
subclass of: Order

Product
type: Class
subclass of: Product

Call
type: Class
subclass of: Event

Call Qualification
type: Class
comment: Qualification stage label attached to a call. Hyros lets users rename qualification stages over time; `oldName` preserves the prior label so historical filters/reports keep working after a rename.
subclass of: Thing

Lead Journey Cart Item
type: Class
comment: Cart shape as it appears inside a lead's journey response. Named so downstream contracts have a stable type when handling `GET /leads/journey` results — the shape differs slightly from the cart creation/update payload (carries `events` count + attribution).
subclass of: Order

Cart Item
type: Class
subclass of: OrderItem

Item
type: Class
subclass of: OrderItem

Subscription
type: Class
subclass of: Order

Webhook Lead Child
type: Class
comment: Minimal lead reference inside a webhook payload.
subclass of: Person

Webhook Lead
type: Class
comment: Full lead shape as it appears inside webhook payloads.
subclass of: Person
subclass of: Webhook Lead Child

Webhook Product
type: Class
comment: Product shape inside webhook payloads.
subclass of: Product

Webhook Attribution
type: Class
comment: Attribution shape as it appears inside webhook payloads. Extends the REST `Attribution` model with `UTCClickDate`, a webhook-only field that the REST API does not expose.
subclass of: Attribution

Webhook Sale Entity
type: Class
comment: Sale entity inside `sale.attributed` webhook bodies.
subclass of: Order

Webhook Lead Opt In Entity
type: Class
comment: Lead opt-in entity inside `lead.opted.in` webhook bodies.
subclass of: SubscribeAction

Webhook Lead Origin Assigned Entity
type: Class
comment: Origin-assignment entity inside `lead.origin.assigned` webhook bodies.
subclass of: Thing

Webhook Call Entity
type: Class
comment: Call entity inside `call.attributed` webhook bodies.
subclass of: Event

Webhook Event Base
type: Class
comment: Common envelope on every webhook event. The consumer must dedupe on `eventId` — Hyros does not guarantee exactly-once delivery.
subclass of: Thing

Sale Attributed Event
type: Class
comment: `sale.attributed` — fired when a sale is connected to a lead.
subclass of: Webhook Event Base

Lead Opt In Event
type: Class
comment: `lead.opted.in` — fired when a lead subscribes / opts in.
subclass of: Webhook Event Base

Lead Origin Assigned Event
type: Class
comment: `lead.origin.assigned` — fired when a lead becomes the origin of another lead.
subclass of: Webhook Event Base

Call Attributed Event
type: Class
comment: `call.attributed` — fired when a call is connected to a lead.
subclass of: Webhook Event Base

AdspendType
type: ConceptScheme
has top concept: Facebook
has top concept: Google
has top concept: Tiktok
has top concept: Snapchat
has top concept: Linkedin
has top concept: Twitter
has top concept: Pinterest
has top concept: Bing

Facebook
type: Concept
in scheme: AdspendType
top concept of: AdspendType
alternative label: FACEBOOK
notation: FACEBOOK

Google
type: Concept
in scheme: AdspendType
top concept of: AdspendType
alternative label: GOOGLE
notation: GOOGLE

Tiktok
type: Concept
in scheme: AdspendType
top concept of: AdspendType
alternative label: TIKTOK
notation: TIKTOK

Snapchat
type: Concept
in scheme: AdspendType
top concept of: AdspendType
alternative label: SNAPCHAT
notation: SNAPCHAT

Linkedin
type: Concept
in scheme: AdspendType
top concept of: AdspendType
alternative label: LINKEDIN
notation: LINKEDIN

Twitter
type: Concept
in scheme: AdspendType
top concept of: AdspendType
alternative label: TWITTER
notation: TWITTER

Pinterest
type: Concept
in scheme: AdspendType
top concept of: AdspendType
alternative label: PINTEREST
notation: PINTEREST

Bing
type: Concept
in scheme: AdspendType
top concept of: AdspendType
alternative label: BING
notation: BING

CallState
type: ConceptScheme
has top concept: Qualified
has top concept: Unqualified
has top concept: Cancelled
has top concept: No Show

Qualified
type: Concept
in scheme: CallState
top concept of: CallState
alternative label: QUALIFIED
notation: QUALIFIED

Unqualified
type: Concept
in scheme: CallState
top concept of: CallState
alternative label: UNQUALIFIED
notation: UNQUALIFIED

Cancelled
type: Concept
in scheme: CallState
top concept of: CallState
alternative label: CANCELLED
notation: CANCELLED

No Show
type: Concept
in scheme: CallState
top concept of: CallState
alternative label: NO_SHOW
notation: NO_SHOW

LeadOriginMechanism
type: ConceptScheme
comment: Mechanism by which a lead was assigned as origin of another lead. Used exclusively by `WebhookLeadOriginAssignedEntity.mechanism` — declared here (in the REST namespace) because the body entity it belongs to is co-located with the other webhook body shapes.
has top concept: Session Id
has top concept: Phone Number
has top concept: Ip
has top concept: Manual

Session Id
type: Concept
in scheme: LeadOriginMechanism
top concept of: LeadOriginMechanism
alternative label: SESSION_ID
notation: SESSION_ID

Phone Number
type: Concept
in scheme: LeadOriginMechanism
top concept of: LeadOriginMechanism
alternative label: PHONE_NUMBER
notation: PHONE_NUMBER

Ip
type: Concept
in scheme: LeadOriginMechanism
top concept of: LeadOriginMechanism
alternative label: IP
notation: IP

Manual
type: Concept
in scheme: LeadOriginMechanism
top concept of: LeadOriginMechanism
alternative label: MANUAL
notation: MANUAL

SubscriptionStatus
type: ConceptScheme
has top concept: Active
has top concept: Trialing
has top concept: Canceled
has top concept: Past Due
has top concept: Incomplete
has top concept: Incomplete Expired
has top concept: Unpaid
has top concept: Completed
has top concept: Paused

Active
type: Concept
in scheme: SubscriptionStatus
top concept of: SubscriptionStatus
alternative label: ACTIVE
notation: ACTIVE

Trialing
type: Concept
in scheme: SubscriptionStatus
top concept of: SubscriptionStatus
alternative label: TRIALING
notation: TRIALING

Canceled
type: Concept
in scheme: SubscriptionStatus
top concept of: SubscriptionStatus
alternative label: CANCELED
notation: CANCELED

Past Due
type: Concept
in scheme: SubscriptionStatus
top concept of: SubscriptionStatus
alternative label: PAST_DUE
notation: PAST_DUE

Incomplete
type: Concept
in scheme: SubscriptionStatus
top concept of: SubscriptionStatus
alternative label: INCOMPLETE
notation: INCOMPLETE

Incomplete Expired
type: Concept
in scheme: SubscriptionStatus
top concept of: SubscriptionStatus
alternative label: INCOMPLETE_EXPIRED
notation: INCOMPLETE_EXPIRED

Unpaid
type: Concept
in scheme: SubscriptionStatus
top concept of: SubscriptionStatus
alternative label: UNPAID
notation: UNPAID

Completed
type: Concept
in scheme: SubscriptionStatus
top concept of: SubscriptionStatus
alternative label: COMPLETED
notation: COMPLETED

Paused
type: Concept
in scheme: SubscriptionStatus
top concept of: SubscriptionStatus
alternative label: PAUSED
notation: PAUSED

platform
type: ConceptScheme
has top concept: Facebook
has top concept: Google
has top concept: Tiktok
has top concept: Snapchat
has top concept: Linkedin
has top concept: Twitter
has top concept: Pinterest
has top concept: Bing
has top concept: Google V2

Facebook
type: Concept
in scheme: platform
top concept of: platform
alternative label: FACEBOOK
notation: FACEBOOK

Google
type: Concept
in scheme: platform
top concept of: platform
alternative label: GOOGLE
notation: GOOGLE

Tiktok
type: Concept
in scheme: platform
top concept of: platform
alternative label: TIKTOK
notation: TIKTOK

Snapchat
type: Concept
in scheme: platform
top concept of: platform
alternative label: SNAPCHAT
notation: SNAPCHAT

Linkedin
type: Concept
in scheme: platform
top concept of: platform
alternative label: LINKEDIN
notation: LINKEDIN

Twitter
type: Concept
in scheme: platform
top concept of: platform
alternative label: TWITTER
notation: TWITTER

Pinterest
type: Concept
in scheme: platform
top concept of: platform
alternative label: PINTEREST
notation: PINTEREST

Bing
type: Concept
in scheme: platform
top concept of: platform
alternative label: BING
notation: BING

Google V2
type: Concept
in scheme: platform
top concept of: platform
alternative label: GOOGLE_V2
notation: GOOGLE_V2

platform
type: ConceptScheme
has top concept: Facebook
has top concept: Google
has top concept: Tiktok
has top concept: Snapchat
has top concept: Linkedin
has top concept: Twitter
has top concept: Pinterest
has top concept: Bing
has top concept: Google V2

Facebook
type: Concept
in scheme: platform
top concept of: platform
alternative label: FACEBOOK
notation: FACEBOOK

Google
type: Concept
in scheme: platform
top concept of: platform
alternative label: GOOGLE
notation: GOOGLE

Tiktok
type: Concept
in scheme: platform
top concept of: platform
alternative label: TIKTOK
notation: TIKTOK

Snapchat
type: Concept
in scheme: platform
top concept of: platform
alternative label: SNAPCHAT
notation: SNAPCHAT

Linkedin
type: Concept
in scheme: platform
top concept of: platform
alternative label: LINKEDIN
notation: LINKEDIN

Twitter
type: Concept
in scheme: platform
top concept of: platform
alternative label: TWITTER
notation: TWITTER

Pinterest
type: Concept
in scheme: platform
top concept of: platform
alternative label: PINTEREST
notation: PINTEREST

Bing
type: Concept
in scheme: platform
top concept of: platform
alternative label: BING
notation: BING

Google V2
type: Concept
in scheme: platform
top concept of: platform
alternative label: GOOGLE_V2
notation: GOOGLE_V2

creation epoch
type: Property

ad account id
type: Property
comment: Query alias: 2 models declare adAccountId.

ad source
type: Property
comment: Query alias: 3 models declare adSource.

ad source id
type: Property
comment: Query alias: 3 models declare adSourceId.

aov
type: Property
comment: Query alias: 2 models declare aov.

attribution
type: Property
comment: Query alias: 3 models declare attribution.

attribution model
type: Property
comment: Query alias: 2 models declare attributionModel.

cac
type: Property
comment: Query alias: 2 models declare cac.

campaign id
type: Property
comment: Query alias: 1 model declares campaignId.

cancel at date
type: Property
comment: Query alias: 1 model declares cancelAtDate.

carts
type: Property
comment: Query alias: 1 model declares carts.

category
type: Property
comment: Query alias: 5 models declare category.

category name
type: Property
comment: Query alias: 1 model declares categoryName.

child lead
type: Property
comment: Query alias: 1 model declares childLead.

click date
type: Property
comment: Query alias: 1 model declares clickDate.

click id
type: Property
comment: Query alias: 1 model declares clickId.

cost
type: Property
comment: Query alias: 2 models declare cost.

cost of goods
type: Property
comment: Query alias: 1 model declares costOfGoods.

cost per sale
type: Property
comment: Query alias: 2 models declare costPerSale.

creation epoch
type: Property
comment: Query alias: 1 model declares creationEpoch.

currency
type: Property
comment: Query alias: 1 model declares currency.

discount
type: Property
comment: Query alias: 1 model declares discount.

disregarded
type: Property
comment: Query alias: 2 models declare disregarded.

email
type: Property
comment: Query alias: 2 models declare email.

event id
type: Property
comment: Query alias: 1 model declares eventId.

events
type: Property
comment: Query alias: 1 model declares events.

external id
type: Property
comment: Query alias: 3 models declare externalId.

first name
type: Property
comment: Query alias: 2 models declare firstName.

first optin
type: Property
comment: Query alias: 1 model declares firstOptin.

gbra id
type: Property
comment: Query alias: 1 model declares gbraId.

gcl id
type: Property
comment: Query alias: 1 model declares gclId.

goal
type: Property
comment: Query alias: 2 models declare goal.

hard cost
type: Property
comment: Query alias: 1 model declares hardCost.

id
type: Property
comment: Query alias: 17 models declare id.

integration
type: Property
comment: Query alias: 1 model declares integration.

ips
type: Property
comment: Query alias: 2 models declare ips.

item discount
type: Property
comment: Query alias: 1 model declares itemDiscount.

join date
type: Property
comment: Query alias: 1 model declares joinDate.

last name
type: Property
comment: Query alias: 2 models declare lastName.

linked leads
type: Property
comment: Query alias: 1 model declares linkedLeads.

matching values
type: Property
comment: Query alias: 1 model declares matchingValues.

mechanism
type: Property
comment: Query alias: 1 model declares mechanism.

name
type: Property
comment: Query alias: 16 models declare name.

net profit
type: Property
comment: Query alias: 2 models declare netProfit.

new customers percentage
type: Property
comment: Query alias: 2 models declare newCustomersPercentage.

old name
type: Property
comment: Query alias: 1 model declares oldName.

order id
type: Property
comment: Query alias: 3 models declare orderId.

organic
type: Property
comment: Query alias: 2 models declare organic.

origin lead
type: Property
comment: Query alias: 1 model declares originLead.

packages
type: Property
comment: Query alias: 1 model declares packages.

periodicity
type: Property
comment: Query alias: 1 model declares periodicity.

phone numbers
type: Property
comment: Query alias: 2 models declare phoneNumbers.

plan id
type: Property
comment: Query alias: 1 model declares planId.

platform
type: Property
comment: Query alias: 2 models declare platform.

products
type: Property
comment: Query alias: 1 model declares products.

provider
type: Property
comment: Query alias: 5 models declare provider.

qualification
type: Property
comment: Query alias: 1 model declares qualification.

qualified
type: Property
comment: Query alias: 4 models declare qualified.

quantity
type: Property
comment: Query alias: 4 models declare quantity.

recurring
type: Property
comment: Query alias: 2 models declare recurring.

recurring customers
type: Property
comment: Query alias: 2 models declare recurringCustomers.

recurring revenue
type: Property
comment: Query alias: 2 models declare recurringRevenue.

referrer url
type: Property
comment: Query alias: 1 model declares referrerUrl.

refund
type: Property
comment: Query alias: 2 models declare refund.

refund count
type: Property
comment: Query alias: 2 models declare refundCount.

refunded
type: Property
comment: Query alias: 1 model declares refunded.

refund sales percentage
type: Property
comment: Query alias: 2 models declare refundSalesPercentage.

request id
type: Property
comment: Query alias: 1 model declares request_id.

result
type: Property
comment: Query alias: 1 model declares result.

revenue
type: Property
comment: Query alias: 2 models declare revenue.

roas
type: Property
comment: Query alias: 2 models declare roas.

score
type: Property
comment: Query alias: 4 models declare score.

sku
type: Property
comment: Query alias: 2 models declare sku.

source
type: Property
comment: Query alias: 1 model declares source.

source link ad
type: Property
comment: Query alias: 1 model declares sourceLinkAd.

source link id
type: Property
comment: Query alias: 1 model declares sourceLinkId.

state
type: Property
comment: Query alias: 1 model declares state.

status
type: Property
comment: Query alias: 1 model declares status.

subscription id
type: Property
comment: Query alias: 2 models declare subscriptionId.

tag
type: Property
comment: Query alias: 8 models declare tag.

tags
type: Property
comment: Query alias: 2 models declare tags.

taxes
type: Property
comment: Query alias: 1 model declares taxes.

timestamp
type: Property
comment: Query alias: 1 model declares timestamp.

total revenue
type: Property
comment: Query alias: 2 models declare totalRevenue.

traffic source
type: Property
comment: Query alias: 2 models declare trafficSource.

trial end date
type: Property
comment: Query alias: 1 model declares trialEndDate.

trial start date
type: Property
comment: Query alias: 1 model declares trialStartDate.

type
type: Property
comment: Query alias: 8 models declare type.

unique customers
type: Property
comment: Query alias: 2 models declare uniqueCustomers.

unique sales
type: Property
comment: Query alias: 2 models declare uniqueSales.

usdprice
type: Property
comment: Query alias: 1 model declares USDPrice.

utcclick date
type: Property
comment: Query alias: 1 model declares UTCClickDate.

utcdate
type: Property
comment: Query alias: 4 models declare UTCDate.

utcjoin date
type: Property
comment: Query alias: 1 model declares UTCJoinDate.

wbra id
type: Property
comment: Query alias: 1 model declares wbraId.

request id
type: Property
alternate name: request_id
sub property of: request id
domain: Success Response
range: string

result
type: Property
comment: Literal `"OK"` on success.
alternate name: result
sub property of: result
domain: Success Response
range: string

id
type: Property
comment: ID of lead in external platform.
alternate name: id
sub property of: id
sub property of: identifier
domain: Provider
range: string

integration
type: Property
comment: Details of the integration that originated the record.
alternate name: integration
sub property of: integration
domain: Provider
range: Provider Integration

name
type: Property
comment: Human-readable integration name (e.g. "Stripe", "ClickFunnels").
alternate name: name
sub property of: name
domain: Provider Integration
range: string

type
type: Property
comment: Integration platform type (provider classification).
alternate name: type
sub property of: type
domain: Provider Integration
range: string

id
type: Property
comment: Account ID of the integration in the external platform.
alternate name: id
sub property of: id
sub property of: identifier
domain: Provider Integration
range: string

currency
type: Property
alternate name: currency
sub property of: currency
sub property of: priceCurrency
domain: Price
range: string

price
type: Property
alternate name: price
sub property of: price
domain: Price
range: double

discount
type: Property
alternate name: discount
sub property of: discount
domain: Price
range: double

hard cost
type: Property
alternate name: hardCost
sub property of: hard cost
domain: Price
range: double

refunded
type: Property
alternate name: refunded
sub property of: refunded
domain: Price
range: double

ad source id
type: Property
alternate name: adSourceId
sub property of: ad source id
sub property of: identifier
domain: Ad Source
range: string

ad account id
type: Property
alternate name: adAccountId
sub property of: ad account id
domain: Ad Source
range: string

platform
type: Property
comment: Source platform. `AdspendType` is the REST API's enum and includes `BING`, but Hyros's webhook spec omits `BING` from its `AdSource.platform` list — webhook payloads will never carry that value even though the type permits it. REST responses can. Live REST inventory also returns versioned Google platform values such as `GOOGLE_V2`.
alternate name: platform
sub property of: platform
domain: Ad Source
range: string
code list: platform

name
type: Property
comment: Ad or campaign display name returned by `/api/v1.0/ads`.
alternate name: name
sub property of: name
domain: Ad List Item Response
range: string

ad source
type: Property
comment: Raw nested ad source returned by `/api/v1.0/ads`.
alternate name: adSource
sub property of: ad source
domain: Ad List Item Response
range: Ad Source

source
type: Property
comment: Raw nested Hyros source returned by `/api/v1.0/ads`.
alternate name: source
sub property of: source
domain: Ad List Item Response
range: Source

creation date
type: Property
comment: Unix epoch milliseconds returned by `/api/v1.0/ads`.
alternate name: creationDate
domain: Ad List Item Response
range: integer

name
type: Property
alternate name: name
sub property of: name
domain: Source
range: string

tag
type: Property
alternate name: tag
sub property of: tag
sub property of: keywords
domain: Source
range: string

disregarded
type: Property
alternate name: disregarded
sub property of: disregarded
domain: Source
range: boolean

organic
type: Property
alternate name: organic
sub property of: organic
domain: Source
range: boolean

ad source
type: Property
alternate name: adSource
sub property of: ad source
domain: Source
range: Ad Source

traffic source
type: Property
alternate name: trafficSource
sub property of: traffic source
domain: Source
range: Traffic Source

goal
type: Property
alternate name: goal
sub property of: goal
domain: Source
range: Goal

category
type: Property
alternate name: category
sub property of: category
domain: Source
range: Category

creation epoch
type: Property
comment: Unix epoch seconds (per Hyros source spec — NOT ISO 8601 like `creationDate` on Lead/Sale/Call/Subscription). Wire field is `creationDate`; renamed to `creationEpoch` in TypeSpec so the RDF predicate (`hyros:creationEpoch`) is distinct from the string-typed `hyros:creationDate` used by other entities. This avoids a SHACL datatype contradiction (xsd:integer on Source vs xsd:string in the ontology's predicate range declaration).
alternate name: creationDate
sub property of: creation epoch
domain: Source
range: integer

id
type: Property
alternate name: id
sub property of: id
sub property of: identifier
domain: Traffic Source
range: string

name
type: Property
alternate name: name
sub property of: name
domain: Traffic Source
range: string

id
type: Property
alternate name: id
sub property of: id
sub property of: identifier
domain: Goal
range: string

name
type: Property
alternate name: name
sub property of: name
domain: Goal
range: string

id
type: Property
alternate name: id
sub property of: id
sub property of: identifier
domain: Category
range: string

name
type: Property
alternate name: name
sub property of: name
domain: Category
range: string

name
type: Property
comment: Ad or campaign display name derived from `/api/v1.0/ads`.
alternate name: name
sub property of: name
domain: Ad Inventory
range: string

ad source id
type: Property
comment: Ad source id flattened from `adSource.adSourceId`.
alternate name: adSourceId
sub property of: ad source id
sub property of: identifier
domain: Ad Inventory
range: string

ad account id
type: Property
comment: Ad account id flattened from `adSource.adAccountId`.
alternate name: adAccountId
sub property of: ad account id
domain: Ad Inventory
range: string

platform
type: Property
comment: Platform flattened from `adSource.platform`; live REST can return `GOOGLE_V2`.
alternate name: platform
sub property of: platform
domain: Ad Inventory
range: string
code list: platform

creation date
type: Property
comment: Unix epoch milliseconds from `/api/v1.0/ads`. This wire field remains `creationDate`, but its RDF predicate is mapped to `hyros:creationEpoch` to avoid conflicting with ISO/date-like `creationDate` fields on other Hyros entities.
alternate name: creationDate
sub property of: creation epoch
domain: Ad Inventory
range: integer

name
type: Property
alternate name: name
sub property of: name
domain: Source Link Ad
range: string

ad source id
type: Property
alternate name: adSourceId
sub property of: ad source id
domain: Source Link Ad
range: string

source link id
type: Property
alternate name: sourceLinkId
sub property of: source link id
sub property of: identifier
domain: Attribution
range: string

name
type: Property
alternate name: name
sub property of: name
domain: Attribution
range: string

tag
type: Property
alternate name: tag
sub property of: tag
sub property of: keywords
domain: Attribution
range: string

disregarded
type: Property
alternate name: disregarded
sub property of: disregarded
domain: Attribution
range: boolean

organic
type: Property
alternate name: organic
sub property of: organic
domain: Attribution
range: boolean

click date
type: Property
alternate name: clickDate
sub property of: click date
sub property of: dateCreated
domain: Attribution
range: dateTime

click id
type: Property
alternate name: clickId
sub property of: click id
domain: Attribution
range: string

ad source
type: Property
alternate name: adSource
sub property of: ad source
domain: Attribution
range: Ad Source

source link ad
type: Property
alternate name: sourceLinkAd
sub property of: source link ad
domain: Attribution
range: Source Link Ad

traffic source
type: Property
alternate name: trafficSource
sub property of: traffic source
domain: Attribution
range: Traffic Source

goal
type: Property
alternate name: goal
sub property of: goal
domain: Attribution
range: Goal

category
type: Property
alternate name: category
sub property of: category
domain: Attribution
range: Category

gcl id
type: Property
comment: Only for Google.
alternate name: gclId
sub property of: gcl id
domain: Attribution
range: string

gbra id
type: Property
comment: Only for Google.
alternate name: gbraId
sub property of: gbra id
domain: Attribution
range: string

wbra id
type: Property
comment: Only for Google.
alternate name: wbraId
sub property of: wbra id
domain: Attribution
range: string

id
type: Property
comment: Runtime-stable report row id, usually the configured source/ad id.
alternate name: id
sub property of: id
sub property of: identifier
domain: Attribution Report
range: string

campaign id
type: Property
comment: Campaign/source id returned by `/api/v1.0/attribution` when grouped by campaign/source level.
alternate name: campaignId
sub property of: campaign id
domain: Attribution Report
range: string

attribution model
type: Property
alternate name: attributionModel
sub property of: attribution model
domain: Attribution Report
range: string

date
type: Property
comment: Report period day from the dynamic Hyros row.
alternate name: date
domain: Attribution Report
range: string

revenue
type: Property
alternate name: revenue
sub property of: revenue
domain: Attribution Report
range: double

sales
type: Property
alternate name: sales
domain: Attribution Report
range: double

calls
type: Property
alternate name: calls
domain: Attribution Report
range: double

cost
type: Property
alternate name: cost
sub property of: cost
domain: Attribution Report
range: double

roas
type: Property
alternate name: roas
sub property of: roas
domain: Attribution Report
range: double

aov
type: Property
alternate name: aov
sub property of: aov
domain: Attribution Report
range: double

cac
type: Property
alternate name: cac
sub property of: cac
domain: Attribution Report
range: double

cost per sale
type: Property
alternate name: costPerSale
sub property of: cost per sale
domain: Attribution Report
range: double

net profit
type: Property
alternate name: netProfit
sub property of: net profit
domain: Attribution Report
range: double

unique sales
type: Property
alternate name: uniqueSales
sub property of: unique sales
domain: Attribution Report
range: double

unique customers
type: Property
alternate name: uniqueCustomers
sub property of: unique customers
domain: Attribution Report
range: double

total revenue
type: Property
alternate name: totalRevenue
sub property of: total revenue
domain: Attribution Report
range: double

recurring revenue
type: Property
alternate name: recurringRevenue
sub property of: recurring revenue
domain: Attribution Report
range: double

new customers percentage
type: Property
alternate name: newCustomersPercentage
sub property of: new customers percentage
domain: Attribution Report
range: double

recurring customers
type: Property
alternate name: recurringCustomers
sub property of: recurring customers
domain: Attribution Report
range: double

refund
type: Property
alternate name: refund
sub property of: refund
domain: Attribution Report
range: double

refund count
type: Property
alternate name: refundCount
sub property of: refund count
domain: Attribution Report
range: double

refund sales percentage
type: Property
alternate name: refundSalesPercentage
sub property of: refund sales percentage
domain: Attribution Report
range: double

id
type: Property
comment: Ad account id used for the `/api/v1.0/attribution/ad-account` request.
alternate name: id
sub property of: id
sub property of: identifier
domain: Ad Account Report
range: string

attribution model
type: Property
alternate name: attributionModel
sub property of: attribution model
domain: Ad Account Report
range: string

start date
type: Property
comment: Query window lower bound used for this aggregate row.
alternate name: startDate
domain: Ad Account Report
range: string

end date
type: Property
comment: Query window upper bound used for this aggregate row.
alternate name: endDate
domain: Ad Account Report
range: string

revenue
type: Property
alternate name: revenue
sub property of: revenue
domain: Ad Account Report
range: double

sales
type: Property
alternate name: sales
domain: Ad Account Report
range: double

calls
type: Property
alternate name: calls
domain: Ad Account Report
range: double

cost
type: Property
alternate name: cost
sub property of: cost
domain: Ad Account Report
range: double

roas
type: Property
alternate name: roas
sub property of: roas
domain: Ad Account Report
range: double

aov
type: Property
alternate name: aov
sub property of: aov
domain: Ad Account Report
range: double

cac
type: Property
alternate name: cac
sub property of: cac
domain: Ad Account Report
range: double

cost per sale
type: Property
alternate name: costPerSale
sub property of: cost per sale
domain: Ad Account Report
range: double

net profit
type: Property
alternate name: netProfit
sub property of: net profit
domain: Ad Account Report
range: double

unique sales
type: Property
alternate name: uniqueSales
sub property of: unique sales
domain: Ad Account Report
range: double

unique customers
type: Property
alternate name: uniqueCustomers
sub property of: unique customers
domain: Ad Account Report
range: double

total revenue
type: Property
alternate name: totalRevenue
sub property of: total revenue
domain: Ad Account Report
range: double

recurring revenue
type: Property
alternate name: recurringRevenue
sub property of: recurring revenue
domain: Ad Account Report
range: double

new customers percentage
type: Property
alternate name: newCustomersPercentage
sub property of: new customers percentage
domain: Ad Account Report
range: double

recurring customers
type: Property
alternate name: recurringCustomers
sub property of: recurring customers
domain: Ad Account Report
range: double

refund
type: Property
alternate name: refund
sub property of: refund
domain: Ad Account Report
range: double

refund count
type: Property
alternate name: refundCount
sub property of: refund count
domain: Ad Account Report
range: double

refund sales percentage
type: Property
alternate name: refundSalesPercentage
sub property of: refund sales percentage
domain: Ad Account Report
range: double

email
type: Property
alternate name: email
sub property of: email
domain: Lead
range: string

id
type: Property
alternate name: id
sub property of: id
sub property of: identifier
domain: Lead
range: string

creation date
type: Property
alternate name: creationDate
sub property of: dateCreated
domain: Lead
range: dateTime

tags
type: Property
alternate name: tags
sub property of: tags
sub property of: keywords
domain: Lead
range: string

ips
type: Property
alternate name: ips
sub property of: ips
domain: Lead
range: string

phone numbers
type: Property
alternate name: phoneNumbers
sub property of: phone numbers
sub property of: telephone
domain: Lead
range: string

first name
type: Property
alternate name: firstName
sub property of: first name
sub property of: givenName
domain: Lead
range: string

last name
type: Property
alternate name: lastName
sub property of: last name
sub property of: familyName
domain: Lead
range: string

provider
type: Property
alternate name: provider
sub property of: provider
domain: Lead
range: Provider

lead
type: Property
alternate name: lead
domain: Lead Journey
range: Lead

sales
type: Property
alternate name: sales
domain: Lead Journey
range: Sale

calls
type: Property
alternate name: calls
domain: Lead Journey
range: Call

carts
type: Property
alternate name: carts
sub property of: carts
domain: Lead Journey
range: Lead Journey Cart Item

linked leads
type: Property
alternate name: linkedLeads
sub property of: linked leads
domain: Lead Journey
range: Lead

id
type: Property
comment: Hyros-assigned internal sale ID (prefixed `sle-...`).
alternate name: id
sub property of: id
sub property of: identifier
domain: Sale
range: string

order id
type: Property
comment: Client-supplied stable identifier from the upstream order system (typically a Stripe charge ID, payment processor reference, or e-commerce order number). Acts as a dedup key on `POST /orders`: resubmitting the same `orderId` updates the existing sale rather than creating a duplicate. Use this as the at-least-once retry handle when ingesting from a source system that issues stable IDs.
alternate name: orderId
sub property of: order id
sub property of: orderNumber
domain: Sale
range: string

creation date
type: Property
alternate name: creationDate
sub property of: orderDate
domain: Sale
range: dateTime

qualified
type: Property
alternate name: qualified
sub property of: qualified
domain: Sale
range: boolean

score
type: Property
alternate name: score
sub property of: score
domain: Sale
range: double

recurring
type: Property
alternate name: recurring
sub property of: recurring
domain: Sale
range: boolean

quantity
type: Property
alternate name: quantity
sub property of: quantity
sub property of: orderQuantity
domain: Sale
range: double

lead
type: Property
alternate name: lead
sub property of: customer
domain: Sale
range: Lead

first source
type: Property
alternate name: firstSource
domain: Sale
range: Attribution

last source
type: Property
alternate name: lastSource
domain: Sale
range: Attribution

price
type: Property
alternate name: price
sub property of: totalPaymentDue
domain: Sale
range: Price

product
type: Property
alternate name: product
sub property of: orderedItem
domain: Sale
range: Product

provider
type: Property
alternate name: provider
sub property of: provider
domain: Sale
range: Provider

id
type: Property
alternate name: id
sub property of: id
sub property of: identifier
domain: Product
range: string

name
type: Property
alternate name: name
sub property of: name
domain: Product
range: string

tag
type: Property
alternate name: tag
sub property of: tag
sub property of: keywords
domain: Product
range: string

sku
type: Property
alternate name: sku
sub property of: sku
domain: Product
range: string

category
type: Property
alternate name: category
sub property of: category
domain: Product
range: Category

provider
type: Property
alternate name: provider
sub property of: provider
domain: Product
range: Provider

id
type: Property
comment: Hyros-assigned internal call ID.
alternate name: id
sub property of: id
sub property of: identifier
domain: Call
range: string

tag
type: Property
alternate name: tag
sub property of: tag
sub property of: keywords
domain: Call
range: string

qualified
type: Property
alternate name: qualified
sub property of: qualified
domain: Call
range: boolean

name
type: Property
alternate name: name
sub property of: name
domain: Call
range: string

external id
type: Property
comment: Client-supplied stable identifier from the upstream calling system (e.g. Calendly event ID). Acts as a dedup key on `POST /calls`: resubmitting the same `externalId` updates the existing call rather than creating a duplicate. Use this as the at-least-once retry handle when ingesting from a source system that issues stable IDs.
alternate name: externalId
sub property of: external id
domain: Call
range: string

score
type: Property
alternate name: score
sub property of: score
domain: Call
range: double

creation date
type: Property
alternate name: creationDate
sub property of: dateCreated
domain: Call
range: dateTime

state
type: Property
alternate name: state
sub property of: state
domain: Call
range: string
code list: CallState

qualification
type: Property
alternate name: qualification
sub property of: qualification
domain: Call
range: Call Qualification

lead
type: Property
alternate name: lead
domain: Call
range: Lead

first source
type: Property
alternate name: firstSource
domain: Call
range: Attribution

last source
type: Property
alternate name: lastSource
domain: Call
range: Attribution

name
type: Property
comment: Current qualification stage name.
alternate name: name
sub property of: name
domain: Call Qualification
range: string

old name
type: Property
comment: Previous qualification stage name, if the stage was renamed.
alternate name: oldName
sub property of: old name
domain: Call Qualification
range: string

id
type: Property
comment: Cart identifier in Hyros.
alternate name: id
sub property of: id
sub property of: identifier
domain: Lead Journey Cart Item
range: string

order id
type: Property
comment: Order ID this cart resulted in. Only present if the cart was purchased.
alternate name: orderId
sub property of: order id
sub property of: orderNumber
domain: Lead Journey Cart Item
range: string

creation date
type: Property
comment: ISO 8601 cart creation timestamp.
alternate name: creationDate
sub property of: dateCreated
domain: Lead Journey Cart Item
range: dateTime

events
type: Property
comment: Number of cart events (add-to-cart, update) observed for this cart.
alternate name: events
sub property of: events
domain: Lead Journey Cart Item
range: integer

provider
type: Property
comment: Upstream provider that originated the cart record.
alternate name: provider
sub property of: provider
domain: Lead Journey Cart Item
range: Provider

products
type: Property
comment: Products in the cart at the time of the snapshot.
alternate name: products
sub property of: products
sub property of: orderedItem
domain: Lead Journey Cart Item
range: Product

first source
type: Property
comment: First attribution (first-touch) source for the cart's owning lead.
alternate name: firstSource
domain: Lead Journey Cart Item
range: Attribution

last source
type: Property
comment: Last attribution (last-touch) source for the cart's owning lead.
alternate name: lastSource
domain: Lead Journey Cart Item
range: Attribution

name
type: Property
alternate name: name
sub property of: name
domain: Cart Item
range: string

price
type: Property
alternate name: price
sub property of: price
domain: Cart Item
range: double

external id
type: Property
alternate name: externalId
sub property of: external id
domain: Cart Item
range: string

quantity
type: Property
alternate name: quantity
sub property of: quantity
sub property of: orderQuantity
domain: Cart Item
range: double

sku
type: Property
comment: Unique product reference code.
alternate name: sku
sub property of: sku
domain: Cart Item
range: string

name
type: Property
comment: Name of the product.
alternate name: name
sub property of: name
domain: Item
range: string

price
type: Property
comment: Product price per unit (costOfGoods included).
alternate name: price
sub property of: price
domain: Item
range: double

external id
type: Property
comment: Unique identifier from the external integration.
alternate name: externalId
sub property of: external id
domain: Item
range: string

quantity
type: Property
comment: Number of copies purchased. Defaults to 1.
alternate name: quantity
sub property of: quantity
sub property of: orderQuantity
domain: Item
range: double

cost of goods
type: Property
comment: Cost per unit of manufacture. Must be included in the price. Defaults to 0.
alternate name: costOfGoods
sub property of: cost of goods
domain: Item
range: double

taxes
type: Property
comment: Taxes applied to the item per unit. Defaults to 0.
alternate name: taxes
sub property of: taxes
domain: Item
range: double

item discount
type: Property
comment: Discount applied to this specific line item.
alternate name: itemDiscount
sub property of: item discount
domain: Item
range: double

packages
type: Property
comment: Product packages this item belongs to (used for recurring sales attribution).
alternate name: packages
sub property of: packages
domain: Item
range: string

tag
type: Property
comment: Tag to create for the sale item.
alternate name: tag
sub property of: tag
sub property of: keywords
domain: Item
range: string

category name
type: Property
comment: Links the sale to a product category.
alternate name: categoryName
sub property of: category name
domain: Item
range: string

id
type: Property
alternate name: id
sub property of: id
sub property of: identifier
domain: Subscription
range: string

subscription id
type: Property
alternate name: subscriptionId
sub property of: subscription id
domain: Subscription
range: string

start date
type: Property
alternate name: startDate
sub property of: startDate
domain: Subscription
range: dateTime

end date
type: Property
alternate name: endDate
sub property of: endDate
domain: Subscription
range: dateTime

cancel at date
type: Property
alternate name: cancelAtDate
sub property of: cancel at date
domain: Subscription
range: string

trial start date
type: Property
alternate name: trialStartDate
sub property of: trial start date
domain: Subscription
range: string

trial end date
type: Property
alternate name: trialEndDate
sub property of: trial end date
domain: Subscription
range: string

price
type: Property
comment: Faithful to the source spec: scalar number on Subscription (unlike Sale.price which is a Price object). Hyros treats subscription pricing as a single recurring amount rather than a multi-field breakdown.
alternate name: price
domain: Subscription
range: decimal

status
type: Property
alternate name: status
sub property of: status
domain: Subscription
range: string
code list: SubscriptionStatus

periodicity
type: Property
alternate name: periodicity
sub property of: periodicity
domain: Subscription
range: string

plan id
type: Property
alternate name: planId
sub property of: plan id
domain: Subscription
range: string

tag
type: Property
alternate name: tag
sub property of: tag
sub property of: keywords
domain: Subscription
range: string

name
type: Property
alternate name: name
sub property of: name
domain: Subscription
range: string

lead
type: Property
alternate name: lead
sub property of: customer
domain: Subscription
range: Lead

first source
type: Property
alternate name: firstSource
domain: Subscription
range: Attribution

last source
type: Property
alternate name: lastSource
domain: Subscription
range: Attribution

category
type: Property
alternate name: category
sub property of: category
domain: Subscription
range: Category

provider
type: Property
alternate name: provider
sub property of: provider
domain: Subscription
range: Provider

email
type: Property
alternate name: email
sub property of: email
domain: Webhook Lead Child
range: string

join date
type: Property
comment: Join date in the user's timezone.
alternate name: joinDate
sub property of: join date
sub property of: dateCreated
domain: Webhook Lead Child
range: dateTime

utcjoin date
type: Property
comment: Join date in UTC.
alternate name: UTCJoinDate
sub property of: utcjoin date
domain: Webhook Lead Child
range: string

ips
type: Property
alternate name: ips
sub property of: ips
domain: Webhook Lead
range: string

tags
type: Property
alternate name: tags
sub property of: tags
sub property of: keywords
domain: Webhook Lead
range: string

phone numbers
type: Property
alternate name: phoneNumbers
sub property of: phone numbers
sub property of: telephone
domain: Webhook Lead
range: string

first name
type: Property
alternate name: firstName
sub property of: first name
sub property of: givenName
domain: Webhook Lead
range: string

last name
type: Property
alternate name: lastName
sub property of: last name
sub property of: familyName
domain: Webhook Lead
range: string

id
type: Property
alternate name: id
sub property of: id
sub property of: identifier
domain: Webhook Product
range: string

quantity
type: Property
alternate name: quantity
sub property of: quantity
sub property of: orderQuantity
domain: Webhook Product
range: double

name
type: Property
alternate name: name
sub property of: name
domain: Webhook Product
range: string

tag
type: Property
alternate name: tag
sub property of: tag
sub property of: keywords
domain: Webhook Product
range: string

category
type: Property
alternate name: category
sub property of: category
domain: Webhook Product
range: Category

price
type: Property
comment: Price in the outbound currency configured in Hyros.
alternate name: price
sub property of: priceSpecification
domain: Webhook Product
range: Price

usdprice
type: Property
comment: Price in USD.
alternate name: USDPrice
sub property of: usdprice
domain: Webhook Product
range: Price

utcclick date
type: Property
comment: Click date in UTC. Only present on webhook payloads.
alternate name: UTCClickDate
sub property of: utcclick date
domain: Webhook Attribution
range: string

id
type: Property
alternate name: id
sub property of: id
sub property of: identifier
domain: Webhook Sale Entity
range: string

type
type: Property
alternate name: type
sub property of: type
sub property of: additionalType
domain: Webhook Sale Entity
range: string

date
type: Property
comment: Date of the sale in the user's timezone.
alternate name: date
sub property of: orderDate
domain: Webhook Sale Entity
range: dateTime

utcdate
type: Property
comment: Date of the sale in UTC.
alternate name: UTCDate
sub property of: utcdate
domain: Webhook Sale Entity
range: string

qualified
type: Property
comment: True if the sale score is 1.
alternate name: qualified
sub property of: qualified
domain: Webhook Sale Entity
range: boolean

score
type: Property
alternate name: score
sub property of: score
domain: Webhook Sale Entity
range: double

order id
type: Property
alternate name: orderId
sub property of: order id
sub property of: orderNumber
domain: Webhook Sale Entity
range: string

recurring
type: Property
alternate name: recurring
sub property of: recurring
domain: Webhook Sale Entity
range: boolean

attribution
type: Property
alternate name: attribution
sub property of: attribution
domain: Webhook Sale Entity
range: Webhook Attribution

lead
type: Property
alternate name: lead
domain: Webhook Sale Entity
range: Webhook Lead

product
type: Property
alternate name: product
domain: Webhook Sale Entity
range: Webhook Product

id
type: Property
alternate name: id
sub property of: id
sub property of: identifier
domain: Webhook Lead Opt In Entity
range: string

first optin
type: Property
comment: Identifies whether this is the first opt-in for the lead.
alternate name: firstOptin
sub property of: first optin
domain: Webhook Lead Opt In Entity
range: boolean

date
type: Property
comment: Opt-in date in the user's timezone.
alternate name: date
sub property of: dateCreated
domain: Webhook Lead Opt In Entity
range: dateTime

utcdate
type: Property
comment: Opt-in date in UTC.
alternate name: UTCDate
sub property of: utcdate
domain: Webhook Lead Opt In Entity
range: string

referrer url
type: Property
comment: Referrer URL from which the lead opted in.
alternate name: referrerUrl
sub property of: referrer url
domain: Webhook Lead Opt In Entity
range: string

lead
type: Property
alternate name: lead
sub property of: agent
domain: Webhook Lead Opt In Entity
range: Webhook Lead

attribution
type: Property
comment: All attributions the lead has.
alternate name: attribution
sub property of: attribution
domain: Webhook Lead Opt In Entity
range: Webhook Attribution

first source
type: Property
alternate name: firstSource
domain: Webhook Lead Opt In Entity
range: Webhook Attribution

last source
type: Property
alternate name: lastSource
domain: Webhook Lead Opt In Entity
range: Webhook Attribution

mechanism
type: Property
alternate name: mechanism
sub property of: mechanism
domain: Webhook Lead Origin Assigned Entity
range: string
code list: LeadOriginMechanism

child lead
type: Property
comment: The lead assigned as child. Wire field is `lead`; renamed to `childLead` in TypeSpec to disambiguate from `originLead` and to make the predicate-name match for `hyros:childLead`.
alternate name: lead
sub property of: child lead
domain: Webhook Lead Origin Assigned Entity
range: Webhook Lead Child

origin lead
type: Property
comment: The lead assigned as origin.
alternate name: originLead
sub property of: origin lead
domain: Webhook Lead Origin Assigned Entity
range: Webhook Lead

date
type: Property
comment: Origin-assignment time in the user's timezone.
alternate name: date
sub property of: dateCreated
domain: Webhook Lead Origin Assigned Entity
range: dateTime

utcdate
type: Property
comment: Origin-assignment time in UTC.
alternate name: UTCDate
sub property of: utcdate
domain: Webhook Lead Origin Assigned Entity
range: string

matching values
type: Property
comment: Values on which the two leads were matched.
alternate name: matchingValues
sub property of: matching values
domain: Webhook Lead Origin Assigned Entity
range: string

id
type: Property
alternate name: id
sub property of: id
sub property of: identifier
domain: Webhook Call Entity
range: string

type
type: Property
alternate name: type
sub property of: type
sub property of: additionalType
domain: Webhook Call Entity
range: string

date
type: Property
comment: Call date in the user's timezone.
alternate name: date
sub property of: startDate
domain: Webhook Call Entity
range: dateTime

utcdate
type: Property
comment: Call date in UTC.
alternate name: UTCDate
sub property of: utcdate
domain: Webhook Call Entity
range: string

qualified
type: Property
alternate name: qualified
sub property of: qualified
domain: Webhook Call Entity
range: boolean

score
type: Property
alternate name: score
sub property of: score
domain: Webhook Call Entity
range: double

tag
type: Property
alternate name: tag
sub property of: tag
sub property of: keywords
domain: Webhook Call Entity
range: string

attribution
type: Property
alternate name: attribution
sub property of: attribution
domain: Webhook Call Entity
range: Webhook Attribution

lead
type: Property
alternate name: lead
sub property of: agent
domain: Webhook Call Entity
range: Webhook Lead

subscription id
type: Property
comment: ID of the subscription that triggered delivery.
alternate name: subscriptionId
sub property of: subscription id
domain: Webhook Event Base
range: string

event id
type: Property
comment: Unique event ID, suitable for consumer-side deduplication.
alternate name: eventId
sub property of: event id
sub property of: identifier
domain: Webhook Event Base
range: string

type
type: Property
comment: Event type discriminator.
alternate name: type
sub property of: type
sub property of: additionalType
domain: Webhook Event Base
range: string

timestamp
type: Property
comment: ISO 8601 timestamp when the event was sent.
alternate name: timestamp
sub property of: timestamp
sub property of: dateCreated
domain: Webhook Event Base
range: dateTime

type
type: Property
alternate name: type
sub property of: type
domain: Sale Attributed Event
range: string

body
type: Property
alternate name: body
domain: Sale Attributed Event
range: Webhook Sale Entity

type
type: Property
alternate name: type
sub property of: type
domain: Lead Opt In Event
range: string

body
type: Property
alternate name: body
domain: Lead Opt In Event
range: Webhook Lead Opt In Entity

type
type: Property
alternate name: type
sub property of: type
domain: Lead Origin Assigned Event
range: string

body
type: Property
alternate name: body
domain: Lead Origin Assigned Event
range: Webhook Lead Origin Assigned Entity

type
type: Property
alternate name: type
sub property of: type
domain: Call Attributed Event
range: string

body
type: Property
alternate name: body
domain: Call Attributed Event
range: Webhook Call Entity