airbyte.SourceFacebookMarketing

Coming soon!

Coming soon!

Coming soon!

Coming soon!

name string

The unique name of the resource.

args SourceFacebookMarketingArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

resource_name str

The unique name of the resource.

args SourceFacebookMarketingArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name string

The unique name of the resource.

args SourceFacebookMarketingArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args SourceFacebookMarketingArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args SourceFacebookMarketingArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

Configuration SourceFacebookMarketingConfiguration

WorkspaceId string

DefinitionId string

The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.

Name string

Name of the source e.g. dev-mysql-instance.

SecretId string

Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Configuration SourceFacebookMarketingConfigurationArgs

WorkspaceId string

DefinitionId string

The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.

Name string

Name of the source e.g. dev-mysql-instance.

SecretId string

Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceFacebookMarketingConfiguration

workspaceId String

definitionId String

The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.

name String

Name of the source e.g. dev-mysql-instance.

secretId String

Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceFacebookMarketingConfiguration

workspaceId string

definitionId string

The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.

name string

Name of the source e.g. dev-mysql-instance.

secretId string

Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceFacebookMarketingConfigurationArgs

workspace_id str

definition_id str

The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.

name str

Name of the source e.g. dev-mysql-instance.

secret_id str

Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration Property Map

workspaceId String

definitionId String

The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.

name String

Name of the source e.g. dev-mysql-instance.

secretId String

Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

CreatedAt double

Id string

The provider-assigned unique ID for this managed resource.

SourceId string

SourceType string

CreatedAt float64

Id string

The provider-assigned unique ID for this managed resource.

SourceId string

SourceType string

createdAt Double

id String

The provider-assigned unique ID for this managed resource.

sourceId String

sourceType String

createdAt number

id string

The provider-assigned unique ID for this managed resource.

sourceId string

sourceType string

created_at float

id str

The provider-assigned unique ID for this managed resource.

source_id str

source_type str

createdAt Number

id String

The provider-assigned unique ID for this managed resource.

sourceId String

sourceType String

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

AccountIds List<string>

The Facebook Ad account ID(s) to pull data from. The Ad account ID number is in the account dropdown menu or in your browser's address bar of your \n\nMeta Ads Manager\n\n. See the \n\ndocs\n\n for more information.

Credentials SourceFacebookMarketingConfigurationCredentials

Credentials for connecting to the Facebook Marketing API

AccessToken string

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

AdStatuses List<string>

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

AdsetStatuses List<string>

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

CampaignStatuses List<string>

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

CustomInsights List<SourceFacebookMarketingConfigurationCustomInsight>

A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action*breakdowns. Click on "add" to fill this field.

EndDate string

The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.

FetchThumbnailImages bool

Set to active if you want to fetch the thumbnailurl and store the result in thumbnaildata_url for each Ad Creative. Default: false

InsightsJobTimeout double

Insights Job Timeout establishes the maximum amount of time (in minutes) of waiting for the report job to complete. When timeout is reached the job is considered failed and we are trying to request smaller amount of data by breaking the job to few smaller ones. If you definitely know that 60 minutes is not enough for your report to be processed then you can decrease the timeout value, so we start breaking job to smaller parts faster. Default: 60

InsightsLookbackWindow double

The attribution window. Facebook freezes insight data 28 days after it was generated, which means that all data from the past 28 days may have changed since we last emitted it, so you can retrieve refreshed insights from the past by setting this parameter. If you set a custom lookback window value in Facebook account, please provide the same value here. Default: 28

PageSize double

Page size used when sending requests to Facebook API to specify number of records per page when response has pagination. Most users do not need to set this field unless they specifically need to tune the connector to address specific issues or use cases. Default: 100

StartDate string

The date from which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. If not set then all data will be replicated for usual streams and only last 2 years for insight streams.

AccountIds []string

The Facebook Ad account ID(s) to pull data from. The Ad account ID number is in the account dropdown menu or in your browser's address bar of your \n\nMeta Ads Manager\n\n. See the \n\ndocs\n\n for more information.

