Data Sources FAQ
Instagram
What are the prerequisites for setting up the Instagram source connector?
- A Meta for Developers account.
- An Instagram Business account linked to your Facebook page.
- A Facebook Ad Account ID.
- The Instagram Graph API enabled on your Facebook app.
- Required permissions for authentication:
instagram_basicinstagram_manage_insightspages_show_listpages_read_engagement
How do I generate an access token for the Instagram source connector?
Use the Graph API Explorer or create an app in your Meta for Developers account. Grant the app the necessary permissions (instagram_basic, instagram_manage_insights, etc.), and generate the access token.
What is the purpose of the Start Date field in the configuration?
The Start Date specifies the date from which the connector begins replicating User Insights data. For example, setting 2017-01-25T00:00:00Z ensures that only data generated on or after January 25, 2017, will be synced.
How do I verify the connection to the Instagram source?
After entering the required details (Source Type, Start Date, and Access Token), click on Test Connection. If the connection is successful, you can proceed with the configuration.
What permissions are required for the access token to function properly?
instagram_basic: For basic Instagram account data.instagram_manage_insights: For accessing performance metrics.pages_show_list: To view the list of pages linked to your account.pages_read_engagement: To read engagement data.
Magento
What are the prerequisites for setting up the Magento source connector?
- A Magento admin account with permissions to configure integrations and generate API tokens.
- The correct base URL of your Magento store (e.g.,
https://yourstore.com) with HTTPS enabled.
What details are required to configure the Magento source connector?
- Magento Site: The base URL of your Magento store.
- Username: The username for your Magento admin account.
- Password: The corresponding password for the admin account.
How do I verify that the Magento connector is configured correctly?
After filling in the Magento Site, Username, and Password, click Test Connection. If the connection is successful, the connector is properly configured.
Can the connector work with Magento stores without HTTPS enabled?
No, HTTPS is required for secure API communication. Ensure your Magento store URL is configured with HTTPS.
What should I do if the Test Connection fails?
- Verify that the Magento URL is correct and accessible.
- Ensure the username and password are accurate and have the necessary permissions.
- Check your network or firewall settings to ensure they are not blocking API requests.
Facebook Marketing
What are the prerequisites for setting up the Facebook Marketing source connector?
- A Facebook account with Ads Manager access.
- Admin-level permissions for the ad accounts.
- A valid access token with permissions:
ads_managementads_readread_insightsbusiness_management
- The Ads account and campaigns must also be active.
How do I find my Facebook Ad Account ID?
Open Meta Ads Manager and locate the Ad Account ID in the account dropdown menu or in the browser’s address bar (e.g., act_111111111111111).
What is the purpose of the Start Date and End Date fields?
The Start Date specifies when to start syncing data, and the End Date defines the cut-off for syncing. If the End Date is not set, the connector will continuously sync the latest data.
How do I generate an access token for the connector?
Go to your app’s dashboard in Meta for Developers. Under Marketing API > Tools, select permissions like ads_management and read_insights, then click Get Token to generate the access token.
What optional settings can I configure for deeper insights?
- Syncing deleted campaigns.
- Fetching thumbnail images.
- Customizing insights with fields and breakdowns.
- Adjusting the page size for API requests.
- Setting an attribution window (default is 28 days) to revisit conversion data.
TikTok Marketing
What are the prerequisites for setting up the TikTok Marketing source connector?
- A TikTok For Business account.
- A Developer Application with the App ID and Secret.
- For sandbox testing, create a Sandbox Ad Account.
What authentication methods are supported for the TikTok Marketing connector?
- OAuth 2.0: Requires App ID, App Secret, Access Token, and Advertiser ID.
- Sandbox Access Token: Requires Access Token and Advertiser ID from the sandbox environment.
What is the purpose of the Replication Start Date and End Date fields?
The Replication Start Date specifies the earliest date for syncing data in the format YYYY-MM-DD.
The End Date defines the cut-off point for data replication. If not set, the connector will sync data up to the current date.
How do I set the Attribution Window for TikTok data?
Specify the attribution window in days. This determines the time frame for attributing conversions to ads, based on your TikTok campaign settings.
How do I verify the connector setup?
After filling in the required details (authentication method, start and end dates, attribution window), click Test Connection. If successful, the connector is ready for data replication.
Snapchat Marketing
What are the prerequisites for setting up the Snapchat Marketing source connector?
- A Snapchat Business account.
- Access to the Snapchat Marketing API.
- An OAuth2 app with a valid Client ID, Client Secret, and configured
redirect_url. - A Refresh Token obtained through the OAuth2 authentication workflow.
How do I generate a refresh token for the Snapchat API?
- Open the authorization link in a browser:
https://accounts.snapchat.com/login/oauth2/authorize... - Log in and authorize the app.
- Capture the code from the redirect URL’s query parameter.
- Exchange the code for an access token and refresh token using a POST request to the
/access_tokenendpoint.
What details are required to configure the Snapchat connector?
- Client ID and Client Secret: Obtained from the OAuth2 app setup.
- Refresh Token: Generated during the OAuth2 workflow.
- Start Date: The earliest date for data replication (e.g.,
2022-01-01). - End Date: The latest date for data replication (optional).
What is the purpose of the Start Date and End Date fields?
The Start Date specifies when to begin syncing data, ensuring no data before this date is replicated.
The End Date defines the cut-off point for syncing data. If not set, the connector will continue syncing the latest data.
How do I verify the Snapchat Marketing connector setup?
After filling in all required fields, click Test Connection. If the connection is successful, the setup is complete, and the connector is ready for data replication.
HubSpot
What are the prerequisites for setting up the HubSpot source connector?
- A HubSpot Developer Account.
- For OAuth Authentication: Client ID, Client Secret, and Refresh Token.
- For Private App Authentication: Access Token from a HubSpot private app.
How do I obtain Client ID and Client Secret for OAuth authentication?
- Log in to your HubSpot Developer Account.
- Navigate to Apps in the left pane and locate or create a new app.
- Assign the necessary permissions (e.g.,
tickets,crm.objects.custom.read,media_bridge.read). - In the Auth Section, find and copy the Client ID and Client Secret.
How do I generate a refresh token for OAuth authentication?
- Open the Sample Install URL in the Auth Section of your app to authenticate your HubSpot account.
- Copy the authorization code from the redirect URL.
- Use a cURL request or API tool (e.g., Postman) to exchange the code for a refresh token by providing the
client_id,client_secret,redirect_uri, andcode.
How do I connect using a Private App Access Token?
- Navigate to Integrations → Private Apps in your HubSpot account.
- Locate or create the required private app.
- Click on View Access Token, copy it, and paste it in the connector configuration under the Private App method.
What fields are required when configuring the HubSpot connector?
- Select the Source Type as HubSpot.
- Provide the Start Date for data replication in the format
YYYY-MM-DD. - For OAuth, enter the Client ID, Client Secret, and Refresh Token.
- For Private App, enter the Access Token.
- Click Test Connection to verify the setup.