connectors.google_analytics_4

Preview the data

post/connectors/google_analytics_4/preview

Request

  • Base URL: https://headless.dataddo.com/customer-api/v1
  • URL: https://headless.dataddo.com/customer-api/v1/connectors/google_analytics_4/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
use_extraction_timestampboolean
use_hashboolean
use_date_startboolean
use_date_stopboolean
use_masked_columnsboolean
hash_columnsstring[]

Array of strings.

masked_columnsstring[]

Array of strings.

context_metadatastring[]

Context Metadata

propertyIdsstring[]

Array of Property Ids.

accountIdsstring[]

Array of Accounts Ids.

subPropertyIdsstring[]

This field is deprecated, use propertyIds instead

dimensionsstring[]

Array of Dimensions.

metricsstring[]

Array of Metrics.

dimension_filterstring nullable

Filter for dimension. Have to be valid json.

metric_filterstring nullable

Filter for metric. Have to be valid json.

limitinteger nullable

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",
  "hash_columns": [
    "id",
    "date_start"
  ],
  "masked_columns": [
    "name",
    "email"
  ],
  "context_metadata": [
    "account_id"
  ],
  "propertyIds": [
    "123456789",
    "987654321"
  ],
  "accountIds": [
    "123456789",
    "987654321"
  ],
  "subPropertyIds": [
    "123456789",
    "987654321"
  ],
  "dimensions": [
    "date",
    "pagePath",
    "pageTitle"
  ],
  "metrics": [
    "page_impressions",
    "page_impressions_unique"
  ],
  "dimension_filter": "{\n            \"filter\": {\n                \"fieldName\": \"screenPageViews\",\n                \"numericFilter\": {\n                    \"operation\": \"GREATER_THAN_OR_EQUAL\",\n                    \"value\": {\n                        \"int64Value\": 200\n                    }\n                }\n            }\n        }",
  "metric_filter": "{\n            \"filter\": {\n                \"fieldName\": \"screenPageViews\",\n                \"numericFilter\": {\n                    \"operation\": \"GREATER_THAN_OR_EQUAL\",\n                    \"value\": {\n                        \"int64Value\": 200\n                    }\n                }\n            }\n        }"
}

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.