Sonobi Connector

The Switchboard Sonobi connector provides automated access with the Sonobi Reporting API

Prerequisites

To configure access to the Sonobi connector you will need to create a Key in the Key Manager with the following information:

User Credentials
Your Sonobi account’s Username and Password so that Switchboard may securely authenticate requests to the API.

Scheduling

The Sonobi 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

dimensions string list
optional
Note that it is recommended that you limit the number of simultaneously requested dimensions to fewer than five. The following values are allowed:
  • _advertiserid
  • _app_name
  • _brandid
  • _browser
  • _bundleid
  • _buy_type
  • _buyerid
  • _country
  • _date
  • _dealid
  • _dealid_end_date
  • _dealid_start_date
  • _device_os
  • _device_type
  • _domain
  • _impression_type
  • _integration_type
  • _lifetime_budget_imps
  • _mediaplanid
  • _mediaplanid_name
  • _placement_type
  • _placementid
  • _placementid_name
  • _siteid
  • _size
  • _source_type
  • _state
  • _storeurl
  • _tag_type
  • _vast_error_code
  • _video_completion
  • _zip
group_by string
optional
How results are to be grouped. Typically set to “day” — that is if you had a “row_per” of _date (an internal setting) and as result want 1 row per unique date. If you wanted an hourly breakdown this parameter would be set to “hour”
metrics string list
required
Valid metrics include:
  • _bid_cpm_average
  • _bid_cpm_max
  • _bid_cpm_min
  • _bid_rate
  • _click_rate
  • _click_rate_dedup
  • _currency_conversion_rate
  • _ecpm
  • _fill_rate
  • _impression_count
  • _impression_count_clicked
  • _impression_count_delivered
  • _impression_count_multi_clicked
  • _impression_count_potential
  • _impression_count_request
  • _impression_count_vast_error
  • _impression_count_viewed
  • _revenue
  • _total_error_rate
  • _unfilled_impressions
  • _unfilled_impressions_cpm
  • _updated_date
  • _win_cpm_average
  • _win_cpm_max
  • _win_cpm_min”

Note that some metrics can not be used in combination with certain dimensions.

It is recommended try different combinations in the JetStream platform to determine which combination of dimensions and metrics are allowed. It will be clear which dimensions are disabled in the UI when you select a given metric. For instance selecting the metric Impression Count Request (_impression_count_request) disables the dimensions Placement Type (_placement_type) and Placement Size (_size)

tz_offset number
optional
timezone offset to use while running the report

Sample Switchboard Script

download t from {
    key: "sonobi";
    type: "sonobi";
    metrics: ["_impression_count", "_revenue", "_ecpm"]; // Required
    dimensions: ["_date"];
    group_by: "day";  // Required
    tz_offset: 0;
} using {*};