Box · Schema

Tracking code

Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. This setting must be enabled for an enterprise before it can be used.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name	Type	Description
type	string	`tracking_code`
name	string	The name of the tracking code, which must be preconfigured in the Admin Console
value	string	The value of the tracking code

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TrackingCode",
  "title": "Tracking code",
  "type": "object",
  "description": "Tracking codes allow an admin to generate reports from the admin console\nand assign an attribute to a specific group of users.\nThis setting must be enabled for an enterprise before it can be used.",
  "properties": {
    "type": {
      "type": "string",
      "description": "`tracking_code`",
      "example": "tracking_code",
      "enum": [
        "tracking_code"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name of the tracking code, which must be preconfigured in\nthe Admin Console",
      "example": "department"
    },
    "value": {
      "type": "string",
      "description": "The value of the tracking code",
      "example": "Sales"
    }
  }
}