Terminology

Use these names in product UI, APIs, support, and engineering documents.

Partner-owned scope

Term	Meaning
Partner	The SaaS company integrating Dataira; also the tenant boundary
Project	One partner-owned product, application, or workspace
Environment	An isolated deployment inside a Project
Runtime API key	A server secret scoped to exactly one Project and Environment
Management credential	A tenant-level server secret for provisioning Projects, Environments, and runtime keys
Datasource	A governed connection that Dataira may query
End-user organization	A partner customer account or workspace inside one Environment

A Partner can own many Projects. Every new Project receives a production Environment. Additional Environments such as staging or preview are optional. API keys, end-user assets, and access policies do not cross Environment boundaries. Datasources may be shared or allowlisted deliberately.

End-user scope

Term	Meaning
End user	The partner's authenticated user, identified by the partner
Conversation	A temporal question-and-answer thread
Saved metric	A reusable answer, table, KPI, or visualization
Dashboard	A composition of saved metrics
Collection	An end-user folder-like grouping of analytics resources
Star	A personal favorite marker
Pin	A personal quick-access or ordering marker

Collections may contain conversations, saved metrics, and dashboards. A resource can belong to multiple Collections. Star and pin state are independent of Collection membership and of whether an answer has been saved as a metric.

Important distinctions

• Use Project only for partner administration; use Collection for the end user's organization.
• Say save a metric, not “pin a metric.” Pin describes a preference on an already-existing resource.
• tenantId identifies the integrating Partner. It is derived from the API key and is not accepted as a token-request override.
• endUserOrgId identifies the Partner's customer organization. It defaults to endUserId when the host product has no organization model.
• Public TypeScript and JSON use tenantId, projectId, environmentId, endUserOrgId, endUserId, and collectionId. Database/JWT forms use the equivalent snake_case names.

Scope summary

Partner
└── Project
    └── Environment (production by default)
        └── End-user organization
            └── End user
                ├── Conversations
                ├── Saved metrics
                ├── Dashboards
                └── Collections, stars, and pins