Skip to main content

Adding parameters to your maze URL

Sean Kinney
  • Updated

Maze allows you to record custom metadata on individual sessions by adding parameters to your maze URL.

Use cases

Parameters can be used for:

  • Tester identification. If you already know who your testers are, you can use URL parameters to generate a unique tester link and pass in identifiable data about the tester (such as name, gender, email, etc.) in your results dashboard. This approach works best if you're using a third-party service to send out the maze links that allows you to insert the identifying information into the link you share with them. Learn more in the section Generating custom URLs below.
  • Completion tracking. If you need to track which participants completed your maze (for instance, for compensation purposes), you can pass an external tester ID as a URL parameter. While we don't support the ability to pass this information back to the original panel provider, you could then do a periodic CSV export to see the list of testers who completed the maze and their external IDs.

Using parameters in your maze URLs

Maze uses a simple nomenclature to help you record data.

This is an example of a maze test URL:
t.maze.co/74641933

And this is the same test URL with custom parameters:
t.maze.co/74641933?name=john&gender=male

By sending that second URL to a tester, we will record the following additional information in the results dashboard:

  • Name: John
  • Gender: Male

You can chain as many parameters as you want, and we will automatically associate the data with your tester: t.maze.co/74641933?name=john&gender=male&...

Once your tester completes a mission, you will be able to see this data by clicking Show more button in the Testers tab of the Results page.

URL parameter information in the Testers tab in the Results dashboard

For a detailed explanation of how to read the dashboard and all the accumulated data, read our guide: Understanding your results

Please note

  • You can only use parameters when sending the maze URL to your own testers. URL parameters are not available when using Maze's panel of hired testers.
  • The parameters id, createdAt, email and userId are already in use. Please don't use them as they won't register your information.

Generating custom URLs

You don't have to manually add parameters to each individual link you send. If you send your test links via a third-party tool, they may have features that allow you to integrate the custom data in the URL dynamically.

For instance, you could send out URLs that include the following (example) syntax: t.maze.co/74641933?name={{first name}}&gender={{gender}}.

While we don't directly support or endorse them, there are several products you could potentially use to generate and distribute custom URLs, such as:

Related articles