connectors.similarweb_batch

Create source

post/connectors/similarweb_batch/create-source

Request

  • Base URL: https://headless.dataddo.com/customer-api/v1
  • URL: https://headless.dataddo.com/customer-api/v1/connectors/similarweb_batch/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
domainsstring[]

Array of domains.

metricsstring[]

Array of metrics.

countriesstring[]

Array of countries.

granularitystring

Granularity

tablestring

Report Table

include_subdomainsboolean

Include subdomains

retention_daysinteger

Retention days

use_extraction_timestampboolean
use_hashboolean
use_date_startboolean
use_date_stopboolean
use_masked_columnsboolean
hash_columnsstring[]

Array of strings.

masked_columnsstring[]

Array of strings.

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",
  "domains": [
    "dataddo.com",
    "facebook.com",
    "google.com"
  ],
  "metrics": [
    "desktop_audience_interests_affinity",
    "desktop_audience_interests_overlap"
  ],
  "countries": [
    "AU",
    "JP"
  ],
  "granularity": "day",
  "table": "traffic_and_engagement",
  "include_subdomains": true,
  "retention_days": 60,
  "hash_columns": [
    "id",
    "date_start"
  ],
  "masked_columns": [
    "name",
    "email"
  ]
}

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.