Identify and categorize your workspaces to better use API data

Within your organization, you can identify and categorize your workspaces, and the data collected during your events, by using a custom "Category" field. This field is enabled and configured in the organization's default workspace settings.

This custom field could for example be used to assign internal project IDs or project owners to the organization's workspaces, or to mark/tag the workspace as belonging to a specific department or branch of an organization, or for anything that might be of assistance from an administrative or accounting perspective.

Once the workspaces of your organization are categorized or tagged using this custom field, you can use an API call to pull the data from those workspaces and filter it to your needs.

How to set-up the custom "Category" field?

To enable and configure the custom "Category" field:

1. In the Backstage home page, select Organizations in the menu to the left of the screen, and select your organization in the My memberships section.
   
   
2. Select Default workspace settings in the list:
   
   
   
3. In the default workspace settings, you can see an option called Enable category, that you can enable:
   
   
   
4. The following options are available to configure the custom field:
   - Choose the name of the custom field, using the Category label.
   - Configure the Category values field in either of the following ways:
   Enter several preset values that will be selectable in a dropdown for the custom field. For example if you want user to be able to select a project owner out of a list of preset owners:
   
   OR leave this field blank so that users can enter their own free flow text, for example in the case of being able to add an internal project ID:
   
   - The Multiselect option can be enabled at workspace creation only. This allows the user to select multiple options if the custom field is configured to be used as a dropdown list (like the Project owner example above).

Note: The Multiselect option must be enabled at the time of creating the workspace (in the workspace creation wizard). It cannot be enabled via the Workspace settings once the workspace is created.

How is this used in my workspaces in Backstage?

Once the custom "Category" field is enabled and configured in the organization default workspace settings, the custom field can be accessed and used:

• In the workspace creation wizard (to be used when creating a workspace).
• In the workspace settings (after a workspace is created)

Note: The Multiselect option must be enabled at the time of creating the workspace (in the workspace creation wizard). It cannot be enabled via the Workspace settings once the workspace is created.

Below are some examples of this can look, based on the two configuration examples described above:

Workspace creation wizard - with example of dropdown list of project owners:
Here the Backstage user creating the workspace can use the Project owner custom field to choose a project owner from the preset list:

Workspace settings - with example of dropdown list of project owners:
In an existing workspace, the Backstage user can access the Project owner field in the workspace settings to select or edit the project owner.

Workspace creation wizard - with example of free flow text project ID:
Here the Backstage user creating the workspace can use the Project ID custom field to enter an ID for the project using free flow text.

Workspace settings - with example of free flow text project ID:
In an existing workspace, the Backstage user can access the Project ID field in the workspace settings to add a project ID or edit it.

How can I use this for an API call

Once the custom "Category" field is configured and populated in your workspaces, the below categories or category properties are included in the data when making an API call to the workspace:

For more information, please refer to the SpotMe API documentation.