Skip to main content
Version: 1.3.0

Group Company

Associates the current user with a company or organization via the group() call.

Code Example

analytics.group("acme-corp", {
"name": "Acme Corp",
"industry": "Technology",
"plan": "free",
"employee_count": 10
});

Event Properties

PropertyTypeConstraintsExamplesDescription
$schemastringrequired
"https://tracking-docs-demo.buchert.digital/schemas/analytics-js/group-company.json"
Defines the structure of the event.
const: "https://tracking-docs-demo.buchert.digital/schemas/analytics-js/group-company.json"
groupIdstringrequired
"acme-corp"
"company_789"
"org_42"
The unique identifier for the group (company, organization, or account).
namestring
"Acme Corp"
"Example Inc"
The name of the group.
industrystring
"Technology"
"Retail"
"Finance"
The industry the group operates in.
planstringenum: [free, pro, enterprise]
"free"
"pro"
"enterprise"
The subscription plan of the group.
employee_countnumber
10
250
5000
The number of employees in the organization.
View Raw JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://tracking-docs-demo.buchert.digital/schemas/analytics-js/group-company.json",
  "title": "Group Company",
  "description": "Associates the current user with a company or organization via the group() call.",
  "x-tracking-targets": [
    "web-segment-js",
    "web-rudderstack-js",
    "web-hightouch-js"
  ],
  "x-method": "group",
  "type": "object",
  "properties": {
    "$schema": {
      "type": "string",
      "description": "Defines the structure of the event.",
      "const": "https://tracking-docs-demo.buchert.digital/schemas/analytics-js/group-company.json"
    },
    "groupId": {
      "type": "string",
      "description": "The unique identifier for the group (company, organization, or account).",
      "examples": [
        "acme-corp",
        "company_789",
        "org_42"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name of the group.",
      "examples": [
        "Acme Corp",
        "Example Inc"
      ]
    },
    "industry": {
      "type": "string",
      "description": "The industry the group operates in.",
      "examples": [
        "Technology",
        "Retail",
        "Finance"
      ]
    },
    "plan": {
      "type": "string",
      "description": "The subscription plan of the group.",
      "enum": [
        "free",
        "pro",
        "enterprise"
      ],
      "examples": [
        "free",
        "pro",
        "enterprise"
      ]
    },
    "employee_count": {
      "type": "number",
      "description": "The number of employees in the organization.",
      "examples": [
        10,
        250,
        5000
      ]
    }
  },
  "required": [
    "$schema",
    "groupId"
  ]
}