v1

latestOpenAPI 3.1.02026-07-2419603.1 MB

Data Activation

List activations

Get all activations. Requires view permission.

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

Query parameters

audience_idstring uuid

Example:aaa1550f-b5a5-4626-a4ac-2f99ff8148fe

When provided, only activations with this audience will be returned

Response

An array of activations matching given criteria

idstring uuid required

Activation ID

namestring required

Activation name

status'active' | 'inactive' required

Activation status. active enables profiles activation, inactive disables profile activation. If activation has no audience associated with it, Activation API will always return inactive.

required_consentsstring[] required

Consent types a profile must contain to be activated

created_atstring date-time required

Activation creation time

updated_atstring date-time required

Activation last update time

is_authorboolean required

Whether the current user is the author of this activation

type'webhook' | 'gads_customer_match' required

Type of activation

Example response

[
  {
    "id": "ca2f7459-e6e6-466b-a4a9-d9af89682c3b",
    "name": "My activation",
    "status": "active",
    "required_consents": [
      "ab_testing_and_personalization",
      "remarketing"
    ],
    "created_at": "2020-07-14T13:30:07Z",
    "updated_at": "2020-07-14T13:30:07Z",
    "author": {
      "email": "author@piwik.pro"
    }
  }
]