v1

latestOpenAPI 3.1.02026-07-2419603.1 MB
Data Activation

List attributes

Returns a list of all profiles attributes available in Data Activation for given app. Requires view permission.

get/api/cdp/settings/v1/app/{app_id}/attribute

Path parameters

app_idstring uuid required

ID of the app.

Example:3929d56c-cd62-4001-a4fc-013f5f954691

Response

OK

column_idstring required

Unique ID of column.

data_type'number' | 'bool' | 'ip' | 'datetime' | 'string' required

Type of the data.

aggregation'first' | 'last' | 'first_last' | 'list' | 'list_unique' | 'min' | 'max' | 'sum' required

Aggregation type for attribute values.

event_data_keystring required

Key of the imported data value or name of Tracker event dimension to populate attribute.

immutableboolean required

A flag indicating whether the attribute is immutable.

If immutable is set to true, the attribute is considered read-only and cannot be modified. If set to false, the attribute can be modified.

publicly_accessibleboolean required

A flag indicating whether the attribute is accessible via the public API.

If publicly_accessible is set to true, the attribute can be retrieved through the public profile attributes endpoint without authentication. If set to false, the attribute is only available through authenticated endpoints.

Example response

[
  {
    "data_type": "string",
    "aggregation": "first",
    "event_data_key": "user_age",
    "column_meta": {
      "column_name": "Browser Type",
      "column_type": "string",
      "column_unit": "currency",
      "column_category": [
        "Device"
      ],
      "analytics_column_id": "goal_revenue",
      "analytics_transformation_id": "sum",
      "value_selectors": [
        "first"
      ],
      "extractions": [
        "first"
      ],
      "aggregation": "first",
      "scope": "event"
    }
  }
]