> For the complete documentation index, see [llms.txt](https://documentation.freshpaint.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.freshpaint.io/integrations/destinations/direct-response-ads/admedia-early-access/admedia-reference.md).

# AdMedia Reference

{% hint style="warning" %}
The AdMedia destination is currently in Early Access. Please contact <support@freshpaint.io> for more information about this integration.
{% endhint %}

## Destination Info

* Supports [Track](https://documentation.freshpaint.io/developer/freshpaint-sdk-reference#track) calls
* Supports [HIPAA mode](https://documentation.freshpaint.io/hipaa-mode)
* Supports forwarding from the [Google Tag Manager Integration](/integrations/google-tag-manager-integration.md)
* Refer to this destination as **AdMedia** in the [Integrations object](https://documentation.freshpaint.io/reference/developer/freshpaint-sdk-reference#using-the-integrations-object)
  * If you've configured multiple Advertisesr IDs, you can choose a specific one by suffixing the Advertiser ID, such as: **AdMedia::1234123456.** You can retrieve this value from the AdMedia configuration page for the Advertiser ID of interest.
* Connection Modes:

<table><thead><tr><th align="right"></th><th data-type="checkbox">Client-side</th><th data-type="checkbox">Server-side</th></tr></thead><tbody><tr><td align="right">Web</td><td>false</td><td>true</td></tr><tr><td align="right">Mobile</td><td>false</td><td>true</td></tr><tr><td align="right">Server</td><td>false</td><td>true</td></tr></tbody></table>

This is a reference document for the AdMedia destination. For information on how to set up this integration, see the AdMedia Quick Start Guide.

## Events

### Required Properties

| Freshpaint Property | AdMedia Parameter | Type   | Requirement | Description                                                                                                   |
| ------------------- | ----------------- | ------ | ----------- | ------------------------------------------------------------------------------------------------------------- |
| `source`            | `source`          | String | Required    | Source website or traffic origin. If source is not set on the event, Freshpaint falls back to `$current_url`. |
| `trans_id`          | `trans_id`        | String | Required    | Unique transaction or event identifier. If not provided, Freshpaint sends a masked event identifier.          |

{% hint style="warning" %}
If your Freshpaint account is set up in [HIPAA Mode](https://documentation.freshpaint.io/readme/hipaa-mode), the URL will be redacted by default because it may contain PHI. For example, if the URL of the event is `https://example.com/heart-conditions#treatments?user=alice` then Freshpaint will send `https://example.com/url-redacted-by-freshpaint`. To send the complete URL to AdMedia, add the Built-in URL (`$current_url`) property to your HIPAA allowlist.
{% endhint %}

### Recommended Properties

| Freshpaint Property | AdMedia Parameter | Type   | Requirement | Description                                                                                                                                                                                                                                                    |
| ------------------- | ----------------- | ------ | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `$click_id`         | `click_id`        | String | Recommended | Click ID captured from the landing page URL when a visitor arrives via an AdMedia ad. Required for deterministic click-through attribution. Without this value, AdMedia records the conversion but cannot attribute it to a campaign, publisher, or placement. |
| `sale_amt`          | `sale_amt`        | Float  | Recommended | Conversion value in USD.                                                                                                                                                                                                                                       |
| `status`            | `status`          | String | Recommended | Conversion status.                                                                                                                                                                                                                                             |
| `status_detail`     | `status_detail`   | String | Recommended | Additional detail about the conversion status.                                                                                                                                                                                                                 |

***

### Optional Properties

| Freshpaint Property | AdMedia Parameter | Type   | Requirement | Description                                                                                                              |
| ------------------- | ----------------- | ------ | ----------- | ------------------------------------------------------------------------------------------------------------------------ |
| `ct`                | `ct`              | String | Optional    | Conversion type or event type (e.g. `purchase`, `lead`, `signup`).                                                       |
| `$ip`               | `ip`              | String | Optional    | The user's IP address. Blocked entirely in HIPAA Mode unless `$ip` is explicitly added to the Advanced HIPAA Allow List. |