connectors.facebook_ads

Create source

post/connectors/facebook_ads/create-source

Request

  • Base URL: https://headless.dataddo.com/customer-api/v1
  • URL: https://headless.dataddo.com/customer-api/v1/connectors/facebook_ads/create-source
  • Auth: none declared

Request body

o_auth_idstring
authorizer_idstring
nullable_fieldsboolean

Setting this parameter to true allows the use of null values. If set to false, default values for each data type will be used instead.

ensure_data_typesobject

Overrides the default data types of the produced Source schema, ensuring that each field is typed as specified.

data_typesobject

Overrides the default data types of the produced Source schema, ensuring that each field is typed as specified.

connector_idstring
template_idstring
labelstring
allow_emptyboolean

Setting this parameter to true allows extraction operations to proceed even if they produce 0 rows. If set to false, the operation will result in an error if no rows are extracted.

date_rangestring nullable
accountIdsstring[]

Array of strings.

pageIdsstring[]

Array of strings.

campaign_idstring nullable
ad_set_idstring nullable
metricsstring[]

Array of strings.

dataLabelsstring[]

Array of strings.

levelstring
timeBreakupstring
breakdownsstring[]

Array of strings.

timezonestring
startstring nullable

Query start date.

stopstring nullable

Query stop date.

filterstring nullable
use_filterboolean nullable
use_unified_attribution_settingboolean
attribution_windowstring nullable
report_timestring nullable
include_filterboolean nullable
by_campaignboolean

Whether to pull data by campaign (needed when we are on ad level and want conversions).

attributesstring[]

Array of strings.

usernamestring

Any Instagram username you want data from

use_extraction_timestampboolean
use_hashboolean
use_date_startboolean
use_date_stopboolean
use_masked_columnsboolean
hash_columnsstring[]

Array of strings.

masked_columnsstring[]

Array of strings.

account_idstring

This field is deprecated, use accountIds instead.

use_dataddo_hashboolean

Use useHash instead.

metricstring[]

Array of Metrics. This field is deprecated, use metrics instead

data_labelstring[]

Array of Data Labels. This field is deprecated, use dataLabels instead

breakdownstring

Breakdowns. This field is deprecated, use breakdowns instead

Example request

{
  "authorizer_id": "P6T8tazCWdf3pkVzIAlnZa10gh",
  "ensure_data_types": {
    "field1": "float",
    "field2": "string",
    "field3": "integer",
    "field4": "date"
  },
  "data_types": {
    "field1": "float",
    "field2": "string",
    "field3": "integer",
    "field4": "date"
  },
  "date_range": "1d1",
  "accountIds": [
    "np1NErz7B4",
    "rPMOx7EOp9"
  ],
  "pageIds": [
    "1",
    "2"
  ],
  "metrics": [
    "page_media_view"
  ],
  "dataLabels": [
    "page_id",
    "page_name"
  ],
  "level": "campaign",
  "breakdowns": [
    "age",
    "gender"
  ],
  "attributes": [
    "id",
    "ig_id",
    "media_id"
  ],
  "username": "dataddo_com",
  "hash_columns": [
    "id",
    "date_start"
  ],
  "masked_columns": [
    "name",
    "email"
  ],
  "metric": [
    "page_media_view"
  ],
  "data_label": [
    "page_id",
    "page_name"
  ],
  "breakdown": "page_id"
}

Response

Create source

external_idstring nullable

The id of the document in external systems. By setting external_id you can link document with external systems id.

is_lockedboolean

You may mark the document as locked to prevent accidental changes. When locked, the document cannot be modified or deleted.

labelstring
descriptionstring
typestring
customer_idstring
created_atinteger
updated_atinteger

Changes

No recorded changes to this operation across all 1 revision of this API.