Credentials SourceFacebookMarketingConfigurationCredentials

Credentials for connecting to the Facebook Marketing API

AccessToken string

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

AdStatuses []string

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

AdsetStatuses []string

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

CampaignStatuses []string

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

CustomInsights []SourceFacebookMarketingConfigurationCustomInsight

A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action*breakdowns. Click on "add" to fill this field.

EndDate string

The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.

FetchThumbnailImages bool

Set to active if you want to fetch the thumbnailurl and store the result in thumbnaildata_url for each Ad Creative. Default: false

InsightsJobTimeout float64

Insights Job Timeout establishes the maximum amount of time (in minutes) of waiting for the report job to complete. When timeout is reached the job is considered failed and we are trying to request smaller amount of data by breaking the job to few smaller ones. If you definitely know that 60 minutes is not enough for your report to be processed then you can decrease the timeout value, so we start breaking job to smaller parts faster. Default: 60

InsightsLookbackWindow float64

The attribution window. Facebook freezes insight data 28 days after it was generated, which means that all data from the past 28 days may have changed since we last emitted it, so you can retrieve refreshed insights from the past by setting this parameter. If you set a custom lookback window value in Facebook account, please provide the same value here. Default: 28

PageSize float64

Page size used when sending requests to Facebook API to specify number of records per page when response has pagination. Most users do not need to set this field unless they specifically need to tune the connector to address specific issues or use cases. Default: 100

StartDate string

The date from which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. If not set then all data will be replicated for usual streams and only last 2 years for insight streams.

accountIds List<String>

The Facebook Ad account ID(s) to pull data from. The Ad account ID number is in the account dropdown menu or in your browser's address bar of your \n\nMeta Ads Manager\n\n. See the \n\ndocs\n\n for more information.

credentials SourceFacebookMarketingConfigurationCredentials

Credentials for connecting to the Facebook Marketing API

accessToken String

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

adStatuses List<String>

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

adsetStatuses List<String>

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

campaignStatuses List<String>

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

customInsights List<SourceFacebookMarketingConfigurationCustomInsight>

A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action*breakdowns. Click on "add" to fill this field.

endDate String

The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.

fetchThumbnailImages Boolean

Set to active if you want to fetch the thumbnailurl and store the result in thumbnaildata_url for each Ad Creative. Default: false

insightsJobTimeout Double

Insights Job Timeout establishes the maximum amount of time (in minutes) of waiting for the report job to complete. When timeout is reached the job is considered failed and we are trying to request smaller amount of data by breaking the job to few smaller ones. If you definitely know that 60 minutes is not enough for your report to be processed then you can decrease the timeout value, so we start breaking job to smaller parts faster. Default: 60

insightsLookbackWindow Double

The attribution window. Facebook freezes insight data 28 days after it was generated, which means that all data from the past 28 days may have changed since we last emitted it, so you can retrieve refreshed insights from the past by setting this parameter. If you set a custom lookback window value in Facebook account, please provide the same value here. Default: 28

pageSize Double

Page size used when sending requests to Facebook API to specify number of records per page when response has pagination. Most users do not need to set this field unless they specifically need to tune the connector to address specific issues or use cases. Default: 100

startDate String

The date from which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. If not set then all data will be replicated for usual streams and only last 2 years for insight streams.

accountIds string[]

The Facebook Ad account ID(s) to pull data from. The Ad account ID number is in the account dropdown menu or in your browser's address bar of your \n\nMeta Ads Manager\n\n. See the \n\ndocs\n\n for more information.

credentials SourceFacebookMarketingConfigurationCredentials

Credentials for connecting to the Facebook Marketing API

accessToken string

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

adStatuses string[]

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

adsetStatuses string[]

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

campaignStatuses string[]

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

customInsights SourceFacebookMarketingConfigurationCustomInsight[]

A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action*breakdowns. Click on "add" to fill this field.

