This API can be used to read out DMP identifier titles added through the /dmp/title/update API. These titles will be returned as part of the query result from /dmp/traffic/custom if requested.
The user must be authenticated and have read permissions to a site group/site with the registered customer prefix the specified origin is using.
Request
The request object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
origin |
String |
Yes |
The origin used for the performance events the names are applicable for. The origin must start with a registered customer prefix. The origin serves as a namespace for the uploaded titles. |
|
group |
String |
Yes |
The parameter name the value belongs to. Examples could be "creative", "ad" or similar. |
|
item |
String |
No |
The parameter value to retrieve a descriptive title for. If no item is specified, the first 50000 items for the group will be returned. |
Response
The response object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
titles |
List of objects |
Contains the list of object describing the titles matching the query. If no title(s) has been added that matches the request, an empty list is returned. |
Each of the objects in the titles field has the following form:
|
Name |
Type |
Description |
|---|---|---|
|
group |
String |
The parameter name. |
|
item |
String |
The parameter value this title describes. |
|
title |
String |
The title stored for this item/group. |
Examples
$ cx.py /dmp/title '{"origin":"xyz-survey1", "item":"03484hd", "group":"question"}'
{
"titles": [
{
"item": "03484hd",
"group": "question",
"title": "Favourite animal"
}
]
}