Metadata allows you to add structured information to your Yorlet data. This information can be used in various ways, such as filtering, sorting, and grouping data. Metadata is a key part of the Yorlet data model and is used to describe the data in a way that is meaningful to your business.

​
How metadata works

Metadata is a set of key-value pairs that describe the data in your Yorlet account. Each key-value pair is associated with a specific data object, such as a customer, building, or unit. You can add metadata to your data objects using the Yorlet API or the Dashboard. Metadata can be used to filter, sort, and group data in your Yorlet account. For example, you can use metadata to filter customers by their location, sort buildings by their size, or group units by their status.

​
Adding metadata

You can add metadata to your data objects using the Yorlet API or the Dashboard. To add metadata using the Yorlet API, you can use the metadata field in the request body of the API call. To add metadata using the Dashboard, you can use the metadata editor in the Dashboard.

​
Using metadata

Once you have added metadata to your data objects, you can use it to filter, sort, and group data in your Yorlet account. We include metadata in all exports to help you analyse your data and make informed decisions.

​
Best practices

When adding metadata to your data objects, it is important to follow best practices to ensure that the metadata is accurate and meaningful. Some best practices for adding metadata include:
  • Use descriptive key names that are easy to understand
  • Use consistent key names across data objects
  • Use meaningful values for each key
  • Avoid adding unnecessary metadata
By following these best practices, you can ensure that your metadata is accurate and meaningful, and that it provides valuable insights into your Yorlet data.