Instagram Extract
- DarkLight
Instagram Extract
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
This article is specific to the following platforms - Snowflake - Redshift - BigQuery.
Instagram Extract
The Instagram Extract component calls the Instagram API to retrieve and store data to be either referenced by an external table or loaded into a table, depending on the user's cloud data warehouse. Users can then transform their data with the Matillion ETL library of transformation components.
Using this component may return structured data that requires flattening. For help with flattening such data, we recommend using the Nested Data Load Component for Amazon Redshift and the Extract Nested Data Component for Snowflake or Google BigQuery.
Properties
Snowflake Properties | ||
|---|---|---|
| Property | Setting | Description |
| Name | String | A human-readable name for the component. |
| Data Source | Select | Select a data source. As noted above, once you have configured the Data Source property, one or more properties specific to that data source will become available to configure. These properties are not optional and must be configured. Please refer to the "Data Source Properties" table in this documentation for guidance with these additional properties. |
| OAuth | Select | The name of the OAuth entry that has been configured for this service. Please refer to our online documentation for help configuring an Instagram OAuth. |
| Page Limit | Number | Limit the number of pages to stage. |
| Location | Storage Location | Provide an S3 bucket path, GCS bucket path, or Azure Blob Storage path that will be used to store the data. Once on an S3 bucket, GCS bucket or Azure Blob, the data can be referenced by an external table. A folder will be created at this location with the same name as the Target Table. |
| Integration | Select | Choose your Google Cloud Storage Integration. Integrations are required to permit Snowflake to read data from and write to a Google Cloud Storage bucket. Integrations must be set up in advance of selecting them in Matillion ETL. To learn more about setting up a storage integration, read our Storage Integration Setup Guide. |
| Warehouse | Select | Choose a Snowflake warehouse that will run the load. |
| Database | Select | Choose a database to create the new table in. |
| Schema | Select | Select the table schema. The special value, [Environment Default], will use the schema defined in the environment. For more information on using multiple schemas, see this article. |
| Target Table | Text | Provide a new table name. Warning: This table will be recreated and will drop any existing table of the same name. |
Redshift Properties | ||
|---|---|---|
| Property | Setting | Description |
| Name | String | A human-readable name for the component. |
| Data Source | Select | Select a data source. As noted above, once you have configured the Data Source property, one or more properties specific to that data source will become available to configure. These properties are not optional and must be configured. Please refer to the "Data Source Properties" table in this documentation for guidance with these additional properties. |
| OAuth | Select | The name of the OAuth entry that has been configured for this service. Please refer to our online documentation for help configuring an Instagram OAuth. |
| Page Limit | Number | Limit the number of pages to stage. |
| Location | Text/Select | Provide an S3 Bucket path that will be used to store the data. Once on an S3 bucket, the data can be referenced by an external table. A folder will be created at this location with the same name as the Target Table. |
| Type | Dropdown | Select between a standard table and an external table. |
| Standard Schema | Dropdown | Select the Redshift schema. The special value, [Environment Default], will use the schema defined in the Matillion ETL environment. |
| External Schema | Select | Select the table's external schema. To learn more about external schemas, please consult the 'Configuring The Matillion ETL Client' section of the Getting Started With Amazon Redshift Spectrum documentation. |
| Target Table | Text | Provide a name for the External Table to be used. Warning: This table will be recreated and will drop any existing table of the same name. |
BigQuery Properties | ||
|---|---|---|
| Property | Setting | Description |
| Name | String | A human-readable name for the component. |
| Data Source | Select | Select a data source. As noted above, once you have configured the Data Source property, one or more properties specific to that data source will become available to configure. These properties are not optional and must be configured. Please refer to the "Data Source Properties" table in this documentation for guidance with these additional properties. |
| OAuth | Select | The name of the OAuth entry that has been configured for this service. Please refer to our online documentation for help configuring an Instagram OAuth. |
| Page Limit | Number | Limit the number of pages to stage. |
| Table Type | Select | Select whether the table is Native (by default in BigQuery) or an external table. |
| Project | Select | Select the Google Bigquery project. The special value, [Environment Default], will use the project defined in the environment. For more information, refer to the BigQuery documentation. |
| Dataset | Select | Select the Google Bigquery dataset to load data into. The special value, [Environment Default], will use the dataset defined in the environment. For more information, refer to the BigQuery documentation. |
| Target Table | String | A name for the table. Warning: This table will be recreated and will drop any existing table of the same name. Only available when the table type is Native. |
| New Target Table | String | A name for the new external table. Only available when the table type is External. |
| Cloud Storage Staging Area | Cloud Storage Bucket | Specify the target Google Cloud Storage bucket to be used for staging the queried data. Users can either:
Only available when the table type is Native. |
| Location | Cloud Storage Bucket | Specify the target Google Cloud Storage bucket to be used for staging the queried data. Users can either:
|
| Load Options | Multiple Select | Clean Cloud Storage Files: Destroy staged files on Cloud Storage after loading data. Default is On. Cloud Storage File Prefix: Give staged file names a prefix of your choice. The default setting is an empty field. Recreate Target Table: Choose whether the component recreates its target table before the data load. If Off, the component will use an existing table or create one if it does not exist. Default is On. Use Grid Variable: Check this checkbox to use a grid variable. This box is unchecked by default. |
Data Source Properties
The following table lists any Data Source that requires one or more unique component properties for configuration. If a Data Source is missing from this table, it does NOT have any unique component properties.
| Data Source | Property Name | Type | Description |
|---|---|---|---|
| Account Insights | Instagram Business Account Id | String | Your Instagram Business Account Id. For users who don't have this already, please follow this guide. |
| Since | String | Provide a "Since" start time parameter. This value can be either a Unix timestamp or any English textual datetime description that can be parsed by the PHP function "strtotime". Note: The "Since" and "Until" parameters are inclusive, meaning that if a user's range includes a day that has not yet ended (i.e, today), subsequent queries throughout the day may return increased values. If users do not include the "Since" and "Until" parameters, the API will default to a 2-day range: yesterday through today. | |
| Until | String | Provide an "Until" start time parameter. This value can be either a Unix timestamp or any English textual datetime description that can be parsed by the PHP function "strtotime". Note: The "Since" and "Until" parameters are inclusive, meaning that if a user's range includes a day that has not yet ended (i.e, today), subsequent queries throughout the day may return increased values. If users do not include the "Since" and "Until" parameters, the API will default to a 2-day range: yesterday through today. | |
| Period | Select | Specify an aggregation period. Select from "day", "day_28", "lifetime", or "week". | |
| Audience Insights | Instagram Business Account Id | String | Your Instagram Business Account Id. For users who don't have this already, please follow this guide. |
| Carousel Insights | Media Id | String | The unique identifier for the media object. |
| Comments | Media Id | String | The unique identifier for the media object. |
| Hashtag Recent Media Search | User Id | String | The unique identifier for the user. |
| Hashtag Id | String | The unique identifier for the hashtag. | |
| Hashtag Search | User Id | String | The unique identifier for the user. |
| Hashtag Query | String | Provide a hashtag string. The hashtag symbol [#] is NOT required. Users should query one hashtag at a time. Note: Users can query a maximum of 30 unique hashtags within a 7-day period. | |
| Hashtag Top Media Search | User Id | String | The unique identifier for the user. |
| Hashtag Id | String | The unique identifier for the hashtag. | |
| Media | Instagram Business Account Id | String | Your Instagram Business Account Id. For users who don't have this already, please follow this guide. |
| Media Insights | Since | String | Provide a "Since" start time parameter. This value can be either a Unix timestamp or any English textual datetime description that can be parsed by the PHP function "strtotime". Note: The "Since" and "Until" parameters are inclusive, meaning that if a user's range includes a day that has not yet ended (i.e, today), subsequent queries throughout the day may return increased values. If users do not include the "Since" and "Until" parameters, the API will default to a 2-day range: yesterday through today. |
| Until | String | Provide an "Until" start time parameter. This value can be either a Unix timestamp or any English textual datetime description that can be parsed by the PHP function "strtotime". Note: The "Since" and "Until" parameters are inclusive, meaning that if a user's range includes a day that has not yet ended (i.e, today), subsequent queries throughout the day may return increased values. If users do not include the "Since" and "Until" parameters, the API will default to a 2-day range: yesterday through today. | |
| Media Id | String | The unique identifier for the media object. | |
| Online Followers | Instagram Business Account Id | String | Your Instagram Business Account Id. For users who don't have this already, please follow this guide. |
| Since | String | Provide a "Since" start time parameter. This value can be either a Unix timestamp or any English textual datetime description that can be parsed by the PHP function "strtotime". Note: The "Since" and "Until" parameters are inclusive, meaning that if a user's range includes a day that has not yet ended (i.e, today), subsequent queries throughout the day may return increased values. If users do not include the "Since" and "Until" parameters, the API will default to a 2-day range: yesterday through today. | |
| Until | String | Provide an "Until" start time parameter. This value can be either a Unix timestamp or any English textual datetime description that can be parsed by the PHP function "strtotime". Note: The "Since" and "Until" parameters are inclusive, meaning that if a user's range includes a day that has not yet ended (i.e, today), subsequent queries throughout the day may return increased values. If users do not include the "Since" and "Until" parameters, the API will default to a 2-day range: yesterday through today. | |
| Replies | Comment Id | String | The unique identifier for the comment. |
| Stories | Instagram Business Account Id | String | Your Instagram Business Account Id. For users who don't have this already, please follow this guide. |
| Story Insights | Media Id | String | The unique identifier for the media object. |
| Video Insights | Media Id | String | The unique identifier for the media object. |