Group Company
Associates the current user with a company or organization via the group() call.
Code Example
- Segment (JS)
- RudderStack (JS)
- Hightouch (JS)
analytics.group("acme-corp", {
"name": "Acme Corp",
"industry": "Technology",
"plan": "free",
"employee_count": 10
});
rudderanalytics.group("acme-corp", {
"name": "Acme Corp",
"industry": "Technology",
"plan": "free",
"employee_count": 10
});
htevents.group("acme-corp", {
"name": "Acme Corp",
"industry": "Technology",
"plan": "free",
"employee_count": 10
});
Event Properties
| Property | Type | Constraints | Examples | Description |
|---|---|---|---|---|
| $schema | string | required | | Defines the structure of the event. |
const: "https://tracking-docs-demo.buchert.digital/schemas/analytics-js/group-company.json" | ||||
| groupId | string | required | | The unique identifier for the group (company, organization, or account). |
| name | string | | The name of the group. | |
| industry | string | | The industry the group operates in. | |
| plan | string | enum: [free, pro, enterprise] | | The subscription plan of the group. |
| employee_count | number | | The number of employees in the organization. |
View Raw JSON Schema
{
: "https://json-schema.org/draft/2020-12/schema",
: "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"
]
}