This API can be used to add descriptive titles for parameters in performance events. These events are sent using /dmp/push or the Javascript sendEvent method.
Parameters will often be unique identifiers or similar, and this makes it possible to annotate them with titles so that query results from /dmp/traffic/custom can be interpreted without having to look the identifier up in an external system. These titles are included when the title field is included in the /dmp/traffic/custom query, similar to how title can be used to resolve URLs to titles in /traffic/event .
The user must be authenticated and have write permission to a sitegroup that is configured with the registered customer prefix used in the origin specification.
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 be prefixed with a registered customer prefix. The origin constitutes the namespace for the titles. |
|
group |
String |
Yes |
The parameter name the value belongs to. The group must be the same as in the DMP event submitted using /dmp/push . |
|
item |
String |
Yes |
The parameter value to add a descriptive title for. |
|
title |
String |
Yes |
The descriptive name or title for this group/item. The maximum allowed length of a title is 80 characters. |
Response
The response object will be empty in the event of a successful operation.
Examples```bash $ ./cx.py /dmp/title '{"origin":"xyz-survey1", "group":"question", "item":"03484hd", "title":"Favourite animal"}' {}