Custom visualizations overview

Unique use cases and data sets can require custom visualizations.

Use the Splunk platform custom visualization API to create visualizations that admins can download and install from Splunkbase. Users can access and configure installed custom visualizations in Splunk Web. The API lets you create a user experience consistent with the standard Splunk platform visualization set.

For user documentation on Splunk platform custom visualization apps, see Custom visualizations.

---

Release notes

The custom visualization API is available as an experimental option for developers in this release. The API is not supported and is subject to change in subsequent releases.

---

Developer resources

Documentation

Tutorial

Build a custom visualization

Learn how to create a working custom visualization. This tutorial includes steps for creating an example visualization, developer best practices, and example code.

API details and best practices

Custom visualization API reference

Review custom visualization components and app directory structure.

Formatter API reference

Review components of the user interface for formatting visualizations.

User experience

Design guidelines

Implement custom visualization appearance and behavior.

Data handling guidelines

Work with user search results and data format errors.

API interactions

Custom visualizations in Simple XML

Add a custom visualization to a dashboard and configure it in Simple XML.

Custom visualizations in SplunkJS

Access and instantiate a custom visualization in SplunkJS.

Questions and feedback

Community

Discuss custom visualizations with other developers on Splunk Answers.

Contact

Contact devinfo@splunk.com with feedback or questions.