Menu
Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
Enterprise
Open source
serializeStateToUrlParam() function
serializeStateToUrlParam() function
Create an string that is used in URL to represent the Explore state. This is basically just a stringified json that is that used as a state of a single Explore pane so it does not represent full Explore URL.
Signature
typescript
export declare function serializeStateToUrlParam(urlState: ExploreUrlState, compact?: boolean): string;
Import
typescript
import { serializeStateToUrlParam } from '@grafana/data';
Parameters
Parameter | Type | Description |
---|---|---|
urlState | ExploreUrlState | |
compact | boolean | this parameter is deprecated and will be removed in a future release. |
Returns:
string
Was this page helpful?
Related resources from Grafana Labs
Additional helpful documentation, links, and articles:

Getting started with the Grafana LGTM Stack
In this webinar, we’ll demo how to get started using the LGTM Stack: Loki for logs, Grafana for visualization, Tempo for traces, and Mimir for metrics.

Getting started with Grafana dashboard design (EMEA Timezone)
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.

Unify your data with Grafana plugins: Datadog, Splunk, MongoDB, and more
In this webinar, learn how to leverage Grafana's plugin ecosystem for access to 80+ data sources, including plugins for Datadog, Splunk, MongoDB, and more.