Special field attributes

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.

Add link to table

• Name: _row_url
• Type: string
• Description: Define the URL to which the entire table links.
• APL query example: extend _row_url = 'https://axiom.co/'
• Expected behavior: Make rows clickable. When clicked, go to the specified URL.

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.

Add link to values in a field

• Name: _FIELDNAME_url
• Type: string
• Description: Define a URL to which values in a field link.
• APL query example: extend _website_url = 'https://axiom.co/'
• Expected behavior: Make values in the website field clickable. When clicked, go to the specified URL.

Replace FIELDNAME with the actual name of the field.

Add tooltip to values in a field

• Name: _FIELDNAME_tooltip
• Type: string
• Description: Define text to be displayed when hovering over values in a field.
• Example Usage: extend _errors_tooltip = 'Number of errors'
• Expected behavior: Display a tooltip with the specified text when the user hovers over values in a field.

Replace FIELDNAME with the actual name of the field.

Add description to values in a field

• Name: _FIELDNAME_description
• Type: string
• Description: Define additional information to be displayed under the values in a field.
• Example Usage: extend _diskusage_description = 'Current disk usage'
• Expected behavior: Display additional text under the values in a field for more context.

Replace FIELDNAME with the actual name of the field.

Example

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.

['http-logs']
| extend _status_tooltip = "The status of the HTTP request is the response code from the server. It shows if an HTTP request has been successfully completed."
| extend _status_description = "This is the status of the HTTP request."
| extend _status_url = "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status"