Update a stream

patchhttps://api.faraday.ai/v1/streams/{stream_id_or_name}

Update the configuration of a stream

Authentication

Bearer Authentication

Provide your API key in the Authorization header. You can find your API key in the Settings page of the dashboard.

Authorization: Bearer YOUR_TOKEN

path parameters

stream_id_or_namestringrequired

The stream's UUID or name

Example: "orders"
Maximum characters: 64

Body

Fields to update on the existing stream. To delete an optional field, set it to null.

categoryone of 2 types
Properties of one of 2 types
One of:
stringenum:
"fig/demography""fig/environment""fig/geography""fig/identity""fig/lifestyle""fig/life_event""fig/property""fig/reachability""fig/society""fig/financial""fig/vehicles""fig/civic""fig/engagement""user_defined"
deprecatedone of 2 types

Whether the stream is deprecated.

Properties of one of 2 types
One of:
boolean

Pass this value to overwrite the existing value.

Title: Overwrite
Default: false
deprecation_notesone of 2 types

Notes about the deprecation of the stream.

Properties of one of 2 types
One of:
string

Pass this value to overwrite the existing value.

Title: Overwrite
descriptionone of 2 types

A description of the stream.

Properties of one of 2 types
One of:
string

Pass this value to overwrite the existing value.

Title: Overwrite
literateone of 2 types

A human-readable name for the stream.

Properties of one of 2 types
One of:
string

Pass this value to overwrite the existing value.

Title: Overwrite
propertiesone of 2 types
Properties of one of 2 types
One of:
Properties of each dictionary value:
allowed_valuesone of 2 types

If values are enumerable, explicitly list allowed values. Values should match the property's type.

Properties of one of 2 types
One of:
Array of:
One of:
boolean
directionality_interpretationone of 2 types

If applicable, describe the meaning of any directionality in the values.

Properties of one of 2 types
One of:
string

Pass this value to overwrite the existing value.

Title: Overwrite
Example: "Higher numbers mean more apparel shopping"
interpretation_mapone of 2 types

For enumerable values, a mapping from value to its interpretation. Key type matches the property type, value is always a string.

Properties of one of 2 types
One of:
object

Pass this value to overwrite the existing value.

Title: Overwrite
Example: {"1":"Low risk","2":"Medium risk","3":"High risk"}
null_value_interpretationone of 2 types

If a unary null replacement is not applicable or viable, describe how NULLs should be interpreted when encountered.

Properties of one of 2 types
One of:
string

Pass this value to overwrite the existing value.

Title: Overwrite
Example: "Unknown"
null_value_replacementone of 4 types

If set, value should be coalesced with this replacement to avoid any NULLs.

Example: false
Properties of one of 4 types
One of:
boolean
statistical_typeone of 2 types
Properties of one of 2 types
One of:
stringenum:
"categorical""multicategorical""ordinal""nominal""continuous_ordinal""categorical_nominal""multicategorical_nominal""categorical_ordinal""binary""count""interval""ratio"
typeone of 2 types
Properties of one of 2 types
One of:
stringenum:
"boolean""long""double""string""date"
unitone of 2 types

For numeric types, in what units is the data stored.

Properties of one of 2 types
One of:
string

Pass this value to overwrite the existing value.

Title: Overwrite
Example: "dollars"
tierone of 2 types
Properties of one of 2 types
One of:
stringenum:
"standard""premium""prohibited"

Responses

200The updated stream
archived_atstring<date-time>

If not null, this resource will no longer receive updates, but will still be visable.

categorystring

A category describing the type of stream property.

Allowed values: fig/demography, fig/environment, fig/geography, fig/identity, fig/lifestyle, fig/life_event, fig/property, fig/reachability, fig/society, fig/financial, fig/vehicles, fig/civic, fig/engagement, user_defined
created_atstring<date-time>required

When this resource was created.

deprecatedboolean

Whether the stream is deprecated.

Default: false
deprecation_notesstring

Notes about the deprecation of the stream.

descriptionstring

A description of the stream.

event_contribution_by_datasetarray[object]

Details of events emitted by each dataset into the stream.

Items of array[object]
dataset_idstring<uuid>required

The dataset the column comes from

event_countintegerrequired
newest_datestring<date>required
oldest_datestring<date>required
parsingarray[object]

How well this dataset's declared formats were read, one entry per column that declares one.

Omitted when no column in this dataset declares a format for the stream, and for contributions
measured bef...

Items of array[object]
candidate_row_countintegerrequired

Rows of the dataset available to this stream.

column_namestringrequired

The dataset column the values are read from.

Example: "purchase_date"
examplesarray[string]

A sample of the values that could not be read, to compare against the declared format.

Example: ["12/31/2024","31-12-2024"]
formatstringrequired

The format declared for this column, which says how its values should be read.

