Syntax used for pipeline parameters
The parameters for Stream and Report pipelines use a standard syntax depending on the parameter type (i.e, a character string only, number, an array of elements, etc.) These follow the JSON syntax for different data types. These also apply if specifying the pipeline parameters over the API rather than in the Dashboard.
- String: a string of alphanumeric characters. Do not enclose in quote marks, though it can include quote marks if needed. Example:
begin-task. - Number: a whole number or float. Example:
42or1.234 - Array: a list of items which may be any valid JSON data type in square brackets, including nested arrays (see the documentation for the parameter),. Examples:
['task-begin', 'task-end'],[23, 43, 123] - Object: a list of key-value pairs in curly braces. Example:
{"name": "begin-trial", "'value": 42} - Boolean: true or false, represented as the value
trueorfalse.