connectors.falcon

Preview the data

post/connectors/falcon/preview

Request

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

Array of strings.

metricIdsstring[]

Array of strings.

channelIdsstring[]

Array of strings.

contentIdsstring[]

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",
  "networks": [
    "instagram",
    "facebook"
  ],
  "metricIds": [
    "1",
    "2"
  ],
  "channelIds": [
    "1",
    "2"
  ],
  "contentIds": [
    "1",
    "2"
  ]
}

Response

Data preview

codestring
blobstring
messagestring
headerstring[]

Array of strings.

keystring[]

Array of strings.

typestring[]
row_countinteger
dataobject[]

Row-oriented data: a list of rows, each row a map keyed by column name.

Example response

{
  "header": [
    "np1NErz7B4",
    "rPMOx7EOp9"
  ],
  "log": [
    {
      "request_header": {
        "key": "value"
      },
      "response_header": {
        "key": "value"
      }
    }
  ],
  "key": [
    "np1NErz7B4",
    "rPMOx7EOp9"
  ]
}

Changes

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