Version: Streamsheets 2.5

OUTBOXMETADATA

Creates a JSON key from the given values or range to retrieve metadata from within a message. This function is normally used in the READ function. OUTBOXMETADATA retrieves values from the Metadata section of an outbox message.

Syntax

=OUTBOXMETADATA(MessageID, [ValuesOrRange])

Arguments

Name	Description
MessageID	ID of the message to retrieve data from. If left empty, the current message in the inbox is used.
ValuesOrRange (optional)	A list of values or a range of cells describing the path to the element path within a JSON structure.

Return

A string key to retrieve metadata from a message.

Examples

Formula	Result	Comment
`=OUTBOXMETADATA("out1", "arrivalTime")`	[out1][arrivalTime]	Returns an identifier that can be used in other Streamsheet functions like READ.
`=READ(OUTBOXMETADATA("out1","arrivalTime"),C11,"Number")`	arrivalTime	The READ function returns the last part of the JSON Path. The value of the Message at the given path will be pushed into cell C11. Here we retrieve the arrival time of a message, which is a default Metadata field added to each message.