Create audience

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

Create a new Audience

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

uuid

required

ID of the audience

app_id

uuid

required

ID of the app

created_at

date-time

required

Audience creation date

updated_at

date-time

required

Latest audience update date

name

string

required

Name of the audience

description

string

required

Description of the audience

membership_duration_days

integer

required

Time (in days) after which profiles are removed from an audience

definition

object

required

Audience definition

operator

const

required

Logical operator to be used between conditions.

conditions

array of objects

required

length between 1 and 10

List of conditions. Maximum number of conditions (sum of profile and event conditions) is 10.

conditions*

object

operator

const

required

Logical operator to be used between conditions.

conditions

array

required

length between 1 and 10

List of conditions.

conditions*

author

object

required

User who created this audience

string

is_author

boolean

required

Whether the audience was created by the user who issues the request

version

integer

required

≥ 1

Version number, incremented on every update of definition or membership_duration_days

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
29
1
curl --request POST \
2
     --url https://example.piwik.pro/api/cdp/settings/v1/app/app_id/audience \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "definition": {
8
    "conditions": [
9
      {
10
        "conditions": [
11
          {
12
            "column_meta": {
13
              "column_type": "number",
14
              "column_unit": "currency",
15
              "analytics_transformation_id": "sum",
16
              "aggregation": "first",
17
              "scope": "event"
18
            },
19
            "value_selector": "first",
20
            "condition": {
21
              "operator": "eq"
22
            }
23
          }
24
        ]
25
      }
26
    ]
27
  }
28
}
29
'


xxxxxxxxxx
93
}
1
{
2
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3
  "app_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4
  "created_at": "2025-04-13T03:05:55.451Z",
5
  "updated_at": "2025-04-13T03:05:55.451Z",
6
  "name": "string",
7
  "description": "string",
8
  "membership_duration_days": 0,
9
  "definition": {
10
    "operator": "string",
11
    "conditions": [
12
      {
13
        "operator": "or",
14
        "conditions": [
15
          {
16
            "condition_type": "string",
17
            "column_id": "location_country_iso_code",
18
            "column_meta": {
19
              "column_name": "Browser Type",
20
              "column_type": "string",
21
              "column_unit": "currency",
22
              "column_category": [
23
                "Device"
24
              ],
25
              "analytics_column_id": "goal_revenue",

Create audience

Get the full experience

Analytics

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