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.