Skip to content
Contact us
Documentation menuStandard properties

Standard properties. The same meaning in every event.

Some properties mean the same in every event. Even when the event catalogue does not define them they are accepted in every validation mode (strict included), and their types are always checked; a definition with the same key on the event takes precedence.

This page is generated at build time from docs/api/openapi/tracking.json in the repository.

Amounts

  • revenue is gross including tax, net_revenue excludes tax, tax is the tax amount; currency is required with an amount.
  • Rates and ROAS are computed from these fields with the one definition of the metric catalogue; sales including tax are never divided by spend excluding tax.

Properties

PropertyTypeMeaning
revenuemoneyGross amount including tax.
valuenumberA non-monetary or estimated value (e.g. a lead score).
taxmoneyThe tax amount.
net_revenuemoneyNet amount excluding tax.
currencycurrencyISO 4217 currency code (TRY, EUR); required whenever an amount is sent.
order_idstringThe order’s id in your product.
transaction_idstringThe payment transaction’s id; also a good source for idempotency.
plan_idstringThe subscription or plan id.
testbooleanWhen true, the event is marked as test even with a live key.

The list and the types are generated at build time from the x-standard-properties section of the Tracking API’s OpenAPI document.

Related pages