> ## Documentation Index
> Fetch the complete documentation index at: https://data-foundation.rockerbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Hivewyre

> Learn how to set up Hivewyre integration with Rockerbox for display tracking

## Setup Process

1. Contact [support@rockerbox.com](mailto:support@rockerbox.com) to enable the integration. Let the team know the launch date and the [tier structure](https://help.rockerbox.com/article/obce43haen-1-hierarchy-mappings) you'd like applied
2. Append click-through URL parameters to your landing page URLs and apply the impression pixel to all active ads using the instructions below. Parameters use macros and do not need to be manually replaced
3. Set up automated spend reporting from Hivewyre to Rockerbox (see Batch Spend section below). This should be completed before launch
4. Allow at least one full day of data collection after launch, then let Rockerbox know you have launched so they can QA your URL and impression pixels

### URL Tracking Parameters

**Example Parameter String:**

```text wrap theme={null}
hw_insertionorderid=${IO_ID}&hw_lineitemid=${CPG_ID}&hw_campaignid=${CP_ID}&hw_creativeid=${CREATIVE_ID}&hw_auctionid=${AUCTION_ID}&hw_referrer=${REFERER_URL_ENC}
```

<Accordion title="Parameter Details">
  | Parameter             | Macro                | Description                   |
  | --------------------- | -------------------- | ----------------------------- |
  | `hw_insertionorderid` | `${IO_ID}`           | Insertion Order ID (required) |
  | `hw_lineitemid`       | `${CPG_ID}`          | Campaign Group/Line Item ID   |
  | `hw_campaignid`       | `${CP_ID}`           | Campaign ID                   |
  | `hw_creativeid`       | `${CREATIVE_ID}`     | Creative ID                   |
  | `hw_auctionid`        | `${AUCTION_ID}`      | Auction ID                    |
  | `hw_referrer`         | `${REFERER_URL_ENC}` | Encoded Referrer URL          |
</Accordion>

### Impression Pixel

```text wrap theme={null}
https://metrics.getrockerbox.com/track/v5?source=[SOURCE]&tier_one=hivewyre&tier_two=${CPG_CODE}&tier_three=${CP_CODE}&tier_four=${CP_ID}&tier_five=${CREATIVE_ID}&auction_id=${AUCTION_ID}&referrer=${REFERER_URL_ENC}
```

**Note:** `[SOURCE]` is a hardcoded value that must be obtained from Rockerbox. It's your company's [Account ID](https://app.rockerbox.com/v3/settings/account).

<Accordion title="Parameter Details">
  | Parameter    | Macro                | Description                     |
  | ------------ | -------------------- | ------------------------------- |
  | `tier_one`   | `hivewyre`           | Platform identifier (hardcoded) |
  | `tier_two`   | `${CPG_CODE}`        | Campaign Group Code (required)  |
  | `tier_three` | `${CP_CODE}`         | Campaign Code (required)        |
  | `tier_four`  | `${CP_ID}`           | Campaign ID                     |
  | `tier_five`  | `${CREATIVE_ID}`     | Creative ID                     |
  | `auction_id` | `${AUCTION_ID}`      | Auction ID                      |
  | `referrer`   | `${REFERER_URL_ENC}` | Encoded Referrer URL            |
</Accordion>

## Batch Spend

Hivewyre pulls reporting from Xandr to be sent to Rockerbox on a weekly cadence.

1. Contact [support@rockerbox.com](mailto:support@rockerbox.com) to obtain the endpoint details for Hivewyre batch file delivery
2. Share the endpoint details with Hivewyre and request weekly reporting with the following requirements:
   * Files sent on a weekly cadence
   * Each file contains the previous 7 days of spend data
   * Reports must contain the columns exactly as noted below, including capitalization and spacing

**Required Columns** (must match exactly, including capitalization and spacing):

```
IO Id
IO Name
Creative Id
Creative Name
Day
Total Revenue (USD)
```

## Verification

After setup:

1. Verify impression pixels are firing correctly
2. Validate click tracking parameters are populating
3. Check spend data appears in Rockerbox dashboard after at least one full week
4. Contact [support@rockerbox.com](mailto:support@rockerbox.com) for QA assistance