JSON Export/Import

JSON Export/Import

Export/Import JSON schemas

💡
Trackingplan allows you to copy the specification of your events to other plans by exporting and importing them as a JSON Schema, maintaining the same rules, and facilitating the handling of multiple specifications across numerous panels and destinations.

Not in the mood to read all the steps? Watch this quick video to see how to export and import your schemas in just a few clicks. For more video tutorials, check out Trackingplan Academy.

Export JSON schema

To export your schemas in JSON format, follow these steps:

  1. Open the export menu you’ll find at the top right of any of your destinations. For this example in particular, we’ll illustrate it by exporting Google’s Analytics 4 setup. Then, click on “JSON Schema” as seen in the picture below.
image
  1. Now it’s time to select all the events and properties you’d like to export. By default, Trackingplan will select them all, but you have the possibility to uncheck those you don't want. You can also click on "clear all" to start afresh and only mark those events and properties that interest you.
image
â˜đŸ»
Pro tip: To facilitate this step, you can first narrow down your selection using the filtering options before clicking on export. This will help you focus on specific events and properties, making the export process more efficient and tailored to your needs.
image
  1. Once you've completed your selection, you can choose between copying your schema to the clipboard to paste it into a file, or downloading it as a file to open directly. Just click on the option you prefer and
 all set! With this, you'll be able to view all the schemas from the providers you want, and for the events you want.
image

Import JSON schema

Now, for importing your JSON schema to other plans (iOS, Android, web) or even to other destinations within the same plan, replicating the setup of your events while maintaining the same rules and specifications across various panels or providers, follow these easy steps:

  1. Open the export menu and click on “Import JSON Schema” as seen in the picture below.
image
  1. Drag and drop the file containing the schemas you’ve just exported, or click on it to select directly from your files. We'll notify you if the file is invalid or if you've made any errors editing it. Don't worry, we'll indicate where and why so you can easily correct it.
image
  1. Now it’s your time to select all the events and properties you’d like to import. If you want to replicate your whole setup, click on “Select all”. If not, just click on the events and properties you want until your selection is completed.
  2. image

Advanced Settings

Finally, before importing, take a moment to check out the Advanced options. These options give you finer control over how your schema is applied and how it interacts with your existing plan.

image

Here’s what each option does:

  • Forbid other properties and auto-forbid new ones: This ensures that only the properties explicitly defined in your schema that you want to export are allowed. Any existing or new properties that don’t match your schema will automatically be marked as forbidden.
  • â˜đŸ»

    Use case: This is particularly useful when you want to enforce strict compliance with your schema and prevent accidental tracking of unsupported properties.

  • Keep existing descriptions: Preserve the descriptions of events and properties that already exist in your plan.
  • â˜đŸ»

    Use case: Ideal when your plan already contains detailed documentation or notes about events, ensuring that importing a new schema doesn’t overwrite valuable information.

  • Reuse existing enums and regexes: Automatically link imported properties to any matching enums or regex rules already defined in your plan.
  • â˜đŸ»

    Use case: This reduces duplication and ensures consistency, so you don’t accidentally create multiple versions of the same validation rules.

  • Clear the destination before importing: Delete all existing events in the destination before applying the new schema.
  • â˜đŸ»

    Use case: This reduces duplication and ensures consistency, so you don’t accidentally create multiple versions of the same validation rules.

    Important: This action is irreversible. Only use it if you want to start completely fresh in the destination environment.

Once you’ve gone through all the advanced options and selected everything you need, click Import to bring your schema in.

← Previous

Plans OverviewPlans Overview

Next →

Split DestinationsSplit Destinations