Create custom attribute

post https://{account}.piwik.pro/api/cdp/settings/v1/app/{app_id}/attribute

Creates a new custom attribute

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

column_id

string

required

Unique ID of column.

event_data_key

string

required

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

immutable

boolean

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.

column_meta

object

required

Column metadata (readonly).

column_name

string

Name of the column.

column_type

string

Type of the column.

number string ipv4 ipv6 bool int uuid hex datetime

column_unit

string

Unit of the column.

currency url days pixels none millisecond

column_category

array of strings

Categories of the column.

column_category

analytics_column_id

string

Name of the column in Analytics module. Used to calculate audience count.

analytics_transformation_id

string

Transformation name used in Analytics module to calculate audience count. Currently one option available.

sum

value_selectors

array of strings

length ≥ 0

List of value selectors possible for given column.

value_selectors

extractions

array of strings

length ≥ 0

List of extractions possible for given column.

extractions

aggregation

string

Aggregation for attribute values.

first last first_last list list_unique min max sum

scope

string

Defines the scope of dimension.

event profile

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://example.piwik.pro/api/cdp/settings/v1/app/app_id/attribute \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "data_type": "number",
8
  "aggregation": "first"
9
}
10
'


xxxxxxxxxx
23
 
1
{
2
  "column_id": "custom_attribute_3",
3
  "event_data_key": "user_age",
4
  "immutable": false,
5
  "column_meta": {
6
    "column_name": "Browser Type",
7
    "column_type": "string",
8
    "column_unit": "currency",
9
    "column_category": [
10
      "Custom attribute"
11
    ],
12
    "analytics_column_id": "goal_revenue",
13
    "analytics_transformation_id": "sum",
14
    "value_selectors": [
15
      "first"
16
    ],
17
    "extractions": [
18
      "first"
19
    ],
20
    "aggregation": "first",
21
    "scope": "event"
22
  }
23
}

201Created

400Bad request response (e.g. missing GET parameter, parameter value out of bounds)

401Access token is missing or invalid

402CDP module is disabled

404Resource not found (bad ID or resource deleted)

422Data in body does not meet requirements (e.g. missing field)

500Internal application error response (some service encountered unexpected error)

Get the full experience

Analytics