connectors.adobe_analytics

Preview the data

post/connectors/adobe_analytics/preview

Request

  • Base URL: https://headless.dataddo.com/customer-api/v1
  • URL: https://headless.dataddo.com/customer-api/v1/connectors/adobe_analytics/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
global_company_idstring

Adobe Analytics global company ID.

report_suite_idstring

Adobe Analytics report suite ID.

metricsstring[]

Selected metric IDs.

dimensionstring

Selected dimension ID. One dimension per request.

include_report_suite_idboolean

Add the report suite ID as a column to the output.

unpivot_metricsboolean

Expand the metric columns into one row per metric, with a metric name and a value column.

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",
  "global_company_id": "examplecompany",
  "report_suite_id": "examplersid",
  "metrics": [
    "metrics/pageviews",
    "metrics/visits"
  ],
  "dimension": "variables/page",
  "hash_columns": [
    "id",
    "date_start"
  ],
  "masked_columns": [
    "name",
    "email"
  ]
}

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.