Skip to main content
PREMIUM ADD-ON ✨Governance is available upon request only. Please contact us to get access to this premium feature.
Setting up governance is a one-time step: you define the entities for your organization, and they apply to every customer. Create parents before their children.

Create an entity

  1. Go to Settings > Governance.
  2. Click Add a governance entity.
  3. Fill in the fields, then click Create governance entity.
The Create a governance entity drawer: Teams, hierarchical, parent Departments, with four attribution keys

Create a governance entity

  • Name and Code: the code is how the API refers to the entity.
  • Description (optional).
  • Type: Hierarchical or Flat.
  • Parent (optional): hierarchical entities only. Leave it empty for the top of the tree.
  • Attribution keys: the event properties that carry the value. Type a key and press enter. Up to 4.
Turn on Create more to add several entities in a row.

View your entities

The Governance entities list has one tab per type. The Hierarchical tab shows the tree, each entity indented under its parent:
The Hierarchical tab: Departments, with Teams nested under it and Users nested under Teams

Hierarchical entities

The Flat tab lists the entities that sit outside the tree:
The Flat tab: API Keys, Endpoints and Agents

Flat entities

Edit or delete an entity

Open the entity’s menu in the Governance entities list, then click Edit entity or Delete entity.

Rules

  • You can always change the name, description and attribution keys. New keys apply to new events only.
  • Once usage is attributed to an entity, its code, role and parent are locked (usage_already_attributed).
  • A flat entity has no parent, and an entity with children can’t become flat.
  • Deleting an entity stops attribution from now on. Billing isn’t affected.

Send attributed events

Tag events with entity values.

Query attributed usage

Read usage and spend per entity.