Skip to main content
Server path: /segment-tracking | Type: Application | PCID required: Yes

Tools


segment_tracking_add_source_to_tracking_plan

Add Source to Tracking Plan Parameters:
ParameterTypeRequiredDefaultDescription
trackingPlanIdstringYesTracking Plan Id
sourceIdstringYesThe id of the Source associated with the Tracking Plan. Config API note: analogous to sourceName.

segment_tracking_create_tracking_plan

Create Tracking Plan Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoThe Tracking Plan’s description.
namestringYesThe Tracking Plan’s name. Config API note: equal to displayName.
typestringYesThe Tracking Plan’s type.

segment_tracking_create_transformation

Create Transformation Parameters:
ParameterTypeRequiredDefaultDescription
allowPropertiesstring[]NoOptional array for allowing properties from your events.
destinationMetadataIdstringNoThe optional Destination metadata id to be associated with the Transformation.
dropbooleanNoOptional boolean value if the Transformation should drop the event entirely when the if statement matches, ignores all other transforms.
enabledbooleanYesIf the Transformation should be enabled.
fqlDefinedPropertiesobject[]NoOptional array for defining new properties in FQL. Currently limited to 1 property.
hashPropertiesConfigurationobjectNoOptional object for hashing properties within an event.
ifstringYesIf statement (FQL) to match events. For standard event matchers, use the following: Track -> “event=’<eventName>’” Identify -> “type=‘identify’” Group -> “type=‘group‘“
namestringYesThe name of the Transformation.
newEventNamestringNoOptional new event name for renaming events. Works only for ‘track’ event type.
propertyRenamesobject[]NoOptional array for renaming properties collected by your events.
propertyValueTransformationsobject[]NoOptional array for transforming properties and values collected by your events. Limited to 10 properties.
sourceIdstringYesThe Source to be associated with the Transformation.

segment_tracking_delete_plan

Delete Tracking Plan Parameters:
ParameterTypeRequiredDefaultDescription
trackingPlanIdstringYesTracking Plan Id

segment_tracking_delete_transformation

Delete Transformation Parameters:
ParameterTypeRequiredDefaultDescription
transformationIdstringYesTransformation Id

segment_tracking_echo

Echo Parameters:
ParameterTypeRequiredDefaultDescription
messagestringYesSets the response message field. The response contains this field’s entry. This parameter exists in alpha.
delaynumberNoThe desired response delay, in milliseconds. This parameter exists in alpha.
triggerErrorbooleanNoIf true, returns an HTTP 4xx error that contains the string in message. This parameter exists in alpha.
triggerMultipleErrorsbooleanNoIf true, returns an HTTP 4xx error that contains the value of the message field in the error message array. This has no effect if the request sets triggerError. This parameter exists in alpha.
triggerUnexpectedErrorbooleanNoIf true, triggers a 500 error. This has no effect if the request sets either triggerError or triggerMultipleErrors. This parameter exists in alpha.
statusCodenumberNoSets the HTTP status code to return. This parameter exists in alpha.

segment_tracking_get_events_volume_from_workspace

Get Events Volume from Workspace Parameters:
ParameterTypeRequiredDefaultDescription
granularitystringYesThe size of each bucket in the requested window. This parameter exists in v1.
startTimestringYesThe ISO8601 formatted timestamp that corresponds to the beginning of the requested time frame, inclusive. This parameter exists in v1.
endTimestringYesThe ISO8601 formatted timestamp that corresponds to the end of the requested time frame, noninclusive. Segment recommends that you lag queries 1 minute behind clock time to reduce the risk for latency to impact the counts. This parameter exists in v1.
groupBystring[]NoA comma-delimited list of strings that represents the dimensions to group the result by. The options are: eventName, eventType and source. This parameter exists in v1.
sourceIdstring[]NoA list of strings which filters the results to the given SourceIds. This parameter exists in v1.
eventNamestring[]NoA list of strings which filters the results to the given EventNames. This parameter exists in v1.
eventTypestring[]NoA list of strings which filters the results to the given EventTypes. This parameter exists in v1.
appVersionstring[]NoA list of strings which filters the results to the given AppVersions. This parameter exists in v1.
paginationobjectNoPagination input for event volume by Workspace. This parameter exists in v1.

