Skip to content

tracking_event-names_set-conversion

Mark an event name as a conversion, or unmark it.

Tool

tracking_event-names_set-conversion

Mark an event name as a conversion, or unmark it.

Mark an event name as a conversion, or unmark it. A marked name publishes `tracking/conversion.recorded` every time that event is recorded, which a workflow can trigger on; an unmarked one publishes nothing. Ingestion, counts and dashboards are unchanged either way.

Behavior

HTTP
POST /tracking/catalog/set-conversion

Arguments

Name
Type
Required
Description
name
string
•
The event name to mark or unmark
isConversion
boolean
•
true makes this event name a workflow trigger; false stops it being one

Response

Field
Type
Always
Description
name
string
•
Event name the conversion flag was applied to
isConversion
boolean
•
The flag as it now stands after the change

Try it

Mark an event name as a conversion, or unmark it.

When to use

Mark an event name as a conversion, or unmark it. A marked name publishes `tracking/conversion.recorded` every time that event is recorded, which a workflow can trigger on; an unmarked one publishes nothing. Ingestion, counts and dashboards are unchanged either way.

Example

Ask your agent something like this:

Mark an event name as a conversion, or unmark it.

The agent will invoke tracking_event-names_set-conversion with these arguments:

{
  "name": "<name>",
  "isConversion": "<isConversion>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select