Edit a GTM stream

put

https://{hostname}/datastream-config-api/v3/log/gtm/streams/{streamId}

Updates the latest version of a Global Traffic Management stream. Each time you edit a stream, its version number increments. Note that only active streams collect and send logs to their destinations. You need to set the activate parameter to true while patching active streams, and optionally for inactive streams if you want to activate them upon request. See Version management and Activate a stream.

Path Params

streamId

integer

required

Uniquely identifies the stream.

Query Params

activate

boolean

Defaults to false

Activates the stream at the time of the request, false by default. When you edit or patch an active stream, you need to set this to true.

Body Params

contractId

string

required

Identifies the contract that has access to the product.

datasetFields

array of objects

required

Identifies data set fields that you want to receive in logs. For the STRUCTURED format, the order of the identifiers defines how these fields' values appear in the log lines. See Data set parameters for the complete list of the fields you can choose.

Dataset fields*

deliveryConfiguration

object

required

Configures log lines, log file format, names of the log files sent to a destination, and delivery frequency for these files.

destination

required

The destination configuration in the stream to send logs. See Destinations for details and features available for each destination.

notificationEmails

array of strings

length ≥ 0

Email addresses where you want to send notifications about the stream's activations and deactivations. By omitting this or specifying an empty array, you can activate or deactivate the stream without notifications.

Notification emails

properties

array of objects

required

Identifies the properties that belong to the same product and you want to monitor in the stream. Note that a stream can only log data for active properties. You can activate a property in the Property Manager API.

Properties*

streamName

string

required

length ≤ 1000

The stream's name.

Response

200The response shows the updated stream.