v1

latestOpenAPI 3.1.02026-07-2419603.1 MB

Data Activation

Create audience

Create a new Audience. Requires edit permission.

post/api/cdp/settings/v1/app/{app_id}/audience

Path parameters

app_idstring uuid required

ID of the app.

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

Request body

namestring required

descriptionstring required

membership_duration_daysinteger required

Example request

{
  "definition": {
    "conditions": [
      {
        "conditions": [
          {
            "column_id": "location_country_iso_code",
            "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"
            },
            "condition": {
              "operator": "eq",
              "label": "Poland"
            }
          }
        ]
      }
    ]
  }
}

Response

Created

idstring uuid required

ID of the audience

app_idstring uuid required

ID of the app

created_atstring date-time required

Audience creation date

updated_atstring date-time required

Latest audience update date

namestring required

Name of the audience

descriptionstring required

Description of the audience

membership_duration_daysinteger required

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

type'standard' | 'sequential' required

is_authorboolean required

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

versioninteger required

Version number, incremented on every update of definition or membership_duration_days

Example response

{
  "definition": {
    "conditions": [
      {
        "conditions": [
          {
            "column_id": "location_country_iso_code",
            "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"
            },
            "condition": {
              "operator": "eq",
              "label": "Poland"
            }
          }
        ]
      }
    ]
  },
  "author": {
    "email": "author@piwik.pro"
  }
}