This page explains how to implement special fields within APL queries to enhance the functionality and interactivity of datasets. Use these fields in APL queries to add unique behaviors to the Axiom user interface.
_row_url
extend _row_url = 'https://axiom.co/'
If you specify a static string as the URL, all rows link to that page. To specify a different URL for each row, use an dynamic expression like extend _row_url = strcat('https://axiom.co/', uri)
where uri
is a field in your data.
_FIELDNAME_url
extend _website_url = 'https://axiom.co/'
website
field clickable. When clicked, go to the specified URL.Replace FIELDNAME
with the actual name of the field.
_FIELDNAME_tooltip
extend _errors_tooltip = 'Number of errors'
Replace FIELDNAME
with the actual name of the field.
_FIELDNAME_description
extend _diskusage_description = 'Current disk usage'
Replace FIELDNAME
with the actual name of the field.
_FIELDNAME_unit
extend _size_unit = "gbytes"
size
field according to the unit specified in the _size_unit
field.Replace FIELDNAME
with the actual name of the field you want to format. For example, for a field named size
, use _size_unit = "gbytes"
to display its values in gigabytes in the query results.
The supported units are the following:
Percentage
Unit name | APL sytax |
---|---|
percent (0-100) | percent100 |
percent (0.0-1.0) | percent |
Currency
Unit name | APL sytax |
---|---|
Dollars ($) | curusd |
Pounds (£) | curgbp |
Euro (€) | cureur |
Bitcoin (฿) | curbtc |
Data (IEC)
Unit name | APL sytax |
---|---|
bits(IEC) | bits |
bytes(IEC) | bytes |
kibibytes | kbytes |
mebibytes | mbytes |
gibibytes | gbytes |
tebibytes | tbytes |
pebibytes | pbytes |
Data (metric)
Unit name | APL sytax |
---|---|
bits(Metric) | decbits |
bytes(Metric) | decbytes |
kilobytes | deckbytes |
megabytes | decmbytes |
gigabytes | decgbytes |
terabytes | dectbytes |
petabytes | decpbytes |
Data rate
Unit name | APL sytax |
---|---|
packets/sec | pps |
bits/sec | bps |
bytes/sec | Bps |
kilobytes/sec | KBs |
kilobits/sec | Kbits |
megabytes/sec | MBs |
megabits/sec | Mbits |
gigabytes/sec | GBs |
gigabits/sec | Gbits |
terabytes/sec | TBs |
terabits/sec | Tbits |
petabytes/sec | PBs |
petabits/sec | Pbits |
Datetime
Unit name | APL sytax |
---|---|
Hertz (1/s) | hertz |
nanoseconds (ns) | ns |
microseconds (µs) | µs |
milliseconds (ms) | ms |
seconds (s) | secs |
minutes (m) | mins |
hours (h) | hours |
days (d) | days |
ago | ago |
Throughput
Unit name | APL sytax |
---|---|
counts/sec (cps) | cps |
ops/sec (ops) | ops |
requests/sec (rps) | reqps |
reads/sec (rps) | rps |
writes/sec (wps) | wps |
I/O ops/sec (iops) | iops |
counts/min (cpm) | cpm |
ops/min (opm) | opm |
requests/min (rps) | reqpm |
reads/min (rpm) | rpm |
writes/min (wpm) | wpm |
The example APL query below adds a tooltip and a description to the values of the status
field. Clicking one of the values in this field leads to a page about status codes. The query adds the new field resp_body_size_bits
that displays the size of the response body in the unit of bits.