Getting Started: FreeWheel Setup Guide
This guide walks you through setting up Watching That with FreeWheel from start to finish — what you'll end up with, how to get there, and what you can do on day one.
Total hands-on time: under 1 hour. Typical time to data in platform: under a week.
Related pages:
Metrics, Dimensions & Filters — platform-wide concepts
FreeWheel: Metrics & Dimensions — event types and dimensions overview
FreeWheel Metrics Reference — complete standard metrics catalogue
FreeWheel Log File Fields — raw field reference
On This Page
Section | What it covers |
|---|---|
The outcome — what's running when setup is complete | |
One-click CloudFormation template (~5 min) | |
FreeWheel API user request + credentials (~10 min + wait) | |
Choosing your 10 event types and 50 data fields (~30 min call) | |
What happens automatically — timeline | |
Reports, Analysis, Monitoring, Inspect, custom metrics | |
Common expansion paths |
What You'll End Up With
By the end of this setup you'll have:
FreeWheel v4 log files flowing into Watching That continuously — every ad request, impression, error, and completion event
Optionally, bid-level logs for full programmatic auction visibility
FreeWheel API access enriching your log data with friendly names, campaign metadata, and configuration details — powering Validation Monitors
Up to 10 event types and up to 50 data fields configured for your organisation — determining your metrics and dimensions
Reports, Analysis, Inspect, and Monitoring all working across your FreeWheel data from the moment data starts flowing
Step 1: Grant Log File Access
|
|
|---|---|
What | Give Watching That read-only access to your FreeWheel v4 log files in AWS S3 |
How | One-click CloudFormation template — enter your FreeWheel Network ID, tick acknowledgement, click Create |
You need | Your FreeWheel Network ID + an AWS login with IAM role creation permission |
Your time | ~5 minutes |
Full instructions |
Once done, send your AWS Account ID and FreeWheel Network ID to your Watching That contact. We configure the ingestion on our side.
Optional — Bid-Level Logs: If your FreeWheel account includes bid-level logs and you want programmatic auction visibility, the same CloudFormation template covers both. No additional setup. See FreeWheel Bid Level Log Fields for the field reference.
Step 2: Set Up API Access
|
|
|---|---|
What | Connect Watching That to the FreeWheel API for friendly names + Validation Monitors |
How | Request an API-only user from your FreeWheel rep, then enter credentials in Watching That |
You need | Ability to request a new user from FreeWheel (your FreeWheel account manager can help) |
Your time | ~10 min to submit + ~2 min to enter credentials. FreeWheel processing: 1–3 business days. |
Full instructions |
We provide the exact form answers to give FreeWheel — no guesswork.
What changes immediately: Friendly names throughout the platform instead of numeric IDs. Validation Monitors become available — automated business rule checks running every ~10 minutes against your FreeWheel configuration.
Step 3: Configure Your Event Types and Data Fields
Your account team works with you to select the right configuration. This is a configuration conversation, not a technical project.
Choosing Your Event Types (up to 10 of 16 available)
A typical selection of 10 covers the full ad delivery lifecycle plus bid-level analytics:
# | Event Type | What It Gives You |
|---|---|---|
1 | IMPRESSION | Ad delivery, revenue, IVT — the foundation |
2 | REQUEST | Ad requests, sessions, ad breaks — top of funnel |
3 | AD AVAIL | Ad slot inventory, fill rate |
4 | ERROR | Errors, unfilled inventory — operational health |
5 | AD COMPLETE | Completion tracking, VTR |
6 | VIDEO VIEW | Content viewership, content starts |
7 | BID REQUEST | Bid volume to demand partners |
8 | BID RECEIVED | Bid responses, win rates, clearing prices |
9 | BID ERROR | Bid failures, timeouts, error types |
10 | SELECTED BID | Auction winners |
Left for later: Three mid-quartile events (FIRST QUARTILE, MIDPOINT, SECOND QUARTILE) for granular viewability, SERVER RESPONSE for demand partner response analysis, SKIP/MUTE for engagement tracking.
Trade-off: If you don't need bid-level data, those four slots free up for quartile events + SERVER RESPONSE — full viewability and demand partner analysis instead of auction visibility.
Choosing Your Data Fields (up to 50 of 60+ available)
Category | Typical Fields | Count | What You Can Do |
|---|---|---|---|
Event Identification | type, errorCode, receivedAt, rid, logFile | 5 | Filter by event type, drill into errors, time-based analysis |
Content & Inventory | mediaId, siteId, siteSectionId, placementId, isLive, seriesId | 6 | Break down by content, site, placement. Live vs VOD. |
Ad Details | adCId, adUnitId, adUnitTypeId, adType, cpm | 5 | Creative, ad unit, position (pre/mid/post), revenue |
Ad Break & Slot | adBreak, adBreakPos, abId, timeUnfilled | 4 | Break structure, position, unfilled time |
User & Device | country, territory, deviceType, playerId, userAgent | 5 | Geo, device, platform breakdowns |
Traffic Quality | isIVT, fwIVTReason | 2 | Invalid traffic filtering and analysis |
Partners & Value Chain | distributionPartnerId, sellingPartnerId, contentProviderPartnerId, fwNetworkId, org | 5 | Partner performance, value chain visibility |
Marketplace & Programmatic | marketUnifiedAdId, marketBuyerSeatId, marketDealId, salesChannelType, mrmRuleId, soldOrderId, purchasedOrderId, listingId | 8 | Deal-level, buyer seats, direct vs programmatic |
Content & Distribution | contentBrandId, endpointId, endpointOwnerId | 3 | Distribution endpoints, content brands |
Ad Break Capacity ⚡ | maxDuration, maxAds, adsSelected, adDuration | 4 | Slot utilisation, break capacity |
Extended ⚡ | dma, creativeDuration, uniqUser | 3 | DMA geo, creative duration, user-level |
Total |
| 50 |
|
Left for later: Audience fields, content detail (genreId, programmerId, tvRating), privacy (privacyChoices), custom key-values (AllRequestKV), additional identity fields. Swap in as priorities shift.
For the complete field reference, see FreeWheel Log File Fields. Fields marked ⚡ are available on request.
Step 4: Data Starts Flowing
Once Steps 1–3 are complete, Watching That begins ingesting your log files. No deployment, no code, no agents to install.
What happens automatically:
Log files picked up from your S3 bucket
Events parsed, enriched with API metadata, indexed
Metrics and dimensions available in all modules
Historical data backfilled (your account team confirms the window)
Timeline:
Step | Your Time | Elapsed |
|---|---|---|
Grant log file access (CloudFormation) | ~5 min | Day 1 |
Request FreeWheel API user | ~10 min | Day 1 |
FreeWheel processes API user request | Waiting | Day 1–3 |
Enter API credentials in Watching That | ~2 min | Day 3–4 |
Event type & field selection call | ~30 min | Day 1–5 |
Data flowing, backfill complete | — | Day 5–7 |
What You Can Do on Day One
With data flowing, everything below works immediately — no additional configuration.
Reports
Delivery health — Gross Impressions, Error Rate (%), Fill Rate (%) by
distributionPartnerIdon timeseries. Partner-level trends at a glance.Revenue by partner and position — Gross Ad Server Revenue by
sellingPartnerIdandadType.Device and geo splits — Fill Rate (%) by
deviceTypeandcountry. Platform-specific or regional issues.Bid performance — Received Bid Rate and Bid Win Rate by
marketBuyerSeatId.
Analysis
Revenue dropped Tuesday? Gross Impressions by
distributionPartnerId→ pivot byerrorCode→ drill intoplacementId. Minutes, not days.Demand partner competitiveness: Bid Participation Rate and Clearing Price by
marketBuyerSeatIdandmarketDealId.Live vs VOD: Fill Rate (%) by
siteSectionIdandisLive.
Monitoring (Anomaly)
Impression flatline —
distributionPartnerIddrops to zero → partner outage caught earlyError spike — Error Rate (%) deviates from 7-day pattern → config change caught
Revenue anomaly — Gross Ad Server Revenue relative change → CPM drops caught
Bid timeout spike — Bid Response Error: Timeouts by
marketBuyerSeatId→ demand partner issues caught
Monitoring (Validation)
With the API connected (Step 2), Validation Monitors check your FreeWheel configuration every ~10 minutes. Your first 3 are free. See the Validation Monitor of the Month series for inspiration.
Inspect
Session-level event viewer. Pull a request ID → see every event in the session: requested, filled, errored, bid on. JSON export. Minutes to resolve.
Custom Metrics
Build your own derived metrics (formulas across base metrics) and filtered metrics (any metric filtered by any dimension) from day one. The FreeWheel Metrics Reference documents the standard starting point — your custom metrics extend from there.
Evolving Your Setup
Change | What You Gain | Typical Trigger |
|---|---|---|
Add quartile events (3 slots) | Full viewability drop-off analysis | Advertiser/agency requires quartile reporting |
Add SERVER RESPONSE (1 slot) | Demand partner response times, unfilled time | Need to diagnose why slots go unfilled |
Swap marketplace → audience fields | Segment performance, targeting effectiveness | Audience-based selling becomes priority |
Add content detail (genreId, programmerId, tvRating) | Content performance × ad revenue | Content team wants programming analytics |
Add pixel tracking | Real-time events alongside log data | Need sub-minute latency |
For pixel deployment, see FreeWheel Pixel Deployment. Event types and fields can be added to your licence at any time.
Summary
What | How | Your Time |
|---|---|---|
Log file access | One-click CloudFormation template | ~5 minutes |
API integration | Request API user, enter credentials | ~10 minutes + wait |
Configuration | Select event types and fields with your account team | ~30 minute call |
Total hands-on time |
| Under 1 hour |
Time to data in platform |
| Typically under a week |