All Macro/ Parameter Lists

Use OffZio macros as placeholders in your tracking URLs, postbacks, and related links. When a click or conversion is processed, each placeholder is replaced with the real value.

On the campaign tracking URL field, click Macros Available to copy a macro. You can also copy any macro from the list below.

How to use macros

Paste your advertiser tracking URL.
Replace the advertiser’s placeholders with OffZio macros, for example {click_id}.
Keep the rest of the URL (domain, path, and parameter names) as the advertiser provided it.

Example:

https://advertiser.example.com/offer?aff_click={click_id}&source={publisher_id}&sub1={sub_id_1}

Related guide: How to Create a Campaign

Tracking URL macros

Click a macro in the product to copy it. Use these placeholders in your URLs.

Click & campaign

MacroNameDescription
`{click_id}`	Click ID	Unique ID for the click. Use this so conversions can be matched back to the original click.
`{campaign_id}`	Campaign ID	Numeric ID of the campaign in OffZio.
`{campaign_name}`	Campaign Name	Name of the campaign, for example `CreditScore PPS web+mob`.

Publisher

MacroNameDescription
`{publisher_id}`	Publisher ID	Numeric ID of the publisher who generated the click.
`{publisher_name}`	Publisher Name	Display name of the publisher.

Landing page

MacroNameDescription
`{lander_id}`	Landing Page ID	ID of the landing page used for this click.

Device & browser

MacroNameDescription
`{click_ip}`	Click IP Address	IP address recorded for the click.
`{device_type}`	Device Type	Device category, such as desktop, mobile, or tablet.
`{device_os}`	Device OS	Operating system of the visitor, such as iOS, Android, or Windows.
`{browser}`	Browser	Browser used for the click.
`{language}`	Language	Browser / device language.
`{user_agent}`	User Agent	Full user-agent string from the click.

Geo

MacroNameDescription
`{country}`	Country Name	Country detected from the click.
`{region}`	Region Name	Region / state detected from the click.
`{city}`	City Name	City detected from the click.

Sub IDs

Use sub IDs to pass extra publisher or source data through the click (placement, creative, keyword, etc.).

MacroNameDescription
`{sub_id_1}`	Sub ID 1	Custom sub parameter 1.
`{sub_id_2}`	Sub ID 2	Custom sub parameter 2.
`{sub_id_3}`	Sub ID 3	Custom sub parameter 3.
`{sub_id_4}`	Sub ID 4	Custom sub parameter 4.
`{sub_id_5}`	Sub ID 5	Custom sub parameter 5.
`{sub_id_6}`	Sub ID 6	Custom sub parameter 6.
`{sub_id_7}`	Sub ID 7	Custom sub parameter 7.
`{sub_id_8}`	Sub ID 8	Custom sub parameter 8.
`{sub_id_9}`	Sub ID 9	Custom sub parameter 9.
`{sub_id_10}`	Sub ID 10	Custom sub parameter 10.

Payout, revenue & conversion

These values are typically empty at click time and are filled when a conversion is recorded (for example on outbound / postback URLs).

MacroNameDescription
`{payout}`	Publisher Payout	Amount paid to the publisher for the conversion.
`{revenue}`	Advertiser Revenue	Amount received from the advertiser for the conversion.
`{status}`	Conversion Status	Status of the conversion, such as approved or pending.
`{goal_type}`	Goal Type	Goal type used for the conversion, such as CPA, CPL, CPI, CPS, or RevShare.
`{sale_amount}`	Sale Amount	Order / sale total. Empty at click; filled on outbound after conversion.
`{sale}`	Sale	Same as sale amount (`{sale_amount}`).

Notes

Macros must include the curly braces, for example {click_id}.
Do not rename OffZio macros. Only replace the advertiser’s tokens with the matching OffZio token.
{sale} and {sale_amount} return the same value.
If a value is not available yet (for example sale amount on a click), the placeholder may be sent empty.