Facebook Video Insights

The Switchboard Facebook Video Insights connector

Prerequisites
Scheduling
Parameters
Sample Switchboard Script

Prerequisites

To configure access to the Facebook Video Insights Connector, you need:

A System User Access Token

Scheduling

The Facebook Video Insights 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?
`api_version`	A string value for the requested Facebook API version.	Optional
`page_ids`	A list of Facebook Page Ids where videos are posted.	Required
`metrics`	A list of requested report metrics. Allowed values are: total_video_views_autoplayed total_video_views_clicked_to_play total_video_views_organic total_video_views_organic_unique total_video_views_paid total_video_views_paid_unique total_video_views_sound_on total_video_complete_views total_video_complete_views_unique total_video_complete_views_auto_played total_video_complete_views_clicked_to_play total_video_complete_views_organic total_video_complete_views_organic_unique total_video_complete_views_paid total_video_complete_views_paid_unique total_video_10s_views total_video_10s_views_unique total_video_10s_views_auto_played total_video_10s_views_clicked_to_play total_video_10s_views_organic total_video_10s_views_paid total_video_10s_views_sound_on total_video_15s_views total_video_60s_excludes_shorter_views total_video_retention_graph total_video_retention_graph_autoplayed total_video_retention_graph_clicked_to_play total_video_avg_time_watched total_video_view_total_time total_video_view_total_time_organic total_video_view_total_time_paid total_video_impressions total_video_impressions_unique total_video_impressions_paid_unique total_video_impressions_paid total_video_impressions_organic_unique total_video_impressions_organic total_video_impressions_viral_unique total_video_impressions_viral total_video_impressions_fan_unique total_video_impressions_fan total_video_impressions_fan_paid_unique total_video_impressions_fan_paid total_video_stories_by_action_type total_video_reactions_by_type_total total_video_view_time_by_age_bucket_and_gender total_video_view_time_by_region_id total_video_views_by_distribution_type total_video_view_time_by_distribution_type total_video_ad_break_ad_cpm total_video_ad_break_ad_impressions total_video_ad_break_earnings	Required

Sample Switchboard Script

import facebook_video_insights from {
    type: "facebook:video_insights";
    key: "video_insights_key";
    metrics: [
    	'total_video_views',
    	'total_video_10s_views',
    	'total_video_avg_time_watched',
    	'total_video_view_total_time',
    	'total_video_impressions_unique',
    	'total_video_ad_break_ad_impressions',
    	'total_video_ad_break_earnings'];
    api_version: "v9.0";
    page_ids: ["12345", "45678"];
} using {
    report_date: datetime;
    page_name: string;
    page_id: integer;
    video_id: integer;
    video_description: string;
    total_video_impressions_unique: integer;
    total_video_views: integer;
    total_video_10s_views: integer;
    total_video_avg_time_watched: integer;
    total_video_view_total_time: integer;
    total_video_ad_break_ad_impressions: integer;
    total_video_ad_break_earnings: float;
};