timestamp.get_timestamp
timestamp.get_timestamp(unix_seconds, optional timestamp_format, optional timezone)
Description
This function returns a string in the format YYYY-MM-DD
, representing the day a timestamp is in.
unix_seconds
is an integer representing the number of seconds past Unix epoch, such as$e.metadata.event_timestamp.seconds
, or a placeholder containing that value.timestamp_format
is optional and is a string representing the format for the timestamp. If omitted, the default is%F %T
. You can specify the format using string literals. For options, see Format elements for date and time partstime_zone
is optional and is a string representing a time zone. If omitted, the default isGMT
. You can specify time zones using string literals. The options are as follows:- The IANA Time Zone (TZ) database name, for example,
America/Los_Angeles
. For more information, see the list of tz database time zones on Wikipedia. - The time zone offset from UTC, in the format
(+|-)H[H][:M[M]]
, for example: "-08:00".
- The IANA Time Zone (TZ) database name, for example,
Here are examples of valid time_zone
specifiers, which you can pass as the second argument to time extraction functions:
"America/Los_Angeles", or "-08:00". ("PST" is not supported)
"America/New_York", or "-05:00". ("EST" is not supported)
"Europe/London"
"UTC"
"GMT"
Param data types
INT
, STRING
, STRING
Return type
STRING
Code samples
Example 1
In this example, the time_zone
argument is omitted, so it defaults to GMT
.
$ts = $e.metadata.collected_timestamp.seconds
timestamp.get_timestamp($ts) = "2024-02-22 10:43:51"
Example 2
This example uses a string literal to define the time_zone
.
$ts = $e.metadata.collected_timestamp.seconds
timestamp.get_timestamp($ts, "%F %T", "America/Los_Angeles") = "2024-02-22 10:43:51"
Example 3
This example uses a string literal to define the timestamp_format
.
$ts = $e.metadata.collected_timestamp.seconds
timestamp.get_timestamp($ts, "%Y-%m", "GMT") = "2024-02"