> For the complete documentation index, see [llms.txt](https://docs.zigpoll.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zigpoll.com/embed/poll-metadata.md).

# Survey Metadata

Get the most out of your implementation by tracking metadata.

Metadata lets you save some additional information to your survey if you like.

For instance if your survey is on the checkout page you might want to save some additional information like "order\_number", "shipping\_address", "customer\_id", etc...

In order to do this, you will want to use the window\.Zigpoll.metadata JSON object. Simply fill it out with the additional information you want to send and place it on your page before the embed code loads. For example, see the code below:

```
    <script type="text/javascript">
      window.Zigpoll.metadata = {
        {
          order_number: ORDER_NUMBER,
          shipping_address: SHIPPING_ADDRESS,
          customer_id: CUSTOMER_ID
      };
    </script>
```

## Editing metadata from the dashboard

Metadata is normally set by the embed or an integration when the response is recorded, but you can adjust it afterwards. On the **Responses** page, click a response to expand it, open the **⋯** menu in its top-right corner and choose **Edit Metadata**. Add, change or remove key/value pairs and click **Save**. A key may contain letters, numbers, dashes and underscores. Keys written by Shopify, Stripe or Square are shown but locked. Edited metadata appears in the response's details, in the metadata filter and in CSV exports.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zigpoll.com/embed/poll-metadata.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.