endDate string

The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.

fetchThumbnailImages boolean

Set to active if you want to fetch the thumbnailurl and store the result in thumbnaildata_url for each Ad Creative. Default: false

insightsJobTimeout number

Insights Job Timeout establishes the maximum amount of time (in minutes) of waiting for the report job to complete. When timeout is reached the job is considered failed and we are trying to request smaller amount of data by breaking the job to few smaller ones. If you definitely know that 60 minutes is not enough for your report to be processed then you can decrease the timeout value, so we start breaking job to smaller parts faster. Default: 60

insightsLookbackWindow number

The attribution window. Facebook freezes insight data 28 days after it was generated, which means that all data from the past 28 days may have changed since we last emitted it, so you can retrieve refreshed insights from the past by setting this parameter. If you set a custom lookback window value in Facebook account, please provide the same value here. Default: 28

pageSize number

Page size used when sending requests to Facebook API to specify number of records per page when response has pagination. Most users do not need to set this field unless they specifically need to tune the connector to address specific issues or use cases. Default: 100

startDate string

The date from which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. If not set then all data will be replicated for usual streams and only last 2 years for insight streams.

account_ids Sequence[str]

The Facebook Ad account ID(s) to pull data from. The Ad account ID number is in the account dropdown menu or in your browser's address bar of your \n\nMeta Ads Manager\n\n. See the \n\ndocs\n\n for more information.

credentials SourceFacebookMarketingConfigurationCredentials

Credentials for connecting to the Facebook Marketing API

access_token str

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

ad_statuses Sequence[str]

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

adset_statuses Sequence[str]

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

campaign_statuses Sequence[str]

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

custom_insights Sequence[SourceFacebookMarketingConfigurationCustomInsight]

A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action*breakdowns. Click on "add" to fill this field.

end_date str

The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.

fetch_thumbnail_images bool

Set to active if you want to fetch the thumbnailurl and store the result in thumbnaildata_url for each Ad Creative. Default: false

insights_job_timeout float

Insights Job Timeout establishes the maximum amount of time (in minutes) of waiting for the report job to complete. When timeout is reached the job is considered failed and we are trying to request smaller amount of data by breaking the job to few smaller ones. If you definitely know that 60 minutes is not enough for your report to be processed then you can decrease the timeout value, so we start breaking job to smaller parts faster. Default: 60

insights_lookback_window float

The attribution window. Facebook freezes insight data 28 days after it was generated, which means that all data from the past 28 days may have changed since we last emitted it, so you can retrieve refreshed insights from the past by setting this parameter. If you set a custom lookback window value in Facebook account, please provide the same value here. Default: 28

page_size float

Page size used when sending requests to Facebook API to specify number of records per page when response has pagination. Most users do not need to set this field unless they specifically need to tune the connector to address specific issues or use cases. Default: 100

start_date str

The date from which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. If not set then all data will be replicated for usual streams and only last 2 years for insight streams.

accountIds List<String>

The Facebook Ad account ID(s) to pull data from. The Ad account ID number is in the account dropdown menu or in your browser's address bar of your \n\nMeta Ads Manager\n\n. See the \n\ndocs\n\n for more information.

credentials Property Map

Credentials for connecting to the Facebook Marketing API

accessToken String

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

adStatuses List<String>

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

adsetStatuses List<String>

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

campaignStatuses List<String>

Select the statuses you want to be loaded in the stream. If no specific statuses are selected, the API's default behavior applies, and some statuses may be filtered out.

customInsights List<Property Map>

A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action*breakdowns. Click on "add" to fill this field.

endDate String

The date until which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.

fetchThumbnailImages Boolean

Set to active if you want to fetch the thumbnailurl and store the result in thumbnaildata_url for each Ad Creative. Default: false

insightsJobTimeout Number

