Special field attributes

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.

Where links open

• If the value of _row_url or _FIELDNAME_url starts with http:// or https://, Axiom opens the link in a new browser tab.
• If the value starts with /, Axiom opens the link in the Axiom app without reloading the page.

Link to a dashboard

The address of a dashboard in the Axiom app is /ORG_ID/dashboards/uid/DASHBOARD_UID. When you open a dashboard, the last segment of the URL is its DASHBOARD_UID. Links without the uid segment work, but Axiom redirects them to the uid address with a full page reload.

To set a filter on the dashboard you link to, add v_FILTER_ID=VALUE to the query string of the link. Replace FILTER_ID with the ID of a filter on that dashboard.

In chart queries in a dashboard, you can use the following variables. Axiom doesn’t declare them automatically. To use them, add them to the declare query_parameters statement at the beginning of your query with the type string.

• axiom_org_id: The ID of your organization.
• axiom_dashboard_id: The ID of the current dashboard as shown in the URL.
• axiom_base_url: The base URL of the Axiom app.
• axiom_url: The full URL of the current page.

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.

Add unit of measurement

• Name: _FIELDNAME_unit
• Type: string
• Description: Specify the unit of measurement for another field’s value allowing for proper formatting and display.
• APL query example: extend _size_unit = "gbytes"
• Expected behavior: Format the value in the 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

Currency

Data (IEC)

Data (metric)

Data rate

Datetime

Throughput

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. The query adds the new field resp_body_size_bits that displays the size of the response body in the unit of bits.

['sample-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'
| extend resp_body_size_bits = resp_body_size_bytes * 8
| extend _resp_body_size_bits_unit = 'bits'