Get profile by identifier

get https://{account}.piwik.pro/api/cdp/profiles/v1/app/{app_id}/profile/{identifier_type}/{identifier_value}

Return profile by id, cookie_id or user_id

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

version

number

required

Profile schema version.

string

required

Unique identifier of a profile.

app_id

uuid

required

ID of the app

created_at

date-time

required

Date and time when profile was created.

updated_at

date-time

required

Date and time when profile was updated.

event_count

integer

required

Number of events for profile.

broken

boolean

required

Flag if profile is broken (e.g. due to being too large).

remind_at

date-time

required

Date and time when the profile will be updated.

audiences

array of objects

required

List of Audiences profile belongs to.

audiences*

object

audience_id

uuid

required

Audience identifier.

audience_version

integer

required

Audience version number, incremented on every update of definition or membership_duration_days.

last_match_time

date-time

required

Date and time when profile matched audience definition. From this date audience membership duration is counted.

expired

boolean

required

Defaults to false

Whether audience membership has expired - membership_duration_days has passed since last_match_time.

activations_done

array of uuids

required

List of Activation IDs that were sent for profile.

activations_done*

identifiers

object

required

List of all known identifiers for profile.

Has additional fields

predefined_attributes

object

required

List of all predefined attributes collected for profile.

Has additional fields

custom_dimension_attributes

object

required

List of all attributes from custom dimensions collected for profile.

Has additional fields

custom_attributes

object

required

List of all custom attributes collected for profile.

Has additional fields

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://example.piwik.pro/api/cdp/profiles/v1/app/app_id/profile/id/identifier_value \
3
     --header 'accept: application/vnd.api+json'


xxxxxxxxxx
199
}
1
{
2
  "version": 1,
3
  "id": "fc82690c0aa9f4a0",
4
  "app_id": "05ab11d9-1876-4f00-b533-596d02572c4d",
5
  "created_at": "2023-09-22T17:39:22.830453Z",
6
  "updated_at": "2023-09-22T17:42:07.443853Z",
7
  "event_count": 34,
8
  "broken": false,
9
  "remind_at": "2023-10-22T17:42:07.443853Z",
10
  "audiences": [
11
    {
12
      "audience_id": "ef3601bf-f770-4f88-a62f-55d4cccf955d",
13
      "audience_version": 1,
14
      "last_match_time": "2023-09-22T17:39:49.066433Z",
15
      "expired": false
16
    }
17
  ],
18
  "activations_done": [
19
    "2fb368ff-c0ca-45b9-bac5-421e40a34ff0"
20
  ],
21
  "identifiers": {
22
    "cookie_id": [
23
      "176a5215ff7b62e3"
24
    ],
25
    "user_id": [

Get profile by identifier

Get the full experience

Analytics

200Profile object

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

402CDP module is disabled

403User does not have permissions for this action

404Profile with given cookie_id or organization was not found

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