Insights Job Timeout establishes the maximum amount of time (in minutes) of waiting for the report job to complete. When timeout is reached the job is considered failed and we are trying to request smaller amount of data by breaking the job to few smaller ones. If you definitely know that 60 minutes is not enough for your report to be processed then you can decrease the timeout value, so we start breaking job to smaller parts faster. Default: 60

insightsLookbackWindow Number

The attribution window. Facebook freezes insight data 28 days after it was generated, which means that all data from the past 28 days may have changed since we last emitted it, so you can retrieve refreshed insights from the past by setting this parameter. If you set a custom lookback window value in Facebook account, please provide the same value here. Default: 28

pageSize Number

Page size used when sending requests to Facebook API to specify number of records per page when response has pagination. Most users do not need to set this field unless they specifically need to tune the connector to address specific issues or use cases. Default: 100

startDate String

The date from which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. If not set then all data will be replicated for usual streams and only last 2 years for insight streams.

AuthenticateViaFacebookMarketingOauth SourceFacebookMarketingConfigurationCredentialsAuthenticateViaFacebookMarketingOauth

ServiceAccountKeyAuthentication SourceFacebookMarketingConfigurationCredentialsServiceAccountKeyAuthentication

AuthenticateViaFacebookMarketingOauth SourceFacebookMarketingConfigurationCredentialsAuthenticateViaFacebookMarketingOauth

ServiceAccountKeyAuthentication SourceFacebookMarketingConfigurationCredentialsServiceAccountKeyAuthentication

authenticateViaFacebookMarketingOauth SourceFacebookMarketingConfigurationCredentialsAuthenticateViaFacebookMarketingOauth

serviceAccountKeyAuthentication SourceFacebookMarketingConfigurationCredentialsServiceAccountKeyAuthentication

authenticateViaFacebookMarketingOauth SourceFacebookMarketingConfigurationCredentialsAuthenticateViaFacebookMarketingOauth

serviceAccountKeyAuthentication SourceFacebookMarketingConfigurationCredentialsServiceAccountKeyAuthentication

authenticate_via_facebook_marketing_oauth SourceFacebookMarketingConfigurationCredentialsAuthenticateViaFacebookMarketingOauth

service_account_key_authentication SourceFacebookMarketingConfigurationCredentialsServiceAccountKeyAuthentication

authenticateViaFacebookMarketingOauth Property Map

serviceAccountKeyAuthentication Property Map

ClientId string

Client ID for the Facebook Marketing API

ClientSecret string

Client Secret for the Facebook Marketing API

AccessToken string

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

ClientId string

Client ID for the Facebook Marketing API

ClientSecret string

Client Secret for the Facebook Marketing API

AccessToken string

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

clientId String

Client ID for the Facebook Marketing API

clientSecret String

Client Secret for the Facebook Marketing API

accessToken String

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

clientId string

Client ID for the Facebook Marketing API

clientSecret string

Client Secret for the Facebook Marketing API

accessToken string

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

client_id str

Client ID for the Facebook Marketing API

client_secret str

Client Secret for the Facebook Marketing API

access_token str

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

clientId String

Client ID for the Facebook Marketing API

clientSecret String

Client Secret for the Facebook Marketing API

accessToken String

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

AccessToken string

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

AccessToken string

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

accessToken String

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

accessToken string

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

access_token str

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

accessToken String

The value of the generated access token. From your App’s Dashboard, click on "Marketing API" then "Tools". Select permissions \n\nadsmanagement, adsread, readinsights, businessmanagement\n\n. Then click on "Get token". See the \n\ndocs\n\n for more information.

Name string

The name value of insight

ActionBreakdowns List<string>

A list of chosen actionbreakdowns for actionbreakdowns

ActionReportTime string

Determines the report time of action stats. For example, if a person saw the ad on Jan 1st but converted on Jan 2nd, when you query the API with actionreporttime=impression, you see a conversion on Jan 1st. When you query the API with actionreporttime=conversion, you see a conversion on Jan 2nd. Default: "mixed"; must be one of ["conversion", "impression", "mixed"]

