Amalgi Analytics

The Amalgi Analytics connector automates access to the Amalgi Analytics API.

Prerequisites
Scheduling
Concurrent Users
Unique Viewers
Content and Viewer Analytics
Ad Analytics and Content Analytics

Prerequisites

To configure access to the Amalgi Analytics connector, you need:

Access Token

To obtain the Access token see the section entitled Access Token Generation in the Amalgi API document.

Scheduling

The Amalgi Analytics 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.

Channels

See the channelList report type in the Amalgi API Documentation for details on what data this downloader provides.

The amagi_analytics:channels downloader is an immediate downloader type.

Sample SBS

download t from {
            type: "amagi_analytics:channels";
            key: "amagi_analytics";
} using { * };

Concurrent Users

See the concurrentUsers report type in the Amalgi API Documentation for details on what data this downloader provides.

The amagi_analytics:concurrent_users downloader is an immediate downloader.

Parameters

hours_limit integer: required; an integer from 1 to 24

Sample SBS

download t from {
            type: "amagi_analytics:concurrent_users";
            key: "amagi_analytics";
            hours_limit: 1;   // required
} using { * };

Unique Viewers

See the uniqueViewersAnalytics report type in the Amalgi API Documentation for details on what data this downloader provides.

The amagi_analytics:unique_viewers_analytics downloader operates on an daily schedule and allows repull days.

Parameters

interval string: required; “DAILY”, “WEEKLY”, or “MONTHLY”
report_timezone string: optional; “US/Pacific”, “US/Eastern”, or “Universal”

Sample SBS

download t from {
            type: "amagi_analytics:unique_viewers_analytics";
            key: "amagi_analytics";
            interval: "DAILY";      // required
            report_timezone: "US/Pacific";   // optional
            lookback_days: 3;     // optional
        } using { * };

Content and Viewer Analytics

See the contentAnalytics and viewershipAnalytics report types in the Amalgi API Documentation for details on what data this downloader provides.

amagi_analytics:content_analytics and amagi_analytics:viewership_analytics are both are daily downloaders and allows repull days.

Parameters

interval string: required; “DAILY” or “HOURLY”
report_timezone string: optional; “US/Pacific”, “US/Eastern”, or “Universal”
city string: optional; The name of city for which to generate analytics
country string: optional; Refer to the section Countries List of the Amalgi API Documentation.
device_name string: optional; Refer to the section Device Type and Device Name Options of the Amalgi API Documentation.
device_type string: optional; Refer to the section Device Type and Device Name Options of the Amalgi API Documentation.
studio_name string: optional; The name of the content studio
content_id string: optional; The unique id of the content assets as per the EPG

Sample SBS Example

download t from {
            type: "amagi_analytics:content_analytics";    // or amagi_analytics:viewership_analytics
            key: "amagi_analytics";
            interval: "DAILY";
            report_timezone: "US/Pacific";
            country: "United States";
            device_name: "Others";
            device_type: "Others";
            lookback_days: 3;     // optional
} using { * };

Ad Analytics and Ad Content Analytics

See the adAnalytics and adContentAnalytics report types in the Amalgi API Documentation for details on what data this downloader provides.

amagi_analytics:ad_analytics and amagi_analytics:ad_content_analytics are both daily and allow repull days.

Parameters

report_timezone string: optional; “US/Pacific”, “US/Eastern” or “Universal”
city string: optional; The name of city for which to generate analytics
country string: optional; Refer to the section Countries List of the Amalgi API Documentation.
device_name string: optional; Refer to the section Device Type and Device Name Options of the Amalgi API Documentation.
device_type string: optional; Refer to the section Device Type and Device Name Options of the Amalgi API Documentation.
studio_name string: optional; The name of the content studio
content_id string: optional; The unique id of the content assets as per the EPG
ad_tag string: optional

Sample SBS

download t from {
            type: "amagi_analytics:ad_analytics";    // or amagi_analytics:ad_content_analytics
            key: "amagi_analytics";
            interval: "DAILY";
            report_timezone: "US/Pacific";
            country: "United States";
            device_name: "Others";
            device_type: "Others";
            lookback_days: 3;     // optional
} using { * };