segment_tracking_get_plan

Get Tracking Plan Parameters:
ParameterTypeRequiredDefaultDescription
trackingPlanIdstringYesTracking Plan Id

segment_tracking_get_transformation

Get Transformation Parameters:
ParameterTypeRequiredDefaultDescription
transformationIdstringYesTransformation Id

segment_tracking_list_rules_from_tracking_plan

List Rules from Tracking Plan Parameters:
ParameterTypeRequiredDefaultDescription
trackingPlanIdstringYesTracking Plan Id
paginationobjectNoPagination options. This parameter exists in v1.

segment_tracking_list_sources_from_tracking_plan

List Sources from Tracking Plan Parameters:
ParameterTypeRequiredDefaultDescription
trackingPlanIdstringYesTracking Plan Id
paginationobjectNoPagination options. This parameter exists in v1.

segment_tracking_list_tracking_plans

List Tracking Plans Parameters:
ParameterTypeRequiredDefaultDescription
typestringNoRequests Tracking Plans of a certain type. If omitted, lists all types. This parameter exists in v1.
paginationobjectNoPagination options. This parameter exists in v1.

segment_tracking_list_transformations

List Transformations Parameters:
ParameterTypeRequiredDefaultDescription
paginationobjectNoPagination options. This parameter exists in v1.

segment_tracking_remove_rules_from_tracking_plan

Remove Rules from Tracking Plan Parameters:
ParameterTypeRequiredDefaultDescription
trackingPlanIdstringYesTracking Plan Id
rulesobject[]YesRules to delete. This parameter exists in v1.

segment_tracking_remove_source_from_tracking_plan

Remove Source from Tracking Plan Parameters:
ParameterTypeRequiredDefaultDescription
trackingPlanIdstringYesTracking Plan Id
sourceIdstringYesThe id of the Source associated with the Tracking Plan. Config API note: analogous to sourceName. This parameter exists in v1.

segment_tracking_replace_rules_in_tracking_plan

Replace Rules in Tracking Plan Parameters:
ParameterTypeRequiredDefaultDescription
trackingPlanIdstringYesTracking Plan Id
rulesobject[]YesRules to replace.

segment_tracking_update_rules_in_tracking_plan

Update Rules in Tracking Plan Parameters:
ParameterTypeRequiredDefaultDescription
trackingPlanIdstringYesTracking Plan Id
rulesobject[]NoRules to update or insert.

segment_tracking_update_tracking_plan

Update Tracking Plan Parameters:
ParameterTypeRequiredDefaultDescription
trackingPlanIdstringYesTracking Plan Id
descriptionstringNoThe Tracking Plan’s description.
namestringNoThe Tracking Plan’s name. Config API note: equal to displayName.

segment_tracking_update_transformation

Update Transformation Parameters:
ParameterTypeRequiredDefaultDescription
transformationIdstringYesTransformation Id
allowPropertiesstring[]NoOptional array for allowing properties from your events.
destinationMetadataIdstringNoThe optional Destination metadata to be associated with the Transformation.
dropbooleanNoOptional boolean value if the Transformation should drop the event entirely when the if statement matches, ignores all other transforms.
enabledbooleanNoIf the Transformation should be enabled.
fqlDefinedPropertiesobject[]NoOptional array for updating properties defined in FQL. Currently limited to 1 property.
hashPropertiesConfigurationobjectNoOptional object for hashing properties within an event.
ifstringNoIf statement (FQL) to match events. For standard event matchers, use the following: Track -> “event=’<eventName>’” Identify -> “type=‘identify’” Group -> “type=‘group‘“
namestringNoThe name of the Transformation.
newEventNamestringNoOptional new event name for renaming events. Works only for ‘track’ event type.
propertyRenamesobject[]NoOptional array for renaming properties collected by your events.
propertyValueTransformationsobject[]NoOptional array for transforming properties and values collected by your events. Limited to 10 properties.
sourceIdstringNoThe optional Source to be associated with the Transformation.