Breakdowns List<string>

A list of chosen breakdowns for breakdowns

EndDate string

The date until which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.

Fields List<string>

A list of chosen fields for fields parameter

InsightsJobTimeout double

The insights job timeout. Default: 60

InsightsLookbackWindow double

The attribution window. Default: 28

Level string

Chosen level for API. Default: "ad"; must be one of ["ad", "adset", "campaign", "account"]

StartDate string

The date from which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z.

TimeIncrement double

Time window in days by which to aggregate statistics. The sync will be chunked into N day intervals, where N is the number of days you specified. For example, if you set this value to 7, then all statistics will be reported as 7-day aggregates by starting from the start_date. If the start and end dates are October 1st and October 30th, then the connector will output 5 records: 01 - 06, 07 - 13, 14 - 20, 21 - 27, and 28 - 30 (3 days only). The minimum allowed value for this field is 1, and the maximum is 89. Default: 1

Name string

The name value of insight

ActionBreakdowns []string

A list of chosen actionbreakdowns for actionbreakdowns

ActionReportTime string

Determines the report time of action stats. For example, if a person saw the ad on Jan 1st but converted on Jan 2nd, when you query the API with actionreporttime=impression, you see a conversion on Jan 1st. When you query the API with actionreporttime=conversion, you see a conversion on Jan 2nd. Default: "mixed"; must be one of ["conversion", "impression", "mixed"]

Breakdowns []string

A list of chosen breakdowns for breakdowns

EndDate string

The date until which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.

Fields []string

A list of chosen fields for fields parameter

InsightsJobTimeout float64

The insights job timeout. Default: 60

InsightsLookbackWindow float64

The attribution window. Default: 28

Level string

Chosen level for API. Default: "ad"; must be one of ["ad", "adset", "campaign", "account"]

StartDate string

The date from which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z.

TimeIncrement float64

Time window in days by which to aggregate statistics. The sync will be chunked into N day intervals, where N is the number of days you specified. For example, if you set this value to 7, then all statistics will be reported as 7-day aggregates by starting from the start_date. If the start and end dates are October 1st and October 30th, then the connector will output 5 records: 01 - 06, 07 - 13, 14 - 20, 21 - 27, and 28 - 30 (3 days only). The minimum allowed value for this field is 1, and the maximum is 89. Default: 1

name String

The name value of insight

actionBreakdowns List<String>

A list of chosen actionbreakdowns for actionbreakdowns

actionReportTime String

Determines the report time of action stats. For example, if a person saw the ad on Jan 1st but converted on Jan 2nd, when you query the API with actionreporttime=impression, you see a conversion on Jan 1st. When you query the API with actionreporttime=conversion, you see a conversion on Jan 2nd. Default: "mixed"; must be one of ["conversion", "impression", "mixed"]

breakdowns List<String>

A list of chosen breakdowns for breakdowns

endDate String

The date until which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.

fields List<String>

A list of chosen fields for fields parameter

insightsJobTimeout Double

The insights job timeout. Default: 60

insightsLookbackWindow Double

The attribution window. Default: 28

level String

Chosen level for API. Default: "ad"; must be one of ["ad", "adset", "campaign", "account"]

startDate String

The date from which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z.

timeIncrement Double

Time window in days by which to aggregate statistics. The sync will be chunked into N day intervals, where N is the number of days you specified. For example, if you set this value to 7, then all statistics will be reported as 7-day aggregates by starting from the start_date. If the start and end dates are October 1st and October 30th, then the connector will output 5 records: 01 - 06, 07 - 13, 14 - 20, 21 - 27, and 28 - 30 (3 days only). The minimum allowed value for this field is 1, and the maximum is 89. Default: 1

name string

The name value of insight

actionBreakdowns string[]

A list of chosen actionbreakdowns for actionbreakdowns

actionReportTime string