Example: "mm_dd_yyyy_slash"
parsed_row_countintegerrequired

Populated rows whose value could be read as the declared format. Divided by populated_row_count
this is the read rate, which should be 100%; any shortfall means the values and the declared
format disagree.

populated_row_countintegerrequired

Candidate rows where the column held a value. An empty column is not a failure to read one.

stale_beforestring<date>

The date those rows were judged against: anything earlier was treated as implausible. The bound
is relative to when the stream was built, so it is reported rather than left to be recalculated
against ...

Example: "1896-08-31"
stale_examplesarray[string]

A sample of the values that were read successfully but resolved to an implausible date. These
never appear in examples, because nothing went wrong when reading them — seeing them is the
only way to ...

Example: ["01/02/03","12/31/01"]
stale_row_countintegerrequired

Rows whose value was read successfully but produced a date too far in the past to be plausible,
which usually means the format is being misread rather than that the data is old. These rows are
excluded from the stream.

stream_propertystringrequired

The stream property these values populate.

Example: "datetime"
event_countinteger

Number of events in the stream.

Example: 1000
idstring<uuid>required

A unique ID for this resource.

Example: "eefb0735-6ad6-4611-a832-40bab2968353"
last_read_input_atstring<date-time>

The last time this resource's input was read.

last_updated_config_atstring<date-time>

The last time this resource's configuration was updated. If this is more recent than last_updated_output_at, the resource will be rebuilt.

last_updated_output_atstring<date-time>

The last time this resource successfully built.

literatestring

A human-readable name for the stream.

namestringrequired
Example: "orders"
Maximum characters: 64
newest_datestring<date>

Date of the most recent event in the stream.

Example: "2022-10-05"
oldest_datestring<date>

Date of the first event in the stream.

Example: "2022-10-05"
propertiesdictionary[string, object]
Additional properties: allowed (values are object)
Values of dictionary[string, object]
Properties of each dictionary value:
allowed_valuesarray[object]

If values are enumerable, explicitly list allowed values. Values should match the property's type.

Example: ["low","medium","high"]
Items of array[object]
One of:
boolean
breaksarray[number]

For continuous data types, list of reasonable cutoff values.

Example: [1,5,10,15,20,25,30,35]
categoriesarray[string]

For STRING type, list of allowed values.

Example: 
[
  "Large families",
  "Single suburbanites",
  "Single urbanites",
  "Small families",
  "Upper middle class small families"
]
directionality_interpretationstring

If applicable, describe the meaning of any directionality in the values.

Example: "Higher numbers mean more apparel shopping"
distributionarray[object]

Counts corresponding to the existing breaks property. Only available when the property is numerical, otherwise empty.

Items of array[object]
countintegerrequired
maxnumber

Upper range of the bin (exclusive). May be null for the last bin.

minnumberrequired

Lower range of the bin (inclusive).

emitted_by_datasetsarray[object]
Items of array[object]
column_namestring

the column used to populate this property on the event stream

dataset_idstring<uuid>required

the dataset the column comes from

interpretation_mapobject

For enumerable values, a mapping from value to its interpretation. Key type matches the property type, value is always a string.

Example: {"1":"Low risk","2":"Medium risk","3":"High risk"}
null_value_interpretationstring

If a unary null replacement is not applicable or viable, describe how NULLs should be interpreted when encountered.

Example: "Unknown"
null_value_replacementone of 3 types

If set, value should be coalesced with this replacement to avoid any NULLs.

Example: false
Properties of one of 3 types
One of:
boolean
statistical_typestring

A string describing the nature of data represented by the trait.

categorical_nominal: the field contains one value of an unordered bounded set. Example: "preferred_channel" — one of "email", "sms", "...

Allowed values: categorical, multicategorical, ordinal, nominal, continuous_ordinal, categorical_nominal, multicategorical_nominal, categorical_ordinal, binary, count, interval, ratio
typestring

What type of data this field contains.

Example: "string"
Allowed values: boolean, long, double, string, date
unitstring

For numeric types, in what units is the data stored.

Example: "dollars"
valuesarray[object]

Top 100 observed values of this property. Only available when the property is categorical or multicategorical, otherwise empty.

Items of array[object]
countintegerrequired
valuestringrequired
resource_typestringrequired

The type of this resource.

Example: "streams"
statusstringrequired

The current state of this resource and any updates.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the status of this resource was last updated.

status_errorstring

If this resource has status == "error", this will contain an error message.

tierstring

A billing tier for the stream property.

Allowed values: standard, premium, prohibited
updated_atstring<date-time>required

When this resource was last updated.

400The request was invalid.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

401No API key was supplied.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

403Access to this resource was forbidden.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

404The requested resource ID was not found.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

409The request was formatted correctly, but conflicted with an existing resource.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

500An internal server error occurred.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

Tags

streams