Objective

This article explains how to add additional Facebook Ads insight action types (such as purchases, leads, or custom conversions) to your Segment source sync. By following these steps, you can collect more granular data from your Facebook Ads campaigns in your warehouse or storage destination.

Product

Twilio Segment

Environment

Segment Console

Procedure 

1. Identify the Required Action Types

   • Determine which Facebook Ads insight action types you want to collect.
   • Use the following format for each action type:
     <field>:<attribution_window>:<action_type>[:<alias>]
   • Examples:
     • actions:default:offsite_conversion.fb_pixel_lead
     • unique_actions:default:offsite_conversion.fb_pixel_lead
     • action_values:default:offsite_conversion.lead

2. Understand the Formula Components

   • <field>: The remote field name from the report (e.g., actions, action_values, unique_actions, etc.).
   • <attribution_window>: Usually set to default (Facebook’s default attribution window, typically 1-28 days).
   • <action_type>: The specific action type, such as offsite_conversion.fb_pixel_purchase, link_click, etc. For a full list, refer to the Facebook Ads API Reference.
   • [:<alias>]: Only required if using a deprecated field name or if the column name exceeds 63 characters.

3. Prepare Your Request

   • List all action types you want to add, separated by commas (no spaces).
   • Ensure all sections are in lowercase.
   • If the column name will exceed 63 characters, add an alias at the end.

4. Submit Your Request to Segment Support

   • Contact Segment Support and provide:
     • The list of action types in the required format.
     • Any breakdowns you need (e.g., by country).
     • The impacted source name and URL.

5. Engineering Implementation

   • The Segment Engineering team will add the requested action types to your source settings.
   • You will be notified once the update is complete.

6. Verify Data Collection

   • After confirmation, check your warehouse or storage destination to ensure the new fields are present in your data.

Additional Information 

• Only the last 30 days of insights data (excluding the current date) are synced by default.
• Adding or updating insight action types currently requires Engineering intervention; it cannot be done directly in the Segment Console.
• If you need current-day data or have a special use case, mention this in your request.
• Always check if previous insights have been added to avoid overwriting existing settings.
• For a full list of supported fields and action types, refer to the [Facebook Ads API Reference].
• The column name must be 63 characters or fewer; use an alias if needed.

• Find more details in Facebook Ad - Object Cloud Sources.