Skip to main content

Target

A target: an audience defined by a TGL expression. As output, a saved target with its definition. As input, identify the audience by id or by filterTgl; label, the dates and workspaceId are ignored. With both, filterTgl is used; with neither, 400 (AE_ERR_405).

idstring

Identifier of the saved target, as returned by GET /api/v2/workspace/{workspaceId}/survey/{surveyCode}/targets.

labelstring

Display name of the target. Ignored when the target is sent in a request.

filterTglstring

TGL expression that defines the audience. In responses it is omitted when the target has no definition that can be expressed in TGL. In requests, send it to define the audience inline.

creationDatestring<date-time>

Creation date and time of the target, ISO 8601 with a UTC offset. Omitted when not available. Ignored in requests.

updatedDatestring<date-time>

Date and time of the last update of the target, ISO 8601 with a UTC offset. Omitted when not available. Ignored in requests.

workspaceIdstring

Id of the workspace that owns the target. Returned only when the target is looked up across workspaces; omitted otherwise. Ignored in requests.

Target
{
"id": "string",
"label": "string",
"filterTgl": "string",
"creationDate": "2024-07-29T15:51:28.071Z",
"updatedDate": "2024-07-29T15:51:28.071Z",
"workspaceId": "string"
}