Determines the report time of action stats. For example, if a person saw the ad on Jan 1st but converted on Jan 2nd, when you query the API with actionreporttime=impression, you see a conversion on Jan 1st. When you query the API with actionreporttime=conversion, you see a conversion on Jan 2nd. Default: "mixed"; must be one of ["conversion", "impression", "mixed"]

breakdowns string[]

A list of chosen breakdowns for breakdowns

endDate string

The date until which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.

fields string[]

A list of chosen fields for fields parameter

insightsJobTimeout number

The insights job timeout. Default: 60

insightsLookbackWindow number

The attribution window. Default: 28

level string

Chosen level for API. Default: "ad"; must be one of ["ad", "adset", "campaign", "account"]

startDate string

The date from which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z.

timeIncrement number

Time window in days by which to aggregate statistics. The sync will be chunked into N day intervals, where N is the number of days you specified. For example, if you set this value to 7, then all statistics will be reported as 7-day aggregates by starting from the start_date. If the start and end dates are October 1st and October 30th, then the connector will output 5 records: 01 - 06, 07 - 13, 14 - 20, 21 - 27, and 28 - 30 (3 days only). The minimum allowed value for this field is 1, and the maximum is 89. Default: 1

name str

The name value of insight

action_breakdowns Sequence[str]

A list of chosen actionbreakdowns for actionbreakdowns

action_report_time str

Determines the report time of action stats. For example, if a person saw the ad on Jan 1st but converted on Jan 2nd, when you query the API with actionreporttime=impression, you see a conversion on Jan 1st. When you query the API with actionreporttime=conversion, you see a conversion on Jan 2nd. Default: "mixed"; must be one of ["conversion", "impression", "mixed"]

breakdowns Sequence[str]

A list of chosen breakdowns for breakdowns

end_date str

The date until which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.

fields Sequence[str]

A list of chosen fields for fields parameter

insights_job_timeout float

The insights job timeout. Default: 60

insights_lookback_window float

The attribution window. Default: 28

level str

Chosen level for API. Default: "ad"; must be one of ["ad", "adset", "campaign", "account"]

start_date str

The date from which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z.

time_increment float

Time window in days by which to aggregate statistics. The sync will be chunked into N day intervals, where N is the number of days you specified. For example, if you set this value to 7, then all statistics will be reported as 7-day aggregates by starting from the start_date. If the start and end dates are October 1st and October 30th, then the connector will output 5 records: 01 - 06, 07 - 13, 14 - 20, 21 - 27, and 28 - 30 (3 days only). The minimum allowed value for this field is 1, and the maximum is 89. Default: 1

name String

The name value of insight

actionBreakdowns List<String>

A list of chosen actionbreakdowns for actionbreakdowns

actionReportTime String

Determines the report time of action stats. For example, if a person saw the ad on Jan 1st but converted on Jan 2nd, when you query the API with actionreporttime=impression, you see a conversion on Jan 1st. When you query the API with actionreporttime=conversion, you see a conversion on Jan 2nd. Default: "mixed"; must be one of ["conversion", "impression", "mixed"]

breakdowns List<String>

A list of chosen breakdowns for breakdowns

endDate String

The date until which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z. All data generated between the start date and this end date will be replicated. Not setting this option will result in always syncing the latest data.

fields List<String>

A list of chosen fields for fields parameter

insightsJobTimeout Number

The insights job timeout. Default: 60

insightsLookbackWindow Number

The attribution window. Default: 28

level String

Chosen level for API. Default: "ad"; must be one of ["ad", "adset", "campaign", "account"]

startDate String

The date from which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z.

timeIncrement Number

Time window in days by which to aggregate statistics. The sync will be chunked into N day intervals, where N is the number of days you specified. For example, if you set this value to 7, then all statistics will be reported as 7-day aggregates by starting from the start_date. If the start and end dates are October 1st and October 30th, then the connector will output 5 records: 01 - 06, 07 - 13, 14 - 20, 21 - 27, and 28 - 30 (3 days only). The minimum allowed value for this field is 1, and the maximum is 89. Default: 1