FreeWheel

The Switchboard FreeWheel Connector provides automated access to publisher and marketplace reports.

Prerequisites

To configure access to the FreeWheel Connector, you need:

  • A Publisher Id
  • API Key

To obtain your FreeWheel API Key, please contact your FreeWheel Account Manager.

Scheduling

The Freewheel connector can be scheduled to ingest data once per day at a user-defined hour and timezone. By default, the connector will run once at 6am PT. See Daily Scheduling for more information.

Parameters

Parameter Description Required/Optional?
dimensions A string list of request report dimensions. Allowed values are:

zone
insertion-order
buyer
buyer-zone
ad
advertiser-publisher
hour-zone
day-content-owner
deal
buyer-deal
country-zone		 Required
publisher_id The numeric id of your publisher account. Required

Sample Switchboard Script

import freewheel_publisher_report from {
    key: "freewheel_key";
    type: "freewheel:publisher";
    dimensions: ["day"];
    publisher_id: 12345;
} using {
    date: datetime("YYYYMMdd");
    auctions: integer;
    bid_price_sum: float;
    bid_selected_price_sum: float;
    bids_cancelled: integer;
    bids_done: integer;
    bids_fail_currency: integer;
    bids_fail_parsing: integer;
    bids_failed: integer;
    bids_filtered_blockrule: integer;
    bids_filtered_duration: integer;
    bids_filtered_floor_price: integer;
    bids_lost: integer;
    bids_selected: integer;
    bids_timeout:  integer;
    clicks: integer;
    impressions: integer;
    intext_inventory: integer;
    no_bid: integer;
    requests_country: integer;
    requests: integer;
    revenue: float;
    vtr0:  integer;
    vtr100: integer;
    vtr25: integer;
    vtr50: integer;
    vtr75: integer;
};