# Plot Plugin Primer
Source: https://docs.parable.work/plugins/plot-plugins
Extend Plot SQL with reusable first-party and custom computations.
Plot Plugins make specialized computations available inside Plot SQL. A Plot
owns the query and its resulting table; a Plot Plugin owns a reusable operation
that the query can invoke.
The first-party Plot Plugins cover the two model-backed operations available
today:
Classify, extract, and generate typed values with one model call per input
row.
Turn text into comparable vectors for retrieval and similarity workflows.
## How Plot Plugins fit
1. A Plot selects and shapes Workspace data with SQL.
2. A Plot Plugin evaluates its operation for the rows that reach the function.
3. DataFusion returns Arrow values as part of the query result.
4. A materialized Plot publishes that result in the
[Parable Pool](/protocols/sql/data-catalog/parable-pool).
Run the SQL through an SDK for the ordinary path, or use Flight SQL when you are
building a protocol-level client. See [Query with the SDKs](/protocols/sql/query-with-sdks)
and [Flight SQL](/protocols/sql/flight-sql).
A [Plot](/ponder/parables/pieces/plots) is a Piece with its own query and
result. A Plot Plugin is a function that a Plot can call; it is not another
Piece.
# Embed
Source: https://docs.parable.work/plugins/plot-plugins/embed
Use the first-party Embed Plot Plugin to create comparable text vectors from SQL.
Embed is a first-party Plot Plugin that turns text into unit-normalized vectors.
Use it to prepare Plot data for retrieval, similarity, classification, and
clustering workflows.
Embed is currently an internal Plot Plugin. Its SQL and materialization
contracts may change before it is included in customer documentation.
Embedding consumes an external model service. Filter invalid input and keep a
`LIMIT` while developing, then set budgets on scheduled Plots.
## Embed text
Only `input` is required. Omitted model coordinates use the platform's default
embedding model, and `purpose` defaults to `document`.
```sql Embed issue titles theme={null}
SELECT
id,
title,
embed(input => title) AS vec
FROM providers.linear.issues
WHERE title IS NOT NULL
LIMIT 50
```
Named arguments use `=>` and cannot be mixed with positional arguments.
| Argument | Requirement | Meaning |
| - | - | - |
| `input` | Required | A `Utf8` or `LargeUtf8` expression evaluated for each row. |
| `provider` | Optional | Defaults to `google`. |
| `name` | Optional | Defaults to `gemini-embedding`. |
| `version` | Optional | Defaults to `001`. |
| `server` | Optional | Routing coordinate: `vertex` or `openrouter`. Defaults to `vertex`. |
| `purpose` | Optional | Defaults to `document`. |
The defaults are the platform's default embedding model in the Workspace's AI
policy. Embedding models are platform-wide: a Workspace sets no default for
`embed()`. The output dimensions come from that model identity and are not a
call-site argument. With the platform default, the return type is a nullable,
unit-normalized `FixedSizeList`.
`server => 'vertex'` runs on the `VERTEX` processor, in the Workspace's own
Vertex project when it has one. `server => 'openrouter'` runs on
`OPENROUTER_ZDR`: every call asks OpenRouter for zero data retention, no data
collection, and providers that honour every parameter. The Workspace's AI
policy lists the processors `embed()` may use; production allows only
`vertex`. A call the policy refuses, and any call while the Workspace's policy
cannot be read, is refused while the query is planned with `QL-MP-001` or
`QL-MP-002`, as for [Ponder](/plugins/plot-plugins/ponder#choose-the-model).
`NULL` or empty input returns `NULL`. If a provider batch fails, the affected
cells become `NULL` and the rest of the query continues.
A call that cannot reach its provider at all fails the query with its cause
and returns no vectors. This happens, for example, when a `vertex` call has no
Vertex project or an `openrouter` call has no API key. A scheduled run fails
with `QR-QU-010` and is charged nothing. A call whose inputs are all `NULL` or
empty sends no request, so it still returns `NULL` vectors.
A scheduled run also fails with `QR-QU-010` when the provider answers a
request with HTTP 401, 403 or 404: credentials it does not accept, a project
without access to the model, or a model it does not serve. No retry changes
that answer, so each attempt of the site's batch stops at its first request
instead of retrying every row
([PARABLE-5328](https://linear.app/parable-work/issue/PARABLE-5328)).
## Match the embedding purpose
Use `document` for stored source text and `query` for a search phrase.
```sql Embed a search query theme={null}
SELECT embed(
provider => 'google',
name => 'gemini-embedding',
version => '001',
server => 'vertex',
purpose => 'query',
input => 'issues about billing'
) AS query_vec
```
Compare each row with one search phrase by giving the phrase its own call.
The phrase is a constant input, so it is embedded once, not once per row:
```sql Rank issues by distance from a search phrase theme={null}
SELECT
id,
title,
array_distance(
embed(input => title),
embed(input => 'customer billing problem', purpose => 'query')
) AS distance
FROM (
SELECT id, title
FROM providers.linear.issues
WHERE title IS NOT NULL
LIMIT 200
) AS issues
ORDER BY distance
LIMIT 20
```
Supported purposes are:
| Purpose | Use |
| - | - |
| `document` | Content that will be searched. |
| `query` | Search text compared with document vectors. |
| `similarity` | General semantic comparison. |
| `classification` | Inputs used as classification features. |
| `clustering` | Inputs grouped by semantic proximity. |
Parable maps these values onto each embedding service's task vocabulary. A
service that does not expose task types receives no service-specific value.
Any other purpose, an unknown argument name, or a `server` other than `vertex`
or `openrouter` is refused while the query is planned. Through Query Layer it
returns gRPC `INVALID_ARGUMENT` with error code `QL-PL-013`
(`INVALID_FUNCTION_ARGUMENT`). The message names the argument and what it
must be, never the value you gave.
## Keep vector identities compatible
Vectors are comparable only when they share `provider`, `name`, variant,
`version`, dimensions, and normalization. `server` controls routing and does
not change vector identity.
`embed()` stamps that identity on its output column. A query that compares
vectors from two different models fails while it plans, before any input is
embedded, with `INVALID_ARGUMENT` and error code `QL-PL-008`
(`INCOMPARABLE_EMBEDDING_MODELS`). The message names both models. Equal
dimensions are not enough:
```sql Refused: two model versions theme={null}
SELECT array_distance(
embed(input => 'alpha', version => '001'),
embed(input => 'alpha', version => '002', purpose => 'query')
) AS distance
```
The check covers `array_distance`. A vector without an
identity, such as a literal vector, is compared on its dimensions alone, and
Parable logs and counts the comparison.
A scheduled Plot keeps its `embed()` vectors in the Plot table itself; Parable
does not create a separate vector table for them. The Plot records the vector
type and the model that wrote the column, so a query reads the column back as
a `FixedSizeList` of the model's dimensions, and the check judges it
like any `embed()` output:
```sql Refused: a Plot column and another model version theme={null}
SELECT array_distance(
vec,
embed(input => 'billing', version => '002', purpose => 'query')
) AS distance
FROM parables.support.issue_vectors
```
A Plot last run before Plots recorded the model holds the column as text, and
a query that reads that column fails until the Plot runs again.
## Execution and limits
Interactive queries and scheduled Plot runs batch inputs, up to
`EMBED_BATCH_SIZE` (32) texts a request, and cap concurrent provider requests.
Scheduled Plot runs pin model identity and purpose, account successful embedding
work, and persist the vectors and the model identity in the Plot table.
`embed()` is Stable: the same text under the same model and purpose gives the
same vector. A query that names the same call twice in one SELECT list sends
each text once. The same call in a SELECT and its WHERE is evaluated by two
plan operators, so a query sends those texts twice. A scheduled run sends each
distinct text once wherever the call sits, because its inference site
memoizes every answer.
A constant `input`, such as a search phrase, is one text. A query sends it
once for each batch of rows the engine passes to `embed()`, at most
`EMBED_BATCH_SIZE` × `EMBED_MAX_CONCURRENCY` rows (128 by default), and every
row reads its vector. A scheduled run sends it once. A `NULL` or empty constant
returns `NULL` on every row without a request.
The service rejects calls above its configured row cap. Model and purpose must
be constant for the invocation; `input` can vary by row or be constant.
Run `embed()` with the same SDK query method as any other Parable SQL. See
[Query with the SDKs](/protocols/sql/query-with-sdks).
# Ponder
Source: https://docs.parable.work/plugins/plot-plugins/ponder
Use the first-party Ponder Plot Plugin to return typed model output from SQL.
Ponder is a first-party Plot Plugin that runs a language model for every input
row and returns a typed SQL value. Use it for classification, extraction, and
other row-wise reasoning that is awkward to express with ordinary SQL.
Every row that reaches `ponder()` creates a model call. Filter the source and
keep a `LIMIT` while developing. Scheduled Plots should also set external-call
and cost budgets.
## Classify rows
Named arguments use `=>`. Supply model coordinates inline or leave them out to
use the default model, make the instruction and output type constant strings,
and label every input with `named_struct`.
```sql Classify Linear issues theme={null}
SELECT
id,
title,
ponder(
provider => 'google',
name => 'gemini',
variant => '2.5',
version => 'flash',
server => 'vertex',
instruction => 'Classify the issue. Reply with one of: bug, feature, question, other.',
output => 'Utf8',
inputs => named_struct('title', title, 'body', description)
) AS category
FROM providers.linear.issues
WHERE title IS NOT NULL
LIMIT 20
```
### Arguments
| Argument | Requirement | Meaning |
| - | - | - |
| `provider`, `name`, `variant`, `version` | Required with inline configuration | Model identity coordinates. |
| `model` | Alternative to inline coordinates | An existing model configuration expression. Do not combine it with inline coordinates. |
| (none of the above) | Optional | Omit every model argument to run the default model (see [Choose the model](#choose-the-model)). |
| `instruction` | Required | Constant system instruction sent for every row. |
| `output` | Required | Constant Arrow output type. |
| `inputs` | Required | A `named_struct` whose field names become prompt labels. |
| `schema` | Required for `Struct` | JSON Schema object encoded as a constant SQL string. |
| `date` | Optional | Model date; defaults to `latest`. |
| `effort` | Optional | Provider-specific reasoning effort. |
| `tokens` | Optional | Maximum output tokens; omission uses the service default. |
| `server` | Optional | Provider route: `vertex`, `anthropic` or `openrouter`. The Workspace's AI policy decides which routes it may use. |
| `request_timeout_seconds` | Optional | Positive per-call timeout no greater than the query timeout budget. |
Do not mix named and positional arguments. The named form is the documented
interface; Parable lowers it to the positional DataFusion function before
planning.
An argument `ponder()` refuses, such as an unknown argument name, a `Struct`
output without `schema`, or an output type it does not support, fails while
the query is planned, before any row is sent. Through Query Layer it returns
gRPC `INVALID_ARGUMENT` with error code `QL-PL-013`
(`INVALID_FUNCTION_ARGUMENT`). The message names the argument and what it must
be, never the value you gave, for example `Missing required ponder() argument
'schema' for Struct output`.
## Choose the model
A call that names a model, inline or through `model`, runs that model. A call
that names none runs the Workspace's default model for `ponder()`, which a
Workspace administrator sets in the Workspace's AI policy. Without a Workspace
default it runs Parable's default, Gemini 3.5 Flash-Lite on Vertex (model id
`gemini-3.5-flash-lite`). Vertex serves that model from its global endpoint,
so Google chooses the region that processes each call.
```sql Use the default model theme={null}
SELECT
id,
ponder(
instruction => 'Classify the issue. Reply with one of: bug, feature, question, other.',
output => 'Utf8',
inputs => named_struct('title', title)
) AS category
FROM providers.linear.issues
LIMIT 20
```
Every model runs on an AI processor, named by its `server`:
| `server` | Processor |
| - | - |
| `vertex` | `VERTEX`, in the Workspace's own Vertex project when it has one |
| `anthropic` | `ANTHROPIC` |
| `openrouter` | `OPENROUTER_ZDR`: every call asks OpenRouter for zero data retention, no data collection, and providers that honour every request parameter |
The Workspace's AI policy lists the processors `ponder()` may use; production
allows only `vertex`. A call whose processor the policy does not allow, a
call that names no model when no default's processor is allowed, and any call
while the Workspace's policy cannot be read are refused while the query is
planned, before any row is sent:
| Code | Meaning |
| - | - |
| `QL-MP-001` | The Workspace's AI policy refuses the call. The message names the reason, such as `PROCESSOR_NOT_ELIGIBLE` or `NO_ELIGIBLE_PROCESSOR`. |
| `QL-MP-002` | The Workspace's AI policy could not be read, so no AI function runs. Retry the query. |
A scheduled Plot run records the same code when the policy refuses it, and
the run fails: a refused call never produces `NULL`. A run whose planning could
not read the policy is retried at the Plot's next fire.
## Choose an output type
Primitive output supports `Utf8`, `Int64`, `Float64`, `Boolean`, `Date32`, and
`Timestamp`. A failed call produces `NULL` for a primitive cell while the rest
of the query continues.
Use `Struct` when downstream SQL needs more than one typed field:
```sql Extract structured output theme={null}
SELECT
id,
classified.category,
classified.reason,
classified.meta.status,
classified.meta.error
FROM (
SELECT
id,
ponder(
provider => 'google',
name => 'gemini',
variant => '2.5',
version => 'flash',
server => 'vertex',
instruction => 'Extract a category and a one-sentence reason.',
output => 'Struct',
schema => '{"type":"object","properties":{"category":{"type":"string"},"reason":{"type":"string"}},"required":["category","reason"]}',
inputs => named_struct('title', title)
) AS classified
FROM providers.linear.issues
LIMIT 20
) AS classified_rows
```
All declared Struct fields are nullable in Arrow. Ponder appends a reserved
`meta` Struct; do not declare `meta` in the supplied schema.
| `meta` field | Meaning |
| - | - |
| `status` | `ok`, `partial`, or `error`. |
| `error` | Missing required fields or provider failure details. |
| `usage` | Input, output, and total token counts when reported. |
| `latency_ms` | Provider-call latency. |
| `model_*` and `finish_reason` | Resolved model identity and completion details. |
| `request` and `cached` | Request trace material and cache state when available. |
`partial` means the response parsed but omitted at least one required field.
`error` means the model call failed. Struct output keeps the metadata alongside
the row so SQL can inspect either state.
## Execution and limits
Interactive queries execute Ponder as an asynchronous DataFusion scalar
function. Scheduled Plot runs split it into a separate inference stage, pin the
output-affecting model and instruction content, and account provider calls and
cost before completing the result. A scheduled run pins the model it resolved,
including a Workspace default, and the AI policy it planned under: a later
policy change reaches the next run, never one already planned. A new default
is a new model, so the Plot's next run recomputes its results.
The inference stage runs the same Ponder code as a query. Every row gets the
same prompt, with its inputs labelled as `named_struct` names them, and a
Report run stores the value a Preview returns: every output type, `NULL` for a
failed primitive call, and `meta` for a Struct. The run records each column
with its output type, so the Report reads it back as the Preview returns it.
Report runs planned before Plots recorded these types stored every
non-`Utf8` `ponder()` column as `String`, which does not match the stored
table, so their Plot output cannot be read; the Plot's next Report run records
the real types. A scheduled run retries a
failed call before it stores the failure, and is charged one external call for
each request that reached the provider.
A call that cannot reach its provider at all, such as a route without a
configured credential, fails the query with its cause instead of returning a
`NULL` per row. A scheduled run fails with `QR-QU-010` and is charged nothing,
and its Report shows that the Plot's AI functions could not reach their AI
processor.
When every input is constant, such as `inputs => named_struct('topic',
'billing')`, every row has the same prompt. A query sends it once for each
batch of rows the engine passes to `ponder()`, at most `PONDER_MAX_CONCURRENCY`
rows (8 by default), and every row in the batch reads that answer. A scheduled
run asks it once.
The service caps input rows and concurrency. A longer per-call timeout can lower
the effective row cap because it consumes more of the query timeout budget.
Run `ponder()` with the same SDK query method as any other Parable SQL. See
[Query with the SDKs](/protocols/sql/query-with-sdks).
# Plugins Primer
Source: https://docs.parable.work/plugins/primer
Understand the Provider and Plot Plugin families and choose the right extension point.
Plugins extend what a Workspace can connect to and what its Plots can do.
A Plugin is published as a Parable: Pages, Packages, Panes, Plots, and
Palettes are authored truth, and each Page and Pane carries its Perception and
Policies; mappings are structural; and releases, exports, Apps, and artifacts
are deterministic derived snapshots. Preferences are the settings people save
for a Pane while using it.
Browse the Plugins that connect Providers and make their data available to
a Workspace.
Use reusable operations inside Plots, including Ponder and the internal
Embed Plugin.
Provider Plugins and Plot Plugins have separate contracts because they extend
different boundaries. A Provider Plugin defines how data enters or is exposed
to the Workspace. A Plot Plugin defines an operation that runs while a Plot is
evaluated.
The portable model layer keeps four concerns separate:
1. an immutable `PluginReleaseManifest` pins the Plugin Parable version, exact
Piece and implementation revisions, derived exports and artifacts, Processor
compatibility, trust inputs, and digest;
2. a `PluginInstallationBinding` holds mutable Workspace configuration,
secret references, permission grants, dependency locks, selected limits,
negotiated host capabilities, trust decision, and health;
3. protocol aliases such as MCP Tool names or SQL function names exist only for
compatibility and never replace Piece identity; and
4. generated Go, TypeScript, Python, and Rust contracts describe these shapes
without claiming an exporter, installer, or runtime implementation.
# Provider Plugin Primer
Source: https://docs.parable.work/plugins/provider-plugins
Learn how Provider Plugins turn external systems into governed data in the Provider Pool.
A Provider Plugin teaches Parable how to retrieve or receive data from a
Provider and turn it into governed tables in the Provider Pool. It owns the
repeatable integration contract; each Workspace supplies its own credentials,
configuration, and enabled data streams.
```mermaid theme={null}
flowchart LR
P["Provider"] --> PP["Provider Plugin"]
PP --> C["Workspace connection"]
C --> S["Data streams"]
S --> D["Provider Pool"]
```
## The parts of a Provider integration
| Product concept | Technical name | Responsibility |
| - | - | - |
| Provider | Vendor or source system | The external product or system whose data a Workspace needs. |
| Provider Plugin | Connector definition | Shared authentication, transport, stream, traversal, limit, and schema rules. |
| Provider connection | Connector instance | One Workspace's selected strategy, credentials, ingestion configuration, and health. |
| Data stream | Tap | One named record stream, such as issues, users, or events. |
| Provider Pool | Provider catalog and tables | The SQL surface produced from synced records. |
Keep these layers separate when writing or debugging a plugin. Changing a
definition changes the integration contract for every connection that uses it.
Changing a connection changes only one Workspace.
## Browse Provider Plugins
Each page in this section documents one installed Provider Plugin: what it
connects, the data streams it provides, setup, permissions, and troubleshooting.
The same page is rendered in Mintlify and loaded into the Provider connection
wizard. Author Overview, Setup Guide, Permissions, and
Troubleshooting as explicit Mintlify `` sections. The app preserves those
boundaries and the order of their content: inner headings such as "Confluence
Cloud setup" remain in the tab where they were written.
The documentation loader carries tab boundaries as ``
markers in the existing Markdown payload. Plain Markdown without these markers
recognizes only exact `## Overview`, `## Setup Guide`, `## Permissions`, and
`## Troubleshooting` section titles. Other headings remain in the current
section; content before a section stays readable in Overview. Fenced code is
always content, never a tab boundary. No heading keywords route content.
A page can scope a section to one authentication method with
`{/* BEGIN AUTH STRATEGY type="..." */}` and `{/* END AUTH STRATEGY */}`
lines. Mintlify shows every section; the wizard leaves out a scoped section
when the Provider does not offer that method.
The Permissions tab keeps its two disclosure levels in the app: expand a data
stream row to read what it enables and its scope, then expand a field row for
that field's developer identifier and interpretation.
## What every Provider Plugin must preserve
Regardless of transport, a plugin must establish:
* a stable Provider and plugin identity;
* an authentication or sender-verification boundary;
* named data streams with explicit record schemas;
* deterministic row identity and update ordering;
* bounded retry, concurrency, and rate-limit behavior; and
* a predictable projection into the
[Provider Pool](/protocols/sql/data-catalog/provider-pool).
Workspace members configure connections and choose which supported streams to
enable. They do not rewrite a plugin's requests, pagination, traversal graph, or
schema contract.
# ActivTrak
Source: https://docs.parable.work/plugins/provider-plugins/activtrak
Sync employee activity and productivity data from ActivTrak
Sync employee activity and productivity data from ActivTrak.
Connect Parable to ActivTrak for workforce productivity analytics.
#### Activity
Working hours, app usage, activity
#### Productivity
Productivity scores, benchmarks
## Data streams
This Provider Plugin defines 5 data streams.
| Stream | Description | Sync |
| - | - | - |
| `clients` | ActivTrak client organizations | full |
| `consumers` | ActivTrak consumer (admin) accounts | full |
| `working_hour_users` | ActivTrak working hours report by user | incremental |
| `working_hour_computers` | ActivTrak working hours report by computer | incremental |
| `activity_logs` | ActivTrak user activity log entries | incremental |
### ActivTrak
#### What You'll Need
| Credential | What it is |
| - | - |
| **Token** | API token generated from ActivTrak admin |
> **Info:** **Setup access in ActivTrak.** These steps require **Administrator**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your ActivTrak administrator.
* **Admin** access to ActivTrak
* Advanced Insights tier (for full API access)
#### Step 1: Access API Settings
1. Log in to ActivTrak
2. Go to **Settings** → **Integrations**
3. Navigate to **API** section
#### Step 2: Generate API Key
1. Click **Generate API Key** or **Create New Key**
2. Name: `Parable Integration`
3. Copy the generated key
> **Warning:** **Copy your API key now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
#### Step 3: Enter values in the form
1. **API Key**: Paste your ActivTrak API key.
2. Click **Save & test connection**.
Developer identifier: `activity_logs`
**Activity Logs.** ActivTrak user activity log entries.
* **Enables:** Trace recorded application or website activity to a user, computer, session, and timestamp, including configured alarm outcomes.
* **Scope:** Reads the records selected by ActivTrak's `/reports/v2/activitylog` operation as an event stream using incremental synchronization. This stream is opt-in. Visibility follows the ActivTrak API key and administrator-defined groups available to that key. The records describe captured activity and configured responses; they do not establish intent, quality of work, or employee performance. This stream supplies no reliable deletion signal.
Developer identifier: `activity_logs.applicationId`
**Application ID.** Identifier of the application used. It provides the reference needed to connect the activity log to the corresponding provider object.
* **Enables:** Connect each activity log in Activity Logs to the referenced application through `activity_logs.applicationId`; flag application ID values that do not resolve in that provider namespace.
* **Interpretation:** ActivTrak reports application ID as an identifier in its application namespace; it is not a universal identity outside ActivTrak.
Developer identifier: `activity_logs.computer`
**Computer.** Name of the computer. It supplies the computer profile facet used to reconcile or attribute the activity log.
* **Enables:** Reconcile the activity log's computer in `activity_logs.computer` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** ActivTrak reports computer as a mutable profile or directory attribute on each activity log; it may be absent, shared, or non-unique.
Developer identifier: `activity_logs.computerId`
**Computer ID.** Identifier of the computer where the activity occurred. It provides the reference needed to connect the activity log to the corresponding provider object.
* **Enables:** Connect each activity log in Activity Logs to the referenced computer through `activity_logs.computerId`; flag computer ID values that do not resolve in that provider namespace.
* **Interpretation:** ActivTrak reports computer ID as an identifier in its computer namespace; it is not a universal identity outside ActivTrak.
Developer identifier: `activity_logs.description`
**Description.** Description of the application or website. It defines the content surface available for this activity log.
* **Enables:** Locate activity log records by description in `activity_logs.description`; attribute each text match to its parent activity log and, when present, its reported author.
* **Interpretation:** ActivTrak supplies description as text on each activity log; referenced files or media are not implied unless explicitly represented.
Developer identifier: `activity_logs.duration`
**Duration.** Duration of the activity in seconds. It supplies the duration measure for the activity log at the provider's declared unit and grain.
* **Enables:** Measure duration through `activity_logs.duration` for each activity log and compare only values with the same unit and record grain.
* **Interpretation:** ActivTrak reports duration as a measure on each activity log; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_logs.emailAlarm`
**Email Alarm.** Whether an email alarm was triggered. It distinguishes the provider-defined email alarm state or classification for the activity log.
* **Enables:** Filter Activity Logs by whether an email alarm was triggered in `activity_logs.emailAlarm`; count true, false, and missing results separately.
* **Interpretation:** ActivTrak reports an email alarm was triggered as a boolean on each activity log; a missing field is unknown, not false.
Developer identifier: `activity_logs.executable`
**Executable.** Executable name of the application. It supplies the executable profile facet used to reconcile or attribute the activity log.
* **Enables:** Reconcile the activity log's executable in `activity_logs.executable` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** ActivTrak reports executable as a mutable profile or directory attribute on each activity log; it may be absent, shared, or non-unique.
Developer identifier: `activity_logs.externalNotificationAlarm`
**External Notification Alarm.** Whether an external notification alarm was triggered. It distinguishes the provider-defined external notification alarm state or classification for the activity log.
* **Enables:** Filter Activity Logs by whether an external notification alarm was triggered in `activity_logs.externalNotificationAlarm`; count true, false, and missing results separately.
* **Interpretation:** ActivTrak reports an external notification alarm was triggered as a boolean on each activity log; a missing field is unknown, not false.
Developer identifier: `activity_logs.location`
**Location.** Location of the user. It supplies the provider-reported address or location facet for the activity log, not a residency determination.
* **Enables:** Group Activity Logs by location in `activity_logs.location` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** ActivTrak reports location as a user, device, request, or resource location attribute on each activity log; it does not establish where data is stored or processed.
Developer identifier: `activity_logs.logId`
**Log ID.** Unique identifier for the log entry. It provides the reference needed to connect the activity log to the corresponding provider object.
* **Enables:** Match repeated activity log entries on log ID in `activity_logs.logId`; collapse only entries that share this declared transform key.
* **Interpretation:** ActivTrak reports log ID as an identifier in its log namespace; it is not a universal identity outside ActivTrak. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `activity_logs.loginDomain`
**Login Domain.** Login domain of the user. It supplies the login domain profile facet used to reconcile or attribute the activity log.
* **Enables:** Reconcile the activity log's login domain in `activity_logs.loginDomain` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** ActivTrak reports login domain as a mutable profile or directory attribute on each activity log; it may be absent, shared, or non-unique.
Developer identifier: `activity_logs.popupAlarm`
**Popup Alarm.** Whether a popup alarm was triggered. It distinguishes the provider-defined popup alarm state or classification for the activity log.
* **Enables:** Filter Activity Logs by whether a popup alarm was triggered in `activity_logs.popupAlarm`; count true, false, and missing results separately.
* **Interpretation:** ActivTrak reports a popup alarm was triggered as a boolean on each activity log; a missing field is unknown, not false.
Developer identifier: `activity_logs.primaryDomain`
**Primary Domain.** Primary domain of the user. It supplies the primary domain profile facet used to reconcile or attribute the activity log.
* **Enables:** Reconcile the activity log's primary domain in `activity_logs.primaryDomain` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** ActivTrak reports primary domain as a mutable profile or directory attribute on each activity log; it may be absent, shared, or non-unique.
Developer identifier: `activity_logs.privateIp`
**Private IP.** Private IP address of the computer. It supplies the provider-reported address or location facet for the activity log, not a residency determination.
* **Enables:** Correlate activity log records that report the same network address in `activity_logs.privateIp` during an authorized investigation; account for shared, proxied, or translated addresses.
* **Interpretation:** ActivTrak reports this as an IP network address on each activity log. It is not verified geolocation, does not identify a person by itself, and does not establish data residency.
Developer identifier: `activity_logs.productivity`
**Provider Category.** Productivity classification score. It distinguishes the provider-defined provider category state or classification for the activity log.
* **Enables:** Segment activity logs by ActivTrak's administrator-defined category in `activity_logs.productivity` and count records for each reported label.
* **Interpretation:** ActivTrak reports provider category as a label from its own taxonomy on each activity log; preserve unknown labels rather than mapping them by assumption. ActivTrak or its administrator defines the classification; it is not a Parable productivity or employee-performance judgment.
Developer identifier: `activity_logs.publicIp`
**Public IP.** Public IP address of the computer. It supplies the provider-reported address or location facet for the activity log, not a residency determination.
* **Enables:** Correlate activity log records that report the same network address in `activity_logs.publicIp` during an authorized investigation; account for shared, proxied, or translated addresses.
* **Interpretation:** ActivTrak reports this as an IP network address on each activity log. It is not verified geolocation, does not identify a person by itself, and does not establish data residency.
Developer identifier: `activity_logs.screenshotUrl`
**Screenshot URL.** URL to the activity screenshot. It locates the provider resource or path associated with the activity log.
* **Enables:** Open the screenshot ActivTrak associated with this exact activity log through `activity_logs.screenshotUrl` for a narrowly authorized record-level investigation.
* **Interpretation:** ActivTrak reports screenshot URL as a resource locator for each activity log; access still depends on viewer permissions and the URL may expire or change. ActivTrak captured and linked the screenshot; Parable does not create it, and access must remain limited to authorized record-level investigation.
Developer identifier: `activity_logs.session`
**Session.** ActivTrak's integer identifier for a captured activity session; needed to correlate entries without treating the field as a count or duration.
* **Enables:** Group activity-log entries that share the same ActivTrak session identifier in `activity_logs.session` and trace that session across recorded applications or websites.
* **Interpretation:** ActivTrak reports an integer identifier for the captured session. It is a provider-scoped correlation key, not a count, duration, or measure of user activity.
Developer identifier: `activity_logs.subpage`
**Subpage.** Subpage or path of the website. It locates the provider resource or path associated with the activity log.
* **Enables:** Resolve the activity log's provider resource or path through `activity_logs.subpage`; verify access separately and do not infer that linked content was ingested.
* **Interpretation:** ActivTrak returns subpage as a resource locator or path for each activity log; access can expire or depend on viewer permissions, and linked content is not implied.
Developer identifier: `activity_logs.terminate`
**Terminate.** Whether the activity was terminated. It distinguishes the provider-defined terminate state or classification for the activity log.
* **Enables:** Filter Activity Logs by whether the activity was terminated in `activity_logs.terminate`; count true, false, and missing results separately.
* **Interpretation:** ActivTrak reports the activity was terminated as a boolean on each activity log; a missing field is unknown, not false.
Developer identifier: `activity_logs.time`
**Time.** Local timestamp of the activity. It anchors the activity log on the provider's reported timeline.
* **Enables:** Order Activity Logs by time in `activity_logs.time` and isolate records inside an exact provider reporting window.
* **Interpretation:** ActivTrak reports time as a timestamp on each activity log; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `activity_logs.time_utc`
**Time UTC.** UTC timestamp of the activity. It anchors the activity log on the provider's reported timeline.
* **Enables:** Order Activity Logs by time UTC in `activity_logs.time_utc` and isolate records inside an exact provider reporting window.
* **Interpretation:** ActivTrak reports time UTC as a timestamp on each activity log; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `activity_logs.time_zone`
**Time Zone.** Time zone of the activity. It is needed to interpret companion dates and times for the activity log in the provider's intended zone.
* **Enables:** Apply the zone in `activity_logs.time_zone` when converting the activity log's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** ActivTrak reports time zone as a timezone identifier for each activity log; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `activity_logs.titleBar`
**Title Bar.** Title bar text of the active window. It supplies the returned title bar text needed to understand the activity log in context.
* **Enables:** Label each activity log with title bar from `activity_logs.titleBar`; distinguish records that share that display name but have different ActivTrak identifiers.
* **Interpretation:** ActivTrak reports title bar as display text for each activity log; names are mutable and are not stable identities.
Developer identifier: `activity_logs.url`
**URL.** Full URL of the website visited. It locates the provider resource or path associated with the activity log.
* **Enables:** Associate each activity log with the resource identified by URL in `activity_logs.url`; verify the link resolves to the expected ActivTrak object.
* **Interpretation:** ActivTrak reports URL as a resource locator for each activity log; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `activity_logs.user`
**User.** Username associated with the activity. It supplies the user profile facet used to reconcile or attribute the activity log.
* **Enables:** Reconcile the activity log's user in `activity_logs.user` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** ActivTrak reports user as a mutable profile or directory attribute on each activity log; it may be absent, shared, or non-unique.
Developer identifier: `activity_logs.website`
**Website.** Website domain visited. It supplies the website profile facet used to reconcile or attribute the activity log.
* **Enables:** Reconcile the activity log's website in `activity_logs.website` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** ActivTrak reports website as a mutable profile or directory attribute on each activity log; it may be absent, shared, or non-unique.
Developer identifier: `activity_logs.websiteId`
**Website ID.** Identifier of the website visited. It provides the reference needed to connect the activity log to the corresponding provider object.
* **Enables:** Connect each activity log in Activity Logs to the referenced website through `activity_logs.websiteId`; flag website ID values that do not resolve in that provider namespace.
* **Interpretation:** ActivTrak reports website ID as an identifier in its website namespace; it is not a universal identity outside ActivTrak.
Developer identifier: `clients`
**Clients.** ActivTrak client organizations.
* **Enables:** Match ActivTrak client organizations to their domains and aliases when reviewing administrator account coverage.
* **Scope:** Reads the records selected by ActivTrak's `/admin/v1/clients` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the ActivTrak API key and administrator-defined groups available to that key. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `clients.alias`
**Alias.** Alias for the client. It supplies the alias profile facet used to reconcile or attribute the client.
* **Enables:** Reconcile the client's alias in `clients.alias` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** ActivTrak reports alias as a mutable profile or directory attribute on each client; it may be absent, shared, or non-unique.
Developer identifier: `clients.domain`
**Domain.** Domain associated with the client. It supplies the domain profile facet used to reconcile or attribute the client.
* **Enables:** Reconcile the client's domain in `clients.domain` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** ActivTrak reports domain as a mutable profile or directory attribute on each client; it may be absent, shared, or non-unique.
Developer identifier: `clients.id`
**ID.** Unique identifier for the client. It provides the reference needed to connect the client to the corresponding provider object.
* **Enables:** Match repeated client entries on ID in `clients.id`; collapse only entries that share this declared transform key.
* **Interpretation:** ActivTrak reports ID as an identifier in its client namespace; it is not a universal identity outside ActivTrak. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `clients.name`
**Name.** Name of the client. It gives the client a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each client with name from `clients.name`; distinguish records that share that display name but have different ActivTrak identifiers.
* **Interpretation:** ActivTrak reports name as display text for each client; names are mutable and are not stable identities.
Developer identifier: `consumers`
**Consumers.** ActivTrak consumer (admin) accounts.
* **Enables:** Verify which ActivTrak administrator accounts can view each group and which roles or SSO settings govern that access.
* **Scope:** Reads the records selected by ActivTrak's `/admin/v1/consumers` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the ActivTrak API key and administrator-defined groups available to that key. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `consumers.email`
**Email.** Email address of the consumer. It supplies the provider-reported address or location facet for the consumer, not a residency determination.
* **Enables:** Attribute each consumer to a person or account by the exact email in `consumers.email`; identify addresses that do not match the ActivTrak directory.
* **Interpretation:** ActivTrak reports email as an address on each consumer; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `consumers.firstName`
**First Name.** First name of the consumer. It gives the consumer a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each consumer with first name from `consumers.firstName`; distinguish records that share that display name but have different ActivTrak identifiers.
* **Interpretation:** ActivTrak reports first name as display text for each consumer; names are mutable and are not stable identities.
Developer identifier: `consumers.id`
**ID.** Unique identifier for the consumer. It provides the reference needed to connect the consumer to the corresponding provider object.
* **Enables:** Match repeated consumer entries on ID in `consumers.id`; collapse only entries that share this declared transform key.
* **Interpretation:** ActivTrak reports ID as an identifier in its consumer namespace; it is not a universal identity outside ActivTrak. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `consumers.lastName`
**Last Name.** Last name of the consumer. It gives the consumer a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each consumer with last name from `consumers.lastName`; distinguish records that share that display name but have different ActivTrak identifiers.
* **Interpretation:** ActivTrak reports last name as display text for each consumer; names are mutable and are not stable identities.
Developer identifier: `consumers.roles`
**Roles.** Roles assigned to the consumer. It preserves the nested context needed to interpret the parent consumer.
* **Enables:** Compare the exact ActivTrak-configured roles set in `consumers.roles` for each consumer; preserve provider labels and unknown entries.
* **Interpretation:** ActivTrak returns roles as an array of ActivTrak consumer role entries on each consumer; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `consumers.roles.displayname`
**Display Name.** Display name of the role. It distinguishes the provider-defined display name state or classification for the ActivTrak consumer role.
* **Enables:** Label each ActivTrak consumer role with display name from `consumers.ActivTrakConsumerRole.displayname`; distinguish records that share that display name but have different ActivTrak identifiers.
* **Interpretation:** ActivTrak reports display name as display text for each ActivTrak consumer role; names are mutable and are not stable identities.
Developer identifier: `consumers.roles.id`
**ID.** Unique identifier for the role. It provides the reference needed to connect the consumer to the corresponding provider object.
* **Enables:** Match repeated ActivTrak consumer role entries on ID in `consumers.ActivTrakConsumerRole.id`; collapse only entries that share this declared transform key.
* **Interpretation:** ActivTrak reports ID as an identifier in its ActivTrak consumer role namespace; it is not a universal identity outside ActivTrak. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `consumers.roles.name`
**Name.** Internal name of the role. It gives the ActivTrak consumer role a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each ActivTrak consumer role with name from `consumers.ActivTrakConsumerRole.name`; distinguish records that share that display name but have different ActivTrak identifiers.
* **Interpretation:** ActivTrak reports name as display text for each ActivTrak consumer role; names are mutable and are not stable identities.
Developer identifier: `consumers.roles.ssoEnabled`
**SSO Enabled.** Whether SSO is enabled for this role. It distinguishes the provider-defined SSO enabled state or classification for the ActivTrak consumer role.
* **Enables:** Filter Consumers by whether SSO is enabled for this role in `consumers.ActivTrakConsumerRole.ssoEnabled`; count true, false, and missing results separately.
* **Interpretation:** ActivTrak reports SSO is enabled for this role as a boolean on each ActivTrak consumer role; a missing field is unknown, not false.
Developer identifier: `consumers.roles.viewableGroups`
**Viewable Groups.** Groups viewable by this role. It preserves the nested context needed to interpret the parent consumer.
* **Enables:** Compare the exact ActivTrak-configured viewable groups set in `consumers.ActivTrakConsumerRole.viewableGroups` for each ActivTrak consumer role; preserve provider labels and unknown entries.
* **Interpretation:** ActivTrak returns viewable groups as an array of ActivTrak viewable group entries on each ActivTrak consumer role; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `consumers.roles.viewableGroups.goalsetter`
**Goalsetter.** Whether this group has goal-setting privileges. It distinguishes the provider-defined goalsetter state or classification for the ActivTrak viewable group.
* **Enables:** Filter Consumers by whether this group has goal-setting privileges in `consumers.ActivTrakViewableGroup.goalsetter`; count true, false, and missing results separately.
* **Interpretation:** ActivTrak reports this group has goal-setting privileges as a boolean on each ActivTrak viewable group; a missing field is unknown, not false.
Developer identifier: `consumers.roles.viewableGroups.groupid`
**Groupid.** Unique identifier for the group. It identifies the related provider object that gives the ActivTrak viewable group its parent, owner, or container context.
* **Enables:** Connect each ActivTrak viewable group to the related groupid in `consumers.ActivTrakViewableGroup.groupid` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** ActivTrak reports groupid as relationship context on each ActivTrak viewable group; resolve it in the named provider namespace rather than by display text alone.
Developer identifier: `consumers.roles.viewableGroups.groupname`
**Groupname.** Name of the group. It gives the ActivTrak viewable group a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Display the groupname from `consumers.ActivTrakViewableGroup.groupname` for each ActivTrak viewable group; resolve duplicate or changed labels through the provider ID rather than the text.
* **Interpretation:** ActivTrak supplies groupname as mutable display text on each ActivTrak viewable group; it is not a stable identity.
Developer identifier: `consumers.username`
**User Name.** Username of the consumer. It gives the consumer a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each consumer with user name from `consumers.username`; distinguish records that share that display name but have different ActivTrak identifiers.
* **Interpretation:** ActivTrak reports user name as display text for each consumer; names are mutable and are not stable identities.
Developer identifier: `working_hour_computers`
**Working Hour Computers.** ActivTrak working hours report by computer.
* **Enables:** Compare recorded active, passive, and total seconds by computer and date using ActivTrak's administrator-defined categories.
* **Scope:** Reads the records selected by ActivTrak's `/reports/v2/workinghours/computers` operation as a changelog stream using incremental synchronization. This stream is opt-in. Visibility follows the ActivTrak API key and administrator-defined groups available to that key. ActivTrak's productive, unproductive, active, and passive labels are administrator-defined classifications, not Parable judgments about employee productivity or performance. This stream supplies no reliable deletion signal.
Developer identifier: `working_hour_computers.activeTime`
**Active Time.** Breakdown of active time by productivity category. It preserves the nested context needed to interpret the parent working hour computer.
* **Enables:** Measure ActivTrak-classified seconds for each working hour computer and compare that reported category across the same user or computer date.
* **Interpretation:** ActivTrak reports active time as a nested object on each working hour computer; optional children may be absent from a valid response. ActivTrak or its administrator defines the classification; it is not a Parable productivity or employee-performance judgment.
Developer identifier: `working_hour_computers.activeTime.productive`
**Provider Category.** Productive time in seconds. It distinguishes the provider-defined provider category state or classification for the ActivTrak time breakdown.
* **Enables:** Measure ActivTrak-classified seconds for each working hour computer and compare that reported category across the same user or computer date.
* **Interpretation:** ActivTrak reports productive time in seconds as seconds on each ActivTrak time breakdown; the surrounding key identifies the administrator-defined category. ActivTrak or its administrator defines the classification; it is not a Parable productivity or employee-performance judgment.
Developer identifier: `working_hour_computers.activeTime.total`
**Total.** Total time in seconds. It supplies the total measure for the ActivTrak time breakdown at the provider's declared unit and grain.
* **Enables:** Measure total through `working_hour_computers.ActivTrakTimeBreakdown.total` for each ActivTrak time breakdown and compare only values with the same unit and record grain.
* **Interpretation:** ActivTrak reports total as a measure on each ActivTrak time breakdown; compare only records with the same unit and aggregation grain.
Developer identifier: `working_hour_computers.activeTime.undefined`
**Undefined.** Undefined (uncategorized) time in seconds. It supplies the undefined measure for the ActivTrak time breakdown at the provider's declared unit and grain.
* **Enables:** Measure undefined through `working_hour_computers.ActivTrakTimeBreakdown.undefined` for each ActivTrak time breakdown and compare only values with the same unit and record grain.
* **Interpretation:** ActivTrak reports undefined as a measure on each ActivTrak time breakdown; compare only records with the same unit and aggregation grain.
Developer identifier: `working_hour_computers.activeTime.unproductive`
**Provider Category.** Unproductive time in seconds. It distinguishes the provider-defined provider category state or classification for the ActivTrak time breakdown.
* **Enables:** Measure ActivTrak-classified seconds for each working hour computer and compare that reported category across the same user or computer date.
* **Interpretation:** ActivTrak reports unproductive time in seconds as seconds on each ActivTrak time breakdown; the surrounding key identifies the administrator-defined category. ActivTrak or its administrator defines the classification; it is not a Parable productivity or employee-performance judgment.
Developer identifier: `working_hour_computers.computer`
**Computer.** Name of the computer. It supplies the computer profile facet used to reconcile or attribute the working hour computer.
* **Enables:** Reconcile the working hour computer's computer in `working_hour_computers.computer` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** ActivTrak reports computer as a mutable profile or directory attribute on each working hour computer; it may be absent, shared, or non-unique.
Developer identifier: `working_hour_computers.computerId`
**Computer ID.** Unique identifier for the computer. It provides the reference needed to connect the working hour computer to the corresponding provider object.
* **Enables:** Match repeated working hour computer entries on computer ID in `working_hour_computers.computerId`; collapse only entries that share this declared transform key.
* **Interpretation:** ActivTrak reports computer ID as an identifier in its computer namespace; it is not a universal identity outside ActivTrak. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `working_hour_computers.date`
**Date.** Date of the working hours record. It anchors the working hour computer on the provider's reported timeline.
* **Enables:** Order Working Hour Computers by date in `working_hour_computers.date` and isolate records inside an exact provider reporting window.
* **Interpretation:** ActivTrak reports date as a calendar date on each working hour computer; its grain is one day and no time of day should be inferred. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `working_hour_computers.firstActivity`
**First Activity.** Timestamp of the first activity recorded. It anchors the working hour computer on the provider's reported timeline.
* **Enables:** Filter Working Hour Computers by first activity in `working_hour_computers.firstActivity`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** ActivTrak reports first activity as a timestamp on each working hour computer; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `working_hour_computers.groups`
**Groups.** Groups the computer belongs to. It preserves the nested context needed to interpret the parent working hour computer.
* **Enables:** Compare the exact ActivTrak-configured groups set in `working_hour_computers.groups` for each working hour computer; preserve provider labels and unknown entries.
* **Interpretation:** ActivTrak returns groups as an array of group value entries on each working hour computer; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `working_hour_computers.lastActivity`
**Last Activity.** Timestamp of the last activity recorded. It anchors the working hour computer on the provider's reported timeline.
* **Enables:** Filter Working Hour Computers by last activity in `working_hour_computers.lastActivity`; pair that boundary with the corresponding start before measuring elapsed time.
* **Interpretation:** ActivTrak reports last activity as a timestamp on each working hour computer; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `working_hour_computers.lastActivityLog`
**Last Activity Log.** Timestamp of the last activity log entry. It anchors the working hour computer on the provider's reported timeline.
* **Enables:** Filter Working Hour Computers by last activity log in `working_hour_computers.lastActivityLog`; pair that boundary with the corresponding start before measuring elapsed time.
* **Interpretation:** ActivTrak reports last activity log as a timestamp on each working hour computer; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `working_hour_computers.location`
**Location.** Location of the computer. It supplies the provider-reported address or location facet for the working hour computer, not a residency determination.
* **Enables:** Group Working Hour Computers by location in `working_hour_computers.location` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** ActivTrak reports location as a user, device, request, or resource location attribute on each working hour computer; it does not establish where data is stored or processed.
Developer identifier: `working_hour_computers.passiveTime`
**Passive Time.** Breakdown of passive time by productivity category. It preserves the nested context needed to interpret the parent working hour computer.
* **Enables:** Measure ActivTrak-classified seconds for each working hour computer and compare that reported category across the same user or computer date.
* **Interpretation:** ActivTrak reports passive time as a nested object on each working hour computer; optional children may be absent from a valid response. ActivTrak or its administrator defines the classification; it is not a Parable productivity or employee-performance judgment.
Developer identifier: `working_hour_computers.TotalOfflineMeetings`
**Total Offline Meetings.** Total number of offline meetings. It supplies the total offline meetings measure for the working hour computer at the provider's declared unit and grain.
* **Enables:** Measure total offline meetings through `working_hour_computers.TotalOfflineMeetings` for each working hour computer and compare only values with the same unit and record grain.
* **Interpretation:** ActivTrak reports total offline meetings as a measure on each working hour computer; compare only records with the same unit and aggregation grain.
Developer identifier: `working_hour_computers.totalTime`
**Total Time.** Total tracked time in seconds. It supplies the total time measure for the working hour computer at the provider's declared unit and grain.
* **Enables:** Measure total time through `working_hour_computers.totalTime` for each working hour computer and compare only values with the same unit and record grain.
* **Interpretation:** ActivTrak reports total time as a measure on each working hour computer; compare only records with the same unit and aggregation grain.
Developer identifier: `working_hour_computers.users`
**Users.** Users who used this computer. It preserves the nested context needed to interpret the parent working hour computer.
* **Enables:** Match every returned user value in `working_hour_computers.users` to the parent working hour computer; use the element's provider identity or role to reconcile membership and attribution.
* **Interpretation:** ActivTrak returns users as an array of user value entries on each working hour computer; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `working_hour_users`
**Working Hour Users.** ActivTrak working hours report by user.
* **Enables:** Compare recorded active, passive, and total seconds by user and date using ActivTrak's administrator-defined categories.
* **Scope:** Reads the records selected by ActivTrak's `/reports/v2/workinghours/users` operation as a changelog stream using incremental synchronization. This stream is opt-in. Visibility follows the ActivTrak API key and administrator-defined groups available to that key. ActivTrak's productive, unproductive, active, and passive labels are administrator-defined classifications, not Parable judgments about employee productivity or performance. This stream supplies no reliable deletion signal.
Developer identifier: `working_hour_users.activeTime`
**Active Time.** Breakdown of active time by productivity category. It preserves the nested context needed to interpret the parent working hour user.
* **Enables:** Measure ActivTrak-classified seconds for each working hour user and compare that reported category across the same user or computer date.
* **Interpretation:** ActivTrak reports active time as a nested object on each working hour user; optional children may be absent from a valid response. ActivTrak or its administrator defines the classification; it is not a Parable productivity or employee-performance judgment.
Developer identifier: `working_hour_users.activeTime.productive`
**Provider Category.** Productive time in seconds. It distinguishes the provider-defined provider category state or classification for the ActivTrak time breakdown.
* **Enables:** Measure ActivTrak-classified seconds for each working hour user and compare that reported category across the same user or computer date.
* **Interpretation:** ActivTrak reports productive time in seconds as seconds on each ActivTrak time breakdown; the surrounding key identifies the administrator-defined category. ActivTrak or its administrator defines the classification; it is not a Parable productivity or employee-performance judgment.
Developer identifier: `working_hour_users.activeTime.total`
**Total.** Total time in seconds. It supplies the total measure for the ActivTrak time breakdown at the provider's declared unit and grain.
* **Enables:** Measure total through `working_hour_users.ActivTrakTimeBreakdown.total` for each ActivTrak time breakdown and compare only values with the same unit and record grain.
* **Interpretation:** ActivTrak reports total as a measure on each ActivTrak time breakdown; compare only records with the same unit and aggregation grain.
Developer identifier: `working_hour_users.activeTime.undefined`
**Undefined.** Undefined (uncategorized) time in seconds. It supplies the undefined measure for the ActivTrak time breakdown at the provider's declared unit and grain.
* **Enables:** Measure undefined through `working_hour_users.ActivTrakTimeBreakdown.undefined` for each ActivTrak time breakdown and compare only values with the same unit and record grain.
* **Interpretation:** ActivTrak reports undefined as a measure on each ActivTrak time breakdown; compare only records with the same unit and aggregation grain.
Developer identifier: `working_hour_users.activeTime.unproductive`
**Provider Category.** Unproductive time in seconds. It distinguishes the provider-defined provider category state or classification for the ActivTrak time breakdown.
* **Enables:** Measure ActivTrak-classified seconds for each working hour user and compare that reported category across the same user or computer date.
* **Interpretation:** ActivTrak reports unproductive time in seconds as seconds on each ActivTrak time breakdown; the surrounding key identifies the administrator-defined category. ActivTrak or its administrator defines the classification; it is not a Parable productivity or employee-performance judgment.
Developer identifier: `working_hour_users.computers`
**Computers.** Computers used by the user. It preserves the nested context needed to interpret the parent working hour user.
* **Enables:** Attribute every returned computer value in `working_hour_users.computers` to its parent working hour user; keep each relationship distinct and distinguish an absent array from an explicitly empty one.
* **Interpretation:** ActivTrak returns computers as an array of computer value entries on each working hour user; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `working_hour_users.date`
**Date.** Date of the working hours record. It anchors the working hour user on the provider's reported timeline.
* **Enables:** Order Working Hour Users by date in `working_hour_users.date` and isolate records inside an exact provider reporting window.
* **Interpretation:** ActivTrak reports date as a calendar date on each working hour user; its grain is one day and no time of day should be inferred. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `working_hour_users.firstActivity`
**First Activity.** Timestamp of the first activity recorded. It anchors the working hour user on the provider's reported timeline.
* **Enables:** Filter Working Hour Users by first activity in `working_hour_users.firstActivity`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** ActivTrak reports first activity as a timestamp on each working hour user; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `working_hour_users.groups`
**Groups.** Groups the user belongs to. It preserves the nested context needed to interpret the parent working hour user.
* **Enables:** Compare the exact ActivTrak-configured groups set in `working_hour_users.groups` for each working hour user; preserve provider labels and unknown entries.
* **Interpretation:** ActivTrak returns groups as an array of group value entries on each working hour user; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `working_hour_users.lastActivity`
**Last Activity.** Timestamp of the last activity recorded. It anchors the working hour user on the provider's reported timeline.
* **Enables:** Filter Working Hour Users by last activity in `working_hour_users.lastActivity`; pair that boundary with the corresponding start before measuring elapsed time.
* **Interpretation:** ActivTrak reports last activity as a timestamp on each working hour user; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `working_hour_users.lastActivityLog`
**Last Activity Log.** Timestamp of the last activity log entry. It anchors the working hour user on the provider's reported timeline.
* **Enables:** Filter Working Hour Users by last activity log in `working_hour_users.lastActivityLog`; pair that boundary with the corresponding start before measuring elapsed time.
* **Interpretation:** ActivTrak reports last activity log as a timestamp on each working hour user; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `working_hour_users.location`
**Location.** Location of the user. It supplies the provider-reported address or location facet for the working hour user, not a residency determination.
* **Enables:** Group Working Hour Users by location in `working_hour_users.location` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** ActivTrak reports location as a user, device, request, or resource location attribute on each working hour user; it does not establish where data is stored or processed.
Developer identifier: `working_hour_users.passiveTime`
**Passive Time.** Breakdown of passive time by productivity category. It preserves the nested context needed to interpret the parent working hour user.
* **Enables:** Measure ActivTrak-classified seconds for each working hour user and compare that reported category across the same user or computer date.
* **Interpretation:** ActivTrak reports passive time as a nested object on each working hour user; optional children may be absent from a valid response. ActivTrak or its administrator defines the classification; it is not a Parable productivity or employee-performance judgment.
Developer identifier: `working_hour_users.TotalOfflineMeetings`
**Total Offline Meetings.** Total number of offline meetings. It supplies the total offline meetings measure for the working hour user at the provider's declared unit and grain.
* **Enables:** Measure total offline meetings through `working_hour_users.TotalOfflineMeetings` for each working hour user and compare only values with the same unit and record grain.
* **Interpretation:** ActivTrak reports total offline meetings as a measure on each working hour user; compare only records with the same unit and aggregation grain.
Developer identifier: `working_hour_users.totalTime`
**Total Time.** Total tracked time in seconds. It supplies the total time measure for the working hour user at the provider's declared unit and grain.
* **Enables:** Measure total time through `working_hour_users.totalTime` for each working hour user and compare only values with the same unit and record grain.
* **Interpretation:** ActivTrak reports total time as a measure on each working hour user; compare only records with the same unit and aggregation grain.
Developer identifier: `working_hour_users.user`
**User.** Username or display name of the user. It supplies the user profile facet used to reconcile or attribute the working hour user.
* **Enables:** Reconcile the working hour user's user in `working_hour_users.user` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** ActivTrak reports user as a mutable profile or directory attribute on each working hour user; it may be absent, shared, or non-unique.
Developer identifier: `working_hour_users.userId`
**User ID.** Unique identifier for the user. It provides the reference needed to connect the working hour user to the corresponding provider object.
* **Enables:** Match repeated working hour user entries on user ID in `working_hour_users.userId`; collapse only entries that share this declared transform key.
* **Interpretation:** ActivTrak reports user ID as an identifier in its user namespace; it is not a universal identity outside ActivTrak. The connector explicitly marks this field as a transform deduplication key. A connector directive maps this field to account identity.
Developer identifier: `working_hour_users.users`
**Users.** Associated user identifiers. It preserves the nested context needed to interpret the parent working hour user.
* **Enables:** Match every returned user value in `working_hour_users.users` to the parent working hour user; use the element's provider identity or role to reconcile membership and attribution.
* **Interpretation:** ActivTrak returns users as an array of user value entries on each working hour user; missing, empty, and permission-redacted arrays are not equivalent.
| Error | Meaning | Solution |
| - | - | - |
| `401 Unauthorized` | Invalid API key | Verify key is correct |
| `403 Forbidden` | Feature not available | Check subscription tier |
**[ActivTrak API](https://support.activtrak.com/hc/en-us/articles/360039987751-ActivConnect-API-Documentation-Setup-Guide)** — Official API documentation
# Anaplan API
Source: https://docs.parable.work/plugins/provider-plugins/anaplan
Anaplan is a cloud-based enterprise planning platform that provides REST APIs for bulk data import/export, transactional data operations, model lifecycle management, audit logging, user identity management (SCIM), and financial consolidation across workspaces and models.
Anaplan is a cloud-based enterprise planning platform that provides REST APIs for bulk data import/export, transactional data operations, model lifecycle management, audit logging, user identity management (SCIM), and financial consolidation across workspaces and models.
Connect Parable to Anaplan for workspace, SCIM, and audit data using email and password with HTTP Basic authentication against the Anaplan token endpoint.
#### Planning data
Models, lists, workspaces you can access with the integration account
#### Identity & audit
SCIM users and groups (with Tenant Admin), audit events (with Tenant Auditor)
## Data streams
This Provider Plugin defines 20 data streams.
| Stream | Description | Sync |
| - | - | - |
| `workspaces` | Lists all workspaces accessible to the authenticated user. Core organizational container in Anaplan. | full |
| `models` | Lists all models across all workspaces accessible to the authenticated user, with optional detailed memory usage information. | full |
| `workspace_models` | Lists all models within a specific workspace. Useful for workspace-scoped model enumeration. | full |
| `model_exports` | Lists all export action definitions within a specific model. Export actions define data extractions from Anaplan modules/views. | full |
| `model_imports` | Lists all import action definitions within a specific model. Import actions define data loading configurations into Anaplan. | full |
| `model_actions` | Lists all actions (delete actions, other named actions) defined within a specific model. | full |
| `model_files` | Lists all files (data sources and export outputs) within a specific model. | full |
| `model_lists` | Lists all lists (dimensions/hierarchies) defined within a specific model. Lists are core structural elements in Anaplan. | full |
| `list_items` | Retrieves all items within a specific list (dimension members). These are the actual data records within Anaplan lists/hierarchies. | full |
| `model_modules` | Lists all modules defined within a specific model. Modules are the primary data containers in Anaplan holding line items and views. | full |
| `module_views` | Lists all saved views within a specific module. Views represent different perspectives/layouts of module data. | full |
| `model_line_items` | Lists all line items defined within a specific model. Line items are the individual data elements (metrics/measures) in Anaplan modules. | full |
| `cloudworks_connections` | Lists all CloudWorks connections configured for the tenant. Connections define external data source/destination endpoints (S3, Azure Blob, BigQuery, etc.). | full |
| `cloudworks_integrations` | Lists all CloudWorks integrations configured for the tenant. Integrations define automated data flows between Anaplan models and external cloud services. | full |
| `cloudworks_run_history` | Lists CloudWorks integration run history records. Provides execution logs showing when integrations ran, their status, and duration. | full |
| `users` | Lists all users in the Anaplan tenant via the Integration API v2. Returns user identity, email, active status, and admin role. Does not require SCIM provisioning or Enterprise tier. | full |
| `scim_users` | Lists all users provisioned in the Anaplan tenant via SCIM 2.0. Returns user identity, email, active status, and workspace assignments. | full |
| `audit_events` | Retrieves audit events from the Anaplan tenant. Captures who-did-what-when across the platform including model changes, user actions, data imports/exports, and administrative operations. Anaplan retains up to 30 days of audit history. Requires Tenant Auditor role. | incremental |
| `model_calendar` | Retrieves the calendar/time configuration for an Anaplan model, including fiscal year settings, time ranges, and period definitions. This is a model-level metadata object but returns structured time taxonomy data. | full |
| `model_versions` | Retrieves version information (revision tags) for Anaplan models via the ALM API. Tracks model versioning history including who created each version and when, supporting change management and activity tracking. | full |
### Basic authentication
#### What You'll Need
| Credential | What it is |
| - | - |
| **Email** | Anaplan integration user email |
| **Password** | Anaplan account password |
> **Info:** **Setup access in Anaplan.** These steps require **Tenant Admin / Workspace Admin as required for the data you sync**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Anaplan administrator.
* **Workspace Admin** on all workspaces you want to sync
* **Tenant Admin** (required for SCIM user and group access)
* **Tenant Auditor** (required for audit event access)
> **Info:** Designate the integration account as an **Exception User** under **Administration → Security Policies** so optional password rotation does not break the connection.
#### Step 1: Confirm integration account
Use (or create) a dedicated Anaplan user for Parable. Grant the roles above for the workspaces and APIs you need.
#### Step 2: How authentication works
Parable sends **email** and **password** to `https://auth.anaplan.com/token/authenticate` using HTTP Basic auth. Anaplan returns a short-lived `AnaplanAuthToken` for API calls; Parable refreshes it automatically.
#### Step 3: Enter values in the form
1. **Email** and **Password**: Enter the integration user credentials in the Provider form.
2. Click **Save & test connection**.
Developer identifier: `audit_events`
Audit Events contain audit events from the Anaplan tenant. Captures who-did-what-when across the platform including model changes, user actions, data imports/exports, and administrative operations. Anaplan retains up to 30 days of audit history. Requires Tenant Auditor role.
* **Enables:** trace recorded Anaplan changes and administrative actions to their actor and event time.
* **Scope:** Reads provider changes through `POST https://audit.anaplan.com/audit/api/1/events/search?limit=10000` using the declared incremental request boundary. The operation requires the Tenant Auditor role and is limited to Anaplan's retained audit window, described here as up to 30 days.
Developer identifier: `audit_events.actionDetails`
Action Details records detailed information about the specific action performed. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret action details according to the provider and Workspace configuration that produced each audit event record.
* **Interpretation:** Keys and value shapes within `actionDetails` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `audit_events.actionDetails.actionId`
Action ID captures the identifier of the action definition (e.g., import ID, export ID, process ID). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same action ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `actionId` as a record-level identifier on `ActionDetails`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.actionDetails.actionName`
Action Name captures the name of the action definition. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact action name value attached to each action detail record.
* **Interpretation:** The provider supplies `actionName` at action detail granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_events.actionDetails.actionType`
Action Type captures the type of action (e.g., import, export, process, delete). It preserves the provider's current classification of this record.
* **Enables:** separate audit event records by the exact provider-reported action type value when describing their recorded state.
* **Interpretation:** The provider supplies `actionType` per action detail record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_events.actionDetails.changedProperties`
Changed Properties records list of properties that were changed during the event. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested changed properties object into its declared child fields for each action detail record.
* **Interpretation:** The provider returns `changedProperties` as a list on `ActionDetails`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `audit_events.actionDetails.changedProperties.newValue`
New Value captures the new value of the property after the change. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded new value with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `newValue` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_events.actionDetails.changedProperties.oldValue`
Old Value captures the previous value of the property before the change. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded old value with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `oldValue` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_events.actionDetails.changedProperties.propertyName`
Property Name captures the name of the property that was changed. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact property name value attached to each changed property record.
* **Interpretation:** The provider supplies `propertyName` at changed property granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_events.actionDetails.durationMs`
Duration Ms captures the duration of the action in milliseconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by duration ms across audit event records.
* **Interpretation:** The provider supplies `durationMs` per action detail record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `audit_events.actionDetails.failureCount`
Failure Count captures the number of records that failed during the action. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported failure count for each action detail record.
* **Interpretation:** The provider supplies `failureCount` at action detail granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `audit_events.actionDetails.recordCount`
Record Count captures the number of records processed by the action, if applicable. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported record count for each action detail record.
* **Interpretation:** The provider supplies `recordCount` at action detail granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `audit_events.actionDetails.sourceFileId`
Source File ID captures the file ID used as the source for an import action. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same source file ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `sourceFileId` as a record-level identifier on `ActionDetails`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.actionDetails.sourceFileName`
Source File Name captures the file name used as the source for an import action. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact source file name value attached to each action detail record.
* **Interpretation:** The provider supplies `sourceFileName` at action detail granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_events.actionDetails.targetListId`
Target List ID captures the target list ID for an import action. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same target list ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `targetListId` as a record-level identifier on `ActionDetails`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.actionDetails.targetModuleId`
Target Module ID captures the target module ID for an import action. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same target module ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `targetModuleId` as a record-level identifier on `ActionDetails`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.actionDetails.taskId`
Task ID captures the task ID if the action was executed as an asynchronous task. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same task ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `taskId` as a record-level identifier on `ActionDetails`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.actionDetails.taskState`
Task State captures the final state of the task (e.g., COMPLETE, FAILED, CANCELLED). It preserves the provider's current classification of this record.
* **Enables:** separate audit event records by the exact provider-reported task state value when describing their recorded state.
* **Interpretation:** The provider supplies `taskState` per action detail record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_events.activityId`
Activity ID is the identifier linking related audit events within a single activity or transaction. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same activity ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `activityId` as a record-level identifier on `AuditEvent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.additionalAttributes`
Additional Attributes records event-specific attributes that vary by event type, returned as a key-value map by the Anaplan audit API. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact additional attributes when validating the configuration or technical definition of a audit event record.
* **Interpretation:** The provider supplies `additionalAttributes` as configuration or technical metadata on `AuditEvent`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `audit_events.checksum`
Checksum records integrity checksum returned by the Anaplan audit API for the event record. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact checksum when validating the configuration or technical definition of a audit event record.
* **Interpretation:** The provider supplies `checksum` as configuration or technical metadata on `AuditEvent`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `audit_events.createdDate`
Created Date records epoch timestamp (milliseconds) when the audit record was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place audit event records on a timeline by created date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdDate` per audit event record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `audit_events.createdTimeZone`
Created Time Zone records time zone associated with `createdDate` when returned by the audit API. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for audit events using the recorded created time zone.
* **Interpretation:** The provider supplies `createdTimeZone` as location or localization context per audit event record; it does not establish a person's real-time physical location.
Developer identifier: `audit_events.errorMessage`
Error Message records error message if the action was unsuccessful. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact error message value attached to each audit event record.
* **Interpretation:** The provider supplies `errorMessage` at audit event granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_events.eventCategory`
Event Category states high-level category grouping for the audit event. It preserves the provider's current classification of this record.
* **Enables:** separate audit event records by the exact provider-reported event category value when describing their recorded state.
* **Interpretation:** The provider supplies `eventCategory` per audit event record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_events.eventDate`
Event Date captures the epoch timestamp (in milliseconds) when the event occurred. It anchors the named event or boundary on the record's timeline.
* **Enables:** place audit event records on a timeline by event date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `eventDate` per audit event record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `audit_events.eventDateIso`
Event Date Iso records ISO 8601 formatted timestamp of when the event occurred. It anchors the named event or boundary on the record's timeline.
* **Enables:** place audit event records on a timeline by event date iso and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `eventDateIso` per audit event record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `audit_events.eventTimeZone`
Event Time Zone records time zone associated with `eventDate` when returned by the audit API. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for audit events using the recorded event time zone.
* **Interpretation:** The provider supplies `eventTimeZone` as location or localization context per audit event record; it does not establish a person's real-time physical location.
Developer identifier: `audit_events.eventType`
Event Type states optional category label for the audit event when the audit API returns it. Live search results typically use `eventTypeId` instead. It preserves the provider's current classification of this record.
* **Enables:** separate audit event records by the exact provider-reported event type value when describing their recorded state.
* **Interpretation:** The provider supplies `eventType` per audit event record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_events.eventTypeId`
Event Type ID identifies event type code returned by the Anaplan audit API (for example USR-8). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same event type ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `eventTypeId` as a record-level identifier on `AuditEvent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.hostName`
Host Name captures the hostname or server from which the action was performed. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact host name when validating the configuration or technical definition of a audit event record.
* **Interpretation:** The provider supplies `hostName` as configuration or technical metadata on `AuditEvent`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `audit_events.id`
ID is the unique identifier for the audit event. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same audit event source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per audit event record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `audit_events.ipAddress`
IP Address captures the IP address from which the action was performed. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** segment audit event records by the recorded IP address without inferring a person's physical presence.
* **Interpretation:** The provider supplies `ipAddress` as location or localization context per audit event record; it does not establish a person's real-time physical location.
Developer identifier: `audit_events.message`
Message records human-readable description of the audit event. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact message value attached to each audit event record.
* **Interpretation:** The provider supplies `message` at audit event granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_events.modelId`
Model ID captures the model ID in which the event occurred, if applicable. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `AuditEvent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.modelName`
Model Name captures the name of the model in which the event occurred. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact model name value attached to each audit event record.
* **Interpretation:** The provider supplies `modelName` at audit event granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_events.objectId`
Object ID captures the unique identifier of the primary object affected by the event. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same object ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `objectId` as a record-level identifier on `AuditEvent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.objectName`
Object Name captures the name of the primary object affected by the event. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact object name value attached to each audit event record.
* **Interpretation:** The provider supplies `objectName` at audit event granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_events.objectType`
Object Type captures the type of the primary object affected (e.g., model, workspace, list, module). It preserves the provider's current classification of this record.
* **Enables:** separate audit event records by the exact provider-reported object type value when describing their recorded state.
* **Interpretation:** The provider supplies `objectType` per audit event record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_events.parameters`
Parameters records additional parameters or context details associated with the audit event. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret parameters according to the provider and Workspace configuration that produced each audit event record.
* **Interpretation:** Keys and value shapes within `parameters` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `audit_events.parameters.name`
Name captures the parameter name or key. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same audit event parameter source row before constructing its represented state.
* **Interpretation:** The provider supplies `name` at one value per audit event parameter record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `audit_events.parameters.type`
Type captures the data type or classification of the parameter value. It preserves the provider's current classification of this record.
* **Enables:** separate audit event records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per audit event parameter record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_events.parameters.value`
Value captures the parameter value. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded value with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `value` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_events.roleId`
Role ID captures the role ID involved in the event, if applicable (e.g., role grant/revoke). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same role ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `roleId` as a record-level identifier on `AuditEvent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.roleName`
Role Name captures the name of the role involved in the event. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported role name attached to each audit event record.
* **Interpretation:** The provider supplies `roleName` at audit event granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `audit_events.sessionId`
Session ID captures the session identifier associated with the user's session at the time of the event. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same session ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `sessionId` as a record-level identifier on `AuditEvent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.sourceType`
Source Type captures the source or channel through which the action was initiated. It preserves the provider's current classification of this record.
* **Enables:** separate audit event records by the exact provider-reported source type value when describing their recorded state.
* **Interpretation:** The provider supplies `sourceType` per audit event record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_events.success`
Success indicates whether the audited action completed successfully. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select audit event records for which the provider reports success as true or false.
* **Interpretation:** The provider supplies `success` as a boolean per audit event record; false and missing are distinct when the field is optional.
Developer identifier: `audit_events.targetUserEmail`
Target User Email captures the email of the target user, if the event involves an action on another user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the audit event record to the provider-reported actor represented by target user email.
* **Interpretation:** The provider supplies `targetUserEmail` as identity or attribution context on each audit event record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `audit_events.targetUserId`
Target User ID captures the user ID of the target user, if the event involves an action on another user (e.g., role assignment). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same target user ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `targetUserId` as a record-level identifier on `AuditEvent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.tenantId`
Tenant ID captures the Anaplan tenant ID associated with this audit event. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same tenant ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `tenantId` as a record-level identifier on `AuditEvent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.userAgent`
User Agent records user-Agent string for the client that performed the action, when present. It preserves the client environment reported with the event.
* **Enables:** count Mixpanel events by the reported user agent client environment.
* **Interpretation:** Mixpanel supplies `userAgent` per tracked event from client metadata; missing values do not identify an operating system or browser.
Developer identifier: `audit_events.userEmail`
User Email captures the email address of the user who performed the action. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the audit event record to the provider-reported actor represented by user email.
* **Interpretation:** The provider supplies `userEmail` as identity or attribution context on each audit event record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `audit_events.userId`
User ID captures the unique identifier of the user who performed the action. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same user ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `userId` as a record-level identifier on `AuditEvent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.userName`
User Name captures the display name or email of the user who performed the action. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the audit event record to the provider-reported actor represented by user name.
* **Interpretation:** The provider supplies `userName` as identity or attribution context on each audit event record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `audit_events.workspaceId`
Workspace ID captures the workspace ID in which the event occurred, if applicable. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit event records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `AuditEvent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_events.workspaceName`
Workspace Name captures the name of the workspace in which the event occurred. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact workspace name value attached to each audit event record.
* **Interpretation:** The provider supplies `workspaceName` at audit event granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `cloudworks_connections`
Cloudworks Connections contain all CloudWorks connections configured for the tenant. Connections define external data source/destination endpoints (S3, Azure Blob, BigQuery, etc.).
* **Enables:** review the external connection definitions available to CloudWorks integrations.
* **Scope:** Reads the declared collection through `GET /cloudworks/2/0/integrations/connections` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `cloudworks_connections.body`
Body records connection-specific configuration details such as bucket name, container, project, etc. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret body according to the provider and Workspace configuration that produced each cloudworks connection record.
* **Interpretation:** Keys and value shapes within `body` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `cloudworks_connections.body.accessKeyId`
Access Key ID identifies AWS access key ID for S3 connections (may be masked or omitted in responses). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks connection records to provider records that carry the same access key ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `accessKeyId` as a record-level identifier on `ConnectionBody`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_connections.body.account`
Account records snowflake account identifier. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested account object into its declared child fields for each connection body record.
* **Interpretation:** The provider returns `account` as a nested object or reference on `ConnectionBody`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `cloudworks_connections.body.authType`
Auth Type states authentication type used by the connection (e.g., password, key, token, oauth). It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported auth type attached to each connection body record.
* **Interpretation:** The provider supplies `authType` at connection body granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `cloudworks_connections.body.bucket`
Bucket records s3 bucket name or GCS bucket name (applicable to AmazonS3, GoogleCloudStorage). It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact bucket when validating the configuration or technical definition of a connection body record.
* **Interpretation:** The provider supplies `bucket` as configuration or technical metadata on `ConnectionBody`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_connections.body.catalog`
Catalog records catalog name for Databricks Unity Catalog or similar. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact catalog when validating the configuration or technical definition of a connection body record.
* **Interpretation:** The provider supplies `catalog` as configuration or technical metadata on `ConnectionBody`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_connections.body.containerName`
Container Name records Azure Blob Storage container name. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact container name when validating the configuration or technical definition of a connection body record.
* **Interpretation:** The provider supplies `containerName` as configuration or technical metadata on `ConnectionBody`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_connections.body.database`
Database records database name for Snowflake, Redshift, JDBC, AzureSql, or AzureSynapse connections. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact database when validating the configuration or technical definition of a connection body record.
* **Interpretation:** The provider supplies `database` as configuration or technical metadata on `ConnectionBody`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_connections.body.datasetId`
Dataset ID identifies bigQuery dataset ID. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks connection records to provider records that carry the same dataset ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `datasetId` as a record-level identifier on `ConnectionBody`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_connections.body.externalId`
External ID identifies external ID used with the IAM role for S3 cross-account access. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks connection records to provider records that carry the same external ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `externalId` as a record-level identifier on `ConnectionBody`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_connections.body.host`
Host records hostname or IP address for SFTP, JDBC, Snowflake, Databricks, or database connections. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact host when validating the configuration or technical definition of a connection body record.
* **Interpretation:** The provider supplies `host` as configuration or technical metadata on `ConnectionBody`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_connections.body.httpPath`
HTTP Path records databricks HTTP path for SQL endpoint. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact HTTP path when validating the configuration or technical definition of a connection body record.
* **Interpretation:** The provider supplies `httpPath` as configuration or technical metadata on `ConnectionBody`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_connections.body.port`
Port records the network port configured for an SFTP, JDBC, or database connection. It preserves the connection endpoint setting used with the host and protocol.
* **Enables:** construct and audit the destination endpoint for each CloudWorks connection.
* **Interpretation:** The provider supplies `port` as an integer connection setting, not a quantity or duration; a missing value may leave protocol-default behavior to other configuration.
Developer identifier: `cloudworks_connections.body.projectId`
Project ID identifies Google Cloud project ID for BigQuery or GCS connections. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks connection records to provider records that carry the same project ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `projectId` as a record-level identifier on `ConnectionBody`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_connections.body.region`
Region records AWS region for S3 connections (e.g., us-east-1). It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** segment cloudworks connection records by the recorded region without inferring a person's physical presence.
* **Interpretation:** The provider supplies `region` as location or localization context per connection body record; it does not establish a person's real-time physical location.
Developer identifier: `cloudworks_connections.body.roleArn`
Role Arn states AWS IAM role ARN used for cross-account access to S3. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported role arn attached to each connection body record.
* **Interpretation:** The provider supplies `roleArn` at connection body granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `cloudworks_connections.body.sasToken`
SAS Token states Azure SAS token for authentication (may be masked in responses). It documents the access-related value reported for this object or membership.
* **Enables:** confirm which CloudWorks connection authentication mode is configured during narrowly authorized troubleshooting without revealing the token value.
* **Interpretation:** Anaplan may mask `sasToken` in responses; treat any returned value as sensitive configuration metadata, never expose it, and never assume it is a reusable credential.
Developer identifier: `cloudworks_connections.body.schema`
Schema records schema name within the database (Snowflake, Redshift, etc.). It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact schema when validating the configuration or technical definition of a connection body record.
* **Interpretation:** The provider supplies `schema` as configuration or technical metadata on `ConnectionBody`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_connections.body.serviceAccountEmail`
Service Account Email records Google service account email used for authentication. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the connection body record to the provider-reported person or account represented by service account email.
* **Interpretation:** The provider supplies `serviceAccountEmail` as identity or attribution context on each connection body record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `cloudworks_connections.body.storageAccountName`
Storage Account Name records Azure Storage account name. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact storage account name when validating the configuration or technical definition of a connection body record.
* **Interpretation:** The provider supplies `storageAccountName` as configuration or technical metadata on `ConnectionBody`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_connections.body.url`
URL records connection URL for Databricks, JDBC, or other URL-based connections. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a connection body record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each connection body record. Availability still follows the provider's permissions and retention.
Developer identifier: `cloudworks_connections.body.username`
User Name records username for SFTP, database, or other credential-based connections. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the connection body record to the provider-reported actor represented by user name.
* **Interpretation:** The provider supplies `username` as identity or attribution context on each connection body record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `cloudworks_connections.body.warehouse`
Warehouse records snowflake warehouse name. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact warehouse when validating the configuration or technical definition of a connection body record.
* **Interpretation:** The provider supplies `warehouse` as configuration or technical metadata on `ConnectionBody`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_connections.connectionId`
Connection ID is the unique identifier for the CloudWorks connection. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same cloud works connection source row before constructing its represented state.
* **Interpretation:** The provider supplies `connectionId` at one value per cloud works connection record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `cloudworks_connections.createdAt`
Created At records ISO 8601 timestamp when the connection was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place cloudworks connection records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per cloud works connection record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `cloudworks_connections.createdBy`
Created By records identifier or email of the user who created the connection. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the cloud works connection record to the provider-reported person or account represented by created by.
* **Interpretation:** The provider supplies `createdBy` as identity or attribution context on each cloud works connection record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `cloudworks_connections.modifiedAt`
Modified At records ISO 8601 timestamp when the connection was last modified. It anchors the named event or boundary on the record's timeline.
* **Enables:** place cloudworks connection records on a timeline by modified at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `modifiedAt` per cloud works connection record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `cloudworks_connections.modifiedBy`
Modified By records identifier or email of the user who last modified the connection. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the cloud works connection record to the provider-reported person or account represented by modified by.
* **Interpretation:** The provider supplies `modifiedBy` as identity or attribution context on each cloud works connection record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `cloudworks_connections.name`
Name records human-readable name of the connection. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each cloud works connection record.
* **Interpretation:** The provider supplies `name` at cloud works connection granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `cloudworks_connections.type`
Type captures the type of external service this connection targets (e.g., AmazonS3, AzureBlob, GoogleBigQuery). It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks connection records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per cloud works connection record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_integrations`
Cloudworks Integrations contain all CloudWorks integrations configured for the tenant. Integrations define automated data flows between Anaplan models and external cloud services.
* **Enables:** map automated CloudWorks data flows to their model and connection configuration.
* **Scope:** Reads the declared collection through `GET /cloudworks/2/0/integrations` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `cloudworks_integrations.actionId`
Action ID is the identifier of the Anaplan import or export action linked to this integration. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks integration records to provider records that carry the same action ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `actionId` as a record-level identifier on `CloudWorksIntegration`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_integrations.connectionId`
Connection ID is the identifier of the CloudWorks connection (external cloud service) used by this integration. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks integration records to provider records that carry the same connection ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `connectionId` as a record-level identifier on `CloudWorksIntegration`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_integrations.connectionType`
Connection Type captures the type of external cloud service connection (e.g., S3, Azure Blob, BigQuery). It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks integration records by the exact provider-reported connection type value when describing their recorded state.
* **Interpretation:** The provider supplies `connectionType` per cloud works integration record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_integrations.createdAt`
Created At records ISO 8601 timestamp when the integration was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place cloudworks integration records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per cloud works integration record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `cloudworks_integrations.createdBy`
Created By records identifier or email of the user who created the integration. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the cloud works integration record to the provider-reported person or account represented by created by.
* **Interpretation:** The provider supplies `createdBy` as identity or attribution context on each cloud works integration record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `cloudworks_integrations.fileId`
File ID is the identifier of the Anaplan file used in the integration data transfer. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks integration records to provider records that carry the same file ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `fileId` as a record-level identifier on `CloudWorksIntegration`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_integrations.integrationId`
Integration ID is the unique identifier for the CloudWorks integration. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same cloud works integration source row before constructing its represented state.
* **Interpretation:** The provider supplies `integrationId` at one value per cloud works integration record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `cloudworks_integrations.lastRunStatus`
Last Run Status states status of the most recent run of this integration. It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks integration records by the exact provider-reported last run status value when describing their recorded state.
* **Interpretation:** The provider supplies `lastRunStatus` per cloud works integration record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_integrations.lastRunTime`
Last Run Time records ISO 8601 timestamp of the most recent run. It anchors the named event or boundary on the record's timeline.
* **Enables:** place cloudworks integration records on a timeline by last run time and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastRunTime` per cloud works integration record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `cloudworks_integrations.lastSuccessfulRunTime`
Last Successful Run Time records ISO 8601 timestamp of the most recent successful run. It anchors the named event or boundary on the record's timeline.
* **Enables:** place cloudworks integration records on a timeline by last successful run time and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastSuccessfulRunTime` per cloud works integration record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `cloudworks_integrations.modelId`
Model ID is the identifier of the Anaplan model associated with this integration. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks integration records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `CloudWorksIntegration`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_integrations.name`
Name records human-readable name of the integration. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each cloud works integration record.
* **Interpretation:** The provider supplies `name` at cloud works integration granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `cloudworks_integrations.notification`
Notification records notification settings for integration run results. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested notification records contained by each cloud works integration record.
* **Interpretation:** The provider returns `notification` as a nested object or reference on `CloudWorksIntegration`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `cloudworks_integrations.notification.enabled`
Enabled indicates whether notifications are enabled for this integration. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select cloudworks integration records for which the provider reports enabled as true or false.
* **Interpretation:** The provider supplies `enabled` as a boolean per integration notification record; false and missing are distinct when the field is optional.
Developer identifier: `cloudworks_integrations.notification.notifyOnFailure`
Notify On Failure indicates whether to send notifications on failed runs. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select cloudworks integration records for which the provider reports notify on failure as true or false.
* **Interpretation:** The provider supplies `notifyOnFailure` as a boolean per integration notification record; false and missing are distinct when the field is optional.
Developer identifier: `cloudworks_integrations.notification.notifyOnSuccess`
Notify On Success indicates whether to send notifications on successful runs. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select cloudworks integration records for which the provider reports notify on success as true or false.
* **Interpretation:** The provider supplies `notifyOnSuccess` as a boolean per integration notification record; false and missing are distinct when the field is optional.
Developer identifier: `cloudworks_integrations.notification.recipients`
Recipients records list of email addresses to receive notifications. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the integration notification record to the provider-reported person or account represented by recipients.
* **Interpretation:** The provider supplies `recipients` as identity or attribution context on each integration notification record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `cloudworks_integrations.nuxVisible`
Nux Visible indicates whether the integration is visible in the new user experience UI. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select cloudworks integration records for which the provider reports nux visible as true or false.
* **Interpretation:** The provider supplies `nuxVisible` as a boolean per cloud works integration record; false and missing are distinct when the field is optional.
Developer identifier: `cloudworks_integrations.runCount`
Run Count reports the total number of times this integration has been executed. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported run count for each cloud works integration record.
* **Interpretation:** The provider supplies `runCount` at cloud works integration granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `cloudworks_integrations.schedule`
Schedule records schedule configuration for automated runs of this integration, if any. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact schedule when validating the configuration or technical definition of a cloud works integration record.
* **Interpretation:** The provider supplies `schedule` as configuration or technical metadata on `CloudWorksIntegration`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_integrations.schedule.cronExpression`
Cron Expression records cron expression defining the schedule, if applicable. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact cron expression when validating the configuration or technical definition of a integration schedule record.
* **Interpretation:** The provider supplies `cronExpression` as configuration or technical metadata on `IntegrationSchedule`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_integrations.schedule.daysOfMonth`
Days Of Month records days of the month on which the schedule runs (for monthly schedules). It preserves the provider-defined period or schedule cadence for this record.
* **Enables:** group cloudworks integration records by the provider-defined days of month period or schedule.
* **Interpretation:** The provider supplies `daysOfMonth` per integration schedule record using its own period or schedule vocabulary; it is not an elapsed-duration measurement.
Developer identifier: `cloudworks_integrations.schedule.daysOfWeek`
Days Of Week records days of the week on which the schedule runs (for weekly schedules). It preserves the provider-defined period or schedule cadence for this record.
* **Enables:** group cloudworks integration records by the provider-defined days of week period or schedule.
* **Interpretation:** The provider supplies `daysOfWeek` per integration schedule record using its own period or schedule vocabulary; it is not an elapsed-duration measurement.
Developer identifier: `cloudworks_integrations.schedule.enabled`
Enabled indicates whether the schedule is currently active. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select cloudworks integration records for which the provider reports enabled as true or false.
* **Interpretation:** The provider supplies `enabled` as a boolean per integration schedule record; false and missing are distinct when the field is optional.
Developer identifier: `cloudworks_integrations.schedule.endDate`
End Date records ISO 8601 date or datetime when the schedule ends, if applicable. It anchors the named event or boundary on the record's timeline.
* **Enables:** place cloudworks integration records on a timeline by end date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `endDate` per integration schedule record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `cloudworks_integrations.schedule.intervalMinutes`
Interval Minutes reports interval in minutes between runs for interval-based schedules. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by interval minutes across cloudworks integration records.
* **Interpretation:** The provider supplies `intervalMinutes` per integration schedule record in the unit stated by the provider description; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `cloudworks_integrations.schedule.scheduleId`
Schedule ID is the unique identifier for the schedule. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks integration records to provider records that carry the same schedule ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `scheduleId` as a record-level identifier on `IntegrationSchedule`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_integrations.schedule.startDate`
Start Date records ISO 8601 date or datetime when the schedule begins. It anchors the named event or boundary on the record's timeline.
* **Enables:** place cloudworks integration records on a timeline by start date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startDate` per integration schedule record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `cloudworks_integrations.schedule.time`
Time records time of day for scheduled execution (HH:mm format). It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact time when validating the configuration or technical definition of a integration schedule record.
* **Interpretation:** The provider supplies `time` as configuration or technical metadata on `IntegrationSchedule`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_integrations.schedule.timezone`
Timezone identifies IANA timezone identifier for the schedule (e.g., America/`New_York`). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks integration records to provider records that carry the same timezone, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `timezone` as a record-level identifier on `IntegrationSchedule`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_integrations.schedule.type`
Type captures the recurrence type of the schedule. It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks integration records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per integration schedule record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_integrations.sources`
Sources lists the configured origin endpoints that feed the integration. It preserves the input-side relationships of the CloudWorks data flow.
* **Enables:** reconstruct which source connections and processes supply data to each integration.
* **Interpretation:** The provider returns `sources` as a list of endpoint definitions on `CloudWorksIntegration`; an empty list and an omitted list are distinct.
Developer identifier: `cloudworks_integrations.sources.actionId`
Action ID identifies Anaplan action identifier (import/export) for Anaplan-type endpoints. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks integration records to provider records that carry the same action ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `actionId` as a record-level identifier on `IntegrationEndpoint`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_integrations.sources.bucket`
Bucket records bucket or container name in the external cloud storage. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact bucket when validating the configuration or technical definition of a integration endpoint record.
* **Interpretation:** The provider supplies `bucket` as configuration or technical metadata on `IntegrationEndpoint`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_integrations.sources.connectionId`
Connection ID is the identifier of the CloudWorks connection for external endpoints.
* **Enables:** Match integration endpoint entries on `connectionId`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** The provider supplies `connectionId` at one value per integration endpoint record.
Developer identifier: `cloudworks_integrations.sources.dataset`
Dataset records dataset name for BigQuery or similar database endpoints. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact dataset when validating the configuration or technical definition of a integration endpoint record.
* **Interpretation:** The provider supplies `dataset` as configuration or technical metadata on `IntegrationEndpoint`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_integrations.sources.fileId`
File ID identifies Anaplan file identifier for Anaplan-type endpoints. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks integration records to provider records that carry the same file ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `fileId` as a record-level identifier on `IntegrationEndpoint`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_integrations.sources.modelId`
Model ID identifies Anaplan model identifier for Anaplan-type endpoints. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks integration records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `IntegrationEndpoint`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_integrations.sources.path`
Path records file path or object key in the external cloud storage. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact path when validating the configuration or technical definition of a integration endpoint record.
* **Interpretation:** The provider supplies `path` as configuration or technical metadata on `IntegrationEndpoint`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_integrations.sources.table`
Table states table name for database-type endpoints. It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks integration records by the exact provider-reported table value when describing their recorded state.
* **Interpretation:** The provider supplies `table` per integration endpoint record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_integrations.sources.type`
Type captures the endpoint type (e.g., 'anaplan', 's3', 'azureblob', 'bigquery', 'googlecloud', 'snowflake'). It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks integration records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per integration endpoint record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_integrations.status`
Status states current status of the integration. It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks integration records by the exact provider-reported status value when describing their recorded state.
* **Interpretation:** The provider supplies `status` per cloud works integration record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_integrations.targets`
Targets lists the configured destination endpoints that receive integration output. It preserves the output-side relationships of the CloudWorks data flow.
* **Enables:** reconstruct which target connections and processes receive data from each integration.
* **Interpretation:** The provider returns `targets` as a list of endpoint definitions on `CloudWorksIntegration`; an empty list and an omitted list are distinct.
Developer identifier: `cloudworks_integrations.tenantId`
Tenant ID is the identifier of the Anaplan tenant that owns this integration. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks integration records to provider records that carry the same tenant ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `tenantId` as a record-level identifier on `CloudWorksIntegration`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_integrations.type`
Type captures the type/direction of the integration (e.g., import or export). It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks integration records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per cloud works integration record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_integrations.updatedAt`
Updated At records ISO 8601 timestamp when the integration was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place cloudworks integration records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per cloud works integration record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `cloudworks_integrations.updatedBy`
Updated By records identifier or email of the user who last updated the integration. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the cloud works integration record to the provider-reported person or account represented by updated by.
* **Interpretation:** The provider supplies `updatedBy` as identity or attribution context on each cloud works integration record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `cloudworks_integrations.version`
Version identifies version identifier for the integration configuration. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks integration records to provider records that carry the same version, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `version` as a record-level identifier on `CloudWorksIntegration`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_integrations.workspaceId`
Workspace ID is the identifier of the Anaplan workspace associated with this integration. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks integration records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `CloudWorksIntegration`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_run_history`
Cloudworks Run History contains CloudWorks integration run history records. Provides execution logs showing when integrations ran, their status, and duration.
* **Enables:** compare integration executions by recorded status, start time, and duration.
* **Scope:** Reads the declared collection through `GET /cloudworks/2/0/integrations/{id}/runs` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `cloudworks_run_history.cancelledBy`
Cancelled By records identifier or email of the user who cancelled the run, if applicable. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the cloud works run history record to the provider-reported person or account represented by cancelled by.
* **Interpretation:** The provider supplies `cancelledBy` as identity or attribution context on each cloud works run history record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `cloudworks_run_history.completedAt`
Completed At states ISO 8601 timestamp indicating when the integration run completed. It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks run history records by the exact provider-reported completed at value when describing their recorded state.
* **Interpretation:** The provider supplies `completedAt` per cloud works run history record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_run_history.createdAt`
Created At records ISO 8601 timestamp indicating when the run record was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place cloudworks run history records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per cloud works run history record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `cloudworks_run_history.duration`
Duration reports duration of the integration run in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by duration across cloudworks run history records.
* **Interpretation:** The provider supplies `duration` per cloud works run history record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `cloudworks_run_history.failedCount`
Failed Count reports the number of records or items that failed during the run. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported failed count for each cloud works run history record.
* **Interpretation:** The provider supplies `failedCount` at cloud works run history granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `cloudworks_run_history.failureDumpAvailable`
Failure Dump Available indicates whether a failure dump file is available for download. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select cloudworks run history records for which the provider reports failure dump available as true or false.
* **Interpretation:** The provider supplies `failureDumpAvailable` as a boolean per cloud works run history record; false and missing are distinct when the field is optional.
Developer identifier: `cloudworks_run_history.failureReason`
Failure Reason records description of the failure reason if the run did not succeed. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact failure reason value attached to each cloud works run history record.
* **Interpretation:** The provider supplies `failureReason` at cloud works run history granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `cloudworks_run_history.id`
ID identifies parent key injected by the ingestor from the `cloudworks_integrations` to `cloudworks_run_history` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks run history records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `CloudWorksRunHistory`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_run_history.ignoredCount`
Ignored Count reports the number of records or items ignored during the run. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported ignored count for each cloud works run history record.
* **Interpretation:** The provider supplies `ignoredCount` at cloud works run history granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `cloudworks_run_history.integrationId`
Integration ID is the identifier of the CloudWorks integration that was executed. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks run history records to provider records that carry the same integration ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `integrationId` as a record-level identifier on `CloudWorksRunHistory`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_run_history.integrationName`
Integration Name records human-readable name of the CloudWorks integration. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact integration name value attached to each cloud works run history record.
* **Interpretation:** The provider supplies `integrationName` at cloud works run history granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `cloudworks_run_history.progress`
Progress reports the integration run's completion percentage from 0 to 100. It records how far execution advanced at the captured state.
* **Enables:** distinguish completed, partial, and potentially stalled runs when reviewing run history.
* **Interpretation:** The provider supplies `progress` as a numeric percentage per CloudWorks run; zero, a partial value, and missing are distinct.
Developer identifier: `cloudworks_run_history.retryCount`
Retry Count reports the number of retry attempts made for this run. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported retry count for each cloud works run history record.
* **Interpretation:** The provider supplies `retryCount` at cloud works run history granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `cloudworks_run_history.runId`
Run ID is the unique identifier for this specific integration run. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same cloud works run history source row before constructing its represented state.
* **Interpretation:** The provider supplies `runId` at one value per cloud works run history record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `cloudworks_run_history.scheduleId`
Schedule ID is the identifier of the schedule that triggered this run, if applicable. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks run history records to provider records that carry the same schedule ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `scheduleId` as a record-level identifier on `CloudWorksRunHistory`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_run_history.sourceInfo`
Source Info identifies the source endpoint used by this integration run. It keeps execution history tied to the input-side connection and process details.
* **Enables:** correlate a run's outcome with the exact source configuration involved in that execution.
* **Interpretation:** The provider returns `sourceInfo` as a nested `RunEndpointInfo` object; absence means no source detail was reported for the run.
Developer identifier: `cloudworks_run_history.sourceInfo.connectionId`
Connection ID is the identifier of the CloudWorks connection used. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks run history records to provider records that carry the same connection ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `connectionId` as a record-level identifier on `RunEndpointInfo`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_run_history.sourceInfo.connectionName`
Connection Name records name of the CloudWorks connection. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact connection name value attached to each run endpoint info record.
* **Interpretation:** The provider supplies `connectionName` at run endpoint info granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `cloudworks_run_history.sourceInfo.fileId`
File ID is the identifier of the file involved in the integration, if applicable. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks run history records to provider records that carry the same file ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `fileId` as a record-level identifier on `RunEndpointInfo`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_run_history.sourceInfo.fileName`
File Name records name of the file involved in the integration, if applicable. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact file name value attached to each run endpoint info record.
* **Interpretation:** The provider supplies `fileName` at run endpoint info granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `cloudworks_run_history.sourceInfo.modelId`
Model ID identifies Anaplan model identifier, if the endpoint is an Anaplan model. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks run history records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `RunEndpointInfo`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_run_history.sourceInfo.path`
Path records path or bucket location for cloud storage endpoints. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact path when validating the configuration or technical definition of a run endpoint info record.
* **Interpretation:** The provider supplies `path` as configuration or technical metadata on `RunEndpointInfo`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `cloudworks_run_history.sourceInfo.type`
Type states type of the endpoint, such as Anaplan, S3, Azure Blob, or Google BigQuery. It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks run history records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per run endpoint info record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_run_history.sourceInfo.workspaceId`
Workspace ID identifies Anaplan workspace identifier, if the endpoint is an Anaplan model. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks run history records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `RunEndpointInfo`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_run_history.startedAt`
Started At records ISO 8601 timestamp indicating when the integration run started. It anchors the named event or boundary on the record's timeline.
* **Enables:** place cloudworks run history records on a timeline by started at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startedAt` per cloud works run history record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `cloudworks_run_history.startedBy`
Started By records identifier or email of the user or system that initiated the run. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the cloud works run history record to the provider-reported person or account represented by started by.
* **Interpretation:** The provider supplies `startedBy` as identity or attribution context on each cloud works run history record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `cloudworks_run_history.status`
Status states current status of the integration run. It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks run history records by the exact provider-reported status value when describing their recorded state.
* **Interpretation:** The provider supplies `status` per cloud works run history record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_run_history.successfulCount`
Successful Count reports the number of records or items successfully processed during the run. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported successful count for each cloud works run history record.
* **Interpretation:** The provider supplies `successfulCount` at cloud works run history granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `cloudworks_run_history.targetInfo`
Target Info identifies the destination endpoint used by this integration run. It keeps execution history tied to the output-side connection and process details.
* **Enables:** correlate a run's outcome with the exact target configuration involved in that execution.
* **Interpretation:** The provider returns `targetInfo` as a nested `RunEndpointInfo` object; absence means no target detail was reported for the run.
Developer identifier: `cloudworks_run_history.taskDetails`
Task Details records list of individual task details within this integration run. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested task details records contained by each cloud works run history record.
* **Interpretation:** The provider returns `taskDetails` as a list on `CloudWorksRunHistory`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `cloudworks_run_history.taskDetails.actionId`
Action ID is the identifier of the Anaplan action (import/export/process) executed by this task. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks run history records to provider records that carry the same action ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `actionId` as a record-level identifier on `RunTaskDetail`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_run_history.taskDetails.completedAt`
Completed At states ISO 8601 timestamp indicating when the task completed. It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks run history records by the exact provider-reported completed at value when describing their recorded state.
* **Interpretation:** The provider supplies `completedAt` per run task detail record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_run_history.taskDetails.failedCount`
Failed Count reports the number of records that failed in this task. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported failed count for each run task detail record.
* **Interpretation:** The provider supplies `failedCount` at run task detail granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `cloudworks_run_history.taskDetails.failureReason`
Failure Reason records description of the failure reason for this task, if applicable. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact failure reason value attached to each run task detail record.
* **Interpretation:** The provider supplies `failureReason` at run task detail granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `cloudworks_run_history.taskDetails.ignoredCount`
Ignored Count reports the number of records ignored by this task. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported ignored count for each run task detail record.
* **Interpretation:** The provider supplies `ignoredCount` at run task detail granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `cloudworks_run_history.taskDetails.modelId`
Model ID is the identifier of the Anaplan model associated with this task. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks run history records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `RunTaskDetail`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_run_history.taskDetails.startedAt`
Started At records ISO 8601 timestamp indicating when the task started. It anchors the named event or boundary on the record's timeline.
* **Enables:** place cloudworks run history records on a timeline by started at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startedAt` per run task detail record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `cloudworks_run_history.taskDetails.successfulCount`
Successful Count reports the number of records successfully processed by this task. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported successful count for each run task detail record.
* **Interpretation:** The provider supplies `successfulCount` at run task detail granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `cloudworks_run_history.taskDetails.taskId`
Task ID is the unique identifier for the task. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same run task detail source row before constructing its represented state.
* **Interpretation:** The provider supplies `taskId` at one value per run task detail record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `cloudworks_run_history.taskDetails.taskName`
Task Name records name of the task. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact task name value attached to each run task detail record.
* **Interpretation:** The provider supplies `taskName` at run task detail granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `cloudworks_run_history.taskDetails.taskStatus`
Task Status states status of this individual task. It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks run history records by the exact provider-reported task status value when describing their recorded state.
* **Interpretation:** The provider supplies `taskStatus` per run task detail record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_run_history.taskDetails.taskType`
Task Type states type of the task, such as import or export. It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks run history records by the exact provider-reported task type value when describing their recorded state.
* **Interpretation:** The provider supplies `taskType` per run task detail record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_run_history.taskDetails.workspaceId`
Workspace ID is the identifier of the Anaplan workspace associated with this task. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cloudworks run history records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `RunTaskDetail`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cloudworks_run_history.totalCount`
Total Count reports the total number of records or items processed during the run. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported total count for each cloud works run history record.
* **Interpretation:** The provider supplies `totalCount` at cloud works run history granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `cloudworks_run_history.trigger`
Trigger states how the integration run was triggered. It preserves the provider's current classification of this record.
* **Enables:** separate cloudworks run history records by the exact provider-reported trigger value when describing their recorded state.
* **Interpretation:** The provider supplies `trigger` per cloud works run history record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `cloudworks_run_history.updatedAt`
Updated At records ISO 8601 timestamp indicating when the run record was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place cloudworks run history records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per cloud works run history record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `list_items`
List Items contain all items within a specific list (dimension members). These are the actual data records within Anaplan lists/hierarchies.
* **Enables:** enumerate the dimension members contained by each Anaplan list.
* **Scope:** Reads the declared collection through `GET /2/0/workspaces/{workspaceId}/models/{modelId}/lists/{id}/items` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `list_items.code`
Code contains an optional external code assigned to the list item, often used for integration mapping with external systems. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact code when validating the configuration or technical definition of a anaplan list item record.
* **Interpretation:** The provider supplies `code` as configuration or technical metadata on `AnaplanListItem`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `list_items.id`
ID captures the unique numeric identifier of the list item within the Anaplan model. This is the internal Anaplan item ID. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same anaplan list item source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per anaplan list item record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `list_items.modelId`
Model ID identifies parent `modelId` injected by the ingestor from the `model_lists` to `list_items` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match list item records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `AnaplanListItem`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `list_items.name`
Name captures the display name of the list item. This is the human-readable label shown in Anaplan. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each anaplan list item record.
* **Interpretation:** The provider supplies `name` at anaplan list item granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `list_items.parent`
Parent captures the ID of the parent list item in a hierarchical list. Null or absent if the item is a top-level member. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the anaplan list item record to the provider-reported person or account represented by parent.
* **Interpretation:** The provider supplies `parent` as identity or attribution context on each anaplan list item record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `list_items.parentName`
Parent Name captures the display name of the parent list item, if the list is hierarchical. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact parent name value attached to each anaplan list item record.
* **Interpretation:** The provider supplies `parentName` at anaplan list item granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `list_items.properties`
Properties contains a map of custom properties (list-level attributes) defined on the list, keyed by property name or ID. Contains values specific to this list item. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret properties according to the provider and Workspace configuration that produced each list item record.
* **Interpretation:** Keys and value shapes within `properties` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `list_items.properties.additionalProperties`
Additional Properties records each key represents a property name or ID defined on the list. The value contains the property's current value for this list item. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact additional properties value attached to each list item property record.
* **Interpretation:** The provider supplies `additionalProperties` at list item property granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `list_items.properties.additionalProperties.id`
ID identifies for properties that reference another list, the ID of the referenced list item. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match list item records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ListItemPropertyValue`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `list_items.properties.additionalProperties.name`
Name records for properties that reference another list, the name of the referenced list item. For text properties, the text value. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each list item property value record.
* **Interpretation:** The provider supplies `name` at list item property value granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `list_items.properties.additionalProperties.type`
Type captures the data type of the property value, such as TEXT, NUMBER, BOOLEAN, DATE, or LIST. It preserves the provider's current classification of this record.
* **Enables:** separate list item records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per list item property value record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `list_items.properties.additionalProperties.value`
Value captures the raw value of the property, represented as a string. Numeric, boolean, and date values are serialized as strings. It anchors the named event or boundary on the record's timeline.
* **Enables:** place list item records on a timeline by value and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `value` per list item property value record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `list_items.subsets`
Subsets contains a map of subset memberships for this list item, keyed by subset name or ID. Values indicate whether the item belongs to each subset. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact subsets value attached to each anaplan list item record.
* **Interpretation:** The provider supplies `subsets` at anaplan list item granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `list_items.subsets.additionalProperties`
Additional Properties records true if the list item belongs to the subset identified by the key, false otherwise. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select list item records for which the provider reports additional properties as true or false.
* **Interpretation:** The provider supplies `additionalProperties` as a boolean per list item subset record; false and missing are distinct when the field is optional.
Developer identifier: `list_items.workspaceId`
Workspace ID identifies parent `workspaceId` injected by the ingestor from the `model_lists` to `list_items` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match list item records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `AnaplanListItem`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_actions`
Model Actions contain all actions (delete actions, other named actions) defined within a specific model.
* **Enables:** catalog named actions available within each model.
* **Scope:** Reads the declared collection through `GET /2/0/workspaces/{workspaceId}/models/{id}/actions` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `model_actions.actionType`
Action Type states action type code returned by the Anaplan actions API (for example `DELETE_BY_SELECTION`, `ORDER_HIERARCHY`). It preserves the provider's current classification of this record.
* **Enables:** separate model action records by the exact provider-reported action type value when describing their recorded state.
* **Interpretation:** The provider supplies `actionType` per model action record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_actions.id`
ID is the unique identifier of the action within the model. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same model action source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per model action record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `model_actions.modelId`
Model ID identifies parent id injected by the ingestor from the `workspace_models` to `model_actions` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model action records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `ModelAction`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_actions.moduleId`
Module ID is the identifier of the module associated with this action, if applicable. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model action records to provider records that carry the same module ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `moduleId` as a record-level identifier on `ModelAction`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_actions.moduleName`
Module Name records name of the module associated with this action, if applicable. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact module name value attached to each model action record.
* **Interpretation:** The provider supplies `moduleName` at model action granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_actions.name`
Name records display name of the action. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each model action record.
* **Interpretation:** The provider supplies `name` at model action granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_actions.type`
Type states legacy/alternate type field when present. Live Integration API responses use `actionType`. It preserves the provider's current classification of this record.
* **Enables:** separate model action records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per model action record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_actions.workspaceId`
Workspace ID identifies parent `workspaceId` injected by the ingestor from the `workspace_models` to `model_actions` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model action records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `ModelAction`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_calendar`
Model Calendar contains the calendar/time configuration for an Anaplan model, including fiscal year settings, time ranges, and period definitions. This is a model-level metadata object but returns structured time taxonomy data.
* **Enables:** interpret model periods against the configured fiscal calendar and time ranges.
* **Scope:** Reads the declared collection through `GET /2/0/workspaces/{workspaceId}/models/{id}/modelCalendar` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `model_calendar.calendarType`
Calendar Type captures the type of calendar used by the model. It preserves the provider's current classification of this record.
* **Enables:** separate model calendar records by the exact provider-reported calendar type value when describing their recorded state.
* **Interpretation:** The provider supplies `calendarType` per model calendar record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_calendar.currentFiscalYear`
Current Fiscal Year records details about the current fiscal year. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested current fiscal year object into its declared child fields for each model calendar record.
* **Interpretation:** The provider returns `currentFiscalYear` as a nested object or reference on `ModelCalendar`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_calendar.currentFiscalYear.endDate`
End Date captures the end date of the fiscal year in ISO 8601 format. It anchors the named event or boundary on the record's timeline.
* **Enables:** place model calendar records on a timeline by end date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `endDate` per fiscal year detail record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `model_calendar.currentFiscalYear.name`
Name captures the display name of the fiscal year (e.g., 'FY24'). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each fiscal year detail record.
* **Interpretation:** The provider supplies `name` at fiscal year detail granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_calendar.currentFiscalYear.startDate`
Start Date captures the start date of the fiscal year in ISO 8601 format. It anchors the named event or boundary on the record's timeline.
* **Enables:** place model calendar records on a timeline by start date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startDate` per fiscal year detail record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `model_calendar.currentFiscalYear.year`
Year identifies the calendar year mapped to the fiscal-year definition. It anchors the provider's fiscal label to a calendar grouping.
* **Enables:** align fiscal periods with calendar-year reporting and resolve labels such as `FY24`.
* **Interpretation:** The provider supplies `year` as a calendar-year value, not a quantity or elapsed duration; missing means no calendar mapping was reported.
Developer identifier: `model_calendar.currentPeriod`
Current Period captures the current active time period in the model calendar. It preserves the provider's current classification of this record.
* **Enables:** separate model calendar records by the exact provider-reported current period value when describing their recorded state.
* **Interpretation:** The provider supplies `currentPeriod` per model calendar record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_calendar.currentPeriod.endDate`
End Date records end date of the current period in ISO 8601 format. It anchors the named event or boundary on the record's timeline.
* **Enables:** place model calendar records on a timeline by end date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `endDate` per current period record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `model_calendar.currentPeriod.id`
ID is the unique identifier of the current period. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model calendar records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `CurrentPeriod`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_calendar.currentPeriod.level`
Level captures the time level of the current period (e.g., 'Month', 'Quarter'). It preserves the provider's current classification of this record.
* **Enables:** separate model calendar records by the exact provider-reported level value when describing their recorded state.
* **Interpretation:** The provider supplies `level` per current period record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_calendar.currentPeriod.name`
Name records display name of the current period (e.g., 'Jan 24', 'Q1 FY24'). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each current period record.
* **Interpretation:** The provider supplies `name` at current period granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_calendar.currentPeriod.startDate`
Start Date records start date of the current period in ISO 8601 format. It anchors the named event or boundary on the record's timeline.
* **Enables:** place model calendar records on a timeline by start date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startDate` per current period record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `model_calendar.enabled`
Enabled indicates whether the calendar/time dimension is enabled for the model. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model calendar records for which the provider reports enabled as true or false.
* **Interpretation:** The provider supplies `enabled` as a boolean per model calendar record; false and missing are distinct when the field is optional.
Developer identifier: `model_calendar.fiscalYear`
Fiscal Year records fiscal year configuration including start month and year offset settings. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact fiscal year when validating the configuration or technical definition of a model calendar record.
* **Interpretation:** The provider supplies `fiscalYear` as configuration or technical metadata on `ModelCalendar`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_calendar.fiscalYear.fiscalYearNameBasedOnEndYear`
Fiscal Year Name Based On End Year records if true, the fiscal year is named based on the calendar year in which it ends; if false, based on the year in which it starts. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model calendar records for which the provider reports fiscal year name based on end year as true or false.
* **Interpretation:** The provider supplies `fiscalYearNameBasedOnEndYear` as a boolean per fiscal year config record; false and missing are distinct when the field is optional.
Developer identifier: `model_calendar.fiscalYear.startMonth`
Start Month captures the month in which the fiscal year begins. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested start month object into its declared child fields for each fiscal year config record.
* **Interpretation:** The provider returns `startMonth` as a nested object or reference on `FiscalYearConfig`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_calendar.fiscalYear.yearLabel`
Year Label captures the label format used for fiscal years (e.g., 'FY' prefix). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact year label value attached to each fiscal year config record.
* **Interpretation:** The provider supplies `yearLabel` at fiscal year config granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_calendar.modelId`
Model ID identifies parent id injected by the ingestor from the `workspace_models` to `model_calendar` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same model calendar source row before constructing its represented state.
* **Interpretation:** The provider supplies `modelId` at one value per model calendar record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `model_calendar.periods`
Periods records list of period definitions configured in the model calendar (e.g., months, quarters, years). It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested periods object into its declared child fields for each model calendar record.
* **Interpretation:** The provider returns `periods` as a list on `ModelCalendar`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_calendar.periods.endDate`
End Date records end date of the period in ISO 8601 format. It anchors the named event or boundary on the record's timeline.
* **Enables:** place model calendar records on a timeline by end date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `endDate` per period definition record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `model_calendar.periods.id`
ID is the unique identifier of the period.
* **Enables:** Match period definition entries on `id`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** The provider supplies `id` at one value per period definition record.
Developer identifier: `model_calendar.periods.isCurrent`
Is Current indicates whether this period is the current active period. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model calendar records for which the provider reports is current as true or false.
* **Interpretation:** The provider supplies `isCurrent` as a boolean per period definition record; false and missing are distinct when the field is optional.
Developer identifier: `model_calendar.periods.level`
Level captures the time level this period belongs to (e.g., 'Month', 'Quarter', 'Year'). It preserves the provider's current classification of this record.
* **Enables:** separate model calendar records by the exact provider-reported level value when describing their recorded state.
* **Interpretation:** The provider supplies `level` per period definition record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_calendar.periods.name`
Name records display name of the period (e.g., 'Jan 23', 'Q2 FY24', 'FY24'). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each period definition record.
* **Interpretation:** The provider supplies `name` at period definition granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_calendar.periods.order`
Order reports sort order of the period within its level. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify model calendar records using the provider-defined order value.
* **Interpretation:** The provider supplies `order` at period definition granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `model_calendar.periods.parentId`
Parent ID is the identifier of the parent period in the time hierarchy (e.g., a month's parent quarter). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model calendar records to provider records that carry the same parent ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `parentId` as a record-level identifier on `PeriodDefinition`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_calendar.periods.startDate`
Start Date records start date of the period in ISO 8601 format. It anchors the named event or boundary on the record's timeline.
* **Enables:** place model calendar records on a timeline by start date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startDate` per period definition record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `model_calendar.timeDimension`
Time Dimension captures the time dimension definition for the model. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the declared time dimension layout or dimensional scope of each model calendar record.
* **Interpretation:** The provider returns `timeDimension` as a nested object or reference on `ModelCalendar`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_calendar.timeDimension.id`
ID is the unique identifier of the time dimension. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model calendar records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `TimeDimension`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_calendar.timeDimension.name`
Name records name of the time dimension. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each time dimension record.
* **Interpretation:** The provider supplies `name` at time dimension granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_calendar.timeLevels`
Time Levels records hierarchy of time levels available in the model (e.g., Day, Week, Month, Quarter, Half Year, Year). It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by time levels on each model calendar record.
* **Interpretation:** The provider returns `timeLevels` as a list on `ModelCalendar`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_calendar.timeLevels.enabled`
Enabled indicates whether this time level is enabled in the model. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model calendar records for which the provider reports enabled as true or false.
* **Interpretation:** The provider supplies `enabled` as a boolean per time level record; false and missing are distinct when the field is optional.
Developer identifier: `model_calendar.timeLevels.id`
ID is the unique identifier of the time level.
* **Enables:** Match time level entries on `id`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** The provider supplies `id` at one value per time level record.
Developer identifier: `model_calendar.timeLevels.name`
Name records name of the time level (e.g., 'Month', 'Quarter', 'Year'). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each time level record.
* **Interpretation:** The provider supplies `name` at time level granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_calendar.timeLevels.order`
Order reports hierarchical order of the time level, with lower values being more granular. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify model calendar records using the provider-defined order value.
* **Interpretation:** The provider supplies `order` at time level granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `model_calendar.timeLevels.periodsPerYear`
Periods Per Year reports the number of periods of this level per year (e.g., 12 for months, 4 for quarters). It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported periods per year for each time level record.
* **Interpretation:** The provider supplies `periodsPerYear` at time level granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `model_calendar.timeRange`
Time Range captures the overall time range configured for the model. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested time range object into its declared child fields for each model calendar record.
* **Interpretation:** The provider returns `timeRange` as a nested object or reference on `ModelCalendar`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_calendar.timeRange.endDate`
End Date captures the end date of the model's time range in ISO 8601 format. It anchors the named event or boundary on the record's timeline.
* **Enables:** place model calendar records on a timeline by end date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `endDate` per time range record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `model_calendar.timeRange.endPeriod`
End Period captures the name or identifier of the last period in the time range. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model calendar records to provider records that carry the same end period, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `endPeriod` as a record-level identifier on `TimeRange`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_calendar.timeRange.futureYears`
Future Years reports the number of future years included in the time range relative to the current year. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported future years for each time range record.
* **Interpretation:** The provider supplies `futureYears` at time range granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `model_calendar.timeRange.numberOfYears`
Number Of Years reports the total number of years spanned by the time range. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported number of years for each time range record.
* **Interpretation:** The provider supplies `numberOfYears` at time range granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `model_calendar.timeRange.pastYears`
Past Years reports the number of past years included in the time range relative to the current year. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported past years for each time range record.
* **Interpretation:** The provider supplies `pastYears` at time range granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `model_calendar.timeRange.startDate`
Start Date captures the start date of the model's time range in ISO 8601 format. It anchors the named event or boundary on the record's timeline.
* **Enables:** place model calendar records on a timeline by start date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startDate` per time range record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `model_calendar.timeRange.startPeriod`
Start Period captures the name or identifier of the first period in the time range. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model calendar records to provider records that carry the same start period, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `startPeriod` as a record-level identifier on `TimeRange`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_calendar.workspaceId`
Workspace ID identifies parent `workspaceId` injected by the ingestor from the `workspace_models` to `model_calendar` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model calendar records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `ModelCalendar`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_calendar.yearRange`
Year Range captures the range of years covered by the model calendar. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested year range object into its declared child fields for each model calendar record.
* **Interpretation:** The provider returns `yearRange` as a nested object or reference on `ModelCalendar`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_calendar.yearRange.endYear`
End Year identifies the last calendar year included in the model's time range. It marks the closing boundary of the configured planning horizon.
* **Enables:** determine whether forecast periods required for analysis fall within the model calendar.
* **Interpretation:** The provider supplies `endYear` as a calendar-year boundary, not a count or duration; missing means the upper boundary was not reported.
Developer identifier: `model_calendar.yearRange.startYear`
Start Year identifies the first calendar year included in the model's time range. It marks the opening boundary of the configured planning horizon.
* **Enables:** determine whether historical periods required for analysis fall within the model calendar.
* **Interpretation:** The provider supplies `startYear` as a calendar-year boundary, not a count or duration; missing means the lower boundary was not reported.
Developer identifier: `model_exports`
Model Exports contain all export action definitions within a specific model. Export actions define data extractions from Anaplan modules/views.
* **Enables:** review the export actions configured to extract data from a model.
* **Scope:** Reads the declared collection through `GET /2/0/workspaces/{workspaceId}/models/{id}/exports` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `model_exports.columnCount`
Column Count reports the number of columns in the export output, if available. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported column count for each model export record.
* **Interpretation:** The provider supplies `columnCount` at model export granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `model_exports.columns`
Columns records definitions of the columns included in the export output. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the declared columns layout or dimensional scope of each model export record.
* **Interpretation:** The provider returns `columns` as a list on `ModelExport`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_exports.columns.columnIndex`
Column Index reports zero-based index position of the column in the export output. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify model export records using the provider-defined column index value.
* **Interpretation:** The provider supplies `columnIndex` at export column granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `model_exports.columns.customHeaderName`
Custom Header Name records custom header name assigned to this column, if any. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret custom header name according to the provider and Workspace configuration that produced each model export record.
* **Interpretation:** Keys and value shapes within `customHeaderName` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `model_exports.columns.dataType`
Data Type states data type of the column values, e.g., TEXT, NUMBER, BOOLEAN, DATE, LIST. It preserves the provider's current classification of this record.
* **Enables:** separate model export records by the exact provider-reported data type value when describing their recorded state.
* **Interpretation:** The provider supplies `dataType` per export column record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_exports.columns.dimensionId`
Dimension ID is the identifier of the dimension this column represents, if applicable. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model export records to provider records that carry the same dimension ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `dimensionId` as a record-level identifier on `ExportColumn`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_exports.columns.dimensionName`
Dimension Name records name of the dimension this column represents. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact dimension name value attached to each export column record.
* **Interpretation:** The provider supplies `dimensionName` at export column granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_exports.columns.lineItemId`
Line Item ID is the identifier of the line item this column represents, if applicable.
* **Enables:** Match export column entries on `lineItemId`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** The provider supplies `lineItemId` at one value per export column record.
Developer identifier: `model_exports.columns.lineItemName`
Line Item Name records name of the line item this column represents, if applicable. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact line item name value attached to each export column record.
* **Interpretation:** The provider supplies `lineItemName` at export column granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_exports.createdAt`
Created At records ISO 8601 timestamp when the export action was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place model export records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per model export record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `model_exports.createdBy`
Created By records identifier or name of the user who created the export action. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the model export record to the provider-reported person or account represented by created by.
* **Interpretation:** The provider supplies `createdBy` as identity or attribution context on each model export record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `model_exports.dataRow`
Data Row identifies the row position where exported data begins. It separates header material from the records intended for parsing.
* **Enables:** start export ingestion at the provider-declared data boundary without treating preceding rows as data.
* **Interpretation:** The provider supplies `dataRow` as a row position, not a count or business measure; zero and missing are not interchangeable.
Developer identifier: `model_exports.delimiter`
Delimiter records text qualifier/delimiter used to wrap field values, e.g., '"'. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact delimiter when validating the configuration or technical definition of a model export record.
* **Interpretation:** The provider supplies `delimiter` as configuration or technical metadata on `ModelExport`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_exports.encoding`
Encoding records character encoding used for the export output, e.g., 'UTF-8'. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact encoding when validating the configuration or technical definition of a model export record.
* **Interpretation:** The provider supplies `encoding` as configuration or technical metadata on `ModelExport`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_exports.exportFormat`
Export Format captures the output format of the exported data. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact export format when validating the configuration or technical definition of a model export record.
* **Interpretation:** The provider supplies `exportFormat` as configuration or technical metadata on `ModelExport`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_exports.exportType`
Export Type captures the type of export, indicating what kind of data source is being exported. It preserves the provider's current classification of this record.
* **Enables:** separate model export records by the exact provider-reported export type value when describing their recorded state.
* **Interpretation:** The provider supplies `exportType` per model export record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_exports.headerRow`
Header Row records row number that contains column headers in the export output. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact header row when validating the configuration or technical definition of a model export record.
* **Interpretation:** The provider supplies `headerRow` as configuration or technical metadata on `ModelExport`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_exports.id`
ID is the unique identifier for the export action definition. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same model export source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per model export record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `model_exports.lastModifiedAt`
Last Modified At records ISO 8601 timestamp when the export action was last modified. It anchors the named event or boundary on the record's timeline.
* **Enables:** place model export records on a timeline by last modified at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastModifiedAt` per model export record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `model_exports.lastModifiedBy`
Last Modified By records identifier or name of the user who last modified the export action. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the model export record to the provider-reported person or account represented by last modified by.
* **Interpretation:** The provider supplies `lastModifiedBy` as identity or attribution context on each model export record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `model_exports.layout`
Layout captures the layout type of the export, such as grid or tabular. It preserves the provider's current classification of this record.
* **Enables:** separate model export records by the exact provider-reported layout value when describing their recorded state.
* **Interpretation:** The provider supplies `layout` per model export record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_exports.lineItems`
Line Items records line item identifiers included in the export, if applicable. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the declared line items layout or dimensional scope of each model export record.
* **Interpretation:** The provider returns `lineItems` as a list on `ModelExport`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_exports.listId`
List ID is the identifier of the list being exported, if the export type is a list export. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model export records to provider records that carry the same list ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `listId` as a record-level identifier on `ModelExport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_exports.listName`
List Name states name of the list being exported, if the export type is a list export. It preserves the provider's current classification of this record.
* **Enables:** separate model export records by the exact provider-reported list name value when describing their recorded state.
* **Interpretation:** The provider supplies `listName` per model export record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_exports.modelId`
Model ID identifies parent id injected by the ingestor from the `workspace_models` to `model_exports` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model export records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `ModelExport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_exports.moduleId`
Module ID is the identifier of the source module from which data is exported. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model export records to provider records that carry the same module ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `moduleId` as a record-level identifier on `ModelExport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_exports.moduleName`
Module Name records name of the source module from which data is exported. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact module name value attached to each model export record.
* **Interpretation:** The provider supplies `moduleName` at model export granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_exports.name`
Name records display name of the export action. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each model export record.
* **Interpretation:** The provider supplies `name` at model export granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_exports.pages`
Pages records page dimension filters applied to the export, if any. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the declared pages layout or dimensional scope of each model export record.
* **Interpretation:** The provider returns `pages` as a list on `ModelExport`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_exports.pages.dimensionId`
Dimension ID is the identifier of the dimension used as a page filter. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model export records to provider records that carry the same dimension ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `dimensionId` as a record-level identifier on `ExportPage`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_exports.pages.dimensionName`
Dimension Name records name of the dimension used as a page filter. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact dimension name value attached to each export page record.
* **Interpretation:** The provider supplies `dimensionName` at export page granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_exports.pages.itemId`
Item ID is the identifier of the selected item within the page dimension.
* **Enables:** Match export page entries on `itemId`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** The provider supplies `itemId` at one value per export page record.
Developer identifier: `model_exports.pages.itemName`
Item Name records name of the selected item within the page dimension. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact item name value attached to each export page record.
* **Interpretation:** The provider supplies `itemName` at export page granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_exports.rowCount`
Row Count reports the number of rows in the export output, if available. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported row count for each model export record.
* **Interpretation:** The provider supplies `rowCount` at model export granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `model_exports.separator`
Separator records column separator/delimiter used in the export output, e.g., ',' or '\t'. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact separator when validating the configuration or technical definition of a model export record.
* **Interpretation:** The provider supplies `separator` as configuration or technical metadata on `ModelExport`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_exports.viewId`
View ID is the identifier of the saved view used for the export, if applicable. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model export records to provider records that carry the same view ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `viewId` as a record-level identifier on `ModelExport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_exports.viewName`
View Name records name of the saved view used for the export, if applicable. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact view name value attached to each model export record.
* **Interpretation:** The provider supplies `viewName` at model export granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_exports.workspaceId`
Workspace ID identifies parent `workspaceId` injected by the ingestor from the `workspace_models` to `model_exports` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model export records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `ModelExport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_files`
Model Files contain all files (data sources and export outputs) within a specific model.
* **Enables:** trace model data-source and export-output files to their parent model.
* **Scope:** Reads the declared collection through `GET /2/0/workspaces/{workspaceId}/models/{id}/files` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `model_files.chunkCount`
Chunk Count captures the number of chunks the file is divided into for upload/download. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported chunk count for each model file record.
* **Interpretation:** The provider supplies `chunkCount` at model file granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `model_files.code`
Code contains an optional code or identifier associated with the file. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact code when validating the configuration or technical definition of a model file record.
* **Interpretation:** The provider supplies `code` as configuration or technical metadata on `ModelFile`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_files.delimiter`
Delimiter captures the column delimiter used in the file (e.g., comma, tab). It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact delimiter when validating the configuration or technical definition of a model file record.
* **Interpretation:** The provider supplies `delimiter` as configuration or technical metadata on `ModelFile`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_files.description`
Description contains a human-readable description of the file. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each model file record.
* **Interpretation:** The provider supplies `description` at model file granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_files.encoding`
Encoding captures the character encoding of the file (e.g., UTF-8). It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact encoding when validating the configuration or technical definition of a model file record.
* **Interpretation:** The provider supplies `encoding` as configuration or technical metadata on `ModelFile`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_files.firstDataRow`
First Data Row identifies the zero-based row where file data begins after any headers. It preserves the parsing boundary recorded for the model file.
* **Enables:** skip header rows and begin processing at the same row position Anaplan uses.
* **Interpretation:** The provider supplies `firstDataRow` as a zero-based row index, not a row count; zero means the first row and missing means no boundary was reported.
Developer identifier: `model_files.format`
Format captures the format of the file content (e.g., txt, csv). It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact format when validating the configuration or technical definition of a model file record.
* **Interpretation:** The provider supplies `format` as configuration or technical metadata on `ModelFile`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_files.headerRow`
Header Row captures the row number that contains column headers (0-indexed). It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact header row when validating the configuration or technical definition of a model file record.
* **Interpretation:** The provider supplies `headerRow` as configuration or technical metadata on `ModelFile`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_files.id`
ID captures the unique identifier of the file within the model. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same model file source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per model file record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `model_files.modelId`
Model ID identifies parent model id injected by the ingestor when iterating per-model. Not part of the upstream Anaplan API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model file records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `ModelFile`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_files.name`
Name captures the display name of the file. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each model file record.
* **Interpretation:** The provider supplies `name` at model file granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_files.origin`
Origin carries the provider-reported origin for each model file record. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested origin object into its declared child fields for each model file record.
* **Interpretation:** The provider returns `origin` as a nested object or reference on `ModelFile`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_files.origin.actionName`
Action Name captures the name of the action (import or export) that produced or consumes this file. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact action name value attached to each file origin record.
* **Interpretation:** The provider supplies `actionName` at file origin granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_files.origin.exportId`
Export ID captures the identifier of the export action associated with this file, if applicable. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model file records to provider records that carry the same export ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `exportId` as a record-level identifier on `FileOrigin`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_files.origin.importId`
Import ID captures the identifier of the import action associated with this file, if applicable. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model file records to provider records that carry the same import ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `importId` as a record-level identifier on `FileOrigin`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_files.origin.type`
Type carries the source state or classification named Type for each file origin row. It preserves the provider's current classification of this record.
* **Enables:** separate model file records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per file origin record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_files.separator`
Separator captures the separator character used in the file, such as a line separator or record delimiter. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact separator when validating the configuration or technical definition of a model file record.
* **Interpretation:** The provider supplies `separator` as configuration or technical metadata on `ModelFile`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_files.workspaceId`
Workspace ID identifies parent workspace id injected by the ingestor when iterating per-workspace. Not part of the upstream Anaplan API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model file records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `ModelFile`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_imports`
Model Imports contain all import action definitions within a specific model. Import actions define data loading configurations into Anaplan.
* **Enables:** review the import actions configured to load data into a model.
* **Scope:** Reads the declared collection through `GET /2/0/workspaces/{workspaceId}/models/{id}/imports` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `model_imports.code`
Code records optional user-defined code for the import action. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret code according to the provider and Workspace configuration that produced each model import record.
* **Interpretation:** Keys and value shapes within `code` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `model_imports.columnMappings`
Column Mappings lists the relationships from source columns to target dimensions or line items. It preserves the import mapping needed to explain where each input value lands.
* **Enables:** reconstruct and audit source-to-target assignments for each model import.
* **Interpretation:** The provider supplies `columnMappings` as a list of mapping objects; an empty list and a missing mapping declaration are distinct.
Developer identifier: `model_imports.columnMappings.columnIndex`
Column Index reports zero-based index of the source column. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify model import records using the provider-defined column index value.
* **Interpretation:** The provider supplies `columnIndex` at column mapping granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `model_imports.columnMappings.columnName`
Column Name identifies name of the source column being mapped. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same column mapping source row before constructing its represented state.
* **Interpretation:** The provider supplies `columnName` at one value per column mapping record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `model_imports.columnMappings.dateFormat`
Date Format records the date format pattern applied when the column contains date values. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact date format when validating the configuration or technical definition of a column mapping record.
* **Interpretation:** The provider supplies `dateFormat` as configuration or technical metadata on `ColumnMapping`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_imports.columnMappings.ignored`
Ignored indicates whether this source column is ignored and not mapped to any target. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model import records for which the provider reports ignored as true or false.
* **Interpretation:** The provider supplies `ignored` as a boolean per column mapping record; false and missing are distinct when the field is optional.
Developer identifier: `model_imports.columnMappings.mappingType`
Mapping Type captures the type of mapping applied to this column. It preserves the provider's current classification of this record.
* **Enables:** separate model import records by the exact provider-reported mapping type value when describing their recorded state.
* **Interpretation:** The provider supplies `mappingType` per column mapping record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_imports.columnMappings.targetDimensionId`
Target Dimension ID is the identifier of the target dimension this column maps to. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model import records to provider records that carry the same target dimension ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `targetDimensionId` as a record-level identifier on `ColumnMapping`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_imports.columnMappings.targetDimensionName`
Target Dimension Name records name of the target dimension this column maps to. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact target dimension name value attached to each column mapping record.
* **Interpretation:** The provider supplies `targetDimensionName` at column mapping granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_imports.columnMappings.targetLineItemId`
Target Line Item ID is the identifier of the target line item this column maps to. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model import records to provider records that carry the same target line item ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `targetLineItemId` as a record-level identifier on `ColumnMapping`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_imports.columnMappings.targetLineItemName`
Target Line Item Name records name of the target line item this column maps to. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact target line item name value attached to each column mapping record.
* **Interpretation:** The provider supplies `targetLineItemName` at column mapping granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_imports.columnMappings.targetPropertyName`
Target Property Name records name of the target property (for list imports) this column maps to. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact target property name value attached to each column mapping record.
* **Interpretation:** The provider supplies `targetPropertyName` at column mapping granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_imports.delimiter`
Delimiter captures the delimiter character used in the source file (e.g., comma, tab). It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact delimiter when validating the configuration or technical definition of a model import record.
* **Interpretation:** The provider supplies `delimiter` as configuration or technical metadata on `ModelImport`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_imports.encoding`
Encoding records character encoding of the source file (e.g., UTF-8). It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact encoding when validating the configuration or technical definition of a model import record.
* **Interpretation:** The provider supplies `encoding` as configuration or technical metadata on `ModelImport`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_imports.firstDataRow`
First Data Row identifies the source-file row where import data begins. It separates headers and preamble rows from the imported records.
* **Enables:** reproduce the import boundary and diagnose row-alignment errors in source files.
* **Interpretation:** The provider supplies `firstDataRow` as a row position, not a row count or business measure; zero and missing are not interchangeable.
Developer identifier: `model_imports.headerRow`
Header Row captures the row number in the source file that contains column headers. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact header row when validating the configuration or technical definition of a model import record.
* **Interpretation:** The provider supplies `headerRow` as configuration or technical metadata on `ModelImport`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_imports.id`
ID is the unique identifier of the import action. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same model import source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per model import record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `model_imports.importDataSourceId`
Import Data Source ID is the identifier of the data source (file or list) used by this import action. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model import records to provider records that carry the same import data source ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `importDataSourceId` as a record-level identifier on `ModelImport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_imports.importDataSourceName`
Import Data Source Name records name of the data source used by this import action. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact import data source name value attached to each model import record.
* **Interpretation:** The provider supplies `importDataSourceName` at model import granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_imports.importDataSourceType`
Import Data Source Type captures the type of data source feeding this import (e.g., file, list, module). It preserves the provider's current classification of this record.
* **Enables:** separate model import records by the exact provider-reported import data source type value when describing their recorded state.
* **Interpretation:** The provider supplies `importDataSourceType` per model import record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_imports.importType`
Import Type captures the type of import, indicating the target structure (e.g., module data, list items, or users). It preserves the provider's current classification of this record.
* **Enables:** separate model import records by the exact provider-reported import type value when describing their recorded state.
* **Interpretation:** The provider supplies `importType` per model import record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_imports.modelId`
Model ID identifies parent model id injected by the ingestor when iterating per-model. Not part of the upstream Anaplan API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model import records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `ModelImport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_imports.name`
Name records display name of the import action. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each model import record.
* **Interpretation:** The provider supplies `name` at model import granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_imports.separator`
Separator captures the text qualifier or separator used in the source file. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact separator when validating the configuration or technical definition of a model import record.
* **Interpretation:** The provider supplies `separator` as configuration or technical metadata on `ModelImport`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_imports.sourceFileId`
Source File ID is the identifier of the source file used by this import action. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model import records to provider records that carry the same source file ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `sourceFileId` as a record-level identifier on `ModelImport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_imports.sourceFileName`
Source File Name records name of the source file used by this import action. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact source file name value attached to each model import record.
* **Interpretation:** The provider supplies `sourceFileName` at model import granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_imports.sourceListId`
Source List ID is the identifier of the source list when importing from a list. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model import records to provider records that carry the same source list ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `sourceListId` as a record-level identifier on `ModelImport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_imports.sourceListName`
Source List Name records name of the source list when importing from a list. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact source list name value attached to each model import record.
* **Interpretation:** The provider supplies `sourceListName` at model import granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_imports.sourceModelId`
Source Model ID is the identifier of the source model if the import pulls data from another Anaplan model. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model import records to provider records that carry the same source model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `sourceModelId` as a record-level identifier on `ModelImport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_imports.sourceModelName`
Source Model Name records name of the source model if the import pulls data from another Anaplan model. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact source model name value attached to each model import record.
* **Interpretation:** The provider supplies `sourceModelName` at model import granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_imports.sourceModuleId`
Source Module ID is the identifier of the source module when importing from a module view. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model import records to provider records that carry the same source module ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `sourceModuleId` as a record-level identifier on `ModelImport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_imports.sourceModuleName`
Source Module Name records name of the source module when importing from a module view. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact source module name value attached to each model import record.
* **Interpretation:** The provider supplies `sourceModuleName` at model import granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_imports.sourceViewId`
Source View ID is the identifier of the source view when importing from a module view. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model import records to provider records that carry the same source view ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `sourceViewId` as a record-level identifier on `ModelImport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_imports.sourceViewName`
Source View Name records name of the source view when importing from a module view. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact source view name value attached to each model import record.
* **Interpretation:** The provider supplies `sourceViewName` at model import granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_imports.targetListId`
Target List ID is the identifier of the target list when the import loads list items. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model import records to provider records that carry the same target list ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `targetListId` as a record-level identifier on `ModelImport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_imports.targetListName`
Target List Name records name of the target list when the import loads list items. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact target list name value attached to each model import record.
* **Interpretation:** The provider supplies `targetListName` at model import granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_imports.targetModuleId`
Target Module ID is the identifier of the target module when the import loads module data. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model import records to provider records that carry the same target module ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `targetModuleId` as a record-level identifier on `ModelImport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_imports.targetModuleName`
Target Module Name records name of the target module when the import loads module data. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact target module name value attached to each model import record.
* **Interpretation:** The provider supplies `targetModuleName` at model import granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_imports.workspaceId`
Workspace ID identifies parent workspace id injected by the ingestor when iterating per-workspace. Not part of the upstream Anaplan API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model import records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `ModelImport`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_line_items`
Model Line Items contain all line items defined within a specific model. Line items are the individual data elements (metrics/measures) in Anaplan modules.
* **Enables:** inventory the measures defined by line items within each planning model.
* **Scope:** Reads the declared collection through `GET /2/0/workspaces/{workspaceId}/models/{id}/lineItems` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `model_line_items.appliesTo`
Applies To lists the dimensions and entities related to the line item. It preserves the relationships that determine where the line item's values exist.
* **Enables:** reconstruct line-item dimensionality and join each line item to its applicable lists or entities.
* **Interpretation:** The provider supplies `appliesTo` as a list of dimension references; an empty list and a missing relationship list are distinct.
Developer identifier: `model_line_items.appliesTo.id`
ID is the unique identifier of the dimension. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same dimension reference source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per dimension reference record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `model_line_items.appliesTo.name`
Name records name of the dimension. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each dimension reference record.
* **Interpretation:** The provider supplies `name` at dimension reference granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_line_items.breakback`
Breakback indicates whether breakback (spread) is enabled for this line item. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model line item records for which the provider reports breakback as true or false.
* **Interpretation:** The provider supplies `breakback` as a boolean per model line item record; false and missing are distinct when the field is optional.
Developer identifier: `model_line_items.broughtForward`
Brought Forward indicates whether the line item uses brought-forward (opening balance) time functionality. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model line item records for which the provider reports brought forward as true or false.
* **Interpretation:** The provider supplies `broughtForward` as a boolean per model line item record; false and missing are distinct when the field is optional.
Developer identifier: `model_line_items.cellCount`
Cell Count captures the total number of cells occupied by this line item across all dimensions. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported cell count for each model line item record.
* **Interpretation:** The provider supplies `cellCount` at model line item granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `model_line_items.code`
Code records optional code assigned to the line item for external reference or integration purposes. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact code when validating the configuration or technical definition of a model line item record.
* **Interpretation:** The provider supplies `code` as configuration or technical metadata on `ModelLineItem`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_line_items.dataTags`
Data Tags records data tags associated with this line item for classification or governance. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** apply the provider-defined data tags classifications to each model line item record.
* **Interpretation:** The provider returns `dataTags` as a list on `ModelLineItem`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_line_items.format`
Format captures the data format/type of the line item (e.g., NUMBER, TEXT, BOOLEAN, DATE, `TIME_ENTITY`, LIST). It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact format when validating the configuration or technical definition of a model line item record.
* **Interpretation:** The provider supplies `format` as configuration or technical metadata on `ModelLineItem`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_line_items.formatMetadata`
Format Metadata records additional metadata about the line item's format, such as associated list or entity details. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact format metadata when validating the configuration or technical definition of a model line item record.
* **Interpretation:** The provider supplies `formatMetadata` as configuration or technical metadata on `ModelLineItem`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_line_items.formatMetadata.dateFormat`
Date Format records the date format pattern for DATE-format line items. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact date format when validating the configuration or technical definition of a format metadata record.
* **Interpretation:** The provider supplies `dateFormat` as configuration or technical metadata on `FormatMetadata`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_line_items.formatMetadata.decimalPlaces`
Decimal Places defines how many digits appear after the decimal point for a NUMBER-format line item. It preserves the provider's numeric display precision.
* **Enables:** reproduce line-item formatting and interpret stored values with the intended decimal precision.
* **Interpretation:** The provider supplies `decimalPlaces` as a formatting count, not an observed business value; zero and missing are not interchangeable.
Developer identifier: `model_line_items.formatMetadata.decimalSeparator`
Decimal Separator records decimal separator character. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact decimal separator when validating the configuration or technical definition of a format metadata record.
* **Interpretation:** The provider supplies `decimalSeparator` as configuration or technical metadata on `FormatMetadata`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_line_items.formatMetadata.groupingSeparator`
Grouping Separator records thousands grouping separator character. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact grouping separator when validating the configuration or technical definition of a format metadata record.
* **Interpretation:** The provider supplies `groupingSeparator` as configuration or technical metadata on `FormatMetadata`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_line_items.formatMetadata.listId`
List ID is the identifier of the associated list, if the line item format is LIST. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model line item records to provider records that carry the same list ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `listId` as a record-level identifier on `FormatMetadata`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_line_items.formatMetadata.listName`
List Name records name of the associated list, if the line item format is LIST. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact list name value attached to each format metadata record.
* **Interpretation:** The provider supplies `listName` at format metadata granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_line_items.formatMetadata.minimumSignificantDigits`
Minimum Significant Digits defines the minimum displayed precision for NUMBER-format line items. It preserves the formatting rule used with decimal places.
* **Enables:** reproduce numeric presentation and distinguish formatting precision from the line item's value.
* **Interpretation:** The provider supplies `minimumSignificantDigits` as a digit-count setting, not an observed business measure; zero and missing are not interchangeable.
Developer identifier: `model_line_items.formatMetadata.negativeNumberNotation`
Negative Number Notation records notation style for negative numbers (e.g., minus sign, parentheses). It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact negative number notation when validating the configuration or technical definition of a format metadata record.
* **Interpretation:** The provider supplies `negativeNumberNotation` as configuration or technical metadata on `FormatMetadata`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_line_items.formatMetadata.zeroFormat`
Zero Format records how zero values are displayed. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact zero format when validating the configuration or technical definition of a format metadata record.
* **Interpretation:** The provider supplies `zeroFormat` as configuration or technical metadata on `FormatMetadata`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_line_items.formula`
Formula captures the formula expression defined for this line item, if any. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact formula when validating the configuration or technical definition of a model line item record.
* **Interpretation:** The provider supplies `formula` as configuration or technical metadata on `ModelLineItem`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_line_items.formulaScope`
Formula Scope captures the scope of the formula, indicating where the formula applies. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact formula scope when validating the configuration or technical definition of a model line item record.
* **Interpretation:** The provider supplies `formulaScope` as configuration or technical metadata on `ModelLineItem`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_line_items.id`
ID is the unique identifier of the line item within the model. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same model line item source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per model line item record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `model_line_items.isSummary`
Is Summary indicates whether this line item is a summary line item. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model line item records for which the provider reports is summary as true or false.
* **Interpretation:** The provider supplies `isSummary` as a boolean per model line item record; false and missing are distinct when the field is optional.
Developer identifier: `model_line_items.modelId`
Model ID identifies parent id injected by the ingestor from the `workspace_models` to `model_line_items` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model line item records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `ModelLineItem`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_line_items.moduleId`
Module ID is the identifier of the module that contains this line item. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model line item records to provider records that carry the same module ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `moduleId` as a record-level identifier on `ModelLineItem`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_line_items.moduleName`
Module Name records name of the module that contains this line item. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact module name value attached to each model line item record.
* **Interpretation:** The provider supplies `moduleName` at model line item granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_line_items.name`
Name records display name of the line item. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each model line item record.
* **Interpretation:** The provider supplies `name` at model line item granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_line_items.notes`
Notes records user-defined notes or description for the line item. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret notes according to the provider and Workspace configuration that produced each model line item record.
* **Interpretation:** Keys and value shapes within `notes` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `model_line_items.parent`
Parent records parent line item reference when nested. Live API returns `{id, name}`; absent or null when the line item has no parent. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact parent value attached to each model line item record.
* **Interpretation:** The provider supplies `parent` at model line item granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_line_items.parent.id`
ID is the identifier of the parent line item. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same line item parent source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per line item parent record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `model_line_items.parent.name`
Name records display name of the parent line item. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each line item parent record.
* **Interpretation:** The provider supplies `name` at line item parent granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_line_items.parentName`
Parent Name records name of the parent line item, if this line item is nested. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact parent name value attached to each model line item record.
* **Interpretation:** The provider supplies `parentName` at model line item granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_line_items.readAccessDriver`
Read Access Driver captures the access driver controlling read permissions for this line item. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported read access driver attached to each model line item record.
* **Interpretation:** The provider supplies `readAccessDriver` at model line item granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `model_line_items.referencedBy`
Referenced By records list of line items or formulas that reference this line item. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the declared referenced by layout or dimensional scope of each model line item record.
* **Interpretation:** The provider returns `referencedBy` as a list on `ModelLineItem`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_line_items.startOfSection`
Start Of Section indicates whether this line item marks the start of a section in the module. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model line item records for which the provider reports start of section as true or false.
* **Interpretation:** The provider supplies `startOfSection` as a boolean per model line item record; false and missing are distinct when the field is optional.
Developer identifier: `model_line_items.style`
Style records display style or formatting hint for the line item. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied style for the represented design or board object.
* **Interpretation:** The provider supplies `style` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `model_line_items.summary`
Summary captures the summary (aggregation) method applied to the line item. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact summary value attached to each model line item record.
* **Interpretation:** The provider supplies `summary` at model line item granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_line_items.timeRange`
Time Range records time range label for the line item as returned by the API (for example Model Calendar, 2016 - 2026). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact time range value attached to each model line item record.
* **Interpretation:** The provider supplies `timeRange` at model line item granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_line_items.timeScale`
Time Scale captures the time scale granularity for the line item (e.g., Month, Quarter, Year). It preserves the provider-defined period or schedule cadence for this record.
* **Enables:** group model line item records by the provider-defined time scale period or schedule.
* **Interpretation:** The provider supplies `timeScale` per model line item record using its own period or schedule vocabulary; it is not an elapsed-duration measurement.
Developer identifier: `model_line_items.useSwitchover`
Use Switchover indicates whether the line item uses switchover for actual vs. forecast data. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model line item records for which the provider reports use switchover as true or false.
* **Interpretation:** The provider supplies `useSwitchover` as a boolean per model line item record; false and missing are distinct when the field is optional.
Developer identifier: `model_line_items.version`
Version records version settings for the line item, if applicable. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact version when validating the configuration or technical definition of a model line item record.
* **Interpretation:** The provider supplies `version` as configuration or technical metadata on `ModelLineItem`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `model_line_items.version.id`
ID is the identifier of the version. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model line item records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `VersionReference`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_line_items.version.name`
Name records name of the version. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each version reference record.
* **Interpretation:** The provider supplies `name` at version reference granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_line_items.workspaceId`
Workspace ID identifies parent `workspaceId` injected by the ingestor from the `workspace_models` to `model_line_items` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model line item records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `ModelLineItem`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_line_items.writeAccessDriver`
Write Access Driver captures the access driver controlling write permissions for this line item. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported write access driver attached to each model line item record.
* **Interpretation:** The provider supplies `writeAccessDriver` at model line item granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `model_lists`
Model Lists contain all lists (dimensions/hierarchies) defined within a specific model. Lists are core structural elements in Anaplan.
* **Enables:** map the lists that define dimensions and hierarchies in each planning model.
* **Scope:** Reads the declared collection through `GET /2/0/workspaces/{workspaceId}/models/{id}/lists` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `model_lists.category`
Category captures the category classification of the list. It preserves the provider's current classification of this record.
* **Enables:** separate model list records by the exact provider-reported category value when describing their recorded state.
* **Interpretation:** The provider supplies `category` per anaplan model list record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_lists.hasSelectiveAccess`
Has Selective Access indicates whether selective access is enabled for this list, restricting which items users can see. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported has selective access attached to each anaplan model list record.
* **Interpretation:** The provider supplies `hasSelectiveAccess` at anaplan model list granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `model_lists.id`
ID captures the unique identifier of the list within the model. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same anaplan model list source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per anaplan model list record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `model_lists.itemCount`
Item Count captures the total number of items currently in the list. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported item count for each anaplan model list record.
* **Interpretation:** The provider supplies `itemCount` at anaplan model list granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `model_lists.managedBy`
Managed By states indicates how the list is managed, e.g., by the system or a specific process. It preserves the provider's current classification of this record.
* **Enables:** separate model list records by the exact provider-reported managed by value when describing their recorded state.
* **Interpretation:** The provider supplies `managedBy` per anaplan model list record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_lists.modelId`
Model ID identifies parent id injected by the ingestor from the `workspace_models` to `model_lists` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model list records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `AnaplanModelList`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_lists.name`
Name captures the display name of the list. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each anaplan model list record.
* **Interpretation:** The provider supplies `name` at anaplan model list granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_lists.nextItemIndex`
Next Item Index captures the next available item index for numbered lists. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify model list records using the provider-defined next item index value.
* **Interpretation:** The provider supplies `nextItemIndex` at anaplan model list granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `model_lists.numberedList`
Numbered List indicates whether this list is a numbered list, where items are auto-numbered by Anaplan. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model list records for which the provider reports numbered list as true or false.
* **Interpretation:** The provider supplies `numberedList` as a boolean per anaplan model list record; false and missing are distinct when the field is optional.
Developer identifier: `model_lists.parent`
Parent records reference to the parent list if this list is part of a hierarchy. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by parent on each anaplan model list record.
* **Interpretation:** The provider returns `parent` as a nested object or reference on `AnaplanModelList`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_lists.parent.id`
ID captures the unique identifier of the referenced list. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model list records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ListReference`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_lists.parent.name`
Name captures the display name of the referenced list. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each list reference record.
* **Interpretation:** The provider supplies `name` at list reference granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_lists.permittedItems`
Permitted Items captures the maximum number of items permitted in the list. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported permitted items for each anaplan model list record.
* **Interpretation:** The provider supplies `permittedItems` at anaplan model list granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `model_lists.productionData`
Production Data indicates whether this list contains production data (relevant for ALM/revision management). It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model list records for which the provider reports production data as true or false.
* **Interpretation:** The provider supplies `productionData` as a boolean per anaplan model list record; false and missing are distinct when the field is optional.
Developer identifier: `model_lists.propertiesCount`
Properties Count captures the number of properties (custom columns) defined on this list. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret properties count according to the provider and Workspace configuration that produced each model list record.
* **Interpretation:** Keys and value shapes within `propertiesCount` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `model_lists.selectiveAccessByDefault`
Selective Access By Default indicates whether selective access is applied by default for new users. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported selective access by default attached to each anaplan model list record.
* **Interpretation:** The provider supplies `selectiveAccessByDefault` at anaplan model list granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `model_lists.subsetCount`
Subset Count captures the number of subsets defined for this list. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported subset count for each anaplan model list record.
* **Interpretation:** The provider supplies `subsetCount` at anaplan model list granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `model_lists.topLevelItem`
Top Level Item states reference to the top-level item in the list hierarchy. It preserves the provider's current classification of this record.
* **Enables:** separate model list records by the exact provider-reported top level item value when describing their recorded state.
* **Interpretation:** The provider supplies `topLevelItem` per anaplan model list record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_lists.topLevelItem.id`
ID captures the unique identifier of the list item. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model list records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ListItemReference`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_lists.topLevelItem.name`
Name captures the display name of the list item. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each list item reference record.
* **Interpretation:** The provider supplies `name` at list item reference granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_lists.usedInAppliesTo`
Used In Applies To indicates whether this list is used in an applies-to context for line items or modules. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model list records for which the provider reports used in applies to as true or false.
* **Interpretation:** The provider supplies `usedInAppliesTo` as a boolean per anaplan model list record; false and missing are distinct when the field is optional.
Developer identifier: `model_lists.useTopLevelAsPageDefault`
Use Top Level As Page Default indicates whether the top-level item of the list is used as the default page selection. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model list records for which the provider reports use top level as page default as true or false.
* **Interpretation:** The provider supplies `useTopLevelAsPageDefault` as a boolean per anaplan model list record; false and missing are distinct when the field is optional.
Developer identifier: `model_lists.workflowEnabled`
Workflow Enabled indicates whether workflow is enabled for this list. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model list records for which the provider reports workflow enabled as true or false.
* **Interpretation:** The provider supplies `workflowEnabled` as a boolean per anaplan model list record; false and missing are distinct when the field is optional.
Developer identifier: `model_lists.workspaceId`
Workspace ID identifies parent `workspaceId` injected by the ingestor from the `workspace_models` to `model_lists` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model list records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `AnaplanModelList`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_modules`
Model Modules contain all modules defined within a specific model. Modules are the primary data containers in Anaplan holding line items and views.
* **Enables:** map the modules that hold line items and views within a model.
* **Scope:** Reads the declared collection through `GET /2/0/workspaces/{workspaceId}/models/{id}/modules` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `model_modules.allVersions`
All Versions indicates whether the module applies across all versions. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model module records for which the provider reports all versions as true or false.
* **Interpretation:** The provider supplies `allVersions` as a boolean per anaplan module record; false and missing are distinct when the field is optional.
Developer identifier: `model_modules.cellCount`
Cell Count reports the number of data cells in the module. It expresses structural scale independently of the module's byte footprint.
* **Enables:** compare module complexity and relate cell volume to memory usage.
* **Interpretation:** The provider supplies `cellCount` as an integer count per module; zero and missing are not interchangeable.
Developer identifier: `model_modules.code`
Code contains an optional user-defined code for the module, used for external integrations and programmatic references. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret code according to the provider and Workspace configuration that produced each model module record.
* **Interpretation:** Keys and value shapes within `code` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `model_modules.currentVersion`
Current Version indicates whether the module applies to the current version of the model. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model module records for which the provider reports current version as true or false.
* **Interpretation:** The provider supplies `currentVersion` as a boolean per anaplan module record; false and missing are distinct when the field is optional.
Developer identifier: `model_modules.dimensions`
Dimensions lists the list and time relationships that define the module's structure. It preserves the axes needed to interpret the module's cells.
* **Enables:** reconstruct module dimensionality and identify which lists or time groupings shape its data.
* **Interpretation:** The provider supplies `dimensions` as a list of dimension references; an empty list and a missing relationship list are distinct.
Developer identifier: `model_modules.dimensions.id`
ID captures the unique identifier of the dimension. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same module dimension source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per module dimension record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `model_modules.dimensions.itemCount`
Item Count captures the number of items in this dimension. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported item count for each module dimension record.
* **Interpretation:** The provider supplies `itemCount` at module dimension granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `model_modules.dimensions.name`
Name captures the display name of the dimension. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each module dimension record.
* **Interpretation:** The provider supplies `name` at module dimension granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_modules.dimensions.type`
Type captures the type of the dimension, such as list, time, or version. It preserves the provider's current classification of this record.
* **Enables:** separate model module records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per module dimension record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_modules.editable`
Editable indicates whether the module data is editable by users. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model module records for which the provider reports editable as true or false.
* **Interpretation:** The provider supplies `editable` as a boolean per anaplan module record; false and missing are distinct when the field is optional.
Developer identifier: `model_modules.id`
ID captures the unique identifier of the module within the model. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same anaplan module source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per anaplan module record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `model_modules.isNumberedList`
Is Numbered List indicates whether the module is backed by a numbered list. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model module records for which the provider reports is numbered list as true or false.
* **Interpretation:** The provider supplies `isNumberedList` as a boolean per anaplan module record; false and missing are distinct when the field is optional.
Developer identifier: `model_modules.isSwitchover`
Is Switchover indicates whether the module uses switchover versioning. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model module records for which the provider reports is switchover as true or false.
* **Interpretation:** The provider supplies `isSwitchover` as a boolean per anaplan module record; false and missing are distinct when the field is optional.
Developer identifier: `model_modules.lineItemCount`
Line Item Count captures the number of line items defined within this module. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported line item count for each anaplan module record.
* **Interpretation:** The provider supplies `lineItemCount` at anaplan module granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `model_modules.memoryUsage`
Memory Usage reports the bytes consumed by the module. It provides the module-level footprint within its model.
* **Enables:** identify memory-heavy modules and compare their contribution to model capacity.
* **Interpretation:** The provider supplies `memoryUsage` as an integer byte value per module; zero and missing are not interchangeable.
Developer identifier: `model_modules.modelId`
Model ID identifies parent id injected by the ingestor from the `workspace_models` to `model_modules` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model module records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `AnaplanModule`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_modules.moduleCategory`
Module Category captures the category grouping this module belongs to, if any. It preserves the provider's current classification of this record.
* **Enables:** separate model module records by the exact provider-reported module category value when describing their recorded state.
* **Interpretation:** The provider supplies `moduleCategory` per anaplan module record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_modules.moduleCategory.id`
ID captures the unique identifier of the module category. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model module records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ModuleCategory`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_modules.moduleCategory.name`
Name captures the display name of the module category. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each module category record.
* **Interpretation:** The provider supplies `name` at module category granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_modules.name`
Name captures the display name of the module. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each anaplan module record.
* **Interpretation:** The provider supplies `name` at anaplan module granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_modules.startOfSection`
Start Of Section indicates whether this module marks the start of a new section in the model contents. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model module records for which the provider reports start of section as true or false.
* **Interpretation:** The provider supplies `startOfSection` as a boolean per anaplan module record; false and missing are distinct when the field is optional.
Developer identifier: `model_modules.usesLineItems`
Uses Line Items indicates whether the module contains line items. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model module records for which the provider reports uses line items as true or false.
* **Interpretation:** The provider supplies `usesLineItems` as a boolean per anaplan module record; false and missing are distinct when the field is optional.
Developer identifier: `model_modules.viewCount`
View Count captures the number of saved views defined within this module. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported view count for each anaplan module record.
* **Interpretation:** The provider supplies `viewCount` at anaplan module granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `model_modules.visible`
Visible indicates whether the module is visible to end users in the Anaplan UI. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model module records for which the provider reports visible as true or false.
* **Interpretation:** The provider supplies `visible` as a boolean per anaplan module record; false and missing are distinct when the field is optional.
Developer identifier: `model_modules.workspaceId`
Workspace ID identifies parent `workspaceId` injected by the ingestor from the `workspace_models` to `model_modules` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model module records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `AnaplanModule`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_versions`
Model Versions contain version information (revision tags) for Anaplan models via the ALM API. Tracks model versioning history including who created each version and when, supporting change management and activity tracking.
* **Enables:** trace ALM revision tags to the creator and creation time recorded by Anaplan.
* **Scope:** Reads the declared collection through `GET /2/0/models/{id}/alm/revisions` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `model_versions.appliedAt`
Applied At records ISO 8601 timestamp indicating when the revision tag was last applied. It anchors the named event or boundary on the record's timeline.
* **Enables:** place model version records on a timeline by applied at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `appliedAt` per model version record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `model_versions.appliedBy`
Applied By captures the user who last applied or deployed this revision tag. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the model version record to the provider-reported person or account represented by applied by.
* **Interpretation:** The provider supplies `appliedBy` as identity or attribution context on each model version record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `model_versions.appliedBy.email`
Email records email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user summary record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each user summary record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `model_versions.appliedBy.id`
ID is the unique identifier of the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model version records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `UserSummary`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_versions.appliedBy.name`
Name records display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user summary record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each user summary record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `model_versions.createdAt`
Created At records ISO 8601 timestamp indicating when the revision tag was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place model version records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per model version record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `model_versions.createdBy`
Created By captures the user who created this revision tag. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the model version record to the provider-reported person or account represented by created by.
* **Interpretation:** The provider supplies `createdBy` as identity or attribution context on each model version record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `model_versions.deleted`
Deleted indicates whether the revision tag has been soft-deleted. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select model version records for which the provider reports deleted as true or false.
* **Interpretation:** The provider supplies `deleted` as a boolean per model version record; false and missing are distinct when the field is optional.
Developer identifier: `model_versions.description`
Description records optional description or notes for the revision tag. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each model version record.
* **Interpretation:** The provider supplies `description` at model version granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_versions.id`
ID is the unique identifier of the revision tag. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same model version source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per model version record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `model_versions.modelId`
Model ID identifies parent model id injected by the ingestor when iterating per-model. Not part of the upstream Anaplan API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model version records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `ModelVersion`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_versions.name`
Name records name or label assigned to the revision tag. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each model version record.
* **Interpretation:** The provider supplies `name` at model version granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `model_versions.revisionId`
Revision ID captures the internal revision identifier associated with this tag. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model version records to provider records that carry the same revision ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `revisionId` as a record-level identifier on `ModelVersion`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `model_versions.revisionNumber`
Revision Number identifies the provider-assigned sequence position of a model revision. It keeps version history snapshots correlated to the revision that produced them.
* **Enables:** order revisions within one model and detect changed or skipped versions between captured snapshots.
* **Interpretation:** The provider supplies `revisionNumber` as a model-scoped revision sequence, not a comparable business measure; equal numbers are meaningful only within the same model history.
Developer identifier: `model_versions.syncState`
Sync State captures the synchronization state of the revision relative to the source model. It preserves the provider's current classification of this record.
* **Enables:** separate model version records by the exact provider-reported sync state value when describing their recorded state.
* **Interpretation:** The provider supplies `syncState` per model version record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `model_versions.tags`
Tags records optional list of tags or labels associated with this revision. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** apply the provider-defined tags classifications to each model version record.
* **Interpretation:** The provider returns `tags` as a list on `ModelVersion`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `model_versions.workspaceId`
Workspace ID identifies parent workspace id injected by the ingestor when iterating per-workspace. Not part of the upstream Anaplan API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model version records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `ModelVersion`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `models`
Models contain all models across all workspaces accessible to the authenticated user, with optional detailed memory usage information.
* **Enables:** compare the planning models visible across workspaces and account for their reported memory footprint.
* **Scope:** Reads the declared collection through `GET /2/0/models` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `models.activeState`
Active State states current active state of the model (e.g., ACTIVE, ARCHIVED). It preserves the provider's current classification of this record.
* **Enables:** separate model records by the exact provider-reported active state value when describing their recorded state.
* **Interpretation:** The provider supplies `activeState` per anaplan model record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `models.categoryValues`
Category Values states category/tag values associated with the model. Each entry is a category-value object returned by the Anaplan model API. It preserves the provider's current classification of this record.
* **Enables:** separate model records by the exact provider-reported category values value when describing their recorded state.
* **Interpretation:** The provider supplies `categoryValues` per anaplan model record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `models.currentWorkspaceId`
Current Workspace ID is the identifier of the workspace that currently contains this model. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model records to provider records that carry the same current workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `currentWorkspaceId` as a record-level identifier on `AnaplanModel`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `models.currentWorkspaceName`
Current Workspace Name records display name of the workspace that currently contains this model. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact current workspace name value attached to each anaplan model record.
* **Interpretation:** The provider supplies `currentWorkspaceName` at anaplan model granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `models.id`
ID is the unique identifier (GUID) of the model. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same anaplan model source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per anaplan model record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `models.isoCreationDate`
Iso Creation Date records ISO 8601 timestamp of when the model was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place model records on a timeline by iso creation date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `isoCreationDate` per anaplan model record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `models.lastModified`
Last Modified records ISO 8601 timestamp of the last modification to the model. It anchors the named event or boundary on the record's timeline.
* **Enables:** place model records on a timeline by last modified and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastModified` per anaplan model record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `models.lastModifiedByUserGuid`
Last Modified By User GUID is the GUID of the user who last modified the model. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model records to provider records that carry the same last modified by user GUID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `lastModifiedByUserGuid` as a record-level identifier on `AnaplanModel`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `models.lastSavedSerialNumber`
Last Saved Serial Number identifies serial number of the last save operation on the model. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model records to provider records that carry the same last saved serial number, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `lastSavedSerialNumber` as a record-level identifier on `AnaplanModel`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `models.memoryUsage`
Memory Usage reports the total memory usage of the model in bytes. Available when `modelDetails`=true. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported memory usage for each anaplan model record.
* **Interpretation:** The provider supplies `memoryUsage` at anaplan model granularity as the storage or memory unit named by the provider; zero and missing are not interchangeable.
Developer identifier: `models.modelSize`
Model Size groups the cell and memory breakdown returned when `modelDetails`=true. It preserves the component detail needed to explain the model's footprint.
* **Enables:** attribute total model memory to modules, lists, versions, time, users, and overhead.
* **Interpretation:** The provider supplies `modelSize` as a nested `ModelSize` object, not a scalar byte value; absence can mean detailed model data was not requested or returned.
Developer identifier: `models.modelSize.generalMemoryUsage`
General Memory Usage reports the bytes consumed by general and overhead model data. It isolates the overhead contribution to the model footprint.
* **Enables:** compare overhead memory between models and calculate its share of total memory usage.
* **Interpretation:** The provider supplies `generalMemoryUsage` as an integer byte value per model-size record; zero and missing are not interchangeable.
Developer identifier: `models.modelSize.listMemoryUsage`
List Memory Usage reports the bytes consumed by list data within the model. It isolates the list contribution to the model footprint.
* **Enables:** rank models by list memory and calculate its share of total memory usage.
* **Interpretation:** The provider supplies `listMemoryUsage` as an integer byte value per model-size record; zero and missing are not interchangeable.
Developer identifier: `models.modelSize.moduleMemoryUsage`
Module Memory Usage reports the bytes consumed by module data within the model. It isolates the module contribution to the model footprint.
* **Enables:** rank models by module memory and calculate its share of total memory usage.
* **Interpretation:** The provider supplies `moduleMemoryUsage` as an integer byte value per model-size record; zero and missing are not interchangeable.
Developer identifier: `models.modelSize.otherMemoryUsage`
Other Memory Usage reports the bytes consumed by model data outside the named memory categories. It preserves the residual contribution to the model footprint.
* **Enables:** reconcile categorized memory with total usage and identify models with unusually large uncategorized consumption.
* **Interpretation:** The provider supplies `otherMemoryUsage` as an integer byte value per model-size record; zero and missing are not interchangeable.
Developer identifier: `models.modelSize.timeMemoryUsage`
Time Memory Usage reports the bytes consumed by time-related model data. It isolates the time-data contribution to the model footprint.
* **Enables:** compare time-related memory between models and calculate its share of total memory usage.
* **Interpretation:** The provider supplies `timeMemoryUsage` as an integer byte value per model-size record; zero and missing are not interchangeable.
Developer identifier: `models.modelSize.totalMemoryUsage`
Total Memory Usage reports the total memory usage of the model in bytes. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported total memory usage for each model size record.
* **Interpretation:** The provider supplies `totalMemoryUsage` at model size granularity as the storage or memory unit named by the provider; zero and missing are not interchangeable.
Developer identifier: `models.modelSize.userMemoryUsage`
User Memory Usage reports the bytes consumed by user-related model data. It isolates the user-data contribution to the model footprint.
* **Enables:** compare user-data memory between models and calculate its share of total memory usage.
* **Interpretation:** The provider supplies `userMemoryUsage` as an integer byte value per model-size record; zero and missing are not interchangeable.
Developer identifier: `models.modelSize.versionMemoryUsage`
Version Memory Usage reports the bytes consumed by version data within the model. It isolates the version-data contribution to the model footprint.
* **Enables:** compare version memory between models and calculate its share of total memory usage.
* **Interpretation:** The provider supplies `versionMemoryUsage` as an integer byte value per model-size record; zero and missing are not interchangeable.
Developer identifier: `models.modelUrl`
Model URL records URL to access the model in the Anaplan web application. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by model URL on a anaplan model record.
* **Interpretation:** The provider supplies `modelUrl` as a URL or resource locator on each anaplan model record. Availability still follows the provider's permissions and retention.
Developer identifier: `models.modules`
Modules records summary list of modules within the model, if returned. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested modules object into its declared child fields for each anaplan model record.
* **Interpretation:** The provider returns `modules` as a list on `AnaplanModel`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `models.modules.id`
ID is the unique identifier of the module. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same module summary source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per module summary record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `models.modules.name`
Name records display name of the module. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each module summary record.
* **Interpretation:** The provider supplies `name` at module summary granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `models.name`
Name records display name of the model. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each anaplan model record.
* **Interpretation:** The provider supplies `name` at anaplan model granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `models.ownerGuid`
Owner GUID is the GUID of the model owner. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model records to provider records that carry the same owner GUID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `ownerGuid` as a record-level identifier on `AnaplanModel`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `models.ownerName`
Owner Name records display name of the model owner. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the anaplan model record to the provider-reported actor represented by owner name.
* **Interpretation:** The provider supplies `ownerName` as identity or attribution context on each anaplan model record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `models.status`
Status states operational status of the model. It preserves the provider's current classification of this record.
* **Enables:** separate model records by the exact provider-reported status value when describing their recorded state.
* **Interpretation:** The provider supplies `status` per anaplan model record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `models.urlShortId`
URL Short ID identifies short identifier used in model URLs. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model records to provider records that carry the same URL short ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `urlShortId` as a record-level identifier on `AnaplanModel`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `models.version`
Version identifies version identifier of the model. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match model records to provider records that carry the same version, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `version` as a record-level identifier on `AnaplanModel`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `module_views`
Module Views contain all saved views within a specific module. Views represent different perspectives/layouts of module data.
* **Enables:** catalog the saved layouts exposed for each model module.
* **Scope:** Reads the declared collection through `GET /2/0/workspaces/{workspaceId}/models/{modelId}/modules/{id}/views` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `module_views.code`
Code records optional code assigned to the view for external reference. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact code when validating the configuration or technical definition of a module view record.
* **Interpretation:** The provider supplies `code` as configuration or technical metadata on `ModuleView`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `module_views.columns`
Columns records list of dimension descriptors placed on the columns axis of the view. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the declared columns layout or dimensional scope of each module view record.
* **Interpretation:** The provider returns `columns` as a list on `ModuleView`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `module_views.columns.id`
ID captures the unique identifier of the dimension. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same view dimension source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per view dimension record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `module_views.columns.name`
Name captures the display name of the dimension. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each view dimension record.
* **Interpretation:** The provider supplies `name` at view dimension granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `module_views.id`
ID captures the unique identifier of the view within the model. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same module view source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per module view record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `module_views.modelId`
Model ID identifies parent `modelId` injected by the ingestor from the `model_modules` to `module_views` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match module view records to provider records that carry the same model ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `modelId` as a record-level identifier on `ModuleView`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `module_views.moduleId`
Module ID captures the identifier of the module this view belongs to. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match module view records to provider records that carry the same module ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `moduleId` as a record-level identifier on `ModuleView`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `module_views.moduleName`
Module Name captures the name of the module this view belongs to. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact module name value attached to each module view record.
* **Interpretation:** The provider supplies `moduleName` at module view granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `module_views.name`
Name captures the display name of the saved view. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each module view record.
* **Interpretation:** The provider supplies `name` at module view granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `module_views.pages`
Pages records list of dimension descriptors placed on the pages (filter) axis of the view. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the declared pages layout or dimensional scope of each module view record.
* **Interpretation:** The provider returns `pages` as a list on `ModuleView`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `module_views.rows`
Rows records list of dimension descriptors placed on the rows axis of the view. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the declared rows layout or dimensional scope of each module view record.
* **Interpretation:** The provider returns `rows` as a list on `ModuleView`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `module_views.workspaceId`
Workspace ID identifies parent `workspaceId` injected by the ingestor from the `model_modules` to `module_views` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match module view records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `ModuleView`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `scim_users`
SCIM Users contain all users provisioned in the Anaplan tenant via SCIM 2.0. Returns user identity, email, active status, and workspace assignments.
* **Enables:** review provisioned identities and their reported workspace assignments.
* **Scope:** Reads the declared collection through `GET /scim/1/0/v2/Users` as a full snapshot. Only SCIM-provisioned users visible to the configured account are included.
Developer identifier: `scim_users.active`
Active indicates whether the user account is active in the Anaplan tenant. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select scim user records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per scim user record; false and missing are distinct when the field is optional.
Developer identifier: `scim_users.displayName`
Display Name captures the user's full display name. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the scim user record to the provider-reported person or account represented by display name.
* **Interpretation:** The provider supplies `displayName` as identity or attribution context on each scim user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `scim_users.emails`
Emails records list of email addresses associated with the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the scim user record to the provider-reported person or account represented by emails.
* **Interpretation:** The provider supplies `emails` as identity or attribution context on each scim user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `scim_users.emails.primary`
Primary indicates whether this is the user's primary email address. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select scim user records for which the provider reports primary as true or false.
* **Interpretation:** The provider supplies `primary` as a boolean per scim email record; false and missing are distinct when the field is optional.
Developer identifier: `scim_users.emails.type`
Type captures the type/label of the email address (e.g., work, home). It preserves the provider's current classification of this record.
* **Enables:** separate scim user records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per scim email record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `scim_users.emails.value`
Value captures the email address value. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same scim email source row before constructing its represented state.
* **Interpretation:** The provider supplies `value` at one value per scim email record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `scim_users.entitlements`
Entitlements states entitlements granted to the user. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported entitlements attached to each scim user record.
* **Interpretation:** The provider supplies `entitlements` at scim user granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `scim_users.entitlements.display`
Display records human-readable display name of the entitlement. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact display value attached to each scim entitlement record.
* **Interpretation:** The provider supplies `display` at scim entitlement granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `scim_users.entitlements.primary`
Primary indicates whether this is the user's primary entitlement. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select scim user records for which the provider reports primary as true or false.
* **Interpretation:** The provider supplies `primary` as a boolean per scim entitlement record; false and missing are distinct when the field is optional.
Developer identifier: `scim_users.entitlements.value`
Value captures the entitlement identifier or name.
* **Enables:** Match scim entitlement entries on `value`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** The provider supplies `value` at one value per scim entitlement record.
Developer identifier: `scim_users.externalId`
External ID identifies external identifier for the user, typically set by the identity provider. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match scim user records to provider records that carry the same external ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `externalId` as a record-level identifier on `ScimUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `scim_users.groups`
Groups records groups the user belongs to within the Anaplan SCIM directory. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each scim user record with the specific provider container named by groups.
* **Interpretation:** The provider returns `groups` as a list on `ScimUser`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `scim_users.groups.$ref`
\$ref captures the URI reference to the full group resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by \$ref on a scim group ref record.
* **Interpretation:** The provider supplies `$ref` as a URL or resource locator on each scim group ref record. Availability still follows the provider's permissions and retention.
Developer identifier: `scim_users.groups.display`
Display captures the display name of the group. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact display value attached to each scim group ref record.
* **Interpretation:** The provider supplies `display` at scim group ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `scim_users.groups.value`
Value captures the unique identifier of the group.
* **Enables:** Match scim group ref entries on `value`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** The provider supplies `value` at one value per scim group ref record.
Developer identifier: `scim_users.id`
ID is the unique identifier for the user within the Anaplan SCIM directory. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same scim user source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per scim user record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `scim_users.meta`
Meta groups the SCIM resource type, location, and creation and modification timestamps for the user. It preserves lifecycle metadata supplied with the resource.
* **Enables:** locate the SCIM resource and correlate user snapshots with their reported creation and last-modified boundaries.
* **Interpretation:** The provider returns `meta` as a nested `ScimMeta` object; absence means the SCIM metadata was not reported with that user.
Developer identifier: `scim_users.meta.created`
Created records ISO 8601 timestamp when the resource was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place scim user records on a timeline by created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created` per scim meta record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `scim_users.meta.lastModified`
Last Modified records ISO 8601 timestamp when the resource was last modified. It anchors the named event or boundary on the record's timeline.
* **Enables:** place scim user records on a timeline by last modified and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastModified` per scim meta record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `scim_users.meta.location`
Location captures the canonical URI of the SCIM resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by location on a scim meta record.
* **Interpretation:** The provider supplies `location` as a URL or resource locator on each scim meta record. Availability still follows the provider's permissions and retention.
Developer identifier: `scim_users.meta.resourceType`
Resource Type captures the SCIM resource type (e.g., User). It preserves the provider's current classification of this record.
* **Enables:** separate scim user records by the exact provider-reported resource type value when describing their recorded state.
* **Interpretation:** The provider supplies `resourceType` per scim meta record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `scim_users.meta.version`
Version captures the version (ETag) of the SCIM resource for optimistic concurrency. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact version when validating the configuration or technical definition of a scim meta record.
* **Interpretation:** The provider supplies `version` as configuration or technical metadata on `ScimMeta`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `scim_users.name`
Name captures the user's name components (given name, family name, etc.). It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the scim user record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each scim user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `scim_users.name.familyName`
Family Name captures the user's last name / family name. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the scim user name record to the provider-reported person or account represented by family name.
* **Interpretation:** The provider supplies `familyName` as identity or attribution context on each scim user name record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `scim_users.name.formatted`
Formatted captures the full name formatted for display. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the scim user name record to the provider-reported person or account represented by formatted.
* **Interpretation:** The provider supplies `formatted` as identity or attribution context on each scim user name record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `scim_users.name.givenName`
Given Name captures the user's first name / given name. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the scim user name record to the provider-reported person or account represented by given name.
* **Interpretation:** The provider supplies `givenName` as identity or attribution context on each scim user name record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `scim_users.name.honorificPrefix`
Honorific Prefix records honorific prefix (e.g., Mr., Dr.). It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the scim user name record to the provider-reported person or account represented by honorific prefix.
* **Interpretation:** The provider supplies `honorificPrefix` as identity or attribution context on each scim user name record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `scim_users.name.honorificSuffix`
Honorific Suffix records honorific suffix (e.g., Jr., III). It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the scim user name record to the provider-reported person or account represented by honorific suffix.
* **Interpretation:** The provider supplies `honorificSuffix` as identity or attribution context on each scim user name record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `scim_users.name.middleName`
Middle Name captures the user's middle name. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the scim user name record to the provider-reported person or account represented by middle name.
* **Interpretation:** The provider supplies `middleName` as identity or attribution context on each scim user name record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `scim_users.roles`
Roles states roles assigned to the user in Anaplan. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported roles attached to each scim user record.
* **Interpretation:** The provider supplies `roles` at scim user granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `scim_users.roles.display`
Display records human-readable display name of the role. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact display value attached to each scim role record.
* **Interpretation:** The provider supplies `display` at scim role granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `scim_users.roles.primary`
Primary indicates whether this is the user's primary role. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select scim user records for which the provider reports primary as true or false.
* **Interpretation:** The provider supplies `primary` as a boolean per scim role record; false and missing are distinct when the field is optional.
Developer identifier: `scim_users.roles.value`
Value captures the role identifier or name.
* **Enables:** Match scim role entries on `value`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** The provider supplies `value` at one value per scim role record.
Developer identifier: `scim_users.schemas`
Schemas records SCIM schema URIs applicable to this user resource (e.g., urn:ietf:params:scim:schemas:core:2.0:User and Anaplan extension schemas). It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact schemas when validating the configuration or technical definition of a scim user record.
* **Interpretation:** The provider supplies `schemas` as configuration or technical metadata on `ScimUser`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `scim_users.urn:scim:schemas:extension:anaplan:2.0:User`
Urn SCIM Schemas Extension Anaplan 2 0 User records Anaplan-specific SCIM extension attributes for the user. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact urn SCIM schemas extension anaplan 2 0 user when validating the configuration or technical definition of a scim user record.
* **Interpretation:** The provider supplies `urn:scim:schemas:extension:anaplan:2.0:User` as configuration or technical metadata on `ScimUser`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `scim_users.urn:scim:schemas:extension:anaplan:2.0:User.lastLoginDate`
Last Login Date records ISO 8601 timestamp of the user's last login to Anaplan. It anchors the named event or boundary on the record's timeline.
* **Enables:** place scim user records on a timeline by last login date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastLoginDate` per anaplan user extension record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `scim_users.urn:scim:schemas:extension:anaplan:2.0:User.lockoutDate`
Lockout Date records ISO 8601 timestamp when the user account was locked out, if applicable. It anchors the named event or boundary on the record's timeline.
* **Enables:** place scim user records on a timeline by lockout date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lockoutDate` per anaplan user extension record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `scim_users.urn:scim:schemas:extension:anaplan:2.0:User.modelCreator`
Model Creator indicates whether the user has model creator privileges. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select scim user records for which the provider reports model creator as true or false.
* **Interpretation:** The provider supplies `modelCreator` as a boolean per anaplan user extension record; false and missing are distinct when the field is optional.
Developer identifier: `scim_users.urn:scim:schemas:extension:anaplan:2.0:User.tenantAdmin`
Tenant Admin indicates whether the user has tenant administrator privileges. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported tenant admin attached to each anaplan user extension record.
* **Interpretation:** The provider supplies `tenantAdmin` at anaplan user extension granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `scim_users.urn:scim:schemas:extension:anaplan:2.0:User.workspaces`
Workspaces records list of Anaplan workspaces the user is assigned to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each anaplan user extension record with the specific provider container named by workspaces.
* **Interpretation:** The provider returns `workspaces` as a list on `AnaplanUserExtension`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `scim_users.urn:scim:schemas:extension:anaplan:2.0:User.workspaces.active`
Active indicates whether the user's assignment to this workspace is currently active. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select scim user records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per anaplan workspace assignment record; false and missing are distinct when the field is optional.
Developer identifier: `scim_users.urn:scim:schemas:extension:anaplan:2.0:User.workspaces.role`
Role captures the user's role within the workspace. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported role attached to each anaplan workspace assignment record.
* **Interpretation:** The provider supplies `role` at anaplan workspace assignment granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `scim_users.urn:scim:schemas:extension:anaplan:2.0:User.workspaces.workspaceId`
Workspace ID captures the unique identifier of the Anaplan workspace. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match scim user records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `AnaplanWorkspaceAssignment`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `scim_users.urn:scim:schemas:extension:anaplan:2.0:User.workspaces.workspaceName`
Workspace Name captures the display name of the Anaplan workspace. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact workspace name value attached to each anaplan workspace assignment record.
* **Interpretation:** The provider supplies `workspaceName` at anaplan workspace assignment granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `scim_users.userName`
User Name captures the user's login name, typically their email address. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the scim user record to the provider-reported actor represented by user name.
* **Interpretation:** The provider supplies `userName` as identity or attribution context on each scim user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `users`
Users contain all users in the Anaplan tenant via the Integration API v2. Returns user identity, email, active status, and admin role. Does not require SCIM provisioning or Enterprise tier.
* **Enables:** resolve Anaplan account identities, active state, and administrator context without requiring SCIM.
* **Scope:** Reads the declared collection through `GET /2/0/users` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `users.active`
Active indicates whether the user account is currently enabled. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select user records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per anaplan user record; false and missing are distinct when the field is optional.
Developer identifier: `users.customerId`
Customer ID identifies Anaplan customer/tenant identifier associated with the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match user records to provider records that carry the same customer ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `customerId` as a record-level identifier on `AnaplanUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `users.email`
Email records user email address (login identifier). It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the anaplan user record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each anaplan user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `users.emailOptIn`
Email Opt In indicates whether the user has opted in to Anaplan email communications. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select user records for which the provider reports email opt in as true or false.
* **Interpretation:** The provider supplies `emailOptIn` as a boolean per anaplan user record; false and missing are distinct when the field is optional.
Developer identifier: `users.firstName`
First Name records user first name. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the anaplan user record to the provider-reported person or account represented by first name.
* **Interpretation:** The provider supplies `firstName` as identity or attribution context on each anaplan user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `users.id`
ID is the unique Anaplan-assigned user identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same anaplan user source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per anaplan user record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `users.lastLoginDate`
Last Login Date records ISO 8601 timestamp of the user's last login, if available. It anchors the named event or boundary on the record's timeline.
* **Enables:** place user records on a timeline by last login date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastLoginDate` per anaplan user record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `users.lastName`
Last Name records user last name. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the anaplan user record to the provider-reported person or account represented by last name.
* **Interpretation:** The provider supplies `lastName` as identity or attribution context on each anaplan user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `users.tenantAdmin`
Tenant Admin indicates whether the user has tenant administrator privileges. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported tenant admin attached to each anaplan user record.
* **Interpretation:** The provider supplies `tenantAdmin` at anaplan user granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `workspace_models`
Workspace Models contain all models within a specific workspace.
* **Enables:** enumerate planning models within each parent workspace.
* **Scope:** Reads the declared collection through `GET /2/0/workspaces/{id}/models` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `workspace_models.activeState`
Active State states current active state of the model (e.g., ACTIVE, ARCHIVED). It preserves the provider's current classification of this record.
* **Enables:** separate workspace model records by the exact provider-reported active state value when describing their recorded state.
* **Interpretation:** The provider supplies `activeState` per workspace model record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `workspace_models.categoryValues`
Category Values states list of category/tag values associated with the model. It preserves the provider's current classification of this record.
* **Enables:** separate workspace model records by the exact provider-reported category values value when describing their recorded state.
* **Interpretation:** The provider supplies `categoryValues` per workspace model record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `workspace_models.categoryValues.categoryId`
Category ID is the identifier of the parent category. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match workspace model records to provider records that carry the same category ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `categoryId` as a record-level identifier on `CategoryValue`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `workspace_models.categoryValues.categoryName`
Category Name states display name of the parent category. It preserves the provider's current classification of this record.
* **Enables:** separate workspace model records by the exact provider-reported category name value when describing their recorded state.
* **Interpretation:** The provider supplies `categoryName` per category value record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `workspace_models.categoryValues.id`
ID is the unique identifier of the category value. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same category value source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per category value record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `workspace_models.categoryValues.name`
Name records display name of the category value. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each category value record.
* **Interpretation:** The provider supplies `name` at category value granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `workspace_models.currentWorkspaceId`
Current Workspace ID is the identifier of the workspace that currently contains this model. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match workspace model records to provider records that carry the same current workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `currentWorkspaceId` as a record-level identifier on `WorkspaceModel`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `workspace_models.currentWorkspaceName`
Current Workspace Name records name of the workspace that currently contains this model. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact current workspace name value attached to each workspace model record.
* **Interpretation:** The provider supplies `currentWorkspaceName` at workspace model granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `workspace_models.id`
ID is the unique identifier (GUID) of the model. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same workspace model source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per workspace model record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `workspace_models.isoCreationDate`
Iso Creation Date records ISO 8601 timestamp of when the model was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place workspace model records on a timeline by iso creation date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `isoCreationDate` per workspace model record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `workspace_models.lastModified`
Last Modified records last-modified timestamp returned by the workspace models API (same instant as `lastModifiedDate` when both are present). It anchors the named event or boundary on the record's timeline.
* **Enables:** place workspace model records on a timeline by last modified and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastModified` per workspace model record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `workspace_models.lastModifiedByUserGuid`
Last Modified By User GUID is the GUID of the user who last modified the model. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match workspace model records to provider records that carry the same last modified by user GUID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `lastModifiedByUserGuid` as a record-level identifier on `WorkspaceModel`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `workspace_models.lastModifiedDate`
Last Modified Date records ISO 8601 timestamp of when the model was last modified. It anchors the named event or boundary on the record's timeline.
* **Enables:** place workspace model records on a timeline by last modified date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastModifiedDate` per workspace model record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `workspace_models.lastSavedSerialNumber`
Last Saved Serial Number identifies serial number of the last save operation on the model. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match workspace model records to provider records that carry the same last saved serial number, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `lastSavedSerialNumber` as a record-level identifier on `WorkspaceModel`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `workspace_models.memoryUsage`
Memory Usage reports the model's total memory consumption in bytes when `modelDetails`=true. It supplies the overall footprint for the workspace-model relationship.
* **Enables:** rank models within a workspace by memory consumption and track capacity concentration.
* **Interpretation:** The provider supplies `memoryUsage` as a numeric byte value per workspace-model record; zero and missing are not interchangeable.
Developer identifier: `workspace_models.modelSize`
Model Size groups the model's cell total and component memory breakdown. It preserves the detail needed to explain the workspace model's footprint.
* **Enables:** relate model scale in cells to the memory consumed by modules, lists, and other components.
* **Interpretation:** The provider supplies `modelSize` as a nested `ModelSize` object, not a scalar byte value; absence means the breakdown was not reported.
Developer identifier: `workspace_models.modelSize.listMemoryUsage`
List Memory Usage reports the bytes consumed by list data within the workspace model. It isolates the list contribution to the model footprint.
* **Enables:** rank workspace models by list memory and calculate its share of total memory usage.
* **Interpretation:** The provider supplies `listMemoryUsage` as a numeric byte value per model-size record; zero and missing are not interchangeable.
Developer identifier: `workspace_models.modelSize.moduleMemoryUsage`
Module Memory Usage reports the bytes consumed by module data within the workspace model. It isolates the module contribution to the model footprint.
* **Enables:** rank workspace models by module memory and calculate its share of total memory usage.
* **Interpretation:** The provider supplies `moduleMemoryUsage` as a numeric byte value per model-size record; zero and missing are not interchangeable.
Developer identifier: `workspace_models.modelSize.otherMemoryUsage`
Other Memory Usage reports the bytes consumed by workspace-model components outside the named categories. It preserves the residual contribution to the model footprint.
* **Enables:** reconcile categorized memory with total usage and identify models with unusually large uncategorized consumption.
* **Interpretation:** The provider supplies `otherMemoryUsage` as a numeric byte value per model-size record; zero and missing are not interchangeable.
Developer identifier: `workspace_models.modelSize.totalCells`
Total Cells reports the total number of cells across all modules in the model. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported total cells for each model size record.
* **Interpretation:** The provider supplies `totalCells` at model size granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `workspace_models.modelSize.totalMemoryUsage`
Total Memory Usage reports the total memory usage of the model in bytes. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported total memory usage for each model size record.
* **Interpretation:** The provider supplies `totalMemoryUsage` at model size granularity as the storage or memory unit named by the provider; zero and missing are not interchangeable.
Developer identifier: `workspace_models.modelUrl`
Model URL records URL to access the model in the Anaplan web interface. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by model URL on a workspace model record.
* **Interpretation:** The provider supplies `modelUrl` as a URL or resource locator on each workspace model record. Availability still follows the provider's permissions and retention.
Developer identifier: `workspace_models.modules`
Modules records summary list of modules within the model, if returned. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested modules object into its declared child fields for each workspace model record.
* **Interpretation:** The provider returns `modules` as a list on `WorkspaceModel`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `workspace_models.modules.id`
ID is the unique identifier of the module. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same module summary source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per module summary record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `workspace_models.modules.name`
Name records display name of the module. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each module summary record.
* **Interpretation:** The provider supplies `name` at module summary granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `workspace_models.name`
Name records display name of the model. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each workspace model record.
* **Interpretation:** The provider supplies `name` at workspace model granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `workspace_models.workspaceId`
Workspace ID identifies parent id injected by the ingestor from the workspaces to `workspace_models` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match workspace model records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspaceId` as a record-level identifier on `WorkspaceModel`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `workspaces`
Workspaces contain all workspaces accessible to the authenticated user. Core organizational container in Anaplan.
* **Enables:** enumerate the Anaplan containers available to the configured account before resolving model-scoped records.
* **Scope:** Reads the declared collection through `GET /2/0/workspaces` as a full snapshot. Results are limited to objects visible to the configured Anaplan exception user; inaccessible workspaces and models are absent.
Developer identifier: `workspaces.active`
Active indicates whether the workspace is currently active. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select workspace records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per workspace record; false and missing are distinct when the field is optional.
Developer identifier: `workspaces.currentSize`
Current Size reports the workspace storage currently used in bytes. It provides the usage value needed alongside the configured allowance.
* **Enables:** calculate capacity utilization and identify the workspaces with the largest storage footprint.
* **Interpretation:** The provider supplies `currentSize` as an integer byte value per workspace; zero and missing are not interchangeable.
Developer identifier: `workspaces.id`
ID is the unique identifier for the workspace. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same workspace source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per workspace record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `workspaces.name`
Name records display name of the workspace. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each workspace record.
* **Interpretation:** The provider supplies `name` at workspace granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `workspaces.sizeAllowance`
Size Allowance reports the maximum workspace storage capacity in bytes. It establishes the capacity ceiling paired with current size.
* **Enables:** compare allotted capacity with current use to identify workspaces approaching their storage limit.
* **Interpretation:** The provider supplies `sizeAllowance` as an integer byte value per workspace; zero and missing are not interchangeable.
| Error | Meaning | Solution |
| - | - | - |
| `401 Unauthorized` on token endpoint | Bad email or password | Verify credentials |
| `401 Caller is unauthorized` on SCIM | Missing Tenant Admin | Grant Tenant Admin to the integration account |
| `401 No valid token header` on audit | Audit auth mismatch | Confirm Tenant Auditor; audit may require different auth |
| `403 Forbidden` on workspaces | Insufficient access | Grant Workspace Admin on target workspaces |
| Password stopped working | Rotation policy | Use Exception User or update the Provider password |
#### Common Issues
#### Account locked after failed attempts
Contact your Tenant Admin to unlock the account.
#### SCIM returns empty user list
Workspace Admin alone is not enough; the account needs **Tenant Admin** for SCIM.
#### Audit events not available
Confirm Tenant Auditor role and supported auth for the audit API with Anaplan support.
**[Anaplan REST API](https://help.anaplan.com/anaplan-api-844c6d40-a21c-423d-8435-ebaaa0372b76)** — API documentation
**[SCIM API](https://help.anaplan.com/anaplan-scim-api-f6a801cd-c253-4ab9-ba03-dac09fd71f7c)** — User provisioning API
**[Audit API](https://auditservice.docs.apiary.io/)** — Audit event API reference
# Atlassian (Legacy)
Source: https://docs.parable.work/plugins/provider-plugins/atlassian
Legacy Atlassian connection retained for compatibility; use the dedicated Jira or Confluence Provider Plugins for new connections.
This legacy Atlassian connection is retained for compatibility. For a new
connection, use Jira Cloud, Jira Data Center, or Confluence Cloud instead.
This Plugin does not expose customer-selectable data streams. Choose the
dedicated Provider Plugin for the Atlassian product you need.
## Data streams
This Provider Plugin defines 0 data streams.
| Stream | Description | Sync |
| - | - | - |
| — | No customer-selectable data streams are declared. | — |
Setup instructions for this Provider Plugin are still being documented.
Review the fields in the connection form and confirm the required access with your Provider administrator before saving credentials.
This Provider Plugin does not declare any data streams.
If validation fails, confirm that the credential is active, the configured account can read the required resources, and every connection field matches the Provider environment.
Parable never returns stored secret values; replace a secret in the connection form when it has expired or been revoked.
# BambooHR
Source: https://docs.parable.work/plugins/provider-plugins/bamboo
Sync employee data from BambooHR
Sync employee data from BambooHR.
Connect Parable to BambooHR for comprehensive HR and people data.
#### Employees
Profiles, job information, contacts
#### Time Off
Balances, requests, policies
## Data streams
This Provider Plugin defines 5 data streams.
| Stream | Description | Sync |
| - | - | - |
| `users` | Employee directory listing all employees | full |
| `time_off_policies` | Time off policies assigned to an employee | full |
| `employee_salaries` | Compensation details for an employee | full |
| `timesheets` | Time tracking timesheet entries | incremental |
| `time_off_requests` | Time off requests submitted by employees | incremental |
### BambooHR
#### What You'll Need
| Credential | What it is |
| - | - |
| **API Key** | Generated from BambooHR settings |
| **Subdomain** | Your BambooHR subdomain |
> **Info:** **Setup access in BambooHR.** These steps require **Administrator**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your BambooHR administrator.
* **Admin** access level in BambooHR
* API key generation permission
#### Step 1: Access Account Settings
1. Log in to BambooHR
2. Click your name in the lower left
3. Select **API Keys**
#### Step 2: Generate API Key
1. Click **Add New Key**
2. Name: `Parable Integration`
3. Click **Generate Key**
> **Warning:** **Copy your API key now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
#### Step 3: Note Your Subdomain
Your BambooHR URL format:
```
https://yourcompany.bamboohr.com
```
Your subdomain is `yourcompany`.
#### Step 4: Enter values in the form
1. **Subdomain** and **API Key**: Enter your BambooHR subdomain and API key.
2. Click **Save & test connection**.
Developer identifier: `employee_salaries`
**Employee Salaries.** Compensation details for an employee.
* **Enables:** Match each employee's pay rate to its currency, pay basis, frequency, and effective date for HR record reconciliation.
* **Scope:** Reads the records selected by BambooHR's `/v1/employees/{employee_id}/` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the BambooHR API user's field-level access, so restricted employee attributes may be absent. Use is limited to authorized workforce and payroll reconciliation; the records are not invoices and do not support performance inference. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `employee_salaries.currency`
**Currency.** Currency code for the pay rate. It distinguishes the provider-defined currency state or classification for the employee salary.
* **Enables:** Reconcile currency in `employee_salaries.currency` by pairing it with the same worker or position, currency, pay basis, and effective period.
* **Interpretation:** BambooHR reports currency on each employee salary; missing and empty values can have different meanings. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
Developer identifier: `employee_salaries.employee_id`
**Employee ID.** Parent employee reference copied into each employee salary because the child operation does not return that relationship. It provides the reference needed to connect the employee salary to the corresponding provider object.
* **Enables:** Match repeated employee salary entries on employee ID in `employee_salaries.employee_id`; collapse only entries that share this declared transform key.
* **Interpretation:** Parable copies employee ID from the parent traversal record into each employee salary; the child BambooHR operation does not return it. The connector explicitly marks this field as a transform deduplication key. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance.
Developer identifier: `employee_salaries.hireDate`
**Hire Date.** Date the employee was hired. It anchors the employee salary on the provider's reported timeline.
* **Enables:** Order Employee Salaries by hire date in `employee_salaries.hireDate` and isolate records inside an exact provider reporting window.
* **Interpretation:** BambooHR reports hire date as a calendar date on each employee salary; its grain is one day and no time of day should be inferred. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance.
Developer identifier: `employee_salaries.paidPer`
**Paid Per.** Pay period unit (e.g. Year, Hour). It supplies the paid per boundary, band, or unit needed to interpret the companion measure.
* **Enables:** Reconcile paid per in `employee_salaries.paidPer` by pairing it with the same worker or position, currency, pay basis, and effective period.
* **Interpretation:** BambooHR reports paid per on each employee salary; missing and empty values can have different meanings. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
Developer identifier: `employee_salaries.payFrequency`
**Pay Frequency.** Frequency of pay (e.g. Monthly, Bi-Weekly). It distinguishes the provider-defined pay frequency state or classification for the employee salary.
* **Enables:** Reconcile pay frequency in `employee_salaries.payFrequency` by pairing it with the same worker or position, currency, pay basis, and effective period.
* **Interpretation:** BambooHR reports pay frequency on each employee salary; missing and empty values can have different meanings. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
Developer identifier: `employee_salaries.payRate`
**Pay Rate.** Pay rate amount. It supplies the pay rate measure for the employee salary at the provider's declared unit and grain.
* **Enables:** Reconcile pay rate in `employee_salaries.payRate` by pairing it with the same worker or position, currency, pay basis, and effective period.
* **Interpretation:** BambooHR reports pay rate as a number at the parent record's grain on each employee salary; compare only records with the same unit and aggregation grain. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
Developer identifier: `employee_salaries.payType`
**Pay Type.** Type of pay (e.g. Salary, Hourly). It distinguishes the provider-defined pay type state or classification for the employee salary.
* **Enables:** Reconcile pay type in `employee_salaries.payType` by pairing it with the same worker or position, currency, pay basis, and effective period.
* **Interpretation:** BambooHR reports pay type as a label from its own taxonomy on each employee salary; preserve unknown labels rather than mapping them by assumption. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
Developer identifier: `time_off_policies`
**Time Off Policies.** Time off policies assigned to an employee.
* **Enables:** Match employees to assigned leave policies and provider-defined time-off types.
* **Scope:** Reads the records selected by BambooHR's `/v1_1/employees/{employee_id}/time_off/policies` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the BambooHR API user's field-level access, so restricted employee attributes may be absent. Use is limited to authorized leave and workforce-availability administration; the records do not support health or performance inference. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `time_off_policies.accrualStartDate`
**Accrual Start Date.** Date when accrual begins for this policy. It anchors the time off policy on the provider's reported timeline.
* **Enables:** Match accrual start date in `time_off_policies.accrualStartDate` to the relevant worker, leave type, unit, and effective date for authorized leave administration.
* **Interpretation:** BambooHR reports accrual start date as a calendar date on each time off policy; its grain is one day and no time of day should be inferred. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_policies.employee_id`
**Employee ID.** Parent employee reference copied into each time off policy because the child operation does not return that relationship. It provides the reference needed to connect the time off policy to the corresponding provider object.
* **Enables:** Connect each time off policy in Time Off Policies to the referenced employee through `time_off_policies.employee_id`; flag employee ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies employee ID from the parent traversal record into each time off policy; the child BambooHR operation does not return it. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_policies.policyName`
**Policy Name.** Name of the time off policy. It gives the time off policy a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each time off policy with policy name from `time_off_policies.policyName`; distinguish records that share that display name but have different BambooHR identifiers.
* **Interpretation:** BambooHR reports policy name as display text for each time off policy; names are mutable and are not stable identities. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_policies.timeOffPolicyId`
**Time Off Policy ID.** Unique identifier for the time off policy. It provides the reference needed to connect the time off policy to the corresponding provider object.
* **Enables:** Match repeated time off policy entries on time off policy ID in `time_off_policies.timeOffPolicyId`; collapse only entries that share this declared transform key.
* **Interpretation:** BambooHR reports time off policy ID as an identifier in its time off policy namespace; it is not a universal identity outside BambooHR. The connector explicitly marks this field as a transform deduplication key. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_policies.timeOffType`
**Time Off Type.** Name of the time off type. It distinguishes the provider-defined time off type state or classification for the time off policy.
* **Enables:** Match time off type in `time_off_policies.timeOffType` to the relevant worker, leave type, unit, and effective date for authorized leave administration.
* **Interpretation:** BambooHR reports time off type as a label from its own taxonomy on each time off policy; preserve unknown labels rather than mapping them by assumption. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_policies.timeOffTypeId`
**Time Off Type ID.** Identifier for the associated time off type. It provides the reference needed to connect the time off policy to the corresponding provider object.
* **Enables:** Connect each time off policy in Time Off Policies to the referenced time off type through `time_off_policies.timeOffTypeId`; flag time off type ID values that do not resolve in that provider namespace.
* **Interpretation:** BambooHR reports time off type ID as an identifier in its time off type namespace; it is not a universal identity outside BambooHR. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests`
**Time Off Requests.** Time off requests submitted by employees.
* **Enables:** Reconcile requested leave dates and amounts with the employee, request status, and provider-defined leave type.
* **Scope:** Reads the records selected by BambooHR's `/v1/time_off/requests` operation as a changelog stream using incremental synchronization. This stream is opt-in. Visibility follows the BambooHR API user's field-level access, so restricted employee attributes may be absent. Use is limited to authorized leave and workforce-availability administration; the records do not support health or performance inference. This stream supplies no reliable deletion signal.
Developer identifier: `time_off_requests.actions`
**Actions.** Per-request action capabilities for the calling user (view, edit, cancel, approve, deny, bypass). It preserves the nested context needed to interpret the parent time off request.
* **Enables:** Attribute actions in `time_off_requests.actions` to the parent time off request; identify parent records where that nested actions object is absent.
* **Interpretation:** BambooHR reports actions as a nested object on each time off request; optional children may be absent from a valid response. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.actions.approve`
**Approve.** Whether the calling user can approve this request. It distinguishes the provider-defined approve state or classification for the BambooHR time off request action.
* **Enables:** Filter Time Off Requests by whether the calling user can approve this request in `time_off_requests.BambooHRTimeOffRequestActions.approve`; count true, false, and missing results separately.
* **Interpretation:** BambooHR reports the calling user can approve this request as a boolean on each BambooHR time off request action; a missing field is unknown, not false. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.actions.bypass`
**Bypass.** Whether the calling user can bypass approval for this request. It distinguishes the provider-defined bypass state or classification for the BambooHR time off request action.
* **Enables:** Filter Time Off Requests by whether the calling user can bypass approval for this request in `time_off_requests.BambooHRTimeOffRequestActions.bypass`; count true, false, and missing results separately.
* **Interpretation:** BambooHR reports the calling user can bypass approval for this request as a boolean on each BambooHR time off request action; a missing field is unknown, not false. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.actions.cancel`
**Cancel.** Whether the calling user can cancel this request. It distinguishes the provider-defined cancel state or classification for the BambooHR time off request action.
* **Enables:** Filter Time Off Requests by whether the calling user can cancel this request in `time_off_requests.BambooHRTimeOffRequestActions.cancel`; count true, false, and missing results separately.
* **Interpretation:** BambooHR reports the calling user can cancel this request as a boolean on each BambooHR time off request action; a missing field is unknown, not false. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.actions.deny`
**Deny.** Whether the calling user can deny this request. It distinguishes the provider-defined deny state or classification for the BambooHR time off request action.
* **Enables:** Filter Time Off Requests by whether the calling user can deny this request in `time_off_requests.BambooHRTimeOffRequestActions.deny`; count true, false, and missing results separately.
* **Interpretation:** BambooHR reports the calling user can deny this request as a boolean on each BambooHR time off request action; a missing field is unknown, not false. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.actions.edit`
**Edit.** Whether the calling user can edit this request. It distinguishes the provider-defined edit state or classification for the BambooHR time off request action.
* **Enables:** Filter Time Off Requests by whether the calling user can edit this request in `time_off_requests.BambooHRTimeOffRequestActions.edit`; count true, false, and missing results separately.
* **Interpretation:** BambooHR reports the calling user can edit this request as a boolean on each BambooHR time off request action; a missing field is unknown, not false. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.actions.view`
**View.** Whether the calling user can view this request. It distinguishes the provider-defined view state or classification for the BambooHR time off request action.
* **Enables:** Filter Time Off Requests by whether the calling user can view this request in `time_off_requests.BambooHRTimeOffRequestActions.view`; count true, false, and missing results separately.
* **Interpretation:** BambooHR reports the calling user can view this request as a boolean on each BambooHR time off request action; a missing field is unknown, not false. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.amount`
**Amount.** Amount of time off requested. It preserves the nested context needed to interpret the parent time off request.
* **Enables:** Attribute amount in `time_off_requests.amount` to the parent time off request; identify parent records where that nested amount object is absent.
* **Interpretation:** BambooHR reports amount as a nested object on each time off request; optional children may be absent from a valid response. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.amount.amount`
**Amount.** Numeric amount of time off. It supplies the amount measure for the BambooHR time off request amount at the provider's declared unit and grain.
* **Enables:** Match amount in `time_off_requests.BambooHRTimeOffRequestAmount.amount` to the relevant worker, leave type, unit, and effective date for authorized leave administration.
* **Interpretation:** BambooHR reports amount as a number at the parent record's grain on each BambooHR time off request amount; compare only records with the same unit and aggregation grain. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.amount.unit`
**Unit.** Unit of the amount (e.g. days, hours). It supplies the unit boundary, band, or unit needed to interpret the companion measure.
* **Enables:** Interpret `time_off_requests.BambooHRTimeOffRequestAmount.unit` with its companion minimum, maximum, interval, or unit before comparing the unit across like-for-like records.
* **Interpretation:** BambooHR reports unit as a boundary, band, interval, or unit on each BambooHR time off request amount; it is meaningful only with its companion measure and provider scale. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.created`
**Created.** Timestamp when the request was created. It anchors the time off request on the provider's reported timeline.
* **Enables:** Order Time Off Requests by created in `time_off_requests.created` and isolate records inside an exact provider reporting window.
* **Interpretation:** BambooHR reports created as a timestamp on each time off request; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.dates`
**Dates.** Map of dates to daily time off amounts. It preserves the nested context needed to interpret the parent time off request.
* **Enables:** Attribute dates in `time_off_requests.dates` to the parent time off request; identify parent records where that nested dates object is absent.
* **Interpretation:** BambooHR reports dates as a nested object on each time off request; optional children may be absent from a valid response. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.employeeId`
**Employee ID.** Identifier of the employee who submitted the request. It provides the reference needed to connect the time off request to the corresponding provider object.
* **Enables:** Connect each time off request in Time Off Requests to the referenced employee through `time_off_requests.employeeId`; flag employee ID values that do not resolve in that provider namespace.
* **Interpretation:** BambooHR reports employee ID as an identifier in its employee namespace; it is not a universal identity outside BambooHR. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.end`
**End.** End date of the time off. It anchors the time off request on the provider's reported timeline.
* **Enables:** Match end in `time_off_requests.end` to the relevant worker, leave type, unit, and effective date for authorized leave administration.
* **Interpretation:** BambooHR reports end as a timestamp on each time off request; timezone and precision follow this API field, and absence is not an inferred event time. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.id`
**ID.** Unique identifier for the time off request. It provides the reference needed to connect the time off request to the corresponding provider object.
* **Enables:** Match repeated time off request entries on ID in `time_off_requests.id`; collapse only entries that share this declared transform key.
* **Interpretation:** BambooHR reports ID as an identifier in its time off request namespace; it is not a universal identity outside BambooHR. The connector explicitly marks this field as a transform deduplication key. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.name`
**Name.** Name of the employee. It gives the time off request a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each time off request with name from `time_off_requests.name`; distinguish records that share that display name but have different BambooHR identifiers.
* **Interpretation:** BambooHR reports name as display text for each time off request; names are mutable and are not stable identities. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.notes`
**Notes.** Notes from manager and employee. It preserves the nested context needed to interpret the parent time off request.
* **Enables:** Attribute notes in `time_off_requests.notes` to the parent time off request; identify parent records where that nested notes object is absent.
* **Interpretation:** BambooHR reports notes as a nested object on each time off request; optional children may be absent from a valid response. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.notes.employee`
**Employee.** Note from the employee. It supplies the returned employee text needed to understand the BambooHR time off request note in context.
* **Enables:** Search the returned employee text in `time_off_requests.BambooHRTimeOffRequestNotes.employee` and attribute each match to its parent time off request and reported author when available.
* **Interpretation:** BambooHR supplies employee as returned text on each BambooHR time off request note; truncation, formatting, and access boundaries can limit completeness. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.notes.manager`
**Manager.** Note from the manager. It supplies the returned manager text needed to understand the BambooHR time off request note in context.
* **Enables:** Search the returned manager text in `time_off_requests.BambooHRTimeOffRequestNotes.manager` and attribute each match to its parent time off request and reported author when available.
* **Interpretation:** BambooHR supplies manager as returned text on each BambooHR time off request note; truncation, formatting, and access boundaries can limit completeness. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.start`
**Start.** Start date of the time off. It anchors the time off request on the provider's reported timeline.
* **Enables:** Match start in `time_off_requests.start` to the relevant worker, leave type, unit, and effective date for authorized leave administration.
* **Interpretation:** BambooHR reports start as a timestamp on each time off request; timezone and precision follow this API field, and absence is not an inferred event time. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.status`
**Status.** Status details of the request. It preserves the nested context needed to interpret the parent time off request.
* **Enables:** Attribute status in `time_off_requests.status` to the parent time off request; identify parent records where that nested status object is absent.
* **Interpretation:** BambooHR reports status as a nested object on each time off request; optional children may be absent from a valid response. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.status.lastChanged`
**Last Changed.** Timestamp when the status was last changed. It anchors the time off request on the provider's reported timeline.
* **Enables:** Order Time Off Requests by last changed in `time_off_requests.BambooHRTimeOffRequestStatus.lastChanged` and isolate records inside an exact provider reporting window.
* **Interpretation:** BambooHR reports last changed as a timestamp on each BambooHR time off request status; timezone and precision follow this API field, and absence is not an inferred event time. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.status.lastChangedByUserId`
**Last Changed By User ID.** Identifier of the user who last changed the status. It provides the reference needed to connect the time off request to the corresponding provider object.
* **Enables:** Connect each BambooHR time off request status in Time Off Requests to the referenced last changed by user through `time_off_requests.BambooHRTimeOffRequestStatus.lastChangedByUserId`; flag last changed by user ID values that do not resolve in that provider namespace.
* **Interpretation:** BambooHR reports last changed by user ID as an identifier in its last changed by user namespace; it is not a universal identity outside BambooHR. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.status.status`
**Status.** Current status of the request. It distinguishes the provider-defined status state or classification for the BambooHR time off request status.
* **Enables:** Segment BambooHR time off request status entries in Time Off Requests by status in `time_off_requests.BambooHRTimeOffRequestStatus.status`; compare counts only within the same BambooHR taxonomy.
* **Interpretation:** BambooHR reports status as a label from its own taxonomy on each BambooHR time off request status; preserve unknown labels rather than mapping them by assumption. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.type`
**Type.** Type of time off requested. It preserves the nested context needed to interpret the parent time off request.
* **Enables:** Attribute type in `time_off_requests.type` to the parent time off request; identify parent records where that nested type object is absent.
* **Interpretation:** BambooHR reports type as a nested object on each time off request; optional children may be absent from a valid response. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.type.id`
**ID.** Identifier for the time off type. It provides the reference needed to connect the time off request to the corresponding provider object.
* **Enables:** Connect each BambooHR time off request type in Time Off Requests to the referenced BambooHR time off request type through `time_off_requests.BambooHRTimeOffRequestType.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** BambooHR reports ID as an identifier in its BambooHR time off request type namespace; it is not a universal identity outside BambooHR. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `time_off_requests.type.name`
**Name.** Name of the time off type. It gives the BambooHR time off request type a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each BambooHR time off request type with name from `time_off_requests.BambooHRTimeOffRequestType.name`; distinguish records that share that display name but have different BambooHR identifiers.
* **Interpretation:** BambooHR reports name as display text for each BambooHR time off request type; names are mutable and are not stable identities. This sensitive workforce attribute is for authorized leave administration only and must not be used for health or performance inference.
Developer identifier: `timesheets`
**Timesheets.** Time tracking timesheet entries.
* **Enables:** Reconcile reported work intervals to an employee, date, and approved timesheet entry.
* **Scope:** Reads the records selected by BambooHR's `/v1/time_tracking/timesheet_entries` operation as a changelog stream using incremental synchronization. This stream is opt-in. Visibility follows the BambooHR API user's field-level access, so restricted employee attributes may be absent. Use is limited to authorized workforce time-entry reconciliation; recorded hours are not a Parable judgment about employee performance. This stream supplies no reliable deletion signal.
Developer identifier: `timesheets.approved`
**Approved.** Whether the entry has been approved. It distinguishes the provider-defined approved state or classification for the timesheet.
* **Enables:** Filter Timesheets by whether the entry has been approved in `timesheets.approved`; count true, false, and missing results separately.
* **Interpretation:** BambooHR reports the entry has been approved as a boolean on each timesheet; a missing field is unknown, not false.
Developer identifier: `timesheets.approvedAt`
**Approved At.** Timestamp when the entry was approved. Null when the entry is still pending. It anchors the timesheet on the provider's reported timeline.
* **Enables:** Order Timesheets by approved at in `timesheets.approvedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** BambooHR reports approved at as a timestamp on each timesheet; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `timesheets.approvedBy`
**Approved By.** Identifier of the approving user. It identifies the related provider object that gives the timesheet its parent, owner, or container context.
* **Enables:** Connect each timesheet to the related approved by in `timesheets.approvedBy` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** BambooHR reports approved by as relationship context on each timesheet; resolve it in the named provider namespace rather than by display text alone.
Developer identifier: `timesheets.date`
**Date.** Date of the timesheet entry. It anchors the timesheet on the provider's reported timeline.
* **Enables:** Order Timesheets by date in `timesheets.date` and isolate records inside an exact provider reporting window.
* **Interpretation:** BambooHR reports date as a calendar date on each timesheet; its grain is one day and no time of day should be inferred. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `timesheets.employeeId`
**Employee ID.** Identifier of the employee. It provides the reference needed to connect the timesheet to the corresponding provider object.
* **Enables:** Connect each timesheet in Timesheets to the referenced employee through `timesheets.employeeId`; flag employee ID values that do not resolve in that provider namespace.
* **Interpretation:** BambooHR reports employee ID as an identifier in its employee namespace; it is not a universal identity outside BambooHR.
Developer identifier: `timesheets.end`
**End.** End time of the entry. It anchors the timesheet on the provider's reported timeline.
* **Enables:** Filter Timesheets by end in `timesheets.end`; pair that boundary with the corresponding start before measuring elapsed time.
* **Interpretation:** BambooHR reports end as a timestamp on each timesheet; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `timesheets.hours`
**Hours.** Number of hours tracked. It supplies the hours measure for the timesheet at the provider's declared unit and grain.
* **Enables:** Measure hours through `timesheets.hours` for each timesheet and compare only values with the same unit and record grain.
* **Interpretation:** BambooHR reports hours as a measure on each timesheet; compare only records with the same unit and aggregation grain.
Developer identifier: `timesheets.id`
**ID.** Unique identifier for the timesheet entry. It provides the reference needed to connect the timesheet to the corresponding provider object.
* **Enables:** Match repeated timesheet entries on ID in `timesheets.id`; collapse only entries that share this declared transform key.
* **Interpretation:** BambooHR reports ID as an identifier in its timesheet namespace; it is not a universal identity outside BambooHR. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `timesheets.note`
**Note.** Note attached to the timesheet entry. It supplies the returned note text needed to understand the timesheet in context.
* **Enables:** Search the returned note text in `timesheets.note` and attribute each match to its parent timesheet and reported author when available.
* **Interpretation:** BambooHR supplies note as returned text on each timesheet; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `timesheets.projectId`
**Project ID.** Identifier of the associated project. It provides the reference needed to connect the timesheet to the corresponding provider object.
* **Enables:** Connect each timesheet in Timesheets to the referenced project through `timesheets.projectId`; flag project ID values that do not resolve in that provider namespace.
* **Interpretation:** BambooHR reports project ID as an identifier in its project namespace; it is not a universal identity outside BambooHR.
Developer identifier: `timesheets.projectInfo`
**Project Info.** Project / task assignment for this timesheet entry, when project tracking is enabled. It preserves the nested context needed to interpret the parent timesheet.
* **Enables:** Attribute project info in `timesheets.projectInfo` to the parent timesheet; identify parent records where that nested project info object is absent.
* **Interpretation:** BambooHR reports project info as a nested object on each timesheet; optional children may be absent from a valid response.
Developer identifier: `timesheets.projectInfo.project`
**Project.** Project the time was logged against. It preserves the nested context needed to interpret the parent timesheet.
* **Enables:** Attribute project in `timesheets.BambooHRTimesheetProjectInfo.project` to the parent timesheet; identify parent records where that nested project object is absent.
* **Interpretation:** BambooHR reports project as a nested object on each BambooHR timesheet project info; optional children may be absent from a valid response.
Developer identifier: `timesheets.projectInfo.project.id`
**ID.** Identifier of the project. It provides the reference needed to connect the timesheet to the corresponding provider object.
* **Enables:** Connect each BambooHR timesheet project in Timesheets to the referenced BambooHR timesheet project through `timesheets.BambooHRTimesheetProject.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** BambooHR reports ID as an identifier in its BambooHR timesheet project namespace; it is not a universal identity outside BambooHR.
Developer identifier: `timesheets.projectInfo.project.name`
**Name.** Display name of the project. It gives the BambooHR timesheet project a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each BambooHR timesheet project with name from `timesheets.BambooHRTimesheetProject.name`; distinguish records that share that display name but have different BambooHR identifiers.
* **Interpretation:** BambooHR reports name as display text for each BambooHR timesheet project; names are mutable and are not stable identities.
Developer identifier: `timesheets.projectInfo.task`
**Task.** Task or sub-activity within the project. It preserves the nested context needed to interpret the parent timesheet.
* **Enables:** Attribute task in `timesheets.BambooHRTimesheetProjectInfo.task` to the parent timesheet; identify parent records where that nested task object is absent.
* **Interpretation:** BambooHR reports task as a nested object on each BambooHR timesheet project info; optional children may be absent from a valid response.
Developer identifier: `timesheets.projectInfo.task.id`
**ID.** Identifier of the task. It provides the reference needed to connect the timesheet to the corresponding provider object.
* **Enables:** Connect each BambooHR timesheet task in Timesheets to the referenced BambooHR timesheet task through `timesheets.BambooHRTimesheetTask.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** BambooHR reports ID as an identifier in its BambooHR timesheet task namespace; it is not a universal identity outside BambooHR.
Developer identifier: `timesheets.projectInfo.task.name`
**Name.** Display name of the task. It gives the BambooHR timesheet task a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each BambooHR timesheet task with name from `timesheets.BambooHRTimesheetTask.name`; distinguish records that share that display name but have different BambooHR identifiers.
* **Interpretation:** BambooHR reports name as display text for each BambooHR timesheet task; names are mutable and are not stable identities.
Developer identifier: `timesheets.start`
**Start.** Start time of the entry. It anchors the timesheet on the provider's reported timeline.
* **Enables:** Filter Timesheets by start in `timesheets.start`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** BambooHR reports start as a timestamp on each timesheet; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `timesheets.taskId`
**Task ID.** Identifier of the associated task. It provides the reference needed to connect the timesheet to the corresponding provider object.
* **Enables:** Connect each timesheet in Timesheets to the referenced task through `timesheets.taskId`; flag task ID values that do not resolve in that provider namespace.
* **Interpretation:** BambooHR reports task ID as an identifier in its task namespace; it is not a universal identity outside BambooHR.
Developer identifier: `timesheets.timezone`
**Timezone.** IANA timezone identifier in which the entry was recorded. It is needed to interpret companion dates and times for the timesheet in the provider's intended zone.
* **Enables:** Apply the zone in `timesheets.timezone` when converting the timesheet's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** BambooHR reports timezone as a timezone identifier for each timesheet; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `timesheets.type`
**Type.** Type of timesheet entry. It distinguishes the provider-defined type state or classification for the timesheet.
* **Enables:** Segment timesheet entries in Timesheets by type in `timesheets.type`; compare counts only within the same BambooHR taxonomy.
* **Interpretation:** BambooHR reports type as a label from its own taxonomy on each timesheet; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `users`
**Users.** Employee directory listing all employees.
* **Enables:** Reconcile BambooHR employee identifiers, contact details, department, job title, manager, and employment status with the authorized workforce directory.
* **Scope:** Reads the records selected by BambooHR's `/v1/employees/directory` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the BambooHR API user's field-level access, so restricted employee attributes may be absent. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `users.canUploadPhoto`
**Can Upload Photo.** Whether employee can upload a photo (1 = yes, 0 = no). It distinguishes the provider-defined can upload photo state or classification for the user.
* **Enables:** Filter Users by the exact BambooHR-defined can upload photo in `users.canUploadPhoto` and preserve unknown values as distinct categories.
* **Interpretation:** BambooHR supplies can upload photo from its own taxonomy on each user; preserve unknown and newly introduced labels.
Developer identifier: `users.department`
**Department.** Department the employee belongs to. It identifies the related provider object that gives the user its parent, owner, or container context.
* **Enables:** Connect each user to the related department in `users.department` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** BambooHR reports department as relationship context on each user; resolve it in the named provider namespace rather than by display text alone.
Developer identifier: `users.displayName`
**Display Name.** Full display name of the employee. It distinguishes the provider-defined display name state or classification for the user.
* **Enables:** Label each user with display name from `users.displayName`; distinguish records that share that display name but have different BambooHR identifiers.
* **Interpretation:** BambooHR reports display name as display text for each user; names are mutable and are not stable identities. A connector directive maps this field to a person's display name.
Developer identifier: `users.division`
**Division.** Division the employee belongs to. It identifies the related provider object that gives the user its parent, owner, or container context.
* **Enables:** Connect each user to the related division in `users.division` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** BambooHR reports division as relationship context on each user; resolve it in the named provider namespace rather than by display text alone.
Developer identifier: `users.firstName`
**First Name.** First name of the employee. It gives the user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each user with first name from `users.firstName`; distinguish records that share that display name but have different BambooHR identifiers.
* **Interpretation:** BambooHR reports first name as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.id`
**ID.** Unique employee identifier. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Match repeated user entries on ID in `users.id`; collapse only entries that share this declared transform key.
* **Interpretation:** BambooHR reports ID as an identifier in its user namespace; it is not a universal identity outside BambooHR. The connector explicitly marks this field as a transform deduplication key. A connector directive maps this field to account identity.
Developer identifier: `users.jobTitle`
**Job Title.** Job title of the employee. It supplies the job title profile facet used to reconcile or attribute the user.
* **Enables:** Label each user with job title from `users.jobTitle`; distinguish records that share that display name but have different BambooHR identifiers.
* **Interpretation:** BambooHR reports job title as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.lastName`
**Last Name.** Last name of the employee. It gives the user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each user with last name from `users.lastName`; distinguish records that share that display name but have different BambooHR identifiers.
* **Interpretation:** BambooHR reports last name as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.linkedIn`
**Linked In.** LinkedIn profile URL. It locates the provider resource or path associated with the user.
* **Enables:** Resolve the user's provider resource or path through `users.linkedIn`; verify access separately and do not infer that linked content was ingested.
* **Interpretation:** BambooHR returns linked in as a resource locator or path for each user; access can expire or depend on viewer permissions, and linked content is not implied.
Developer identifier: `users.location`
**Location.** Office location of the employee. It supplies the provider-reported address or location facet for the user, not a residency determination.
* **Enables:** Group Users by location in `users.location` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** BambooHR reports location as a user, device, request, or resource location attribute on each user; it does not establish where data is stored or processed.
Developer identifier: `users.mobilePhone`
**Mobile Phone.** Mobile phone number. It supplies the mobile phone profile facet used to reconcile or attribute the user.
* **Enables:** Reconcile the user's mobile phone in `users.mobilePhone` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** BambooHR reports mobile phone as a mutable profile or directory attribute on each user; it may be absent, shared, or non-unique.
Developer identifier: `users.photoUploaded`
**Photo Uploaded.** Whether employee has uploaded a photo. It distinguishes the provider-defined photo uploaded state or classification for the user.
* **Enables:** Filter Users by whether employee has uploaded a photo in `users.photoUploaded`; count true, false, and missing results separately.
* **Interpretation:** BambooHR reports employee has uploaded a photo as a boolean on each user; a missing field is unknown, not false.
Developer identifier: `users.photoUrl`
**Photo URL.** URL to the employee's photo. It locates the provider resource or path associated with the user.
* **Enables:** Associate each user with the resource identified by photo URL in `users.photoUrl`; verify the link resolves to the expected BambooHR object.
* **Interpretation:** BambooHR reports photo URL as a resource locator for each user; access still depends on viewer permissions and the URL may expire or change. A connector directive maps this field to the person's identity photo.
Developer identifier: `users.preferredName`
**Preferred Name.** Preferred name or nickname. It gives the user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each user with preferred name from `users.preferredName`; distinguish records that share that display name but have different BambooHR identifiers.
* **Interpretation:** BambooHR reports preferred name as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.pronouns`
**Pronouns.** Preferred pronouns. It supplies the pronouns profile facet used to reconcile or attribute the user.
* **Enables:** Reconcile the user's pronouns in `users.pronouns` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** BambooHR reports pronouns as a mutable profile or directory attribute on each user; it may be absent, shared, or non-unique.
Developer identifier: `users.supervisor`
**Supervisor.** Name of the employee's supervisor. It identifies the related provider object that gives the user its parent, owner, or container context.
* **Enables:** Connect each user to the related supervisor in `users.supervisor` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** BambooHR reports supervisor as relationship context on each user; resolve it in the named provider namespace rather than by display text alone.
Developer identifier: `users.workEmail`
**Work Email.** Work email address. It supplies the provider-reported address or location facet for the user, not a residency determination.
* **Enables:** Attribute each user to a person or account by the exact work email in `users.workEmail`; identify addresses that do not match the BambooHR directory.
* **Interpretation:** BambooHR reports work email as an address on each user; aliases, casing, and unverified addresses can prevent a one-to-one person match. A connector directive maps this field to a person's email identity.
Developer identifier: `users.workPhone`
**Work Phone.** Work phone number. It supplies the work phone profile facet used to reconcile or attribute the user.
* **Enables:** Reconcile the user's work phone in `users.workPhone` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** BambooHR reports work phone as a mutable profile or directory attribute on each user; it may be absent, shared, or non-unique.
Developer identifier: `users.workPhoneExtension`
**Work Phone Extension.** Work phone extension. It supplies the work phone extension profile facet used to reconcile or attribute the user.
* **Enables:** Reconcile the user's work phone extension in `users.workPhoneExtension` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** BambooHR reports work phone extension as a mutable profile or directory attribute on each user; it may be absent, shared, or non-unique.
| Error | Meaning | Solution |
| - | - | - |
| `401 Unauthorized` | Invalid API key | Verify key is correct |
| `403 Forbidden` | Insufficient permissions | Ensure admin access level |
| `404 Not Found` | Wrong subdomain | Check subdomain in URL |
**[BambooHR API](https://documentation.bamboohr.com/reference)** — Official API documentation
# Claude Admin
Source: https://docs.parable.work/plugins/provider-plugins/claude
Sync organizational data and usage analytics from the Anthropic Claude Admin API
Sync organizational data and usage analytics from the Anthropic Claude Admin API.
Connect Parable to the Anthropic **Admin API** to sync organization members, workspaces, API keys, invites, workspace membership, and daily usage/cost reports.
This Provider is separate from **Claude Compliance**, which uses a Compliance Access Key for audit and eDiscovery data.
#### Organization data
Users, workspaces, workspace members, invites, and API key inventory
#### Usage & cost
Daily token usage and cost buckets for FinOps reporting
By default, Parable ingests:
| Data | Admin API area |
| - | - |
| Organization users | `/v1/organizations/users` |
| Workspaces | `/v1/organizations/workspaces` |
| Workspace members | `/v1/organizations/workspaces/{id}/members` |
| API keys (metadata) | `/v1/organizations/api_keys` |
| Pending invites | `/v1/organizations/invites` |
| Daily message usage | `/v1/organizations/usage_report/messages` (grouped by workspace, API key, and model) |
| Daily cost (USD) | `/v1/organizations/cost_report` (grouped by workspace and description) |
| Per-user Claude Code analytics | `/v1/organizations/usage_report/claude_code` |
For compliance audit logs and chat/project content, use the **Claude Compliance** Provider instead.
* [Admin API](https://platform.claude.com/docs/en/manage-claude/admin-api)
* [Usage and Cost API](https://platform.claude.com/docs/en/build-with-claude/usage-cost-api)
* [Compliance API access (key types comparison)](https://platform.claude.com/docs/en/manage-claude/compliance-api-access)
## Data streams
This Provider Plugin defines 8 data streams.
| Stream | Description | Sync |
| - | - | - |
| `users` | Organization users from Anthropic Admin API | full |
| `workspaces` | Organization workspaces from Anthropic Admin API | full |
| `api_keys` | Organization API keys from Anthropic Admin API | full |
| `invites` | Organization invites from Anthropic Admin API | full |
| `workspace_members` | Members of each workspace from Anthropic Admin API | full |
| `usage_report` | Daily usage report (message token counts) from Anthropic Admin API. Default group\_by\[] is workspace\_id, api\_key\_id, and model. Omits speed because that dimension requires the anthropic-beta fast-mode-2026-02-01 header. | incremental |
| `cost_report` | Daily cost report (USD cents) from Anthropic Admin API | incremental |
| `claude_code_analytics` | Per-user daily Claude Code analytics (tokens, cost, productivity) from Anthropic Admin API | incremental |
### Claude Admin
#### What You'll Need
| Credential | What it is |
| - | - |
| **Admin API Key** | Organization admin key from Claude Console (prefix `sk-ant-admin01-`) |
> **Info:** **Setup access in Anthropic Claude Console.** These steps require **organization admin**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Anthropic Claude Console administrator.
* A Claude **organization** (Admin API is unavailable for individual accounts). Set up your organization at Console > Settings > Organization if needed.
* **Admin API Key** access in [Claude Console](https://console.anthropic.com) (not the standard API keys page).
> **Info:** **Claude Platform on AWS:** Most Admin API endpoints are unavailable on Claude Platform on AWS except workspace management. Usage/cost reporting and organization member endpoints may not work in that deployment model.
#### Step 1: Open Admin keys in Claude Console
1. Sign in to [console.anthropic.com](https://console.anthropic.com) as an **organization admin**.
2. Open **Settings > Admin keys** (direct link: [console.anthropic.com/settings/admin-keys](https://console.anthropic.com/settings/admin-keys)).
#### Step 2: Create an Admin API Key
1. Click **Create key** (or **Create Admin Key**).
2. Enter a descriptive name, for example `Parable Platform`.
3. Copy the key immediately. It is shown only once.
> **Warning:** **Copy your Admin API Key now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
> **Warning:** Use an **Admin API Key** (`sk-ant-admin01-...`) from **Settings > Admin keys**. Do **not** use a standard Claude API key from **Settings > API keys** (`sk-ant-api03-...`) — that key is for Messages API calls and will not authenticate to the Admin API.
#### Step 3: Connect in Parable
1. In Parable, open **Platform → Providers** and choose the Provider to add.
2. Select **Anthropic > Claude Admin**.
3. Paste your Admin API Key.
4. Save and run **Test connection**.
Developer identifier: `api_keys`
**API Keys.** Organization API keys from Anthropic Admin API.
* **Enables:** Match each Anthropic API key record to its creator, workspace, status, and lifecycle timestamps without exposing secret key material.
* **Scope:** Reads the records selected by Claude Admin's `/v1/organizations/api_keys` operation as a snapshot stream using full synchronization. Visibility is limited to the Anthropic organization and Admin API privileges granted to the credential. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `api_keys.created_at`
**Created At.** Timestamp when the API key was created. It anchors the API key on the provider's reported timeline.
* **Enables:** Order API Keys by created at in `api_keys.created_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Admin reports created at as a timestamp on each API key; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `api_keys.created_by`
**Created By.** User or entity that created this API key. It preserves the nested context needed to interpret the parent API key.
* **Enables:** Attribute created by in `api_keys.created_by` to the parent API key; identify parent records where that nested created by object is absent.
* **Interpretation:** Claude Admin reports created by as a nested object on each API key; optional children may be absent from a valid response.
Developer identifier: `api_keys.created_by.id`
**ID.** Creator's unique identifier. It provides the reference needed to connect the API key to the corresponding provider object.
* **Enables:** Connect each Anthropic API key created by in API Keys to the referenced Anthropic API key created by through `api_keys.AnthropicApiKeyCreatedBy.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Admin reports ID as an identifier in its Anthropic API key created by namespace; it is not a universal identity outside Claude Admin.
Developer identifier: `api_keys.created_by.type`
**Type.** Creator type (e.g. 'user'). It identifies the related provider object that gives the Anthropic API key created by its parent, owner, or container context.
* **Enables:** Segment Anthropic API key created by entries in API Keys by type in `api_keys.AnthropicApiKeyCreatedBy.type`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports type as a label from its own taxonomy on each Anthropic API key created by; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `api_keys.expires_at`
**Expires At.** Timestamp when the API key expires, if applicable. It anchors the API key on the provider's reported timeline.
* **Enables:** Order API Keys by expires at in `api_keys.expires_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Admin reports expires at as a timestamp on each API key; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `api_keys.id`
**ID.** Unique API key identifier. It provides the reference needed to connect the API key to the corresponding provider object.
* **Enables:** Match repeated API key entries on ID in `api_keys.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Admin reports ID as an identifier in its API key namespace; it is not a universal identity outside Claude Admin. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `api_keys.name`
**Name.** Human-readable name for the API key. It gives the API key a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each API key with name from `api_keys.name`; distinguish records that share that display name but have different Claude Admin identifiers.
* **Interpretation:** Claude Admin reports name as display text for each API key; names are mutable and are not stable identities.
Developer identifier: `api_keys.partial_key_hint`
**Partial Key Hint.** Partial hint of the API key value (e.g. 'sk-ant-...1234'). It provides the reference needed to connect the API key to the corresponding provider object.
* **Enables:** Connect each API key in API Keys to the referenced partial hint through `api_keys.partial_key_hint`; flag partial key hint values that do not resolve in that provider namespace.
* **Interpretation:** Claude Admin reports partial key hint as an identifier in its partial hint namespace; it is not a universal identity outside Claude Admin.
Developer identifier: `api_keys.status`
**Status.** Key status (e.g. 'active', 'inactive', 'archived'). It distinguishes the provider-defined status state or classification for the API key.
* **Enables:** Segment API key entries in API Keys by status in `api_keys.status`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports status as a label from its own taxonomy on each API key; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `api_keys.type`
**Type.** Object type (always 'api\_key'). It distinguishes the provider-defined type state or classification for the API key.
* **Enables:** Segment API key entries in API Keys by type in `api_keys.type`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports type as a label from its own taxonomy on each API key; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `api_keys.workspace_id`
**Workspace ID.** Workspace this key belongs to. It provides the reference needed to connect the API key to the corresponding provider object.
* **Enables:** Connect each API key in API Keys to the referenced workspace through `api_keys.workspace_id`; flag workspace ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Admin reports workspace ID as an identifier in its workspace namespace; it is not a universal identity outside Claude Admin.
Developer identifier: `claude_code_analytics`
**Claude Code Analytics.** Daily per-user Claude Code activity, token, and estimated-cost records from the Anthropic Admin API.
* **Enables:** Measure provider-reported Claude Code activity, token counts, and estimated costs by actor-day and model.
* **Scope:** Reads the records selected by Claude Admin's `/v1/organizations/usage_report/claude_code` operation as an event stream using incremental synchronization. Visibility is limited to the Anthropic organization and Admin API privileges granted to the credential. Estimated costs are decimal currency-lowest-unit estimates—USD may be fractional cents—and are not invoices. Activity measures are provider reports, not Parable judgments about individual performance. This stream supplies no reliable deletion signal.
Developer identifier: `claude_code_analytics.actor`
**Actor.** The structured actor details attached to each Claude Code analytics record in Claude Code Analytics. It preserves the nested context needed to interpret the parent Claude Code analytics record.
* **Enables:** Attribute actor in `claude_code_analytics.actor` to the parent Claude Code analytics record; identify parent records where that nested actor object is absent.
* **Interpretation:** Claude Admin reports actor as a nested object on each Claude Code analytics record; optional children may be absent from a valid response.
Developer identifier: `claude_code_analytics.actor.api_key_name`
**API Key Name.** API key name when actor type is api\_actor. It provides the reference needed to connect the Claude Code analytics record to the corresponding provider object.
* **Enables:** Connect each Anthropic claude code actor in Claude Code Analytics to the referenced API name through `claude_code_analytics.AnthropicClaudeCodeActor.api_key_name`; flag API key name values that do not resolve in that provider namespace.
* **Interpretation:** Claude Admin reports API key name as an identifier in its API name namespace; it is not a universal identity outside Claude Admin.
Developer identifier: `claude_code_analytics.actor.email_address`
**Email Address.** User email when actor type is user\_actor. It supplies the provider-reported address or location facet for the Anthropic Claude Code actor, not a residency determination.
* **Enables:** Attribute each Anthropic claude code actor to a person or account by the exact email address in `claude_code_analytics.AnthropicClaudeCodeActor.email_address`; identify addresses that do not match the Claude Admin directory.
* **Interpretation:** Claude Admin reports email address as an address on each Anthropic claude code actor; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `claude_code_analytics.actor.type`
**Type.** Actor type: user\_actor or api\_actor. It distinguishes the provider-defined type state or classification for the Anthropic Claude Code actor.
* **Enables:** Segment Anthropic claude code actor entries in Claude Code Analytics by type in `claude_code_analytics.AnthropicClaudeCodeActor.type`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports type as a label from its own taxonomy on each Anthropic claude code actor; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `claude_code_analytics.claude_code_analytics_row_id`
**Claude Code Analytics Row ID.** Synthetic primary key for actor-day uniqueness. It provides the reference needed to connect the Claude Code analytics record to the corresponding provider object.
* **Enables:** Match repeated Claude Code analytics record entries on claude code analytics row ID in `claude_code_analytics.claude_code_analytics_row_id`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Admin reports claude code analytics row ID as an identifier in its claude code analytics row namespace; it is not a universal identity outside Claude Admin. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `claude_code_analytics.core_metrics`
**Core Metrics.** The structured core metrics details attached to each Claude Code analytics record in Claude Code Analytics. It preserves the nested context needed to interpret the parent Claude Code analytics record.
* **Enables:** Attribute core metrics in `claude_code_analytics.core_metrics` to the parent Claude Code analytics record; identify parent records where that nested core metrics object is absent.
* **Interpretation:** Claude Admin reports core metrics as a nested object on each Claude Code analytics record; optional children may be absent from a valid response.
Developer identifier: `claude_code_analytics.core_metrics.commits_by_claude_code`
**Commits By Claude Code.** Git commits created through Claude Code. It supplies the commits by Claude Code measure for the Anthropic Claude Code core metric at the provider's declared unit and grain.
* **Enables:** Measure commits by Claude Code through `claude_code_analytics.AnthropicClaudeCodeCoreMetrics.commits_by_claude_code` for each Anthropic Claude Code core metric and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports commits by Claude Code as a measure on each Anthropic Claude Code core metric; compare only records with the same unit and aggregation grain.
Developer identifier: `claude_code_analytics.core_metrics.lines_of_code`
**Lines Of Code.** The structured lines of code details attached to each Anthropic claude code core metrics in Claude Code Analytics. It preserves the nested context needed to interpret the parent Claude Code analytics record.
* **Enables:** Attribute lines of code in `claude_code_analytics.AnthropicClaudeCodeCoreMetrics.lines_of_code` to the parent Claude Code analytics record; identify parent records where that nested lines of code object is absent.
* **Interpretation:** Claude Admin reports lines of code as a nested object on each Anthropic claude code core metric; optional children may be absent from a valid response.
Developer identifier: `claude_code_analytics.core_metrics.lines_of_code.added`
**Added.** Lines of code added. It supplies the added measure for the Anthropic Claude Code lines of code at the provider's declared unit and grain.
* **Enables:** Measure added through `claude_code_analytics.AnthropicClaudeCodeLinesOfCode.added` for each Anthropic Claude Code lines of code and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports added as a measure on each Anthropic Claude Code lines of code; compare only records with the same unit and aggregation grain.
Developer identifier: `claude_code_analytics.core_metrics.lines_of_code.removed`
**Removed.** Lines of code removed. It supplies the removed measure for the Anthropic Claude Code lines of code at the provider's declared unit and grain.
* **Enables:** Measure removed through `claude_code_analytics.AnthropicClaudeCodeLinesOfCode.removed` for each Anthropic Claude Code lines of code and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports removed as a measure on each Anthropic Claude Code lines of code; compare only records with the same unit and aggregation grain.
Developer identifier: `claude_code_analytics.core_metrics.num_sessions`
**Num Sessions.** Number of distinct Claude Code sessions. It supplies the num sessions measure for the Anthropic Claude Code core metric at the provider's declared unit and grain.
* **Enables:** Measure num sessions through `claude_code_analytics.AnthropicClaudeCodeCoreMetrics.num_sessions` for each Anthropic Claude Code core metric and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports num sessions as a measure on each Anthropic Claude Code core metric; compare only records with the same unit and aggregation grain.
Developer identifier: `claude_code_analytics.core_metrics.pull_requests_by_claude_code`
**Pull Requests By Claude Code.** Pull requests created through Claude Code. It supplies the pull requests by Claude Code measure for the Anthropic Claude Code core metric at the provider's declared unit and grain.
* **Enables:** Measure pull requests by Claude Code through `claude_code_analytics.AnthropicClaudeCodeCoreMetrics.pull_requests_by_claude_code` for each Anthropic Claude Code core metric and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports pull requests by Claude Code as a measure on each Anthropic Claude Code core metric; compare only records with the same unit and aggregation grain.
Developer identifier: `claude_code_analytics.customer_type`
**Customer Type.** Customer account type (API or subscription). It distinguishes the provider-defined customer type state or classification for the Claude Code analytic.
* **Enables:** Segment Claude Code analytics record entries in Claude Code Analytics by customer type in `claude_code_analytics.customer_type`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports customer type as a label from its own taxonomy on each Claude Code analytics record; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `claude_code_analytics.date`
**Date.** UTC day for this analytics record. It anchors the Claude Code analytics record on the provider's reported timeline.
* **Enables:** Order Claude Code Analytics by date in `claude_code_analytics.date` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Admin reports date as a timestamp on each Claude Code analytics record; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `claude_code_analytics.model_breakdown`
**Model Breakdown.** Per-model token usage and estimated cost for this actor-day. It preserves the nested context needed to interpret the parent Claude Code analytics record.
* **Enables:** Measure each returned Anthropic claude code model breakdown in `claude_code_analytics.model_breakdown` at its element and time grain; compare values only when Claude Admin reports the same unit and aggregation.
* **Interpretation:** Claude Admin returns model breakdown as an array of Anthropic claude code model breakdown entries on each Claude Code analytics record; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `claude_code_analytics.model_breakdown.estimated_cost`
**Estimated Cost.** The structured estimated cost details attached to each Anthropic claude code model breakdown in Claude Code Analytics. It preserves the nested context needed to interpret the parent Claude Code analytics record.
* **Enables:** Attribute estimated cost in `claude_code_analytics.AnthropicClaudeCodeModelBreakdown.estimated_cost` to the parent Claude Code analytics record; identify parent records where that nested estimated cost object is absent.
* **Interpretation:** Claude Admin reports estimated cost as a nested object on each Anthropic claude code model breakdown; optional children may be absent from a valid response. Monetary amounts are decimal currency-lowest-unit estimates; USD may be fractional cents, and these values are not invoices or integer-cent totals.
Developer identifier: `claude_code_analytics.model_breakdown.estimated_cost.amount`
**Amount.** Estimated cost amount as a decimal in the currency lowest unit; USD values can be fractional cents. This is an estimate, not an invoice amount or integer-cent value. It supplies the amount measure for the Anthropic Claude Code estimated cost at the provider's declared unit and grain.
* **Enables:** Measure amount through `claude_code_analytics.AnthropicClaudeCodeEstimatedCost.amount` for each Anthropic Claude Code estimated cost and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports amount as a measure on each Anthropic Claude Code estimated cost; compare only records with the same unit and aggregation grain. Monetary amounts are decimal currency-lowest-unit estimates; USD may be fractional cents, and these values are not invoices or integer-cent totals.
Developer identifier: `claude_code_analytics.model_breakdown.estimated_cost.currency`
**Currency.** Currency code (USD). It distinguishes the provider-defined currency state or classification for the Anthropic Claude Code estimated cost.
* **Enables:** Filter Claude Code Analytics by the exact Claude Admin-defined currency in `claude_code_analytics.AnthropicClaudeCodeEstimatedCost.currency` and preserve unknown values as distinct categories.
* **Interpretation:** Claude Admin supplies currency from its own taxonomy on each Anthropic Claude Code estimated cost; preserve unknown and newly introduced labels. Monetary amounts are decimal currency-lowest-unit estimates; USD may be fractional cents, and these values are not invoices or integer-cent totals.
Developer identifier: `claude_code_analytics.model_breakdown.model`
**Model.** Claude model identifier. It identifies the related provider object that gives the Anthropic Claude Code model breakdown its parent, owner, or container context.
* **Enables:** Match repeated Anthropic claude code model breakdown entries on model in `claude_code_analytics.AnthropicClaudeCodeModelBreakdown.model`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Admin reports model on each Anthropic claude code model breakdown; missing and empty values can have different meanings. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `claude_code_analytics.model_breakdown.tokens`
**Tokens.** The structured tokens details attached to each Anthropic claude code model breakdown in Claude Code Analytics. It preserves the nested context needed to interpret the parent Claude Code analytics record.
* **Enables:** Attribute tokens in `claude_code_analytics.AnthropicClaudeCodeModelBreakdown.tokens` to the parent Claude Code analytics record; identify parent records where that nested tokens object is absent.
* **Interpretation:** Claude Admin reports tokens as a nested object on each Anthropic claude code model breakdown; optional children may be absent from a valid response.
Developer identifier: `claude_code_analytics.model_breakdown.tokens.cache_creation`
**Cache Creation.** Cache creation tokens. It supplies the cache creation measure for the Anthropic Claude Code model token at the provider's declared unit and grain.
* **Enables:** Measure cache creation through `claude_code_analytics.AnthropicClaudeCodeModelTokens.cache_creation` for each Anthropic Claude Code model token and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports cache creation as a measure on each Anthropic Claude Code model token; compare only records with the same unit and aggregation grain.
Developer identifier: `claude_code_analytics.model_breakdown.tokens.cache_read`
**Cache Read.** Cache read tokens. It supplies the cache read measure for the Anthropic Claude Code model token at the provider's declared unit and grain.
* **Enables:** Measure cache read through `claude_code_analytics.AnthropicClaudeCodeModelTokens.cache_read` for each Anthropic Claude Code model token and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports cache read as a measure on each Anthropic Claude Code model token; compare only records with the same unit and aggregation grain.
Developer identifier: `claude_code_analytics.model_breakdown.tokens.input`
**Input.** Input tokens. It must be interpreted with the enclosing provider field name, type, or custom schema for the Anthropic Claude Code model token.
* **Enables:** Interpret `claude_code_analytics.AnthropicClaudeCodeModelTokens.input` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Claude Admin reports input under the enclosing custom or typed field contract on each Anthropic Claude Code model token; compare it only with values from the same provider key and type.
Developer identifier: `claude_code_analytics.model_breakdown.tokens.output`
**Output.** Output tokens. It supplies the output measure for the Anthropic Claude Code model token at the provider's declared unit and grain.
* **Enables:** Measure output through `claude_code_analytics.AnthropicClaudeCodeModelTokens.output` for each Anthropic Claude Code model token and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports output as a measure on each Anthropic Claude Code model token; compare only records with the same unit and aggregation grain.
Developer identifier: `claude_code_analytics.organization_id`
**Organization ID.** Organization UUID. It provides the reference needed to connect the Claude Code analytics record to the corresponding provider object.
* **Enables:** Connect each Claude Code analytics record in Claude Code Analytics to the referenced organization through `claude_code_analytics.organization_id`; flag organization ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Admin reports organization ID as an identifier in its organization namespace; it is not a universal identity outside Claude Admin.
Developer identifier: `claude_code_analytics.subscription_type`
**Subscription Type.** Subscription tier or plan type returned by the Claude Code Analytics API. It distinguishes the provider-defined subscription type state or classification for the Claude Code analytic.
* **Enables:** Segment Claude Code analytics record entries in Claude Code Analytics by subscription type in `claude_code_analytics.subscription_type`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports subscription type as a label from its own taxonomy on each Claude Code analytics record; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `claude_code_analytics.terminal_type`
**Terminal Type.** Terminal or environment where Claude Code was used. It distinguishes the provider-defined terminal type state or classification for the Claude Code analytic.
* **Enables:** Segment Claude Code analytics record entries in Claude Code Analytics by terminal type in `claude_code_analytics.terminal_type`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports terminal type as a label from its own taxonomy on each Claude Code analytics record; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `claude_code_analytics.tool_actions`
**Tool Actions.** Tool acceptance and rejection counts by tool type. It preserves the nested context needed to interpret the parent Claude Code analytics record.
* **Enables:** Attribute tool actions in `claude_code_analytics.tool_actions` to the parent Claude Code analytics record; identify parent records where that nested tool actions object is absent.
* **Interpretation:** Claude Admin reports tool actions as a nested object on each Claude Code analytics record; optional children may be absent from a valid response.
Developer identifier: `cost_report`
**Cost Report.** Daily cost report from Anthropic Admin API. Amounts are decimals in the currency lowest unit; USD values can be fractional cents.
* **Enables:** Attribute decimal currency-lowest-unit cost report estimates to their time bucket, workspace, model, and cost type.
* **Scope:** Reads the records selected by Claude Admin's `/v1/organizations/cost_report` operation as a changelog stream using incremental synchronization. Visibility is limited to the Anthropic organization and Admin API privileges granted to the credential. Amounts are decimal currency-lowest-unit report estimates—USD may be fractional cents—and are not invoices or integer-cent totals. This stream supplies no reliable deletion signal.
Developer identifier: `cost_report.ending_at`
**Ending At.** End of the bucket time window. It anchors the cost report on the provider's reported timeline.
* **Enables:** Order Cost Report by ending at in `cost_report.ending_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Admin reports ending at as a timestamp on each cost report; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `cost_report.results`
**Results.** Cost line items for this time bucket, one row per cost result element. It preserves the nested context needed to interpret the parent cost report.
* **Enables:** Measure each returned Anthropic cost result in `cost_report.results` at its element and time grain; compare values only when Claude Admin reports the same unit and aggregation.
* **Interpretation:** Claude Admin returns results as an array of Anthropic cost result entries on each cost report; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `cost_report.results.amount`
**Amount.** Cost report amount as a decimal in the currency lowest unit; USD values can be fractional cents. This is a report amount, not an invoice amount or integer-cent value. It supplies the amount measure for the Anthropic cost result at the provider's declared unit and grain.
* **Enables:** Measure amount through `cost_report.AnthropicCostResult.amount` for each Anthropic cost result and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports amount as a measure on each Anthropic cost result; compare only records with the same unit and aggregation grain. Monetary amounts are decimal currency-lowest-unit estimates; USD may be fractional cents, and these values are not invoices or integer-cent totals.
Developer identifier: `cost_report.results.context_window`
**Context Window.** Context window (0-200k or 200k-1M). Absent when not grouping by description or for non-token costs. It supplies the context window boundary, band, or unit needed to interpret the companion measure.
* **Enables:** Interpret `cost_report.AnthropicCostResult.context_window` with its companion minimum, maximum, interval, or unit before comparing the context window across like-for-like records.
* **Interpretation:** Claude Admin reports context window as a boundary, band, interval, or unit on each Anthropic cost result; it is meaningful only with its companion measure and provider scale.
Developer identifier: `cost_report.results.cost_type`
**Cost Type.** Cost type (tokens, web\_search, code\_execution, session\_usage). Absent when not grouping by description. It supplies the cost type measure for the Anthropic cost result at the provider's declared unit and grain.
* **Enables:** Match repeated Anthropic cost result entries on cost type in `cost_report.AnthropicCostResult.cost_type`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Claude Admin reports cost type as a label from its own taxonomy on each Anthropic cost result; preserve unknown labels rather than mapping them by assumption. Monetary amounts are decimal currency-lowest-unit estimates; USD may be fractional cents, and these values are not invoices or integer-cent totals.
Developer identifier: `cost_report.results.currency`
**Currency.** Currency code for the cost amount. Currently always USD. It distinguishes the provider-defined currency state or classification for the Anthropic cost result.
* **Enables:** Filter Cost Report by the exact Claude Admin-defined currency in `cost_report.AnthropicCostResult.currency` and preserve unknown values as distinct categories.
* **Interpretation:** Claude Admin supplies currency from its own taxonomy on each Anthropic cost result; preserve unknown and newly introduced labels. Monetary amounts are decimal currency-lowest-unit estimates; USD may be fractional cents, and these values are not invoices or integer-cent totals.
Developer identifier: `cost_report.results.description`
**Description.** Human-readable cost item description. Absent when not grouping by description. It defines the content surface available for this cost report.
* **Enables:** Match repeated Anthropic cost result entries on description in `cost_report.AnthropicCostResult.description`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Claude Admin supplies description as text on each Anthropic cost result; referenced files or media are not implied unless explicitly represented.
Developer identifier: `cost_report.results.inference_geo`
**Inference Geo.** Inference geography. Absent when not grouping by inference geo. It supplies the provider-reported address or location facet for the Anthropic cost result, not a residency determination.
* **Enables:** Group Cost Report by inference geo in `cost_report.AnthropicCostResult.inference_geo` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Claude Admin reports inference geo as a user, device, request, or resource location attribute on each Anthropic cost result; it does not establish where data is stored or processed.
Developer identifier: `cost_report.results.model`
**Model.** Model name. Absent when not grouping by description or for non-token costs. It supplies the returned model text needed to understand the Anthropic cost result in context.
* **Enables:** Match repeated Anthropic cost result entries on model in `cost_report.AnthropicCostResult.model`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Claude Admin reports model on each Anthropic cost result; missing and empty values can have different meanings.
Developer identifier: `cost_report.results.service_tier`
**Service Tier.** Service tier (batch or standard). Absent when not grouping by description or for non-token costs. It supplies the returned service tier text needed to understand the Anthropic cost result in context.
* **Enables:** Segment Anthropic cost result entries in Cost Report by service tier in `cost_report.AnthropicCostResult.service_tier`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports service tier as a label from its own taxonomy on each Anthropic cost result; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `cost_report.results.token_type`
**Token Type.** Token type dimension. Absent when not grouping by description or for non-token costs. It supplies the token type measure for the Anthropic cost result at the provider's declared unit and grain.
* **Enables:** Match repeated Anthropic cost result entries on token type in `cost_report.AnthropicCostResult.token_type`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Claude Admin reports token type as a label from its own taxonomy on each Anthropic cost result; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `cost_report.results.workspace_id`
**Workspace ID.** Workspace ID. Absent when not grouping by workspace or for the default workspace. It provides the reference needed to connect the cost report to the corresponding provider object.
* **Enables:** Match repeated Anthropic cost result entries on workspace ID in `cost_report.AnthropicCostResult.workspace_id`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Claude Admin reports workspace ID as an identifier in its workspace namespace; it is not a universal identity outside Claude Admin.
Developer identifier: `cost_report.starting_at`
**Starting At.** Start of the bucket time window. It anchors the cost report on the provider's reported timeline.
* **Enables:** Match repeated cost report entries on starting at in `cost_report.starting_at`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Admin reports starting at as a timestamp on each cost report; timezone and precision follow this API field, and absence is not an inferred event time. The connector explicitly marks this field as a transform deduplication key. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `invites`
**Invites.** Organization invites from Anthropic Admin API.
* **Enables:** Track organization invitations by email, role, status, invitation time, and expiration time.
* **Scope:** Reads the records selected by Claude Admin's `/v1/organizations/invites` operation as a snapshot stream using full synchronization. Visibility is limited to the Anthropic organization and Admin API privileges granted to the credential. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `invites.email`
**Email.** Email address the invite was sent to. It supplies the provider-reported address or location facet for the invite, not a residency determination.
* **Enables:** Attribute each invite to a person or account by the exact email in `invites.email`; identify addresses that do not match the Claude Admin directory.
* **Interpretation:** Claude Admin reports email as an address on each invite; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `invites.expires_at`
**Expires At.** Timestamp when the invite expires. It anchors the invite on the provider's reported timeline.
* **Enables:** Order Invites by expires at in `invites.expires_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Admin reports expires at as a timestamp on each invite; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `invites.id`
**ID.** Unique invite identifier. It provides the reference needed to connect the invite to the corresponding provider object.
* **Enables:** Match repeated invite entries on ID in `invites.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Admin reports ID as an identifier in its invite namespace; it is not a universal identity outside Claude Admin. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `invites.invited_at`
**Invited At.** Timestamp when the invite was sent. It anchors the invite on the provider's reported timeline.
* **Enables:** Order Invites by invited at in `invites.invited_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Admin reports invited at as a timestamp on each invite; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `invites.role`
**Role.** Role assigned to the invite (e.g. admin, developer, user). It distinguishes the provider-defined role state or classification for the invite.
* **Enables:** Segment invite entries in Invites by role in `invites.role`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports role as a label from its own taxonomy on each invite; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `invites.status`
**Status.** Invite status (e.g. 'pending', 'accepted', 'expired'). It distinguishes the provider-defined status state or classification for the invite.
* **Enables:** Segment invite entries in Invites by status in `invites.status`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports status as a label from its own taxonomy on each invite; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `invites.type`
**Type.** Object type (always 'invite'). It distinguishes the provider-defined type state or classification for the invite.
* **Enables:** Segment invite entries in Invites by type in `invites.type`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports type as a label from its own taxonomy on each invite; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `usage_report`
**Usage Report.** Daily usage report (message token counts) from Anthropic Admin API. Default group\_by\[] is workspace\_id, api\_key\_id, and model. Omits speed because that dimension requires the Anthropic-beta fast-mode-2026-02-01 header.
* **Enables:** Measure provider-reported token counts by day, workspace, API key, and model using the configured grouping dimensions.
* **Scope:** Reads the records selected by Claude Admin's `/v1/organizations/usage_report/messages` operation as a changelog stream using incremental synchronization. Visibility is limited to the Anthropic organization and Admin API privileges granted to the credential. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. This stream supplies no reliable deletion signal.
Developer identifier: `usage_report.ending_at`
**Ending At.** End of the bucket time window. It anchors the usage report on the provider's reported timeline.
* **Enables:** Order Usage Report by ending at in `usage_report.ending_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Admin reports ending at as a timestamp on each usage report; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `usage_report.results`
**Results.** Usage line items for this time bucket, one row per workspace, API key, and model combination. It preserves the nested context needed to interpret the parent usage report.
* **Enables:** Measure each returned Anthropic usage result in `usage_report.results` at its element and time grain; compare values only when Claude Admin reports the same unit and aggregation.
* **Interpretation:** Claude Admin returns results as an array of Anthropic usage result entries on each usage report; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `usage_report.results.api_key_id`
**API Key ID.** API key ID. Absent for Anthropic Console usage. It provides the reference needed to connect the usage report to the corresponding provider object.
* **Enables:** Match repeated Anthropic usage result entries on API key ID in `usage_report.AnthropicUsageResult.api_key_id`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Claude Admin reports API key ID as an identifier in its API namespace; it is not a universal identity outside Claude Admin.
Developer identifier: `usage_report.results.cache_creation`
**Cache Creation.** The structured cache creation details attached to each Anthropic usage result in Usage Report. It preserves the nested context needed to interpret the parent usage report.
* **Enables:** Attribute cache creation in `usage_report.AnthropicUsageResult.cache_creation` to the parent usage report; identify parent records where that nested cache creation object is absent.
* **Interpretation:** Claude Admin reports cache creation as a nested object on each Anthropic usage result; optional children may be absent from a valid response.
Developer identifier: `usage_report.results.cache_creation.ephemeral_1h_input_tokens`
**Ephemeral 1h Input Tokens.** Input tokens used to create the 1 hour cache entry. It supplies the ephemeral 1h input tokens measure for the Anthropic usage cache creation at the provider's declared unit and grain.
* **Enables:** Measure ephemeral 1h input tokens through `usage_report.AnthropicUsageCacheCreation.ephemeral_1h_input_tokens` for each Anthropic usage cache creation and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports ephemeral 1h input tokens as a measure on each Anthropic usage cache creation; compare only records with the same unit and aggregation grain.
Developer identifier: `usage_report.results.cache_creation.ephemeral_5m_input_tokens`
**Ephemeral 5m Input Tokens.** Input tokens used to create the 5 minute cache entry. It supplies the ephemeral 5m input tokens measure for the Anthropic usage cache creation at the provider's declared unit and grain.
* **Enables:** Measure ephemeral 5m input tokens through `usage_report.AnthropicUsageCacheCreation.ephemeral_5m_input_tokens` for each Anthropic usage cache creation and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports ephemeral 5m input tokens as a measure on each Anthropic usage cache creation; compare only records with the same unit and aggregation grain.
Developer identifier: `usage_report.results.cache_read_input_tokens`
**Cache Read Input Tokens.** Input tokens read from the cache. It supplies the cache read input tokens measure for the Anthropic usage result at the provider's declared unit and grain.
* **Enables:** Measure cache read input tokens through `usage_report.AnthropicUsageResult.cache_read_input_tokens` for each Anthropic usage result and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports cache read input tokens as a measure on each Anthropic usage result; compare only records with the same unit and aggregation grain.
Developer identifier: `usage_report.results.model`
**Model.** Model used. It distinguishes the provider-defined model state or classification for the Anthropic usage result.
* **Enables:** Match repeated Anthropic usage result entries on model in `usage_report.AnthropicUsageResult.model`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Claude Admin reports model on each Anthropic usage result; missing and empty values can have different meanings.
Developer identifier: `usage_report.results.output_tokens`
**Output Tokens.** Output tokens generated. It supplies the output tokens measure for the Anthropic usage result at the provider's declared unit and grain.
* **Enables:** Measure output tokens through `usage_report.AnthropicUsageResult.output_tokens` for each Anthropic usage result and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports output tokens as a measure on each Anthropic usage result; compare only records with the same unit and aggregation grain.
Developer identifier: `usage_report.results.server_tool_use`
**Server Tool Use.** The structured server tool use details attached to each Anthropic usage result in Usage Report. It preserves the nested context needed to interpret the parent usage report.
* **Enables:** Attribute server tool use in `usage_report.AnthropicUsageResult.server_tool_use` to the parent usage report; identify parent records where that nested server tool use object is absent.
* **Interpretation:** Claude Admin reports server tool use as a nested object on each Anthropic usage result; optional children may be absent from a valid response.
Developer identifier: `usage_report.results.server_tool_use.web_search_requests`
**Web Search Requests.** Number of web search requests made. It supplies the web search requests measure for the Anthropic usage server tool use at the provider's declared unit and grain.
* **Enables:** Measure web search requests through `usage_report.AnthropicUsageServerToolUse.web_search_requests` for each Anthropic usage server tool use and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports web search requests as a measure on each Anthropic usage server tool use; compare only records with the same unit and aggregation grain.
Developer identifier: `usage_report.results.uncached_input_tokens`
**Uncached Input Tokens.** Uncached input tokens processed. It supplies the uncached input tokens measure for the Anthropic usage result at the provider's declared unit and grain.
* **Enables:** Measure uncached input tokens through `usage_report.AnthropicUsageResult.uncached_input_tokens` for each Anthropic usage result and compare only values with the same unit and record grain.
* **Interpretation:** Claude Admin reports uncached input tokens as a measure on each Anthropic usage result; compare only records with the same unit and aggregation grain.
Developer identifier: `usage_report.results.workspace_id`
**Workspace ID.** Workspace ID. Absent for the default workspace. It provides the reference needed to connect the usage report to the corresponding provider object.
* **Enables:** Match repeated Anthropic usage result entries on workspace ID in `usage_report.AnthropicUsageResult.workspace_id`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Claude Admin reports workspace ID as an identifier in its workspace namespace; it is not a universal identity outside Claude Admin.
Developer identifier: `usage_report.starting_at`
**Starting At.** Start of the bucket time window. It anchors the usage report on the provider's reported timeline.
* **Enables:** Match repeated usage report entries on starting at in `usage_report.starting_at`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Admin reports starting at as a timestamp on each usage report; timezone and precision follow this API field, and absence is not an inferred event time. The connector explicitly marks this field as a transform deduplication key. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `users`
**Users.** Organization users from Anthropic Admin API.
* **Enables:** Reconcile Anthropic organization users to email, name, role, lifecycle state, and organization membership dates.
* **Scope:** Reads the records selected by Claude Admin's `/v1/organizations/users` operation as a snapshot stream using full synchronization. Visibility is limited to the Anthropic organization and Admin API privileges granted to the credential. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `users.added_at`
**Added At.** Timestamp when the user was added to the organization. It anchors the user on the provider's reported timeline.
* **Enables:** Order Users by added at in `users.added_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Admin reports added at as a timestamp on each user; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `users.email`
**Email.** User's email address. It supplies the provider-reported address or location facet for the user, not a residency determination.
* **Enables:** Attribute each user to a person or account by the exact email in `users.email`; identify addresses that do not match the Claude Admin directory.
* **Interpretation:** Claude Admin reports email as an address on each user; aliases, casing, and unverified addresses can prevent a one-to-one person match. A connector directive maps this field to a person's email identity.
Developer identifier: `users.id`
**ID.** Unique user identifier. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Match repeated user entries on ID in `users.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Admin reports ID as an identifier in its user namespace; it is not a universal identity outside Claude Admin. The connector explicitly marks this field as a transform deduplication key. A connector directive maps this field to account identity.
Developer identifier: `users.name`
**Name.** User's full name. It gives the user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each user with name from `users.name`; distinguish records that share that display name but have different Claude Admin identifiers.
* **Interpretation:** Claude Admin reports name as display text for each user; names are mutable and are not stable identities. A connector directive maps this field to a person's display name.
Developer identifier: `users.role`
**Role.** User's role in the organization (e.g. admin, developer, user). It distinguishes the provider-defined role state or classification for the user.
* **Enables:** Segment user entries in Users by role in `users.role`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports role as a label from its own taxonomy on each user; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `users.type`
**Type.** Object type (always 'user'). It distinguishes the provider-defined type state or classification for the user.
* **Enables:** Segment user entries in Users by type in `users.type`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports type as a label from its own taxonomy on each user; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `workspace_members`
**Workspace Members.** Members of each workspace from Anthropic Admin API.
* **Enables:** Match each workspace membership to its Anthropic user and provider-reported workspace role.
* **Scope:** Reads the records selected by Claude Admin's `/v1/organizations/workspaces/{id}/members` operation as a snapshot stream using full synchronization. Visibility is limited to the Anthropic organization and Admin API privileges granted to the credential. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `workspace_members.membership_key`
**Membership Key.** Parable-generated SHA-1 digest of `workspace_id` and `user_id`, joined with `|`.
* **Enables:** Deduplicate each workspace membership on its own, so a member who belongs to several Claude Admin workspaces keeps one row per workspace.
* **Interpretation:** Parable calculates `membership_key` at ingestion. It identifies one workspace-to-member relationship, not the member or the workspace by itself, and is not a Claude Admin identifier. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `workspace_members.type`
**Type.** Object type (always 'workspace\_member'). It distinguishes the provider-defined type state or classification for the workspace member.
* **Enables:** Segment workspace member entries in Workspace Members by type in `workspace_members.type`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports type as a label from its own taxonomy on each workspace member; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `workspace_members.user_id`
**User ID.** Anthropic's identifier for the workspace member.
* **Enables:** Connect each workspace membership to the member's Claude Admin account through `workspace_members.user_id`.
* **Interpretation:** Claude Admin reports this value in its user namespace. The same value repeats once for every workspace the member belongs to, so it does not identify a row on its own. A connector directive maps this field to account identity.
Developer identifier: `workspace_members.workspace_id`
**Workspace ID.** Unique identifier of the workspace. It provides the reference needed to connect the workspace member to the corresponding provider object.
* **Enables:** Connect each workspace member in Workspace Members to the referenced workspace through `workspace_members.workspace_id`; flag workspace ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Admin reports workspace ID as an identifier in its workspace namespace; it is not a universal identity outside Claude Admin.
Developer identifier: `workspace_members.workspace_role`
**Workspace Role.** The role assigned to the user within this workspace. It distinguishes the provider-defined workspace role state or classification for the workspace member.
* **Enables:** Segment workspace member entries in Workspace Members by workspace role in `workspace_members.workspace_role`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports workspace role as a label from its own taxonomy on each workspace member; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `workspaces`
**Workspaces.** Organization workspaces from Anthropic Admin API.
* **Enables:** Inventory Anthropic workspaces and compare their names, archive state, display color, and lifecycle timestamps.
* **Scope:** Reads the records selected by Claude Admin's `/v1/organizations/workspaces` operation as a snapshot stream using full synchronization. Visibility is limited to the Anthropic organization and Admin API privileges granted to the credential. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `workspaces.archived_at`
**Archived At.** Timestamp when the workspace was archived, if applicable. It anchors the workspace on the provider's reported timeline.
* **Enables:** Order Workspaces by archived at in `workspaces.archived_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Admin reports archived at as a timestamp on each workspace; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `workspaces.compartment_id`
**Compartment ID.** Workspace compartment ID used for CMEK key policy scoping. It provides the reference needed to connect the workspace to the corresponding provider object.
* **Enables:** Connect each workspace in Workspaces to the referenced compartment through `workspaces.compartment_id`; flag compartment ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Admin reports compartment ID as an identifier in its compartment namespace; it is not a universal identity outside Claude Admin.
Developer identifier: `workspaces.created_at`
**Created At.** Timestamp when the workspace was created. It anchors the workspace on the provider's reported timeline.
* **Enables:** Order Workspaces by created at in `workspaces.created_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Admin reports created at as a timestamp on each workspace; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `workspaces.data_residency`
**Data Residency.** Data residency configuration for the workspace. It preserves the nested context needed to interpret the parent workspace.
* **Enables:** Attribute data residency in `workspaces.data_residency` to the parent workspace; identify parent records where that nested data residency object is absent.
* **Interpretation:** Claude Admin reports data residency as a nested object on each workspace; optional children may be absent from a valid response.
Developer identifier: `workspaces.display_color`
**Display Color.** Display color for the workspace (hex code). It distinguishes the provider-defined display color state or classification for the workspace.
* **Enables:** Filter Workspaces by the exact Claude Admin-defined display color in `workspaces.display_color` and preserve unknown values as distinct categories.
* **Interpretation:** Claude Admin supplies display color from its own taxonomy on each workspace; preserve unknown and newly introduced labels.
Developer identifier: `workspaces.external_key_id`
**External Key ID.** CMEK external key ID attached to this workspace (write-once). It provides the reference needed to connect the workspace to the corresponding provider object.
* **Enables:** Connect each workspace in Workspaces to the referenced external through `workspaces.external_key_id`; flag external key ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Admin reports external key ID as an identifier in its external namespace; it is not a universal identity outside Claude Admin.
Developer identifier: `workspaces.id`
**ID.** Unique workspace identifier. It provides the reference needed to connect the workspace to the corresponding provider object.
* **Enables:** Match repeated workspace entries on ID in `workspaces.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Admin reports ID as an identifier in its workspace namespace; it is not a universal identity outside Claude Admin. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `workspaces.name`
**Name.** Workspace name. It gives the workspace a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each workspace with name from `workspaces.name`; distinguish records that share that display name but have different Claude Admin identifiers.
* **Interpretation:** Claude Admin reports name as display text for each workspace; names are mutable and are not stable identities.
Developer identifier: `workspaces.tags`
**Tags.** User-defined string key-value tags (keys must not begin with Anthropic). It preserves the nested context needed to interpret the parent workspace.
* **Enables:** Attribute tags in `workspaces.tags` to the parent workspace; identify parent records where that nested tags object is absent.
* **Interpretation:** Claude Admin reports tags as a nested object on each workspace; optional children may be absent from a valid response.
Developer identifier: `workspaces.type`
**Type.** Object type (always 'workspace'). It distinguishes the provider-defined type state or classification for the workspace.
* **Enables:** Segment workspace entries in Workspaces by type in `workspaces.type`; compare counts only within the same Claude Admin taxonomy.
* **Interpretation:** Claude Admin reports type as a label from its own taxonomy on each workspace; preserve unknown labels rather than mapping them by assumption.
If validation fails, confirm that the credential is active, the configured account can read the required resources, and every connection field matches the Provider environment.
Parable never returns stored secret values; replace a secret in the connection form when it has expired or been revoked.
# Claude Compliance
Source: https://docs.parable.work/plugins/provider-plugins/claude_compliance
Sync audit events, organization directory, and optional claude.ai content metadata from the Anthropic Compliance API
Sync audit events, organization directory, and optional claude.ai content metadata from the Anthropic Compliance API.
Connect Parable to the Anthropic **Compliance API** for audit activity, organization directory data, and optional claude.ai content metadata (chats, projects). This Provider is separate from the **Claude Admin** Provider, which uses an Admin API Key for usage and cost reporting.
By default, Parable syncs **activities**, **organizations**, and **organization\_users** only. Enable additional taps in Provider settings if you need chat or project metadata. Optional taps use the same Compliance Access Key; no extra scopes are required beyond `read:compliance_user_data`.
## Data streams
This Provider Plugin defines 9 data streams.
| Stream | Description | Sync |
| - | - | - |
| `activities` | Audit activity feed from the Anthropic Compliance API. Actor is a discriminated union with all known variants declared; high-frequency type-specific resource ids are declared. Remaining type-specific payload fields are not fully modeled yet. | incremental |
| `organizations` | Linked organizations under the enterprise account | full |
| `organization_users` | Users in each linked organization | full |
| `chats` | Chat metadata for organization users (claude.ai Enterprise content) | incremental |
| `chat_messages` | Messages for each chat conversation | incremental |
| `projects` | Project metadata from claude.ai | full |
| `project_details` | Detailed metadata for each project | full |
| `project_attachments` | Attachment metadata for each project | full |
| `project_documents` | Plain-text content for project\_doc attachments | full |
### Claude Compliance
#### What You'll Need
| Credential | What it is |
| - | - |
| **Compliance Access Key** | Enterprise key with Compliance API scopes (prefix `sk-ant-api01-`) |
> **Info:** **Enterprise required.** Compliance API access requires Claude Enterprise. A Primary Owner must enable the Compliance API before creating keys.
* Claude **Enterprise** plan
* **Primary Owner** role on the claude.ai organization (to enable Compliance API and create Compliance Access Keys)
* Compliance API **enabled** at claude.ai > Organization settings > Data and privacy
#### Step 1: Enable the Compliance API
1. Sign in to [claude.ai](https://claude.ai) as the **Primary Owner**.
2. Open **Organization settings > Data and privacy**.
3. Under **Compliance API**, click **Enable**.
#### Step 2: Create a Compliance Access Key
1. On the same page, open **Compliance access keys**.
2. Click **Create key**.
3. Select these scopes for the default Provider taps:
| Scope | Required for |
| - | - |
| `read:compliance_activities` | Activity feed (`activities` tap) |
| `read:compliance_org_data` | Organization list (`organizations` tap) |
| `read:compliance_user_data` | Organization users and optional chat/project taps |
4. Copy the key immediately. It is shown only once.
> **Warning:** **Copy your now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
> **Warning:** Do **not** use keys from Claude Console > Settings > **API keys** (standard API key) or **Admin keys** (Admin API). Those are for different Providers and API families.
#### Step 3: Connect in Parable
1. In Parable, open **Platform → Providers** and choose the Provider to add.
2. Select **Anthropic > Claude Compliance**.
3. Paste your Compliance Access Key.
4. Save and run **Test connection**.
Developer identifier: `activities`
**Activities.** Audit activity feed from the Anthropic Compliance API. Actor is a discriminated union with all known variants declared; high-frequency type-specific resource IDs are declared. Remaining type-specific payload fields are not fully modeled yet.
* **Enables:** Trace Anthropic compliance activities to the reported actor, organization, resource identifiers, change payload, and time.
* **Scope:** Reads the records selected by Claude Compliance's `/v1/compliance/activities` operation as an event stream using incremental synchronization. Visibility is limited to organizations and content exposed by the Anthropic Compliance API credential. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. This stream supplies no reliable deletion signal.
Developer identifier: `activities.actor`
**Actor.** The structured actor details attached to each activity in Activities. It preserves the nested context needed to interpret the parent activity.
* **Enables:** Attribute actor in `activities.actor` to the parent activity; identify parent records where that nested actor object is absent.
* **Interpretation:** Claude Compliance reports actor as a nested object on each activity; optional children may be absent from a valid response.
Developer identifier: `activities.actor.admin_api_key_id`
**Admin API Key ID.** Admin API key ID when type is admin\_api\_key\_actor. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each Claude Compliance activity actor in Activities to the referenced admin API through `activities.ClaudeComplianceActivityActor.admin_api_key_id`; flag admin API key ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports admin API key ID as an identifier in its admin API namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.actor.api_key_id`
**API Key ID.** Customer API or Compliance Access key ID when type is api\_actor. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each Claude Compliance activity actor in Activities to the referenced API through `activities.ClaudeComplianceActivityActor.api_key_id`; flag API key ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports API key ID as an identifier in its API namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.actor.audience`
**Audience.** OIDC audience claim(s) when type is federated\_identity\_actor. It preserves the nested context needed to interpret the parent activity.
* **Enables:** Attribute audience in `activities.ClaudeComplianceActivityActor.audience` to the parent activity; identify parent records where that nested audience object is absent.
* **Interpretation:** Claude Compliance reports audience as a nested object on each Claude Compliance activity actor; optional children may be absent from a valid response.
Developer identifier: `activities.actor.directory_id`
**Directory ID.** SCIM directory ID when type is scim\_directory\_sync\_actor. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each Claude Compliance activity actor in Activities to the referenced directory through `activities.ClaudeComplianceActivityActor.directory_id`; flag directory ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports directory ID as an identifier in its directory namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.actor.email_address`
**Email Address.** Email when type is user\_actor or anthropic\_actor (absent for Anthropic operators). It supplies the provider-reported address or location facet for the Claude Compliance activity actor, not a residency determination.
* **Enables:** Attribute each Claude Compliance activity actor to a person or account by the exact email address in `activities.ClaudeComplianceActivityActor.email_address`; identify addresses that do not match the Claude Compliance directory.
* **Interpretation:** Claude Compliance reports email address as an address on each Claude Compliance activity actor; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `activities.actor.idp_connection_type`
**Idp Connection Type.** IdP connection type (e.g. OktaSCIMV2) when type is scim\_directory\_sync\_actor. It distinguishes the provider-defined idp connection type state or classification for the Claude Compliance activity actor.
* **Enables:** Segment Claude Compliance activity actor entries in Activities by idp connection type in `activities.ClaudeComplianceActivityActor.idp_connection_type`; compare counts only within the same Claude Compliance taxonomy.
* **Interpretation:** Claude Compliance reports idp connection type as a label from its own taxonomy on each Claude Compliance activity actor; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `activities.actor.ip_address`
**IP Address.** The provider-reported IP address for each Claude Compliance activity actor in Activities. It supplies the provider-reported address or location facet for the Claude Compliance activity actor, not a residency determination.
* **Enables:** Correlate activity records that report the same network address in `activities.ClaudeComplianceActivityActor.ip_address` during an authorized investigation; account for shared, proxied, or translated addresses.
* **Interpretation:** Claude Compliance reports this as an IP network address on each Claude Compliance activity actor. It is not verified geolocation, does not identify a person by itself, and does not establish data residency.
Developer identifier: `activities.actor.issuer`
**Issuer.** OIDC issuer when type is federated\_identity\_actor. It supplies the issuer profile facet used to reconcile or attribute the Claude Compliance activity actor.
* **Enables:** Reconcile the activity's issuer in `activities.ClaudeComplianceActivityActor.issuer` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Claude Compliance reports issuer as a mutable profile or directory attribute on each Claude Compliance activity actor; it may be absent, shared, or non-unique.
Developer identifier: `activities.actor.service`
**Service.** Automated process name when type is system\_actor. It distinguishes the provider-defined service state or classification for the Claude Compliance activity actor.
* **Enables:** Filter Activities by the exact Claude Compliance-defined service in `activities.ClaudeComplianceActivityActor.service` and preserve unknown values as distinct categories.
* **Interpretation:** Claude Compliance supplies service from its own taxonomy on each Claude Compliance activity actor; preserve unknown and newly introduced labels.
Developer identifier: `activities.actor.service_account_id`
**Service Account ID.** Service account ID when type is service\_account\_actor. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each Claude Compliance activity actor in Activities to the referenced service account through `activities.ClaudeComplianceActivityActor.service_account_id`; flag service account ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports service account ID as an identifier in its service account namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.actor.subject`
**Subject.** OIDC subject when type is federated\_identity\_actor. It defines the content surface available for this activity.
* **Enables:** Locate Claude Compliance activity actor records by subject in `activities.ClaudeComplianceActivityActor.subject`; attribute each text match to its parent activity and, when present, its reported author.
* **Interpretation:** Claude Compliance supplies subject as text on each Claude Compliance activity actor; referenced files or media are not implied unless explicitly represented.
Developer identifier: `activities.actor.type`
**Type.** Actor discriminator (user\_actor, api\_actor, admin\_api\_key\_actor, unauthenticated\_user\_actor, anthropic\_actor, system\_actor, service\_account\_actor, scim\_directory\_sync\_actor, federated\_identity\_actor). It distinguishes the provider-defined type state or classification for the Claude Compliance activity actor.
* **Enables:** Segment Claude Compliance activity actor entries in Activities by type in `activities.ClaudeComplianceActivityActor.type`; compare counts only within the same Claude Compliance taxonomy.
* **Interpretation:** Claude Compliance reports type as a label from its own taxonomy on each Claude Compliance activity actor; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `activities.actor.unauthenticated_email_address`
**Unauthenticated Email Address.** Email attempted before sign-in when type is unauthenticated\_user\_actor. Kept as plain string because pre-auth values may be malformed. It supplies the provider-reported address or location facet for the Claude Compliance activity actor, not a residency determination.
* **Enables:** Attribute each Claude Compliance activity actor to a person or account by the exact unauthenticated email address in `activities.ClaudeComplianceActivityActor.unauthenticated_email_address`; identify addresses that do not match the Claude Compliance directory.
* **Interpretation:** Claude Compliance reports unauthenticated email address as an address on each Claude Compliance activity actor; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `activities.actor.user_agent`
**User Agent.** The provider-reported user agent for each Claude Compliance activity actor in Activities. It supplies the user agent profile facet used to reconcile or attribute the Claude Compliance activity actor.
* **Enables:** Reconcile the activity's user agent in `activities.ClaudeComplianceActivityActor.user_agent` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Claude Compliance reports user agent as a mutable profile or directory attribute on each Claude Compliance activity actor; it may be absent, shared, or non-unique.
Developer identifier: `activities.actor.user_id`
**User ID.** Stable user account ID when type is user\_actor. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each Claude Compliance activity actor in Activities to the referenced user through `activities.ClaudeComplianceActivityActor.user_id`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports user ID as an identifier in its user namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.actor.workos_event_id`
**Workos Event ID.** WorkOS event ID when type is scim\_directory\_sync\_actor. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each Claude Compliance activity actor in Activities to the referenced workos event through `activities.ClaudeComplianceActivityActor.workos_event_id`; flag workos event ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports workos event ID as an identifier in its workos event namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.agent_id`
**Agent ID.** The provider-reported agent ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced agent through `activities.agent_id`; flag agent ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports agent ID as an identifier in its agent namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.api_key_id`
**API Key ID.** The provider-reported API key ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced API through `activities.api_key_id`; flag API key ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports API key ID as an identifier in its API namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.claude_artifact_id`
**Claude Artifact ID.** The provider-reported claude artifact ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced claude artifact through `activities.claude_artifact_id`; flag claude artifact ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports claude artifact ID as an identifier in its claude artifact namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.claude_artifact_version_id`
**Claude Artifact Version ID.** The provider-reported claude artifact version ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced claude artifact version through `activities.claude_artifact_version_id`; flag claude artifact version ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports claude artifact version ID as an identifier in its claude artifact version namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.claude_chat_id`
**Claude Chat ID.** The provider-reported claude chat ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced claude chat through `activities.claude_chat_id`; flag claude chat ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports claude chat ID as an identifier in its claude chat namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.claude_file_id`
**Claude File ID.** The provider-reported claude file ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced claude file through `activities.claude_file_id`; flag claude file ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports claude file ID as an identifier in its claude file namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.claude_project_document_id`
**Claude Project Document ID.** The provider-reported claude project document ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced claude project document through `activities.claude_project_document_id`; flag claude project document ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports claude project document ID as an identifier in its claude project document namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.claude_project_id`
**Claude Project ID.** The provider-reported claude project ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced claude project through `activities.claude_project_id`; flag claude project ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports claude project ID as an identifier in its claude project namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.created_at`
**Created At.** The provider-reported created at for each activity in Activities. It anchors the activity on the provider's reported timeline.
* **Enables:** Order Activities by created at in `activities.created_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports created at as a timestamp on each activity; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `activities.current_value`
**Current Value.** New setting/value for update-style activities. It preserves the nested context needed to interpret the parent activity.
* **Enables:** Attribute current value in `activities.current_value` to the parent activity; identify parent records where that nested current value object is absent.
* **Interpretation:** Claude Compliance reports current value as a nested object on each activity; optional children may be absent from a valid response.
Developer identifier: `activities.display_name`
**Display Name.** The provider-reported display name for each activity in Activities. It distinguishes the provider-defined display name state or classification for the activity.
* **Enables:** Label each activity with display name from `activities.display_name`; distinguish records that share that display name but have different Claude Compliance identifiers.
* **Interpretation:** Claude Compliance reports display name as display text for each activity; names are mutable and are not stable identities.
Developer identifier: `activities.extension_id`
**Extension ID.** The provider-reported extension ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced extension through `activities.extension_id`; flag extension ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports extension ID as an identifier in its extension namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.filename`
**Filename.** The provider-reported filename for each activity in Activities. It identifies the file, document, recording, or attachment metadata associated with the activity.
* **Enables:** Associate the filename in `activities.filename` with its parent activity; inventory the artifact reference without assuming binary content is present.
* **Interpretation:** Claude Compliance reports filename as file, document, recording, or attachment metadata on each activity; binary bytes are not implied. This field is metadata or a reference for the file or attachment; it does not by itself include binary content.
Developer identifier: `activities.group_id`
**Group ID.** The provider-reported group ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced group through `activities.group_id`; flag group ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports group ID as an identifier in its group namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.id`
**ID.** The provider-reported ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Match repeated activity entries on ID in `activities.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Compliance reports ID as an identifier in its activity namespace; it is not a universal identity outside Claude Compliance. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `activities.integration_id`
**Integration ID.** The provider-reported integration ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced integration through `activities.integration_id`; flag integration ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports integration ID as an identifier in its integration namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.invite_id`
**Invite ID.** The provider-reported invite ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced invite through `activities.invite_id`; flag invite ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports invite ID as an identifier in its invite namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.mcp_server_id`
**Mcp Server ID.** The provider-reported MCP server ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced MCP server through `activities.mcp_server_id`; flag MCP server ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports MCP server ID as an identifier in its MCP server namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.mcp_server_name`
**Mcp Server Name.** The provider-reported MCP server name for each activity in Activities. It gives the activity a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each activity with MCP server name from `activities.mcp_server_name`; distinguish records that share that display name but have different Claude Compliance identifiers.
* **Interpretation:** Claude Compliance reports MCP server name as display text for each activity; names are mutable and are not stable identities.
Developer identifier: `activities.organization_id`
**Organization ID.** The provider-reported organization ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced organization through `activities.organization_id`; flag organization ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports organization ID as an identifier in its organization namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.organization_uuid`
**Organization UUID.** The provider-reported organization UUID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced organization through `activities.organization_uuid`; flag organization UUID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports organization UUID as an identifier in its organization namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.plugin_id`
**Plugin ID.** The provider-reported plugin ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced plugin through `activities.plugin_id`; flag plugin ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports plugin ID as an identifier in its plugin namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.plugin_name`
**Plugin Name.** The provider-reported plugin name for each activity in Activities. It gives the activity a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each activity with plugin name from `activities.plugin_name`; distinguish records that share that display name but have different Claude Compliance identifiers.
* **Interpretation:** Claude Compliance reports plugin name as display text for each activity; names are mutable and are not stable identities.
Developer identifier: `activities.previous_value`
**Previous Value.** Prior setting/value for update-style activities. It preserves the nested context needed to interpret the parent activity.
* **Enables:** Attribute previous value in `activities.previous_value` to the parent activity; identify parent records where that nested previous value object is absent.
* **Interpretation:** Claude Compliance reports previous value as a nested object on each activity; optional children may be absent from a valid response.
Developer identifier: `activities.profile_id`
**Profile ID.** The provider-reported profile ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced profile through `activities.profile_id`; flag profile ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports profile ID as an identifier in its profile namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.resource_id`
**Resource ID.** The provider-reported resource ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced resource through `activities.resource_id`; flag resource ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports resource ID as an identifier in its resource namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.resource_type`
**Resource Type.** The provider-reported resource type for each activity in Activities. It distinguishes the provider-defined resource type state or classification for the activity.
* **Enables:** Segment activity entries in Activities by resource type in `activities.resource_type`; compare counts only within the same Claude Compliance taxonomy.
* **Interpretation:** Claude Compliance reports resource type as a label from its own taxonomy on each activity; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `activities.role_id`
**Role ID.** The provider-reported role ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced role through `activities.role_id`; flag role ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports role ID as an identifier in its role namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.skill_id`
**Skill ID.** The provider-reported skill ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced skill through `activities.skill_id`; flag skill ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports skill ID as an identifier in its skill namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.skill_name`
**Skill Name.** The provider-reported skill name for each activity in Activities. It gives the activity a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each activity with skill name from `activities.skill_name`; distinguish records that share that display name but have different Claude Compliance identifiers.
* **Interpretation:** Claude Compliance reports skill name as display text for each activity; names are mutable and are not stable identities.
Developer identifier: `activities.spend_limit_id`
**Spend Limit ID.** The provider-reported spend limit ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced spend limit through `activities.spend_limit_id`; flag spend limit ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports spend limit ID as an identifier in its spend limit namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.type`
**Type.** Activity type discriminator (e.g. claude\_chat\_created). It distinguishes the provider-defined type state or classification for the activity.
* **Enables:** Segment activity entries in Activities by type in `activities.type`; compare counts only within the same Claude Compliance taxonomy.
* **Interpretation:** Claude Compliance reports type as a label from its own taxonomy on each activity; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `activities.updates`
**Updates.** Structured update payload for multi-field change activities. It preserves the nested context needed to interpret the parent activity.
* **Enables:** Attribute updates in `activities.updates` to the parent activity; identify parent records where that nested updates object is absent.
* **Interpretation:** Claude Compliance reports updates as a nested object on each activity; optional children may be absent from a valid response.
Developer identifier: `activities.user_id`
**User ID.** The provider-reported user ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced user through `activities.user_id`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports user ID as an identifier in its user namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `activities.workspace_id`
**Workspace ID.** The provider-reported workspace ID for each activity in Activities. It provides the reference needed to connect the activity to the corresponding provider object.
* **Enables:** Connect each activity in Activities to the referenced workspace through `activities.workspace_id`; flag workspace ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports workspace ID as an identifier in its workspace namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `chat_messages`
**Chat Messages.** Messages for each chat conversation.
* **Enables:** Attribute returned user, assistant, and tool content blocks to their chat, sender role, files, and timestamp.
* **Scope:** Reads the records selected by Claude Compliance's `/v1/compliance/apps/chats/{id}/messages` operation as an event stream using incremental synchronization. This stream is opt-in. Visibility is limited to organizations and content exposed by the Anthropic Compliance API credential. Content contains returned text and tool blocks and can be server-truncated; referenced or generated file bytes are not implied by file metadata. This stream supplies no reliable deletion signal.
Developer identifier: `chat_messages.artifacts`
**Artifacts.** The structured artifacts details attached to each chat message in Chat Messages. It preserves the nested context needed to interpret the parent chat message.
* **Enables:** Attribute artifacts in `chat_messages.artifacts` to the parent chat message; identify parent records where that nested artifacts object is absent.
* **Interpretation:** Claude Compliance reports artifacts as a nested object on each chat message; optional children may be absent from a valid response. This structured payload describes message-level file or artifact references; it does not establish that referenced bytes were collected.
Developer identifier: `chat_messages.chat_id`
**Chat ID.** The provider-reported chat ID for each chat message in Chat Messages. It provides the reference needed to connect the chat message to the corresponding provider object.
* **Enables:** Connect each chat message in Chat Messages to the referenced chat through `chat_messages.chat_id`; flag chat ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports chat ID as an identifier in its chat namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `chat_messages.claude_chat_id`
**Claude Chat ID.** The provider-reported claude chat ID for each chat message in Chat Messages. It provides the reference needed to connect the chat message to the corresponding provider object.
* **Enables:** Connect each chat message in Chat Messages to the referenced claude chat through `chat_messages.claude_chat_id`; flag claude chat ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports claude chat ID as an identifier in its claude chat namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `chat_messages.content`
**Content.** Content blocks (text, tool\_use, tool\_result) as returned by the Compliance API. It preserves the nested context needed to interpret the parent chat message.
* **Enables:** Search the returned content content in `chat_messages.content` while preserving element order and attribution to the parent chat message.
* **Interpretation:** Claude Compliance returns content as ordered content or provider-generated content metadata on each chat message; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `chat_messages.content.content`
**Content.** Nested tool\_result content items. It preserves the nested context needed to interpret the parent chat message.
* **Enables:** Attribute content in `chat_messages.ClaudeComplianceContentBlock.content` to the parent chat message; identify parent records where that nested content object is absent.
* **Interpretation:** Claude Compliance reports content as a nested object on each Claude Compliance content block; optional children may be absent from a valid response.
Developer identifier: `chat_messages.content.id`
**ID.** Tool-use ID when type is tool\_use. It provides the reference needed to connect the chat message to the corresponding provider object.
* **Enables:** Connect each Claude Compliance content block in Chat Messages to the referenced Claude Compliance content block through `chat_messages.ClaudeComplianceContentBlock.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports ID as an identifier in its Claude Compliance content block namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `chat_messages.content.input`
**Input.** JSON-encoded tool arguments when type is tool\_use. It must be interpreted with the enclosing provider field name, type, or custom schema for the Claude Compliance content block.
* **Enables:** Interpret `chat_messages.ClaudeComplianceContentBlock.input` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Claude Compliance reports input under the enclosing custom or typed field contract on each Claude Compliance content block; compare it only with values from the same provider key and type.
Developer identifier: `chat_messages.content.integration_name`
**Integration Name.** The provider-reported integration name for each Claude Compliance content block in Chat Messages. It gives the Claude Compliance content block a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each Claude Compliance content block with integration name from `chat_messages.ClaudeComplianceContentBlock.integration_name`; distinguish records that share that display name but have different Claude Compliance identifiers.
* **Interpretation:** Claude Compliance reports integration name as display text for each Claude Compliance content block; names are mutable and are not stable identities.
Developer identifier: `chat_messages.content.is_error`
**Is Error.** True when a tool\_result reported an error. It distinguishes the provider-defined is error state or classification for the Claude Compliance content block.
* **Enables:** Filter Chat Messages by whether true when a tool\_result reported an error in `chat_messages.ClaudeComplianceContentBlock.is_error`; count true, false, and missing results separately.
* **Interpretation:** Claude Compliance reports true when a tool\_result reported an error as a boolean on each Claude Compliance content block; a missing field is unknown, not false.
Developer identifier: `chat_messages.content.mcp_server_url`
**Mcp Server URL.** The provider-reported MCP server URL for each Claude Compliance content block in Chat Messages. It locates the provider resource or path associated with the Claude Compliance content block.
* **Enables:** Associate each Claude Compliance content block with the resource identified by MCP server URL in `chat_messages.ClaudeComplianceContentBlock.mcp_server_url`; verify the link resolves to the expected Claude Compliance object.
* **Interpretation:** Claude Compliance reports MCP server URL as a resource locator for each Claude Compliance content block; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `chat_messages.content.name`
**Name.** Tool name for tool\_use / tool\_result blocks. It gives the Claude Compliance content block a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each Claude Compliance content block with name from `chat_messages.ClaudeComplianceContentBlock.name`; distinguish records that share that display name but have different Claude Compliance identifiers.
* **Interpretation:** Claude Compliance reports name as display text for each Claude Compliance content block; names are mutable and are not stable identities.
Developer identifier: `chat_messages.content.text`
**Text.** Text content when type is text. It defines the content surface available for this chat message.
* **Enables:** Locate Claude Compliance content block records by text in `chat_messages.ClaudeComplianceContentBlock.text`; attribute each text match to its parent chat message and, when present, its reported author.
* **Interpretation:** Anthropic returns structured text or tool blocks; a truncation flag means the server shortened a block, and file references do not imply file bytes.
Developer identifier: `chat_messages.content.tool_use_id`
**Tool Use ID.** Referenced tool\_use ID when type is tool\_result. It provides the reference needed to connect the chat message to the corresponding provider object.
* **Enables:** Connect each Claude Compliance content block in Chat Messages to the referenced tool use through `chat_messages.ClaudeComplianceContentBlock.tool_use_id`; flag tool use ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports tool use ID as an identifier in its tool use namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `chat_messages.content.truncated`
**Truncated.** True when server shortened this block. It distinguishes the provider-defined truncated state or classification for the Claude Compliance content block.
* **Enables:** Filter Chat Messages by whether true when server shortened this block in `chat_messages.ClaudeComplianceContentBlock.truncated`; count true, false, and missing results separately.
* **Interpretation:** Claude Compliance reports true when server shortened this block as a boolean on each Claude Compliance content block; a missing field is unknown, not false.
Developer identifier: `chat_messages.content.type`
**Type.** Block discriminator: text, tool\_use, or tool\_result. It supplies the returned type text needed to understand the Claude Compliance content block in context.
* **Enables:** Segment Claude Compliance content block entries in Chat Messages by type in `chat_messages.ClaudeComplianceContentBlock.type`; compare counts only within the same Claude Compliance taxonomy.
* **Interpretation:** Claude Compliance reports type as a label from its own taxonomy on each Claude Compliance content block; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `chat_messages.created_at`
**Created At.** The provider-reported created at for each chat message in Chat Messages. It anchors the chat message on the provider's reported timeline.
* **Enables:** Order Chat Messages by created at in `chat_messages.created_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports created at as a timestamp on each chat message; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `chat_messages.files`
**Files.** The structured files details attached to each chat message in Chat Messages. It preserves the nested context needed to interpret the parent chat message.
* **Enables:** Attribute files in `chat_messages.files` to the parent chat message; identify parent records where that nested files object is absent.
* **Interpretation:** Claude Compliance reports files as a nested object on each chat message; optional children may be absent from a valid response. This structured payload describes message-level file or artifact references; it does not establish that referenced bytes were collected.
Developer identifier: `chat_messages.generated_files`
**Generated Files.** The structured generated files details attached to each chat message in Chat Messages. It preserves the nested context needed to interpret the parent chat message.
* **Enables:** Attribute generated files in `chat_messages.generated_files` to the parent chat message; identify parent records where that nested generated files object is absent.
* **Interpretation:** Claude Compliance reports generated files as a nested object on each chat message; optional children may be absent from a valid response. This structured payload describes message-level file or artifact references; it does not establish that referenced bytes were collected.
Developer identifier: `chat_messages.id`
**ID.** The provider-reported ID for each chat message in Chat Messages. It provides the reference needed to connect the chat message to the corresponding provider object.
* **Enables:** Match repeated chat message entries on ID in `chat_messages.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Compliance reports ID as an identifier in its chat message namespace; it is not a universal identity outside Claude Compliance. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `chat_messages.role`
**Role.** Message sender: user or assistant. It supplies the returned role text needed to understand the chat message in context.
* **Enables:** Segment chat message entries in Chat Messages by role in `chat_messages.role`; compare counts only within the same Claude Compliance taxonomy.
* **Interpretation:** Claude Compliance reports role as a label from its own taxonomy on each chat message; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `chats`
**Chats.** Chat metadata for organization users (claude.AI Enterprise content).
* **Enables:** Inventory chat metadata and connect each conversation to its user, project, model, organization, and lifecycle timestamps.
* **Scope:** Reads the records selected by Claude Compliance's `/v1/compliance/apps/chats` operation as a changelog stream using incremental synchronization. This stream is opt-in. Visibility is limited to organizations and content exposed by the Anthropic Compliance API credential. These records contain chat metadata, not message content; message blocks are read through the chat-message stream. Removal is recognized from the provider's tombstone state rather than absence alone.
Developer identifier: `chats.created_at`
**Created At.** The provider-reported created at for each chat in Chats. It anchors the chat on the provider's reported timeline.
* **Enables:** Order Chats by created at in `chats.created_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports created at as a timestamp on each chat; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `chats.deleted_at`
**Deleted At.** The provider-reported deleted at for each chat in Chats. It anchors the chat on the provider's reported timeline.
* **Enables:** Order Chats by deleted at in `chats.deleted_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports deleted at as a timestamp on each chat; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `chats.href`
**Href.** The provider-reported href for each chat in Chats. It locates the provider resource or path associated with the chat.
* **Enables:** Associate each chat with the resource identified by href in `chats.href`; verify the link resolves to the expected Claude Compliance object.
* **Interpretation:** Claude Compliance reports href as a resource locator for each chat; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `chats.id`
**ID.** The provider-reported ID for each chat in Chats. It provides the reference needed to connect the chat to the corresponding provider object.
* **Enables:** Match repeated chat entries on ID in `chats.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Compliance reports ID as an identifier in its chat namespace; it is not a universal identity outside Claude Compliance. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `chats.model`
**Model.** The provider-reported model for each chat in Chats. It distinguishes the provider-defined model state or classification for the chat.
* **Enables:** Filter Chats by the exact Claude Compliance-defined model in `chats.model` and preserve unknown values as distinct categories.
* **Interpretation:** Claude Compliance supplies model from its own taxonomy on each chat; preserve unknown and newly introduced labels.
Developer identifier: `chats.name`
**Name.** The provider-reported name for each chat in Chats. It gives the chat a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each chat with name from `chats.name`; distinguish records that share that display name but have different Claude Compliance identifiers.
* **Interpretation:** Claude Compliance reports name as display text for each chat; names are mutable and are not stable identities.
Developer identifier: `chats.organization_id`
**Organization ID.** The provider-reported organization ID for each chat in Chats. It provides the reference needed to connect the chat to the corresponding provider object.
* **Enables:** Connect each chat in Chats to the referenced organization through `chats.organization_id`; flag organization ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports organization ID as an identifier in its organization namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `chats.organization_uuid`
**Organization UUID.** The provider-reported organization UUID for each chat in Chats. It provides the reference needed to connect the chat to the corresponding provider object.
* **Enables:** Connect each chat in Chats to the referenced organization through `chats.organization_uuid`; flag organization UUID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports organization UUID as an identifier in its organization namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `chats.project_id`
**Project ID.** The provider-reported project ID for each chat in Chats. It provides the reference needed to connect the chat to the corresponding provider object.
* **Enables:** Connect each chat in Chats to the referenced project through `chats.project_id`; flag project ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports project ID as an identifier in its project namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `chats.updated_at`
**Updated At.** The provider-reported updated at for each chat in Chats. It anchors the chat on the provider's reported timeline.
* **Enables:** Order Chats by updated at in `chats.updated_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports updated at as a timestamp on each chat; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `chats.user`
**User.** The structured user details attached to each chat in Chats. It preserves the nested context needed to interpret the parent chat.
* **Enables:** Attribute user in `chats.user` to the parent chat; identify parent records where that nested user object is absent.
* **Interpretation:** Claude Compliance reports user as a nested object on each chat; optional children may be absent from a valid response.
Developer identifier: `chats.user_id`
**User ID.** The provider-reported user ID for each chat in Chats. It provides the reference needed to connect the chat to the corresponding provider object.
* **Enables:** Connect each chat in Chats to the referenced user through `chats.user_id`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports user ID as an identifier in its user namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `organization_users`
**Organization Users.** Users in each linked organization.
* **Enables:** Match each linked organization to its users, email identities, names, organization roles, and creation times.
* **Scope:** Reads the records selected by Claude Compliance's `/v1/compliance/organizations/{uuid}/users` operation as a snapshot stream using full synchronization. Visibility is limited to organizations and content exposed by the Anthropic Compliance API credential. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `organization_users.created_at`
**Created At.** The provider-reported created at for each organization user in Organization Users. It anchors the organization user on the provider's reported timeline.
* **Enables:** Order Organization Users by created at in `organization_users.created_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports created at as a timestamp on each organization user; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `organization_users.email`
**Email.** The provider-reported email for each organization user in Organization Users. It supplies the email profile facet used to reconcile or attribute the organization user.
* **Enables:** Attribute each organization user to a person or account by the exact email in `organization_users.email`; identify addresses that do not match the Claude Compliance directory.
* **Interpretation:** Claude Compliance reports email as an address on each organization user; aliases, casing, and unverified addresses can prevent a one-to-one person match. A connector directive maps this field to a person's email identity.
Developer identifier: `organization_users.full_name`
**Full Name.** The provider-reported full name for each organization user in Organization Users. It gives the organization user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each organization user with full name from `organization_users.full_name`; distinguish records that share that display name but have different Claude Compliance identifiers.
* **Interpretation:** Claude Compliance reports full name as display text for each organization user; names are mutable and are not stable identities. A connector directive maps this field to a person's display name.
Developer identifier: `organization_users.id`
**ID.** The provider-reported ID for each organization user in Organization Users. It provides the reference needed to connect the organization user to the corresponding provider object.
* **Enables:** Match repeated organization user entries on ID in `organization_users.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Compliance reports ID as an identifier in its organization user namespace; it is not a universal identity outside Claude Compliance. The connector explicitly marks this field as a transform deduplication key. A connector directive maps this field to account identity.
Developer identifier: `organization_users.organization_id`
**Organization ID.** The provider-reported organization ID for each organization user in Organization Users. It provides the reference needed to connect the organization user to the corresponding provider object.
* **Enables:** Connect each organization user in Organization Users to the referenced organization through `organization_users.organization_id`; flag organization ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports organization ID as an identifier in its organization namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `organization_users.organization_role`
**Organization Role.** The provider-reported organization role for each organization user in Organization Users. It distinguishes the provider-defined organization role state or classification for the organization user.
* **Enables:** Segment organization user entries in Organization Users by organization role in `organization_users.organization_role`; compare counts only within the same Claude Compliance taxonomy.
* **Interpretation:** Claude Compliance reports organization role as a label from its own taxonomy on each organization user; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `organization_users.organization_uuid`
**Organization UUID.** The provider-reported organization UUID for each organization user in Organization Users. It provides the reference needed to connect the organization user to the corresponding provider object.
* **Enables:** Connect each organization user in Organization Users to the referenced organization through `organization_users.organization_uuid`; flag organization UUID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports organization UUID as an identifier in its organization namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `organizations`
**Organizations.** Linked organizations under the enterprise account.
* **Enables:** Inventory enterprise-linked Anthropic organizations by UUID, name, and creation time before user and content traversal.
* **Scope:** Reads the records selected by Claude Compliance's `/v1/compliance/organizations` operation as a snapshot stream using full synchronization. Visibility is limited to organizations and content exposed by the Anthropic Compliance API credential. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `organizations.created_at`
**Created At.** The provider-reported created at for each organization in Organizations. It anchors the organization on the provider's reported timeline.
* **Enables:** Order Organizations by created at in `organizations.created_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports created at as a timestamp on each organization; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `organizations.name`
**Name.** The provider-reported name for each organization in Organizations. It gives the organization a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each organization with name from `organizations.name`; distinguish records that share that display name but have different Claude Compliance identifiers.
* **Interpretation:** Claude Compliance reports name as display text for each organization; names are mutable and are not stable identities.
Developer identifier: `organizations.uuid`
**UUID.** The provider-reported UUID for each organization in Organizations. It provides the reference needed to connect the organization to the corresponding provider object.
* **Enables:** Match repeated organization entries on UUID in `organizations.uuid`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Compliance reports UUID as an identifier in its organization namespace; it is not a universal identity outside Claude Compliance. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `project_attachments`
**Project Attachments.** Attachment metadata for each project.
* **Enables:** Inventory attachment metadata and match each file reference to its project by identifier and checksum.
* **Scope:** Reads the records selected by Claude Compliance's `/v1/compliance/apps/projects/{id}/attachments` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility is limited to organizations and content exposed by the Anthropic Compliance API credential. Attachment identifiers, names, MIME types, checksums, and sizes are metadata; file bytes are not included. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `project_attachments.created_at`
**Created At.** The provider-reported created at for each project attachment in Project Attachments. It anchors the project attachment on the provider's reported timeline.
* **Enables:** Order Project Attachments by created at in `project_attachments.created_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports created at as a timestamp on each project attachment; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `project_attachments.filename`
**Filename.** The provider-reported filename for each project attachment in Project Attachments. It identifies the file, document, recording, or attachment metadata associated with the project attachment.
* **Enables:** Associate the filename in `project_attachments.filename` with its parent project attachment; inventory the artifact reference without assuming binary content is present.
* **Interpretation:** Claude Compliance reports filename as file, document, recording, or attachment metadata on each project attachment; binary bytes are not implied. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `project_attachments.id`
**ID.** The provider-reported ID for each project attachment in Project Attachments. It provides the reference needed to connect the project attachment to the corresponding provider object.
* **Enables:** Match repeated project attachment entries on ID in `project_attachments.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Compliance reports ID as an identifier in its project attachment namespace; it is not a universal identity outside Claude Compliance. The connector explicitly marks this field as a transform deduplication key. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `project_attachments.md5`
**Md5.** MD5 checksum of the attachment content. It supplies the returned md5 text needed to understand the project attachment in context.
* **Enables:** Search the returned md5 text in `project_attachments.md5` and attribute each match to its parent project attachment and reported author when available.
* **Interpretation:** Claude Compliance supplies md5 as returned text on each project attachment; truncation, formatting, and access boundaries can limit completeness. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `project_attachments.mime_type`
**MIME Type.** The provider-reported MIME type for each project attachment in Project Attachments. It identifies the file, document, recording, or attachment metadata associated with the project attachment.
* **Enables:** Segment project attachment entries in Project Attachments by MIME type in `project_attachments.mime_type`; compare counts only within the same Claude Compliance taxonomy.
* **Interpretation:** Claude Compliance reports MIME type as a label from its own taxonomy on each project attachment; preserve unknown labels rather than mapping them by assumption. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `project_attachments.project_id`
**Project ID.** The provider-reported project ID for each project attachment in Project Attachments. It provides the reference needed to connect the project attachment to the corresponding provider object.
* **Enables:** Connect each project attachment in Project Attachments to the referenced project through `project_attachments.project_id`; flag project ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports project ID as an identifier in its project namespace; it is not a universal identity outside Claude Compliance. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `project_attachments.size_bytes`
**Size Bytes.** Attachment size in bytes. It supplies the size bytes measure for the project attachment at the provider's declared unit and grain.
* **Enables:** Measure size bytes through `project_attachments.size_bytes` for each project attachment and compare only values with the same unit and record grain.
* **Interpretation:** Claude Compliance reports size bytes as a measure on each project attachment; compare only records with the same unit and aggregation grain. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `project_attachments.type`
**Type.** The provider-reported type for each project attachment in Project Attachments. It distinguishes the provider-defined type state or classification for the project attachment.
* **Enables:** Segment project attachment entries in Project Attachments by type in `project_attachments.type`; compare counts only within the same Claude Compliance taxonomy.
* **Interpretation:** Claude Compliance reports type as a label from its own taxonomy on each project attachment; preserve unknown labels rather than mapping them by assumption. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `project_details`
**Project Details.** Detailed metadata for each project.
* **Enables:** Review project metadata, instructions, owner, privacy state, attachment and chat counts, and lifecycle timestamps.
* **Scope:** Reads the records selected by Claude Compliance's `/v1/compliance/apps/projects/{id}` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility is limited to organizations and content exposed by the Anthropic Compliance API credential. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. Removal is recognized from the provider's tombstone state rather than absence alone.
Developer identifier: `project_details.attachments_count`
**Attachments Count.** The provider-reported attachments count for each project detail in Project Details. It supplies the attachments count measure for the project detail at the provider's declared unit and grain.
* **Enables:** Measure attachments count through `project_details.attachments_count` for each project detail and compare only values with the same unit and record grain.
* **Interpretation:** Claude Compliance reports attachments count as a measure on each project detail; compare only records with the same unit and aggregation grain. This field is metadata or a reference for the file or attachment; it does not by itself include binary content.
Developer identifier: `project_details.chats_count`
**Chats Count.** The provider-reported chats count for each project detail in Project Details. It supplies the chats count measure for the project detail at the provider's declared unit and grain.
* **Enables:** Measure chats count through `project_details.chats_count` for each project detail and compare only values with the same unit and record grain.
* **Interpretation:** Claude Compliance reports chats count as a measure on each project detail; compare only records with the same unit and aggregation grain.
Developer identifier: `project_details.created_at`
**Created At.** The provider-reported created at for each project detail in Project Details. It anchors the project detail on the provider's reported timeline.
* **Enables:** Order Project Details by created at in `project_details.created_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports created at as a timestamp on each project detail; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `project_details.deleted_at`
**Deleted At.** The provider-reported deleted at for each project detail in Project Details. It anchors the project detail on the provider's reported timeline.
* **Enables:** Order Project Details by deleted at in `project_details.deleted_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports deleted at as a timestamp on each project detail; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `project_details.description`
**Description.** The provider-reported description for each project detail in Project Details. It defines the content surface available for this project detail.
* **Enables:** Locate project detail records by description in `project_details.description`; attribute each text match to its parent project detail and, when present, its reported author.
* **Interpretation:** Claude Compliance supplies description as text on each project detail; referenced files or media are not implied unless explicitly represented.
Developer identifier: `project_details.id`
**ID.** The provider-reported ID for each project detail in Project Details. It provides the reference needed to connect the project detail to the corresponding provider object.
* **Enables:** Match repeated project detail entries on ID in `project_details.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Compliance reports ID as an identifier in its project detail namespace; it is not a universal identity outside Claude Compliance. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `project_details.instructions`
**Instructions.** The provider-reported instructions for each project detail in Project Details. It defines the content surface available for this project detail.
* **Enables:** Locate project detail records by instructions in `project_details.instructions`; attribute each text match to its parent project detail and, when present, its reported author.
* **Interpretation:** Claude Compliance supplies instructions as text on each project detail; referenced files or media are not implied unless explicitly represented.
Developer identifier: `project_details.is_private`
**Is Private.** The provider-reported is private for each project detail in Project Details. It distinguishes the provider-defined is private state or classification for the project detail.
* **Enables:** Filter Project Details by whether is private in `project_details.is_private`; count true, false, and missing results separately.
* **Interpretation:** Claude Compliance reports is private as a boolean on each project detail; a missing field is unknown, not false.
Developer identifier: `project_details.name`
**Name.** The provider-reported name for each project detail in Project Details. It gives the project detail a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each project detail with name from `project_details.name`; distinguish records that share that display name but have different Claude Compliance identifiers.
* **Interpretation:** Claude Compliance reports name as display text for each project detail; names are mutable and are not stable identities.
Developer identifier: `project_details.organization_id`
**Organization ID.** The provider-reported organization ID for each project detail in Project Details. It provides the reference needed to connect the project detail to the corresponding provider object.
* **Enables:** Connect each project detail in Project Details to the referenced organization through `project_details.organization_id`; flag organization ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports organization ID as an identifier in its organization namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `project_details.organization_uuid`
**Organization UUID.** The provider-reported organization UUID for each project detail in Project Details. It provides the reference needed to connect the project detail to the corresponding provider object.
* **Enables:** Connect each project detail in Project Details to the referenced organization through `project_details.organization_uuid`; flag organization UUID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports organization UUID as an identifier in its organization namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `project_details.updated_at`
**Updated At.** The provider-reported updated at for each project detail in Project Details. It anchors the project detail on the provider's reported timeline.
* **Enables:** Order Project Details by updated at in `project_details.updated_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports updated at as a timestamp on each project detail; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `project_details.user`
**User.** The structured user details attached to each project detail in Project Details. It preserves the nested context needed to interpret the parent project detail.
* **Enables:** Attribute user in `project_details.user` to the parent project detail; identify parent records where that nested user object is absent.
* **Interpretation:** Claude Compliance reports user as a nested object on each project detail; optional children may be absent from a valid response.
Developer identifier: `project_documents`
**Project Documents.** Plain-text content for project\_doc attachments.
* **Enables:** Search the plain-text project-document content returned by Anthropic and attribute it to its project and creator.
* **Scope:** Reads the records selected by Claude Compliance's `/v1/compliance/apps/projects/documents/{id}` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility is limited to organizations and content exposed by the Anthropic Compliance API credential. The stream contains plain-text project-document content, not non-document attachment bytes. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `project_documents.content`
**Content.** The provider-reported content for each project document in Project Documents. It defines the content surface available for this project document.
* **Enables:** Locate project document records by content in `project_documents.content`; attribute each text match to its parent project document and, when present, its reported author.
* **Interpretation:** Anthropic returns plain-text project-document content; other attachment bytes are outside this stream.
Developer identifier: `project_documents.created_at`
**Created At.** The provider-reported created at for each project document in Project Documents. It anchors the project document on the provider's reported timeline.
* **Enables:** Order Project Documents by created at in `project_documents.created_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports created at as a timestamp on each project document; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `project_documents.filename`
**Filename.** The provider-reported filename for each project document in Project Documents. It identifies the file, document, recording, or attachment metadata associated with the project document.
* **Enables:** Associate the filename in `project_documents.filename` with its parent project document; inventory the artifact reference without assuming binary content is present.
* **Interpretation:** Claude Compliance reports filename as file, document, recording, or attachment metadata on each project document; binary bytes are not implied. This field is metadata or a reference for the file or attachment; it does not by itself include binary content.
Developer identifier: `project_documents.id`
**ID.** The provider-reported ID for each project document in Project Documents. It provides the reference needed to connect the project document to the corresponding provider object.
* **Enables:** Match repeated project document entries on ID in `project_documents.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Compliance reports ID as an identifier in its project document namespace; it is not a universal identity outside Claude Compliance. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `project_documents.project_id`
**Project ID.** The provider-reported project ID for each project document in Project Documents. It provides the reference needed to connect the project document to the corresponding provider object.
* **Enables:** Connect each project document in Project Documents to the referenced project through `project_documents.project_id`; flag project ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports project ID as an identifier in its project namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `project_documents.user`
**User.** The structured user details attached to each project document in Project Documents. It preserves the nested context needed to interpret the parent project document.
* **Enables:** Attribute user in `project_documents.user` to the parent project document; identify parent records where that nested user object is absent.
* **Interpretation:** Claude Compliance reports user as a nested object on each project document; optional children may be absent from a valid response.
Developer identifier: `projects`
**Projects.** Project metadata from claude.AI.
* **Enables:** Inventory project metadata and connect each project to its owner, organization, privacy state, and lifecycle timestamps.
* **Scope:** Reads the records selected by Claude Compliance's `/v1/compliance/apps/projects` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility is limited to organizations and content exposed by the Anthropic Compliance API credential. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. Removal is recognized from the provider's tombstone state rather than absence alone.
Developer identifier: `projects.created_at`
**Created At.** The provider-reported created at for each project in Projects. It anchors the project on the provider's reported timeline.
* **Enables:** Order Projects by created at in `projects.created_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports created at as a timestamp on each project; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `projects.deleted_at`
**Deleted At.** The provider-reported deleted at for each project in Projects. It anchors the project on the provider's reported timeline.
* **Enables:** Order Projects by deleted at in `projects.deleted_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports deleted at as a timestamp on each project; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `projects.id`
**ID.** The provider-reported ID for each project in Projects. It provides the reference needed to connect the project to the corresponding provider object.
* **Enables:** Match repeated project entries on ID in `projects.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Claude Compliance reports ID as an identifier in its project namespace; it is not a universal identity outside Claude Compliance. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `projects.is_private`
**Is Private.** The provider-reported is private for each project in Projects. It distinguishes the provider-defined is private state or classification for the project.
* **Enables:** Filter Projects by whether is private in `projects.is_private`; count true, false, and missing results separately.
* **Interpretation:** Claude Compliance reports is private as a boolean on each project; a missing field is unknown, not false.
Developer identifier: `projects.name`
**Name.** The provider-reported name for each project in Projects. It gives the project a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each project with name from `projects.name`; distinguish records that share that display name but have different Claude Compliance identifiers.
* **Interpretation:** Claude Compliance reports name as display text for each project; names are mutable and are not stable identities.
Developer identifier: `projects.organization_id`
**Organization ID.** The provider-reported organization ID for each project in Projects. It provides the reference needed to connect the project to the corresponding provider object.
* **Enables:** Connect each project in Projects to the referenced organization through `projects.organization_id`; flag organization ID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports organization ID as an identifier in its organization namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `projects.organization_uuid`
**Organization UUID.** The provider-reported organization UUID for each project in Projects. It provides the reference needed to connect the project to the corresponding provider object.
* **Enables:** Connect each project in Projects to the referenced organization through `projects.organization_uuid`; flag organization UUID values that do not resolve in that provider namespace.
* **Interpretation:** Claude Compliance reports organization UUID as an identifier in its organization namespace; it is not a universal identity outside Claude Compliance.
Developer identifier: `projects.updated_at`
**Updated At.** The provider-reported updated at for each project in Projects. It anchors the project on the provider's reported timeline.
* **Enables:** Order Projects by updated at in `projects.updated_at` and isolate records inside an exact provider reporting window.
* **Interpretation:** Claude Compliance reports updated at as a timestamp on each project; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `projects.user`
**User.** The structured user details attached to each project in Projects. It preserves the nested context needed to interpret the parent project.
* **Enables:** Attribute user in `projects.user` to the parent project; identify parent records where that nested user object is absent.
* **Interpretation:** Claude Compliance reports user as a nested object on each project; optional children may be absent from a valid response.
If validation fails, confirm that the credential is active, the configured account can read the required resources, and every connection field matches the Provider environment.
Parable never returns stored secret values; replace a secret in the connection form when it has expired or been revoked.
# Confluence Cloud
Source: https://docs.parable.work/plugins/provider-plugins/confluencecloud
Sync spaces, pages, users, and audit logs from Confluence Cloud
Sync spaces, pages, users, and audit logs from Confluence Cloud.
## Confluence Cloud setup
Parable lists one **Confluence Cloud** Provider under Atlassian. In the connection wizard, use **Authentication method** to choose **Email + API Token** or **OAuth 2.0 Client Credentials (2LO)**.
Both methods sync the same taps: spaces, pages, page content, users, and audit logs.
## Data streams
This Provider Plugin defines 5 data streams.
| Stream | Description | Sync |
| - | - | - |
| `spaces` | Confluence spaces | full |
| `pages` | Confluence pages | incremental |
| `page_content` | Full page content including body | full |
| `users` | Confluence users | full |
| `audit` | Confluence audit logs | incremental |
### Confluence
#### What You'll Need
| Credential | What it is |
| - | - |
| **API Token** | Generated from Atlassian account settings |
| **Email Address** | Your Atlassian account email |
| **Base URL** | Your Confluence instance URL (e.g., `https://your-company.atlassian.net`) |
| **Domain** | Your Atlassian domain (e.g., `your-company.atlassian.net`) |
#### Prerequisites
* **Confluence Administrator** or **Space Administrator** for comprehensive data access
* **View permission** on spaces and pages you want to sync
#### Setup
1. Create an API token at [https://id.atlassian.com/manage-profile/security/api-tokens](https://id.atlassian.com/manage-profile/security/api-tokens)
2. Note your Confluence site URL (`https://your-company.atlassian.net`) and domain
3. In Parable, select **Email + API Token**, enter credentials and connection settings, then **Save & test connection**
#### What You'll Need
| Credential | What it is |
| - | - |
| **Client ID** | From the service account OAuth 2.0 credential in Atlassian Administration |
| **Client Secret** | From the same OAuth 2.0 credential |
| **Cloud ID** | Site identifier for `api.atlassian.com` gateway URLs |
#### Prerequisites
* Atlassian organization admin access to create service accounts and OAuth credentials
* Confluence product access granted to the service account on the target site
* Confluence permissions on the service account in addition to OAuth scopes
The same Atlassian OAuth client credentials can be reused for Jira Cloud and Confluence Cloud when both products are on the same site, as long as the credential includes the scopes for each product you connect.
#### Setup
1. In [Atlassian Administration](https://admin.atlassian.com), create a service account and grant it **Confluence** access on the target site
2. Create **OAuth 2.0** credentials on that service account with these scopes:
* `read:space:confluence`
* `read:space-details:confluence`
* `read:page:confluence`
* `read:user:confluence`
* `read:audit-log:confluence`
3. Copy **Client ID** and **Client Secret**
4. Find **Cloud ID** via admin console or `GET https://api.atlassian.com/oauth/token/accessible-resources` (use the site `id`)
5. In Parable, select **OAuth 2.0 Client Credentials (2LO)**, enter Client ID, Client Secret, and Cloud ID, then **Save & test connection**
#### OAuth scopes
| Scope | Purpose |
| - | - |
| `read:space:confluence` | Spaces list |
| `read:space-details:confluence` | Space details |
| `read:page:confluence` | Pages and page content |
| `read:user:confluence` | User directory |
| `read:audit-log:confluence` | Audit logs |
Developer identifier: `audit`
**Audit.** Confluence audit logs.
* **Enables:** Trace Confluence audit records to the author, affected object, action, category, source address, and creation time.
* **Scope:** Reads the records selected by Confluence Cloud's `/wiki/rest/api/audit` operation as an event stream using incremental synchronization. This stream is opt-in. Visibility follows the Confluence account and space permissions associated with the credential. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. This stream supplies no reliable deletion signal.
Developer identifier: `audit.affectedObject`
**Affected Object.** The primary object affected by the action. It preserves the nested context needed to interpret the parent audit.
* **Enables:** Attribute affected object in `audit.affectedObject` to the parent audit; identify parent records where that nested affected object object is absent.
* **Interpretation:** Confluence Cloud reports affected object as a nested object on each audit; optional children may be absent from a valid response.
Developer identifier: `audit.affectedObject.name`
**Name.** Name of the object. It gives the Confluence Cloud audit object a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Match repeated Confluence Cloud audit object entries on name in `audit.ConfluenceCloudAuditObject.name`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Confluence Cloud reports name as display text for each Confluence Cloud audit object; names are mutable and are not stable identities.
Developer identifier: `audit.affectedObject.objectType`
**Object Type.** Type of the object (e.g., 'page', 'space', 'user'). It identifies the related provider object that gives the Confluence Cloud audit object its parent, owner, or container context.
* **Enables:** Segment Confluence Cloud audit object entries in Audit by object type in `audit.ConfluenceCloudAuditObject.objectType`; compare counts only within the same Confluence Cloud taxonomy.
* **Interpretation:** Confluence Cloud reports object type as a label from its own taxonomy on each Confluence Cloud audit object; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `audit.associatedObjects`
**Associated Objects.** Additional objects associated with the action (e.g., parent objects). It preserves the nested context needed to interpret the parent audit.
* **Enables:** Attribute every returned Confluence Cloud audit object in `audit.associatedObjects` to its parent audit; keep each relationship distinct and distinguish an absent array from an explicitly empty one.
* **Interpretation:** Confluence Cloud returns associated objects as an array of Confluence Cloud audit object entries on each audit; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `audit.author`
**Author.** User who performed the audited action. It preserves the nested context needed to interpret the parent audit.
* **Enables:** Attribute author in `audit.author` to the parent audit; identify parent records where that nested author object is absent.
* **Interpretation:** Confluence Cloud reports author as a nested object on each audit; optional children may be absent from a valid response.
Developer identifier: `audit.author.accountId`
**Account ID.** Atlassian account ID of the author. It provides the reference needed to connect the audit to the corresponding provider object.
* **Enables:** Connect each Confluence Cloud audit author in Audit to the referenced account through `audit.ConfluenceCloudAuditAuthor.accountId`; flag account ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports account ID as an identifier in its account namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `audit.author.displayName`
**Display Name.** Display name of the author. It distinguishes the provider-defined display name state or classification for the Confluence Cloud audit author.
* **Enables:** Label each Confluence Cloud audit author with display name from `audit.ConfluenceCloudAuditAuthor.displayName`; distinguish records that share that display name but have different Confluence Cloud identifiers.
* **Interpretation:** Confluence Cloud reports display name as display text for each Confluence Cloud audit author; names are mutable and are not stable identities.
Developer identifier: `audit.author.type`
**Type.** Author type (e.g., 'user'). It identifies the related provider object that gives the Confluence Cloud audit author its parent, owner, or container context.
* **Enables:** Segment Confluence Cloud audit author entries in Audit by type in `audit.ConfluenceCloudAuditAuthor.type`; compare counts only within the same Confluence Cloud taxonomy.
* **Interpretation:** Confluence Cloud reports type as a label from its own taxonomy on each Confluence Cloud audit author; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `audit.category`
**Category.** Audit category (e.g., 'permissions', 'pages'). It distinguishes the provider-defined category state or classification for the audit.
* **Enables:** Segment audit entries in Audit by category in `audit.category`; compare counts only within the same Confluence Cloud taxonomy.
* **Interpretation:** Confluence Cloud reports category as a label from its own taxonomy on each audit; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `audit.changedValues`
**Changed Values.** List of value changes recorded for the action. It preserves the nested context needed to interpret the parent audit.
* **Enables:** Search the returned changed values content in `audit.changedValues` while preserving element order and attribution to the parent audit.
* **Interpretation:** Confluence Cloud returns changed values as ordered content or provider-generated content metadata on each audit; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `audit.changedValues.name`
**Name.** Name of the changed field. It gives the Confluence Cloud audit changed value a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Match repeated Confluence Cloud audit changed value entries on name in `audit.ConfluenceCloudAuditChangedValue.name`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Confluence Cloud reports name as display text for each Confluence Cloud audit changed value; names are mutable and are not stable identities.
Developer identifier: `audit.changedValues.newValue`
**New Value.** New value of the field. It must be interpreted with the enclosing provider field name, type, or custom schema for the Confluence Cloud audit changed value.
* **Enables:** Interpret `audit.ConfluenceCloudAuditChangedValue.newValue` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Confluence Cloud reports new value under the enclosing custom or typed field contract on each Confluence Cloud audit changed value; compare it only with values from the same provider key and type.
Developer identifier: `audit.changedValues.oldValue`
**Old Value.** Previous value of the field. It must be interpreted with the enclosing provider field name, type, or custom schema for the Confluence Cloud audit changed value.
* **Enables:** Interpret `audit.ConfluenceCloudAuditChangedValue.oldValue` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Confluence Cloud reports old value under the enclosing custom or typed field contract on each Confluence Cloud audit changed value; compare it only with values from the same provider key and type.
Developer identifier: `audit.creationDate`
**Creation Date.** Unix epoch milliseconds when the audit entry was created. It anchors the audit on the provider's reported timeline.
* **Enables:** Match repeated audit entries on creation date in `audit.creationDate`; collapse only entries that share this declared transform key.
* **Interpretation:** Confluence Cloud reports creation date in milliseconds since the Unix epoch on each audit; it is not ISO-8601 and must be converted with that explicit unit. The connector explicitly marks this field as a transform deduplication key. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `audit.description`
**Description.** Detailed description of the audited action. It defines the content surface available for this audit.
* **Enables:** Locate audit records by description in `audit.description`; attribute each text match to its parent audit and, when present, its reported author.
* **Interpretation:** Confluence Cloud supplies description as text on each audit; referenced files or media are not implied unless explicitly represented.
Developer identifier: `audit.remoteAddress`
**Remote Address.** Remote IP address from which the action was performed. It supplies the provider-reported address or location facet for the audit, not a residency determination.
* **Enables:** Group Audit by the exact remote address in `audit.remoteAddress` while keeping that address or location separate from geolocation and residency claims.
* **Interpretation:** Confluence Cloud reports remote address as an address or location facet on each audit; it does not establish verified geolocation or data residency.
Developer identifier: `audit.summary`
**Summary.** Short human-readable summary of the audited action. It defines the content surface available for this audit.
* **Enables:** Locate audit records by summary in `audit.summary`; attribute each text match to its parent audit and, when present, its reported author.
* **Interpretation:** Confluence Cloud supplies summary as text on each audit; referenced files or media are not implied unless explicitly represented.
Developer identifier: `audit.superAdmin`
**Super Admin.** Whether the action was performed by a super administrator. It distinguishes the provider-defined super admin state or classification for the audit.
* **Enables:** Filter Audit by whether the action was performed by a super administrator in `audit.superAdmin`; count true, false, and missing results separately.
* **Interpretation:** Confluence Cloud reports the action was performed by a super administrator as a boolean on each audit; a missing field is unknown, not false.
Developer identifier: `audit.sysAdmin`
**Sys Admin.** Whether the action was performed by a system administrator. It distinguishes the provider-defined sys admin state or classification for the audit.
* **Enables:** Filter Audit by whether the action was performed by a system administrator in `audit.sysAdmin`; count true, false, and missing results separately.
* **Interpretation:** Confluence Cloud reports the action was performed by a system administrator as a boolean on each audit; a missing field is unknown, not false.
Developer identifier: `page_content`
**Page Content.** Full page content including body.
* **Enables:** Search the full page body representation returned by Confluence and attribute it to the page and version.
* **Scope:** Reads the records selected by Confluence Cloud's `/wiki/api/v2/pages/{id}` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the Confluence account and space permissions associated with the credential. The returned page body is included, but binary attachments and content hidden from the credential are not. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `page_content.authorId`
**Author ID.** Account ID of the page creator. It provides the reference needed to connect the page content to the corresponding provider object.
* **Enables:** Connect each page content in Page Content to the referenced author through `page_content.authorId`; flag author ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports author ID as an identifier in its author namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `page_content.body`
**Body.** Body content of the page in the requested representation(s). It preserves the nested context needed to interpret the parent page content.
* **Enables:** Attribute body in `page_content.body` to the parent page content; identify parent records where that nested body object is absent.
* **Interpretation:** Confluence Cloud reports body as a nested object on each page content; optional children may be absent from a valid response.
Developer identifier: `page_content.body.atlas_doc_format`
**Atlas Doc Format.** Page body in Atlassian Document Format (JSON-based). It preserves the nested context needed to interpret the parent page content.
* **Enables:** Attribute atlas doc format in `page_content.PageContentBody.atlas_doc_format` to the parent page content; identify parent records where that nested atlas doc format object is absent.
* **Interpretation:** Confluence Cloud reports atlas doc format as a nested object on each page content body; optional children may be absent from a valid response.
Developer identifier: `page_content.body.atlas_doc_format.representation`
**Representation.** The representation type identifier (e.g., 'storage', 'atlas\_doc\_format'). It identifies the related provider object that gives the page content body representation its parent, owner, or container context.
* **Enables:** Connect each page content body representation to the related representation in `page_content.PageContentBodyRepresentation.representation` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** Confluence Cloud reports representation as relationship context on each page content body representation; resolve it in the named provider namespace rather than by display text alone.
Developer identifier: `page_content.body.atlas_doc_format.value`
**Value.** The body content string in the given representation format. It supplies the returned value text needed to understand the page content body representation in context.
* **Enables:** Search the returned value text in `page_content.PageContentBodyRepresentation.value` and attribute each match to its parent page content and reported author when available.
* **Interpretation:** Confluence Cloud supplies value as returned text on each page content body representation; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `page_content.body.storage`
**Storage.** Page body in Confluence storage format (XHTML-based). It preserves the nested context needed to interpret the parent page content.
* **Enables:** Attribute storage in `page_content.PageContentBody.storage` to the parent page content; identify parent records where that nested storage object is absent.
* **Interpretation:** Confluence Cloud reports storage as a nested object on each page content body; optional children may be absent from a valid response.
Developer identifier: `page_content.createdAt`
**Created At.** Timestamp when the page was originally created (ISO 8601). It anchors the page content on the provider's reported timeline.
* **Enables:** Order Page Content by created at in `page_content.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Confluence Cloud reports created at as a timestamp on each page content; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `page_content.id`
**ID.** Unique identifier for the page. It provides the reference needed to connect the page content to the corresponding provider object.
* **Enables:** Match repeated page content entries on ID in `page_content.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Confluence Cloud reports ID as an identifier in its page content namespace; it is not a universal identity outside Confluence Cloud. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `page_content.lastOwnerId`
**Last Owner ID.** Account ID of the previous page owner. It provides the reference needed to connect the page content to the corresponding provider object.
* **Enables:** Connect each page content in Page Content to the referenced last owner through `page_content.lastOwnerId`; flag last owner ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports last owner ID as an identifier in its last owner namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `page_content.ownerId`
**Owner ID.** Account ID of the page owner. It provides the reference needed to connect the page content to the corresponding provider object.
* **Enables:** Connect each page content in Page Content to the referenced owner through `page_content.ownerId`; flag owner ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports owner ID as an identifier in its owner namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `page_content.page_id`
**Page ID.** Parent page reference copied into each page content because the child operation does not return that relationship. It provides the reference needed to connect the page content to the corresponding provider object.
* **Enables:** Connect each page content in Page Content to the referenced page through `page_content.page_id`; flag page ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies page ID from the parent traversal record into each page content; the child Confluence Cloud operation does not return it.
Developer identifier: `page_content.parentId`
**Parent ID.** ID of the parent page, if any. It provides the reference needed to connect the page content to the corresponding provider object.
* **Enables:** Connect each page content in Page Content to the referenced parent through `page_content.parentId`; flag parent ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports parent ID as an identifier in its parent namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `page_content.parentType`
**Parent Type.** Type of the parent entity (page or space). It identifies the related provider object that gives the page content its parent, owner, or container context.
* **Enables:** Segment page content entries in Page Content by parent type in `page_content.parentType`; compare counts only within the same Confluence Cloud taxonomy.
* **Interpretation:** Confluence Cloud reports parent type as a label from its own taxonomy on each page content; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `page_content.position`
**Position.** The position of the page relative to its siblings in the page tree. It supplies the position measure for the page content at the provider's declared unit and grain.
* **Enables:** Measure position through `page_content.position` for each page content and compare only values with the same unit and record grain.
* **Interpretation:** Confluence Cloud reports position as a measure on each page content; compare only records with the same unit and aggregation grain.
Developer identifier: `page_content.spaceId`
**Space ID.** ID of the space containing this page. It provides the reference needed to connect the page content to the corresponding provider object.
* **Enables:** Connect each page content in Page Content to the referenced space through `page_content.spaceId`; flag space ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports space ID as an identifier in its space namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `page_content.status`
**Status.** Page status (current, archived, trashed, draft, deleted). It distinguishes the provider-defined status state or classification for the page content.
* **Enables:** Segment page content entries in Page Content by status in `page_content.status`; compare counts only within the same Confluence Cloud taxonomy.
* **Interpretation:** Confluence Cloud reports status as a label from its own taxonomy on each page content; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `page_content.title`
**Title.** Title of the page. It gives the page content a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each page content with title from `page_content.title`; distinguish records that share that display name but have different Confluence Cloud identifiers.
* **Interpretation:** Confluence Cloud reports title as display text for each page content; names are mutable and are not stable identities.
Developer identifier: `page_content.version`
**Version.** Version information for the latest revision of the page. It preserves the nested context needed to interpret the parent page content.
* **Enables:** Attribute version in `page_content.version` to the parent page content; identify parent records where that nested version object is absent.
* **Interpretation:** Confluence Cloud reports version as a nested object on each page content; optional children may be absent from a valid response.
Developer identifier: `page_content.version.authorId`
**Author ID.** Account ID of the user who made this version edit. It provides the reference needed to connect the page content to the corresponding provider object.
* **Enables:** Connect each page content version in Page Content to the referenced author through `page_content.PageContentVersion.authorId`; flag author ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports author ID as an identifier in its author namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `page_content.version.createdAt`
**Created At.** Timestamp when this version was created. It anchors the page content on the provider's reported timeline.
* **Enables:** Order Page Content by created at in `page_content.PageContentVersion.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Confluence Cloud reports created at as a timestamp on each page content version; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `page_content.version.message`
**Message.** Optional message provided by the editor for this version. It supplies the returned message text needed to understand the page content version in context.
* **Enables:** Search the returned message text in `page_content.PageContentVersion.message` and attribute each match to its parent page content and reported author when available.
* **Interpretation:** Confluence Cloud supplies message as returned text on each page content version; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `page_content.version.minorEdit`
**Minor Edit.** Whether this version was flagged as a minor edit. It distinguishes the provider-defined minor edit state or classification for the page content version.
* **Enables:** Filter Page Content by whether this version was flagged as a minor edit in `page_content.PageContentVersion.minorEdit`; count true, false, and missing results separately.
* **Interpretation:** Confluence Cloud reports this version was flagged as a minor edit as a boolean on each page content version; a missing field is unknown, not false.
Developer identifier: `page_content.version.number`
**Number.** Version number indicating how many times the page has been edited. It supplies the number measure for the page content version at the provider's declared unit and grain.
* **Enables:** Measure number through `page_content.PageContentVersion.number` for each page content version and compare only values with the same unit and record grain.
* **Interpretation:** Confluence Cloud reports number as a measure on each page content version; compare only records with the same unit and aggregation grain.
Developer identifier: `pages`
**Pages.** Confluence pages.
* **Enables:** Inventory Confluence page metadata and connect each page to its space, parent, author, and content fetch.
* **Scope:** Reads the records selected by Confluence Cloud's `/wiki/api/v2/pages` operation as a snapshot stream using incremental synchronization. Visibility follows the Confluence account and space permissions associated with the credential. Page list records are metadata; the separate page-content stream carries the returned body representation. This stream supplies no reliable deletion signal.
Developer identifier: `pages._links`
**Links.** Links related to this page resource. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute links in `pages._links` to the parent page; identify parent records where that nested links object is absent.
* **Interpretation:** Confluence Cloud reports links as a nested object on each page; optional children may be absent from a valid response.
Developer identifier: `pages._links.base`
**Base.** Base URL of the Confluence instance. It locates the provider resource or path associated with the page link.
* **Enables:** Associate each page link with the resource identified by base in `pages.PageLinks.base`; verify the link resolves to the expected Confluence Cloud object.
* **Interpretation:** Confluence Cloud reports base as a resource locator for each page link; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `pages._links.editui`
**Editui.** Relative URL to edit the page in the Confluence web UI. It locates the provider resource or path associated with the page link.
* **Enables:** Resolve the page's provider resource or path through `pages.PageLinks.editui`; verify access separately and do not infer that linked content was ingested.
* **Interpretation:** Confluence Cloud returns editui as a resource locator or path for each page link; access can expire or depend on viewer permissions, and linked content is not implied.
Developer identifier: `pages._links.next`
**Next.** URL or relative path for the next page of results (pagination). It is needed to continue the provider result set without skipping or repeating a page.
* **Enables:** Resume Confluence Cloud pagination from `pages.PageLinks.next` and verify that every page boundary advances before requesting the next result set.
* **Interpretation:** Confluence Cloud returns next as opaque pagination state; it has no business meaning and must be replayed exactly when requesting the next page.
Developer identifier: `pages._links.self`
**Self.** Full API URL for this page resource. It locates the provider resource or path associated with the page link.
* **Enables:** Associate each page link with the resource identified by self in `pages.PageLinks.self`; verify the link resolves to the expected Confluence Cloud object.
* **Interpretation:** Confluence Cloud reports self as a resource locator for each page link; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `pages._links.tinyui`
**Tinyui.** Short relative URL (tiny link) for the page. It locates the provider resource or path associated with the page link.
* **Enables:** Resolve the page's provider resource or path through `pages.PageLinks.tinyui`; verify access separately and do not infer that linked content was ingested.
* **Interpretation:** Confluence Cloud returns tinyui as a resource locator or path for each page link; access can expire or depend on viewer permissions, and linked content is not implied.
Developer identifier: `pages._links.webui`
**Webui.** Relative URL to the page in the Confluence web UI. It is needed to continue the provider result set without skipping or repeating a page.
* **Enables:** Resume Confluence Cloud pagination from `pages.PageLinks.webui` and verify that every page boundary advances before requesting the next result set.
* **Interpretation:** Confluence Cloud returns webui as opaque pagination state; it has no business meaning and must be replayed exactly when requesting the next page.
Developer identifier: `pages.authorId`
**Author ID.** Account ID of the page creator. It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Connect each page in Pages to the referenced author through `pages.authorId`; flag author ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports author ID as an identifier in its author namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `pages.body`
**Body.** Body content of the page in the requested format. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute body in `pages.body` to the parent page; identify parent records where that nested body object is absent.
* **Interpretation:** Confluence Cloud reports body as a nested object on each page; optional children may be absent from a valid response.
Developer identifier: `pages.body.atlas_doc_format`
**Atlas Doc Format.** Page body in Atlassian Document Format (JSON-based). It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute atlas doc format in `pages.PageBody.atlas_doc_format` to the parent page; identify parent records where that nested atlas doc format object is absent.
* **Interpretation:** Confluence Cloud reports atlas doc format as a nested object on each page body; optional children may be absent from a valid response.
Developer identifier: `pages.body.atlas_doc_format.representation`
**Representation.** The representation type identifier (e.g., 'storage', 'atlas\_doc\_format'). It identifies the related provider object that gives the body representation its parent, owner, or container context.
* **Enables:** Connect each body representation to the related representation in `pages.BodyRepresentation.representation` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** Confluence Cloud reports representation as relationship context on each body representation; resolve it in the named provider namespace rather than by display text alone.
Developer identifier: `pages.body.atlas_doc_format.value`
**Value.** The body content string in the given representation format. It supplies the returned value text needed to understand the body representation in context.
* **Enables:** Search the returned value text in `pages.BodyRepresentation.value` and attribute each match to its parent page and reported author when available.
* **Interpretation:** Confluence Cloud supplies value as returned text on each body representation; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `pages.body.storage`
**Storage.** Page body in Confluence storage format (XHTML-based). It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute storage in `pages.PageBody.storage` to the parent page; identify parent records where that nested storage object is absent.
* **Interpretation:** Confluence Cloud reports storage as a nested object on each page body; optional children may be absent from a valid response.
Developer identifier: `pages.createdAt`
**Created At.** Timestamp when the page was originally created (ISO 8601). It anchors the page on the provider's reported timeline.
* **Enables:** Order Pages by created at in `pages.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Confluence Cloud reports created at as a timestamp on each page; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `pages.id`
**ID.** Unique identifier for the page. It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Match repeated page entries on ID in `pages.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Confluence Cloud reports ID as an identifier in its page namespace; it is not a universal identity outside Confluence Cloud. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `pages.lastOwnerId`
**Last Owner ID.** Account ID of the previous page owner. It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Connect each page in Pages to the referenced last owner through `pages.lastOwnerId`; flag last owner ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports last owner ID as an identifier in its last owner namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `pages.ownerId`
**Owner ID.** Account ID of the page owner (may differ from author). It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Connect each page in Pages to the referenced owner through `pages.ownerId`; flag owner ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports owner ID as an identifier in its owner namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `pages.parentId`
**Parent ID.** ID of the parent page, if any. It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Connect each page in Pages to the referenced parent through `pages.parentId`; flag parent ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports parent ID as an identifier in its parent namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `pages.parentType`
**Parent Type.** Type of the parent entity (page or space). It distinguishes the provider-defined parent type state or classification for the page.
* **Enables:** Segment page entries in Pages by parent type in `pages.parentType`; compare counts only within the same Confluence Cloud taxonomy.
* **Interpretation:** Confluence Cloud reports parent type as a label from its own taxonomy on each page; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `pages.position`
**Position.** The position of the page relative to its siblings in the page tree. It supplies the position measure for the page at the provider's declared unit and grain.
* **Enables:** Measure position through `pages.position` for each page and compare only values with the same unit and record grain.
* **Interpretation:** Confluence Cloud reports position as a measure on each page; compare only records with the same unit and aggregation grain.
Developer identifier: `pages.spaceId`
**Space ID.** ID of the space containing this page. It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Connect each page in Pages to the referenced space through `pages.spaceId`; flag space ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports space ID as an identifier in its space namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `pages.status`
**Status.** Page status (current, archived, trashed, draft, etc.). It distinguishes the provider-defined status state or classification for the page.
* **Enables:** Segment page entries in Pages by status in `pages.status`; compare counts only within the same Confluence Cloud taxonomy.
* **Interpretation:** Confluence Cloud reports status as a label from its own taxonomy on each page; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `pages.title`
**Title.** Title of the page. It gives the page a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each page with title from `pages.title`; distinguish records that share that display name but have different Confluence Cloud identifiers.
* **Interpretation:** Confluence Cloud reports title as display text for each page; names are mutable and are not stable identities.
Developer identifier: `pages.version`
**Version.** Version information for the latest revision of the page. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute version in `pages.version` to the parent page; identify parent records where that nested version object is absent.
* **Interpretation:** Confluence Cloud reports version as a nested object on each page; optional children may be absent from a valid response.
Developer identifier: `pages.version.authorId`
**Author ID.** Account ID of the user who made this version edit. It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Connect each page version in Pages to the referenced author through `pages.PageVersion.authorId`; flag author ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports author ID as an identifier in its author namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `pages.version.createdAt`
**Created At.** Timestamp when this version was created (effectively the last modified date). It anchors the page on the provider's reported timeline.
* **Enables:** Order Pages by created at in `pages.PageVersion.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Confluence Cloud reports created at as a timestamp on each page version; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `pages.version.message`
**Message.** Optional message provided by the editor for this version. It supplies the returned message text needed to understand the page version in context.
* **Enables:** Search the returned message text in `pages.PageVersion.message` and attribute each match to its parent page and reported author when available.
* **Interpretation:** Confluence Cloud supplies message as returned text on each page version; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `pages.version.minorEdit`
**Minor Edit.** Whether this version was flagged as a minor edit. It distinguishes the provider-defined minor edit state or classification for the page version.
* **Enables:** Filter Pages by whether this version was flagged as a minor edit in `pages.PageVersion.minorEdit`; count true, false, and missing results separately.
* **Interpretation:** Confluence Cloud reports this version was flagged as a minor edit as a boolean on each page version; a missing field is unknown, not false.
Developer identifier: `pages.version.number`
**Number.** Version number indicating how many times the page has been edited. It supplies the number measure for the page version at the provider's declared unit and grain.
* **Enables:** Measure number through `pages.PageVersion.number` for each page version and compare only values with the same unit and record grain.
* **Interpretation:** Confluence Cloud reports number as a measure on each page version; compare only records with the same unit and aggregation grain.
Developer identifier: `spaces`
**Spaces.** Confluence spaces.
* **Enables:** Inventory Confluence spaces by key, name, type, status, homepage, author, and creation time.
* **Scope:** Reads the records selected by Confluence Cloud's `/wiki/api/v2/spaces` operation as a snapshot stream using full synchronization. Visibility follows the Confluence account and space permissions associated with the credential. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `spaces._links`
**Links.** Links related to this space resource. It preserves the nested context needed to interpret the parent space.
* **Enables:** Attribute links in `spaces._links` to the parent space; identify parent records where that nested links object is absent.
* **Interpretation:** Confluence Cloud reports links as a nested object on each space; optional children may be absent from a valid response.
Developer identifier: `spaces._links.self`
**Self.** Self link URL for the space API resource. It locates the provider resource or path associated with the space link.
* **Enables:** Associate each space link with the resource identified by self in `spaces.SpaceLinks.self`; verify the link resolves to the expected Confluence Cloud object.
* **Interpretation:** Confluence Cloud reports self as a resource locator for each space link; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `spaces._links.webui`
**Webui.** Relative web UI path for the space. It is needed to continue the provider result set without skipping or repeating a page.
* **Enables:** Resume Confluence Cloud pagination from `spaces.SpaceLinks.webui` and verify that every page boundary advances before requesting the next result set.
* **Interpretation:** Confluence Cloud returns webui as opaque pagination state; it has no business meaning and must be replayed exactly when requesting the next page.
Developer identifier: `spaces.authorId`
**Author ID.** Account ID of the space creator. It provides the reference needed to connect the space to the corresponding provider object.
* **Enables:** Connect each space in Spaces to the referenced author through `spaces.authorId`; flag author ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports author ID as an identifier in its author namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `spaces.createdAt`
**Created At.** ISO 8601 timestamp when the space was created. It anchors the space on the provider's reported timeline.
* **Enables:** Order Spaces by created at in `spaces.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Confluence Cloud reports created at as a timestamp on each space; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `spaces.currentActiveAlias`
**Current Active Alias.** Human-readable alias currently in use for the space. For spaces created under the new space-key model this is the value users see and reference, and it can differ from key. It identifies the related provider object that gives the space its parent, owner, or container context.
* **Enables:** Connect each space to the related current active alias in `spaces.currentActiveAlias` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** Confluence Cloud reports current active alias as relationship context on each space; resolve it in the named provider namespace rather than by display text alone.
Developer identifier: `spaces.description`
**Description.** Description of the space in the requested format. It preserves the nested context needed to interpret the parent space.
* **Enables:** Attribute description in `spaces.description` to the parent space; identify parent records where that nested description object is absent.
* **Interpretation:** Confluence Cloud reports description as a nested object on each space; optional children may be absent from a valid response.
Developer identifier: `spaces.description.plain`
**Plain.** Plain text representation of the space description. It preserves the nested context needed to interpret the parent space.
* **Enables:** Attribute plain in `spaces.SpaceDescription.plain` to the parent space; identify parent records where that nested plain object is absent.
* **Interpretation:** Confluence Cloud reports plain as a nested object on each space description; optional children may be absent from a valid response.
Developer identifier: `spaces.description.plain.representation`
**Representation.** The representation format (e.g., 'plain', 'view'). It must be interpreted with the enclosing provider field name, type, or custom schema for the space description body.
* **Enables:** Interpret `spaces.SpaceDescriptionBody.representation` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Confluence Cloud reports representation under the enclosing custom or typed field contract on each space description body; compare it only with values from the same provider key and type.
Developer identifier: `spaces.description.plain.value`
**Value.** The description content in the given representation. It supplies the returned value text needed to understand the space description body in context.
* **Enables:** Search the returned value text in `spaces.SpaceDescriptionBody.value` and attribute each match to its parent space and reported author when available.
* **Interpretation:** Confluence Cloud supplies value as returned text on each space description body; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `spaces.description.view`
**View.** View (rendered HTML) representation of the space description. It preserves the nested context needed to interpret the parent space.
* **Enables:** Attribute view in `spaces.SpaceDescription.view` to the parent space; identify parent records where that nested view object is absent.
* **Interpretation:** Confluence Cloud reports view as a nested object on each space description; optional children may be absent from a valid response.
Developer identifier: `spaces.homepageId`
**Homepage ID.** ID of the space's homepage content. It provides the reference needed to connect the space to the corresponding provider object.
* **Enables:** Connect each space in Spaces to the referenced homepage through `spaces.homepageId`; flag homepage ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports homepage ID as an identifier in its homepage namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `spaces.icon`
**Icon.** Icon associated with the space. Only present when include-icon is true. It preserves the nested context needed to interpret the parent space.
* **Enables:** Attribute icon in `spaces.icon` to the parent space; identify parent records where that nested icon object is absent.
* **Interpretation:** Confluence Cloud reports icon as a nested object on each space; optional children may be absent from a valid response.
Developer identifier: `spaces.icon.apiDownloadLink`
**API Download Link.** API download link for the space icon. It locates the provider resource or path associated with the space icon.
* **Enables:** Associate each space icon with the resource identified by API download link in `spaces.SpaceIcon.apiDownloadLink`; verify the link resolves to the expected Confluence Cloud object.
* **Interpretation:** Confluence Cloud reports API download link as a resource locator for each space icon; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `spaces.icon.path`
**Path.** Relative path to the space icon image. It locates the provider resource or path associated with the space icon.
* **Enables:** Resolve the space's provider resource or path through `spaces.SpaceIcon.path`; verify access separately and do not infer that linked content was ingested.
* **Interpretation:** Confluence Cloud returns path as a resource locator or path for each space icon; access can expire or depend on viewer permissions, and linked content is not implied.
Developer identifier: `spaces.id`
**ID.** Unique identifier for the space. It provides the reference needed to connect the space to the corresponding provider object.
* **Enables:** Match repeated space entries on ID in `spaces.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Confluence Cloud reports ID as an identifier in its space namespace; it is not a universal identity outside Confluence Cloud. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `spaces.key`
**Key.** Short unique key for the space (e.g., 'ENG'). It provides the reference needed to connect the space to the corresponding provider object.
* **Enables:** Connect each space in Spaces to the referenced space through `spaces.key`; flag key values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports key as an identifier in its space namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `spaces.name`
**Name.** Display name of the space. It gives the space a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each space with name from `spaces.name`; distinguish records that share that display name but have different Confluence Cloud identifiers.
* **Interpretation:** Confluence Cloud reports name as display text for each space; names are mutable and are not stable identities.
Developer identifier: `spaces.status`
**Status.** Space status (current or archived). It distinguishes the provider-defined status state or classification for the space.
* **Enables:** Segment space entries in Spaces by status in `spaces.status`; compare counts only within the same Confluence Cloud taxonomy.
* **Interpretation:** Confluence Cloud reports status as a label from its own taxonomy on each space; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `spaces.type`
**Type.** Space type (global or personal). It distinguishes the provider-defined type state or classification for the space.
* **Enables:** Segment space entries in Spaces by type in `spaces.type`; compare counts only within the same Confluence Cloud taxonomy.
* **Interpretation:** Confluence Cloud reports type as a label from its own taxonomy on each space; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `users`
**Users.** Confluence users.
* **Enables:** Reconcile Confluence account identifiers and display names to account type and active status when visible to the credential.
* **Scope:** Reads the records selected by Confluence Cloud's `/wiki/rest/api/search/user` operation as a snapshot stream using full synchronization. Visibility follows the Confluence account and space permissions associated with the credential. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `users._links`
**Links.** HAL-style links related to this user resource. It preserves the nested context needed to interpret the parent user.
* **Enables:** Attribute links in `users._links` to the parent user; identify parent records where that nested links object is absent.
* **Interpretation:** Confluence Cloud reports links as a nested object on each user; optional children may be absent from a valid response.
Developer identifier: `users._links.base`
**Base.** Base URL of the Confluence instance. It locates the provider resource or path associated with the Confluence Cloud user link.
* **Enables:** Associate each Confluence Cloud user link with the resource identified by base in `users.ConfluenceCloudUserLinks.base`; verify the link resolves to the expected Confluence Cloud object.
* **Interpretation:** Confluence Cloud reports base as a resource locator for each Confluence Cloud user link; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `users._links.next`
**Next.** Relative URL for the next page of results (present only in list envelope, included here for completeness). It is needed to continue the provider result set without skipping or repeating a page.
* **Enables:** Resume Confluence Cloud pagination from `users.ConfluenceCloudUserLinks.next` and verify that every page boundary advances before requesting the next result set.
* **Interpretation:** Confluence Cloud returns next as opaque pagination state; it has no business meaning and must be replayed exactly when requesting the next page.
Developer identifier: `users._links.self`
**Self.** Full URL to the user API resource. It locates the provider resource or path associated with the Confluence Cloud user link.
* **Enables:** Associate each Confluence Cloud user link with the resource identified by self in `users.ConfluenceCloudUserLinks.self`; verify the link resolves to the expected Confluence Cloud object.
* **Interpretation:** Confluence Cloud reports self as a resource locator for each Confluence Cloud user link; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `users.accountId`
**Account ID.** Unique Atlassian account ID for the user. Primary key for cross-referencing users across all Confluence content and Atlassian products. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Match repeated user entries on account ID in `users.accountId`; collapse only entries that share this declared transform key.
* **Interpretation:** Confluence Cloud reports account ID as an identifier in its account namespace; it is not a universal identity outside Confluence Cloud. The connector explicitly marks this field as a transform deduplication key. A connector directive maps this field to account identity.
Developer identifier: `users.accountType`
**Account Type.** Type of account. Distinguishes human users from service accounts for accurate tool adoption metrics. It distinguishes the provider-defined account type state or classification for the user.
* **Enables:** Segment user entries in Users by account type in `users.accountType`; compare counts only within the same Confluence Cloud taxonomy.
* **Interpretation:** Confluence Cloud reports account type as a label from its own taxonomy on each user; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `users.displayName`
**Display Name.** Display name shown in the UI. Fallback display name for user identification. It distinguishes the provider-defined display name state or classification for the user.
* **Enables:** Label each user with display name from `users.displayName`; distinguish records that share that display name but have different Confluence Cloud identifiers.
* **Interpretation:** Confluence Cloud reports display name as display text for each user; names are mutable and are not stable identities. A connector directive maps this field to a person's display name.
Developer identifier: `users.email`
**Email.** Email address of the user. Primary cross-connector identity resolution field for matching users across SaaS tools. It supplies the provider-reported address or location facet for the user, not a residency determination.
* **Enables:** Attribute each user to a person or account by the exact email in `users.email`; identify addresses that do not match the Confluence Cloud directory.
* **Interpretation:** Confluence Cloud reports email as an address on each user; aliases, casing, and unverified addresses can prevent a one-to-one person match. A connector directive maps this field to a person's email identity.
Developer identifier: `users.isExternalCollaborator`
**Is External Collaborator.** Whether the user is an external collaborator (guest) in the Confluence instance. It distinguishes the provider-defined is external collaborator state or classification for the user.
* **Enables:** Filter Users by whether the user is an external collaborator (guest) in the confluence instance in `users.isExternalCollaborator`; count true, false, and missing results separately.
* **Interpretation:** Confluence Cloud reports the user is an external collaborator (guest) in the confluence instance as a boolean on each user; a missing field is unknown, not false.
Developer identifier: `users.operations`
**Operations.** List of permitted operations for this user in the current context. It preserves the nested context needed to interpret the parent user.
* **Enables:** Compare the exact Confluence Cloud-configured operations set in `users.operations` for each user; preserve provider labels and unknown entries.
* **Interpretation:** Confluence Cloud returns operations as an array of Confluence Cloud operation entries on each user; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `users.operations.operation`
**Operation.** The operation type, e.g. 'use', 'create', 'read', 'update', 'delete', 'administer'. It distinguishes the provider-defined operation state or classification for the Confluence Cloud operation.
* **Enables:** Filter Users by the exact Confluence Cloud-defined operation in `users.ConfluenceCloudOperation.operation` and preserve unknown values as distinct categories.
* **Interpretation:** Confluence Cloud supplies operation from its own taxonomy on each Confluence Cloud operation; preserve unknown and newly introduced labels.
Developer identifier: `users.operations.targetType`
**Target Type.** The target entity type the operation applies to, e.g. 'page', 'blogpost', 'space', 'application'. It identifies the related provider object that gives the Confluence Cloud operation its parent, owner, or container context.
* **Enables:** Segment Confluence Cloud operation entries in Users by target type in `users.ConfluenceCloudOperation.targetType`; compare counts only within the same Confluence Cloud taxonomy.
* **Interpretation:** Confluence Cloud reports target type as a label from its own taxonomy on each Confluence Cloud operation; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `users.personalSpace`
**Personal Space.** Reference to the user's personal space, if one exists. It preserves the nested context needed to interpret the parent user.
* **Enables:** Attribute personal space in `users.personalSpace` to the parent user; identify parent records where that nested personal space object is absent.
* **Interpretation:** Confluence Cloud reports personal space as a nested object on each user; optional children may be absent from a valid response.
Developer identifier: `users.personalSpace._links`
**Links.** Links related to this space. It preserves the nested context needed to interpret the parent user.
* **Enables:** Attribute links in `users.ConfluenceCloudPersonalSpace._links` to the parent user; identify parent records where that nested links object is absent.
* **Interpretation:** Confluence Cloud reports links as a nested object on each Confluence Cloud personal space; optional children may be absent from a valid response.
Developer identifier: `users.personalSpace._links.self`
**Self.** Full URL to the space API resource. It locates the provider resource or path associated with the Confluence Cloud space link.
* **Enables:** Associate each Confluence Cloud space link with the resource identified by self in `users.ConfluenceCloudSpaceLinks.self`; verify the link resolves to the expected Confluence Cloud object.
* **Interpretation:** Confluence Cloud reports self as a resource locator for each Confluence Cloud space link; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `users.personalSpace._links.webui`
**Webui.** Relative URL to the space in the Confluence web UI. It is needed to continue the provider result set without skipping or repeating a page.
* **Enables:** Resume Confluence Cloud pagination from `users.ConfluenceCloudSpaceLinks.webui` and verify that every page boundary advances before requesting the next result set.
* **Interpretation:** Confluence Cloud returns webui as opaque pagination state; it has no business meaning and must be replayed exactly when requesting the next page.
Developer identifier: `users.personalSpace.id`
**ID.** Numeric ID of the personal space. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Connect each Confluence Cloud personal space in Users to the referenced Confluence Cloud personal space through `users.ConfluenceCloudPersonalSpace.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports ID as an identifier in its Confluence Cloud personal space namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `users.personalSpace.key`
**Key.** The space key, typically prefixed with \~ for personal spaces. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Connect each Confluence Cloud personal space in Users to the referenced Confluence Cloud personal space through `users.ConfluenceCloudPersonalSpace.key`; flag key values that do not resolve in that provider namespace.
* **Interpretation:** Confluence Cloud reports key as an identifier in its Confluence Cloud personal space namespace; it is not a universal identity outside Confluence Cloud.
Developer identifier: `users.personalSpace.name`
**Name.** Display name of the personal space. It gives the Confluence Cloud personal space a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each Confluence Cloud personal space with name from `users.ConfluenceCloudPersonalSpace.name`; distinguish records that share that display name but have different Confluence Cloud identifiers.
* **Interpretation:** Confluence Cloud reports name as display text for each Confluence Cloud personal space; names are mutable and are not stable identities.
Developer identifier: `users.personalSpace.status`
**Status.** Current status of the space, e.g. 'current' or 'archived'. It identifies the related provider object that gives the Confluence Cloud personal space its parent, owner, or container context.
* **Enables:** Segment Confluence Cloud personal space entries in Users by status in `users.ConfluenceCloudPersonalSpace.status`; compare counts only within the same Confluence Cloud taxonomy.
* **Interpretation:** Confluence Cloud reports status as a label from its own taxonomy on each Confluence Cloud personal space; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `users.personalSpace.type`
**Type.** Type of space, e.g. 'personal' or 'global'. It identifies the related provider object that gives the Confluence Cloud personal space its parent, owner, or container context.
* **Enables:** Segment Confluence Cloud personal space entries in Users by type in `users.ConfluenceCloudPersonalSpace.type`; compare counts only within the same Confluence Cloud taxonomy.
* **Interpretation:** Confluence Cloud reports type as a label from its own taxonomy on each Confluence Cloud personal space; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `users.profilePicture`
**Profile Picture.** Profile picture metadata for the user. It preserves the nested context needed to interpret the parent user.
* **Enables:** Attribute profile picture in `users.profilePicture` to the parent user; identify parent records where that nested profile picture object is absent.
* **Interpretation:** Confluence Cloud reports profile picture as a nested object on each user; optional children may be absent from a valid response.
Developer identifier: `users.profilePicture.height`
**Height.** Height of the profile picture in pixels. It supplies the height measure for the Confluence Cloud profile picture at the provider's declared unit and grain.
* **Enables:** Measure height through `users.ConfluenceCloudProfilePicture.height` for each Confluence Cloud profile picture and compare only values with the same unit and record grain.
* **Interpretation:** Confluence Cloud reports height as a measure on each Confluence Cloud profile picture; compare only records with the same unit and aggregation grain.
Developer identifier: `users.profilePicture.isDefault`
**Is Default.** Whether this is the default/generated avatar rather than a user-uploaded image. It distinguishes the provider-defined is default state or classification for the Confluence Cloud profile picture.
* **Enables:** Filter Users by whether this is the default/generated avatar rather than a user-uploaded image in `users.ConfluenceCloudProfilePicture.isDefault`; count true, false, and missing results separately.
* **Interpretation:** Confluence Cloud reports this is the default/generated avatar rather than a user-uploaded image as a boolean on each Confluence Cloud profile picture; a missing field is unknown, not false.
Developer identifier: `users.profilePicture.path`
**Path.** Relative path to the profile picture resource. It locates the provider resource or path associated with the Confluence Cloud profile picture.
* **Enables:** Resolve the user's provider resource or path through `users.ConfluenceCloudProfilePicture.path`; verify access separately and do not infer that linked content was ingested.
* **Interpretation:** Confluence Cloud returns path as a resource locator or path for each Confluence Cloud profile picture; access can expire or depend on viewer permissions, and linked content is not implied.
Developer identifier: `users.profilePicture.width`
**Width.** Width of the profile picture in pixels. It supplies the width measure for the Confluence Cloud profile picture at the provider's declared unit and grain.
* **Enables:** Measure width through `users.ConfluenceCloudProfilePicture.width` for each Confluence Cloud profile picture and compare only values with the same unit and record grain.
* **Interpretation:** Confluence Cloud reports width as a measure on each Confluence Cloud profile picture; compare only records with the same unit and aggregation grain.
Developer identifier: `users.publicName`
**Public Name.** Display name of the user. Human-readable identifier for org overview reporting. It identifies the related provider object that gives the user its parent, owner, or container context.
* **Enables:** Label each user with public name from `users.publicName`; distinguish records that share that display name but have different Confluence Cloud identifiers.
* **Interpretation:** Confluence Cloud reports public name as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.type`
**Type.** The object type identifier, typically 'known' for recognized users. It identifies the related provider object that gives the user its parent, owner, or container context.
* **Enables:** Segment user entries in Users by type in `users.type`; compare counts only within the same Confluence Cloud taxonomy.
* **Interpretation:** Confluence Cloud reports type as a label from its own taxonomy on each user; preserve unknown labels rather than mapping them by assumption.
| Error | Meaning | Solution |
| - | - | - |
| **401 Unauthorized** (API token) | Invalid credentials | Check email and API token |
| **401 on token exchange** (OAuth) | Invalid client ID/secret or missing `audience` | Recreate credentials; include `audience=api.atlassian.com` |
| **403 Forbidden** | Missing scope or Confluence permission | Check scopes and service account access |
| **Empty space list** | Wrong Cloud ID or no browse access | Verify Cloud ID; grant Confluence access |
# Contentful
Source: https://docs.parable.work/plugins/provider-plugins/contentful
Sync content entries and assets from Contentful
Sync content entries and assets from Contentful.
Connect Parable to Contentful Content Management API for content data access.
#### Content
Entries, content types, assets
#### Space Management
Spaces, environments, users
## Data streams
This Provider Plugin defines 46 data streams.
| Stream | Description | Sync |
| - | - | - |
| `spaces` | Contentful spaces accessible to the authenticated token | full |
| `environments` | Environments within a Contentful space | full |
| `entries` | Content entries within a Contentful environment | incremental |
| `assets` | Media assets within a Contentful environment | incremental |
| `content_types` | Content type definitions within a Contentful environment | full |
| `api_keys` | Contentful api keys | full |
| `app_definitions` | Contentful app definitions | full |
| `app_installations` | Contentful app installations | full |
| `assets_all` | Contentful assets all | full |
| `bulk_actions` | Contentful bulk actions | full |
| `cma_assets` | Contentful cma assets | full |
| `cma_content_types` | Contentful cma content types | full |
| `cma_entries` | Contentful cma entries | full |
| `cma_locales` | Contentful cma locales | full |
| `cma_tags` | Contentful cma tags | full |
| `comments` | Contentful comments | full |
| `content_type_snapshots` | Contentful content type snapshots | full |
| `editor_interfaces` | Contentful editor interfaces | full |
| `entries_all` | Contentful entries all | full |
| `entry_snapshots` | Contentful entry snapshots | full |
| `environment_aliases` | Contentful environment aliases | full |
| `extensions` | Contentful extensions | full |
| `locales` | Contentful locales | full |
| `organization_memberships` | Contentful organization memberships | full |
| `organization_periodic_usages` | Contentful organization periodic usages | full |
| `organization_space_memberships` | Contentful organization space memberships | full |
| `organization_users` | Contentful organization users | full |
| `organizations` | Contentful organizations | full |
| `releases` | Contentful releases | full |
| `roles` | Contentful roles | full |
| `scheduled_actions` | Contentful scheduled actions | full |
| `space_memberships` | Contentful space memberships | full |
| `space_usages` | Contentful space usages | full |
| `sync_initial` | Contentful sync initial | full |
| `tags` | Contentful tags | full |
| `tasks` | Contentful tasks | full |
| `taxonomy_concept_schemes` | Contentful taxonomy concept schemes | full |
| `taxonomy_concepts` | Contentful taxonomy concepts | full |
| `team_memberships` | Contentful team memberships | full |
| `team_space_memberships` | Contentful team space memberships | full |
| `teams` | Contentful teams | full |
| `ui_extensions` | Contentful ui extensions | full |
| `usage_periods` | Contentful usage periods | full |
| `webhook_call_details` | Contentful webhook call details | full |
| `webhook_calls` | Contentful webhook calls | full |
| `webhooks` | Contentful webhooks | full |
### API token
#### What You'll Need
| Credential | What it is |
| - | - |
| **Token** | CMA personal access token from Contentful |
| **Space ID** | Your Contentful space identifier |
> **Info:** **Setup access in Contentful.** These steps require **Administrator**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Contentful administrator.
* **Admin** role in the Contentful space
* Permission to create API tokens
#### Step 1: Access Settings
1. Log in to Contentful
2. Go to **Settings** → **API keys**
3. Navigate to **Content Management tokens** tab
#### Step 2: Generate Personal Access Token
1. Click **Generate personal token**
2. Name: `Parable Integration`
3. Click **Generate**
> **Warning:** **Copy your personal access token now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
#### Step 3: Note Your Space ID
Find your Space ID in:
* **Settings** → **General settings** → **Space ID**
* Or in the URL: `app.contentful.com/spaces/{SPACE_ID}/...`
#### Step 4: Enter values in the form
1. **Token** and **Space ID**: Paste your Content Management API token and space identifier.
2. Click **Save & test connection**.
Developer identifier: `api_keys`
API Keys contain the Contentful API keys collection returned by the configured operation.
* **Enables:** inventory API-key metadata without treating a key record as evidence that its secret is available.
* **Scope:** Reads the declared collection through `GET /api-keys` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `api_keys.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful api key source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful api key record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `app_definitions`
App Definitions contain the Contentful app definitions collection returned by the configured operation.
* **Enables:** review the Contentful extension or application configuration represented by app definitions.
* **Scope:** Reads the declared collection through `GET /app-definitions` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `app_definitions.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful app definition source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful app definition record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `app_installations`
App Installations contain the Contentful app installations collection returned by the configured operation.
* **Enables:** review the Contentful extension or application configuration represented by app installations.
* **Scope:** Reads the declared collection through `GET /app-installations` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `app_installations.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful app installation source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful app installation record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `assets`
Assets contain media assets within a Contentful environment.
* **Enables:** catalog media assets and their file metadata within an environment.
* **Scope:** Reads provider changes through `GET /spaces/{space_id}/environments/{environment_id}/assets` using the declared incremental request boundary. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `assets._synthetic_primary_key`
Synthetic Primary Key identifies synthetic primary key computed by the ingestor from `space_id`, `environment_id`, and sys.id. Not part of the upstream API response; written into each row at bronze ingestion time. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful asset source row before constructing its represented state.
* **Interpretation:** Parable generates `_synthetic_primary_key` at one value per contentful asset record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `assets.environment_id`
Environment ID identifies parent sys.id injected by the ingestor from the environments to assets traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match asset records to provider records that carry the same environment ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `environment_id` as a record-level identifier on `ContentfulAsset`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `assets.fields`
Fields records asset fields including title, description, and file details. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret fields according to the provider and Workspace configuration that produced each asset record.
* **Interpretation:** Contentful entry field keys and localized value shapes follow the customer's content model and environment locale configuration; they are not fixed by this base schema.
Developer identifier: `assets.fields.description`
Description records localized description of the asset. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description returned for each Contentful asset record.
* **Interpretation:** The value covers only the assets content returned by this Contentful operation; omitted locales and fields are not inferred.
Developer identifier: `assets.fields.file`
File records localized file details including URL, content type, and dimensions. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact file when validating the configuration or technical definition of a contentful asset field record.
* **Interpretation:** The provider supplies `file` as configuration or technical metadata on `ContentfulAssetFields`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `assets.fields.title`
Title records localized title of the asset. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact title returned for each Contentful asset record.
* **Interpretation:** The value covers only the assets content returned by this Contentful operation; omitted locales and fields are not inferred.
Developer identifier: `assets.space_id`
Space ID identifies parent `space_id` injected by the ingestor from the environments to assets traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match asset records to provider records that carry the same space ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `space_id` as a record-level identifier on `ContentfulAsset`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `assets.sys`
Sys records system metadata for the asset. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested sys object into its declared child fields for each contentful asset record.
* **Interpretation:** The provider returns `sys` as a nested object or reference on `ContentfulAsset`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `assets.sys.createdAt`
Created At records creation timestamp. It anchors the named event or boundary on the record's timeline.
* **Enables:** place asset records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per contentful asset sys metadata record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `assets.sys.id`
ID identifies asset unique identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match asset records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ContentfulAssetSysMetadata`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `assets.sys.publishedAt`
Published At records last publish timestamp. It anchors the named event or boundary on the record's timeline.
* **Enables:** place asset records on a timeline by published at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `publishedAt` per contentful asset sys metadata record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `assets.sys.revision`
Revision identifies the asset's provider-managed published revision. It correlates a captured asset with the publication state visible to delivery consumers.
* **Enables:** distinguish newly published asset revisions and relate publication changes to the asset version.
* **Interpretation:** The provider supplies `revision` as a publication sequence scoped to one asset; missing means no published revision was reported.
Developer identifier: `assets.sys.type`
Type states resource type. It preserves the provider's current classification of this record.
* **Enables:** separate asset records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per contentful asset sys metadata record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `assets.sys.updatedAt`
Updated At records last update timestamp. It anchors the named event or boundary on the record's timeline.
* **Enables:** place asset records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per contentful asset sys metadata record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `assets.sys.version`
Version identifies the current provider-managed version of the asset, including unpublished changes. It correlates a captured asset with the content change that produced it.
* **Enables:** detect edits between snapshots of the same asset and distinguish its current version from its published revision.
* **Interpretation:** The provider supplies `version` as a sequence scoped to one asset, not a measure comparable across different assets.
Developer identifier: `assets_all`
Assets All contains the Contentful assets all collection returned by the configured operation.
* **Enables:** catalog media-asset records and file metadata returned by assets all.
* **Scope:** Reads the declared collection through `GET /assets-all` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `assets_all.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful assets all source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful assets all record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `bulk_actions`
Bulk Actions contain the Contentful bulk actions collection returned by the configured operation.
* **Enables:** track Contentful bulk operations by action type, status, and target entities.
* **Scope:** Reads the declared collection through `GET /bulk-actions` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `bulk_actions.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful bulk action source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful bulk action record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `cma_assets`
Cma Assets contain the Contentful Management API assets collection returned by the configured operation.
* **Enables:** catalog media-asset records and file metadata returned by cma assets.
* **Scope:** Reads the declared collection through `GET /cma-assets` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `cma_assets.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful cma asset source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful cma asset record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `cma_content_types`
Cma Content Types contain the Contentful Management API content types collection returned by the configured operation.
* **Enables:** interpret entry structure using the cma content types definitions.
* **Scope:** Reads the declared collection through `GET /cma-content-types` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `cma_content_types.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful cma content type source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful cma content type record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `cma_entries`
Cma Entries contain the Contentful Management API entries collection returned by the configured operation.
* **Enables:** inspect the content-entry field maps and system metadata returned by cma entries.
* **Scope:** Reads the declared collection through `GET /cma-entries` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `cma_entries.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful cma entry source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful cma entry record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `cma_locales`
Cma Locales contain the Contentful Management API locales collection returned by the configured operation.
* **Enables:** interpret locale codes, names, and fallback relationships from cma locales.
* **Scope:** Reads the declared collection through `GET /cma-locales` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `cma_locales.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful cma locale source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful cma locale record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `cma_tags`
Cma Tags contain the Contentful Management API tags collection returned by the configured operation.
* **Enables:** categorize Contentful resources using the cma tags records they reference.
* **Scope:** Reads the declared collection through `GET /cma-tags` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `cma_tags.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful cma tag source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful cma tag record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `comments`
Comments contain the Contentful comments collection returned by the configured operation.
* **Enables:** review Contentful comment text with its author and target resource.
* **Scope:** Reads the declared collection through `GET /comments` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `comments.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful comment source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful comment record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `content_type_snapshots`
Content Type Snapshots contain the Contentful content type snapshots collection returned by the configured operation.
* **Enables:** review historical content type snapshots captured by Contentful.
* **Scope:** Reads the declared collection through `GET /content-type-snapshots` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `content_type_snapshots.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful content type snapshot source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful content type snapshot record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `content_types`
Content Types contain content type definitions within a Contentful environment.
* **Enables:** interpret entry fields against their Contentful content-type definitions.
* **Scope:** Reads the declared collection through `GET /spaces/{space_id}/environments/{environment_id}/content_types` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `content_types._synthetic_primary_key`
Synthetic Primary Key identifies synthetic primary key computed by the ingestor from `space_id`, `environment_id`, and sys.id. Not part of the upstream API response; written into each row at bronze ingestion time. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful content type source row before constructing its represented state.
* **Interpretation:** Parable generates `_synthetic_primary_key` at one value per contentful content type record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `content_types.description`
Description records description of the content type. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description returned for each Contentful content type record.
* **Interpretation:** The value covers only the content types content returned by this Contentful operation; omitted locales and fields are not inferred.
Developer identifier: `content_types.displayField`
Display Field states ID of the field used as the display title for entries of this type. It preserves the provider's current classification of this record.
* **Enables:** separate content type records by the exact provider-reported display field value when describing their recorded state.
* **Interpretation:** The provider supplies `displayField` per contentful content type record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `content_types.environment_id`
Environment ID identifies parent sys.id injected by the ingestor from the environments to `content_types` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match content type records to provider records that carry the same environment ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `environment_id` as a record-level identifier on `ContentfulContentType`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `content_types.fields`
Fields records field definitions for this content type. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret fields according to the provider and Workspace configuration that produced each content type record.
* **Interpretation:** Contentful entry field keys and localized value shapes follow the customer's content model and environment locale configuration; they are not fixed by this base schema.
Developer identifier: `content_types.fields.disabled`
Disabled indicates whether the field is disabled in the UI. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select content type records for which the provider reports disabled as true or false.
* **Interpretation:** The provider supplies `disabled` as a boolean per contentful field definition record; false and missing are distinct when the field is optional.
Developer identifier: `content_types.fields.id`
ID identifies field identifier used in the API. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful field definition source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful field definition record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `content_types.fields.localized`
Localized indicates whether the field supports localization. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select content type records for which the provider reports localized as true or false.
* **Interpretation:** The provider supplies `localized` as a boolean per contentful field definition record; false and missing are distinct when the field is optional.
Developer identifier: `content_types.fields.name`
Name records human-readable field name. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Contentful content type record.
* **Interpretation:** The value covers only the content types content returned by this Contentful operation; omitted locales and fields are not inferred.
Developer identifier: `content_types.fields.omitted`
Omitted indicates whether the field is omitted from API responses. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select content type records for which the provider reports omitted as true or false.
* **Interpretation:** The provider supplies `omitted` as a boolean per contentful field definition record; false and missing are distinct when the field is optional.
Developer identifier: `content_types.fields.required`
Required indicates whether the field is required. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select content type records for which the provider reports required as true or false.
* **Interpretation:** The provider supplies `required` as a boolean per contentful field definition record; false and missing are distinct when the field is optional.
Developer identifier: `content_types.fields.type`
Type states field data type (Symbol, Text, Integer, Number, Date, Boolean, Object, Location, Array, Link, RichText). It preserves the provider's current classification of this record.
* **Enables:** separate content type records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per contentful field definition record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `content_types.name`
Name records human-readable name of the content type. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Contentful content type record.
* **Interpretation:** The value covers only the content types content returned by this Contentful operation; omitted locales and fields are not inferred.
Developer identifier: `content_types.space_id`
Space ID identifies parent `space_id` injected by the ingestor from the environments to `content_types` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match content type records to provider records that carry the same space ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `space_id` as a record-level identifier on `ContentfulContentType`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `content_types.sys`
Sys states system metadata for the content type. It preserves the provider's current classification of this record.
* **Enables:** separate content type records by the exact provider-reported sys value when describing their recorded state.
* **Interpretation:** The provider supplies `sys` per contentful content type record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `content_types.sys.createdAt`
Created At records creation timestamp. It anchors the named event or boundary on the record's timeline.
* **Enables:** place content type records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per contentful content type sys metadata record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `content_types.sys.id`
ID identifies content type unique identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match content type records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ContentfulContentTypeSysMetadata`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `content_types.sys.type`
Type states resource type. It preserves the provider's current classification of this record.
* **Enables:** separate content type records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per contentful content type sys metadata record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `content_types.sys.updatedAt`
Updated At records last update timestamp. It anchors the named event or boundary on the record's timeline.
* **Enables:** place content type records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per contentful content type sys metadata record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `content_types.sys.version`
Version identifies the current provider-managed version of the content-type definition. It correlates schema snapshots with the definition change that produced them.
* **Enables:** detect content-model changes and order snapshots of the same content type.
* **Interpretation:** The provider supplies `version` as a sequence scoped to one content type, not a measure comparable across different definitions.
Developer identifier: `editor_interfaces`
Editor Interfaces contain the Contentful editor interfaces collection returned by the configured operation.
* **Enables:** review field-control and editor-layout configuration for content types.
* **Scope:** Reads the declared collection through `GET /editor-interfaces` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `editor_interfaces.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful editor interface source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful editor interface record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `entries`
Entries contain content entries within a Contentful environment.
* **Enables:** inspect content-entry fields and system metadata returned for an environment.
* **Scope:** Reads provider changes through `GET /spaces/{space_id}/environments/{environment_id}/entries` using the declared incremental request boundary. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `entries._synthetic_primary_key`
Synthetic Primary Key identifies synthetic primary key computed by the ingestor from `space_id`, `environment_id`, and sys.id. Not part of the upstream API response; written into each row at bronze ingestion time. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful entry source row before constructing its represented state.
* **Interpretation:** Parable generates `_synthetic_primary_key` at one value per contentful entry record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `entries.environment_id`
Environment ID identifies parent sys.id injected by the ingestor from the environments to entries traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match entry records to provider records that carry the same environment ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `environment_id` as a record-level identifier on `ContentfulEntry`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `entries.fields`
Fields records dynamic content fields defined by the content type. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret fields according to the provider and Workspace configuration that produced each entry record.
* **Interpretation:** Contentful entry field keys and localized value shapes follow the customer's content model and environment locale configuration; they are not fixed by this base schema.
Developer identifier: `entries.space_id`
Space ID identifies parent `space_id` injected by the ingestor from the environments to entries traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match entry records to provider records that carry the same space ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `space_id` as a record-level identifier on `ContentfulEntry`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `entries.sys`
Sys records system metadata for the entry. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested sys records contained by each contentful entry record.
* **Interpretation:** The provider returns `sys` as a nested object or reference on `ContentfulEntry`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `entries.sys.contentType`
Content Type states link to the content type that defines this entry's schema. It preserves the provider's current classification of this record.
* **Enables:** separate entry records by the exact provider-reported content type value when describing their recorded state.
* **Interpretation:** The provider supplies `contentType` per contentful entry sys metadata record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `entries.sys.contentType.sys`
Sys records system link metadata. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested sys object into its declared child fields for each contentful content type link record.
* **Interpretation:** The provider returns `sys` as a nested object or reference on `ContentfulContentTypeLink`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `entries.sys.contentType.sys.id`
ID identifies linked resource identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match entry records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ContentfulLinkSysSimple`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `entries.sys.contentType.sys.linkType`
Link Type captures the type of the linked resource. It preserves the provider's current classification of this record.
* **Enables:** separate entry records by the exact provider-reported link type value when describing their recorded state.
* **Interpretation:** The provider supplies `linkType` per contentful link sys simple record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `entries.sys.contentType.sys.type`
Type states always 'Link'. It preserves the provider's current classification of this record.
* **Enables:** separate entry records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per contentful link sys simple record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `entries.sys.createdAt`
Created At records creation timestamp. It anchors the named event or boundary on the record's timeline.
* **Enables:** place entry records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per contentful entry sys metadata record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `entries.sys.id`
ID identifies entry unique identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match entry records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ContentfulEntrySysMetadata`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `entries.sys.publishedAt`
Published At records last publish timestamp. It anchors the named event or boundary on the record's timeline.
* **Enables:** place entry records on a timeline by published at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `publishedAt` per contentful entry sys metadata record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `entries.sys.revision`
Revision identifies the entry's provider-managed published revision. It correlates a captured entry with the publication state visible to delivery consumers.
* **Enables:** distinguish newly published entry revisions and relate publication changes to the entry version.
* **Interpretation:** The provider supplies `revision` as a publication sequence scoped to one entry; missing means no published revision was reported.
Developer identifier: `entries.sys.type`
Type states resource type. It preserves the provider's current classification of this record.
* **Enables:** separate entry records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per contentful entry sys metadata record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `entries.sys.updatedAt`
Updated At records last update timestamp. It anchors the named event or boundary on the record's timeline.
* **Enables:** place entry records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per contentful entry sys metadata record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `entries.sys.version`
Version identifies the current provider-managed version of the entry, including unpublished changes. It correlates a captured entry with the content change that produced it.
* **Enables:** detect edits between snapshots of the same entry and distinguish its current version from its published revision.
* **Interpretation:** The provider supplies `version` as a sequence scoped to one entry, not a measure comparable across different entries.
Developer identifier: `entries_all`
Entries All contains the Contentful entries all collection returned by the configured operation.
* **Enables:** inspect the content-entry field maps and system metadata returned by entries all.
* **Scope:** Reads the declared collection through `GET /entries-all` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `entries_all.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful entries all source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful entries all record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `entry_snapshots`
Entry Snapshots contain the Contentful entry snapshots collection returned by the configured operation.
* **Enables:** review historical entry snapshots captured by Contentful.
* **Scope:** Reads the declared collection through `GET /entry-snapshots` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `entry_snapshots.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful entry snapshot source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful entry snapshot record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `environment_aliases`
Environment Aliases contain the Contentful environment aliases collection returned by the configured operation.
* **Enables:** resolve an environment alias to the environment it currently targets.
* **Scope:** Reads the declared collection through `GET /environment-aliases` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `environment_aliases.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful environment alias source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful environment alias record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `environments`
Environments contain environments within a Contentful space.
* **Enables:** map Contentful content to the environment that contains it.
* **Scope:** Reads the declared collection through `GET /spaces/{space_id}/environments` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `environments._synthetic_primary_key`
Synthetic Primary Key identifies synthetic primary key computed by the ingestor from `space_id` and sys.id. Not part of the upstream API response; written into each row at bronze ingestion time. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful environment source row before constructing its represented state.
* **Interpretation:** Parable generates `_synthetic_primary_key` at one value per contentful environment record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `environments.name`
Name records human-readable name of the environment. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Contentful environment record.
* **Interpretation:** The value covers only the environments content returned by this Contentful operation; omitted locales and fields are not inferred.
Developer identifier: `environments.space_id`
Space ID identifies parent sys.id injected by the ingestor from the spaces to environments traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match environment records to provider records that carry the same space ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `space_id` as a record-level identifier on `ContentfulEnvironment`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `environments.sys`
Sys states system metadata for the environment. It preserves the provider's current classification of this record.
* **Enables:** separate environment records by the exact provider-reported sys value when describing their recorded state.
* **Interpretation:** The provider supplies `sys` per contentful environment record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `environments.sys.createdAt`
Created At records creation timestamp. It anchors the named event or boundary on the record's timeline.
* **Enables:** place environment records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per contentful environment sys metadata record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `environments.sys.id`
ID identifies environment unique identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match environment records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ContentfulEnvironmentSysMetadata`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `environments.sys.status`
Status states link to the environment status. It preserves the provider's current classification of this record.
* **Enables:** separate environment records by the exact provider-reported status value when describing their recorded state.
* **Interpretation:** The provider supplies `status` per contentful environment sys metadata record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `environments.sys.status.sys`
Sys records system link metadata. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested sys object into its declared child fields for each contentful environment status link record.
* **Interpretation:** The provider returns `sys` as a nested object or reference on `ContentfulEnvironmentStatusLink`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `environments.sys.status.sys.id`
ID identifies linked resource identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match environment records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ContentfulLinkSys`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `environments.sys.status.sys.linkType`
Link Type captures the type of the linked resource. It preserves the provider's current classification of this record.
* **Enables:** separate environment records by the exact provider-reported link type value when describing their recorded state.
* **Interpretation:** The provider supplies `linkType` per contentful link sy record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `environments.sys.status.sys.type`
Type states always 'Link' for link references. It preserves the provider's current classification of this record.
* **Enables:** separate environment records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per contentful link sy record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `environments.sys.type`
Type states resource type. It preserves the provider's current classification of this record.
* **Enables:** separate environment records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per contentful environment sys metadata record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `environments.sys.updatedAt`
Updated At records last update timestamp. It anchors the named event or boundary on the record's timeline.
* **Enables:** place environment records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per contentful environment sys metadata record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `environments.sys.version`
Version identifies the current provider-managed version of the environment metadata. It correlates successive snapshots with the configuration revision they represent.
* **Enables:** detect intervening environment changes and order snapshots of the same environment.
* **Interpretation:** The provider supplies `version` as a sequence scoped to one Contentful resource, not a measure comparable across different environments.
Developer identifier: `extensions`
Extensions contain the Contentful extensions collection returned by the configured operation.
* **Enables:** review the Contentful extension or application configuration represented by extensions.
* **Scope:** Reads the declared collection through `GET /extensions` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `extensions.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful extension source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful extension record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `locales`
Locales contain the Contentful locales collection returned by the configured operation.
* **Enables:** interpret localized entry values using environment locale definitions.
* **Scope:** Reads the declared collection through `GET /locales` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `locales.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful locale source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful locale record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `organization_memberships`
Organization Memberships contain the Contentful organization memberships collection returned by the configured operation.
* **Enables:** map organization memberships to the organizations, spaces, teams, roles, or accounts named by each membership record.
* **Scope:** Reads the declared collection through `GET /organization-memberships` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `organization_memberships.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful organization membership source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful organization membership record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `organization_periodic_usages`
Organization Periodic Usages contain the Contentful organization periodic usages collection returned by the configured operation.
* **Enables:** measure the provider-reported organization periodic usages values within their stated periods and units.
* **Scope:** Reads the declared collection through `GET /organization-periodic-usages` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `organization_periodic_usages.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful organization periodic usage source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful organization periodic usage record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `organization_space_memberships`
Organization Space Memberships contain the Contentful organization space memberships collection returned by the configured operation.
* **Enables:** map organization space memberships to the organizations, spaces, teams, roles, or accounts named by each membership record.
* **Scope:** Reads the declared collection through `GET /organization-space-memberships` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `organization_space_memberships.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful organization space membership source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful organization space membership record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `organization_users`
Organization Users contain the Contentful organization users collection returned by the configured operation.
* **Enables:** resolve identities represented by organization users records.
* **Scope:** Reads the declared collection through `GET /organization-users` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `organization_users.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful organization user source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful organization user record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `organizations`
Organizations contain the Contentful organizations collection returned by the configured operation.
* **Enables:** catalog Contentful organizations used as membership and content-administration containers.
* **Scope:** Reads the declared collection through `GET /organizations` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `organizations.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful organization source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful organization record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `releases`
Releases contain the Contentful releases collection returned by the configured operation.
* **Enables:** review which content entities are grouped into Contentful release records.
* **Scope:** Reads the declared collection through `GET /releases` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `releases.id`
ID identifies the release record. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same Contentful release before constructing its represented state.
* **Interpretation:** The provider supplies `id` once per Contentful release, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `roles`
Roles contain the Contentful roles collection returned by the configured operation.
* **Enables:** interpret membership assignments using the permissions encoded in Contentful role records.
* **Scope:** Reads the declared collection through `GET /roles` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `roles.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful role source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful role record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `scheduled_actions`
Scheduled Actions contain the Contentful scheduled actions collection returned by the configured operation.
* **Enables:** review scheduled publishing or unpublishing actions and their target times.
* **Scope:** Reads the declared collection through `GET /scheduled-actions` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `scheduled_actions.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful scheduled action source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful scheduled action record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `space_memberships`
Space Memberships contain the Contentful space memberships collection returned by the configured operation.
* **Enables:** map space memberships to the organizations, spaces, teams, roles, or accounts named by each membership record.
* **Scope:** Reads the declared collection through `GET /space-memberships` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `space_memberships.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful space membership source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful space membership record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `space_usages`
Space Usages contain the Contentful space usages collection returned by the configured operation.
* **Enables:** measure the provider-reported space usages values within their stated periods and units.
* **Scope:** Reads the declared collection through `GET /space-usages` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `space_usages.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful space usage source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful space usage record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `spaces`
Spaces contain Contentful spaces accessible to the authenticated token.
* **Enables:** enumerate token-visible Contentful spaces before loading environment-scoped content.
* **Scope:** Reads the declared collection through `GET /spaces` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `spaces._synthetic_primary_key`
Synthetic Primary Key identifies synthetic primary key computed by the ingestor from sys.id. Not part of the upstream API response; written into each row at bronze ingestion time. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful space source row before constructing its represented state.
* **Interpretation:** Parable generates `_synthetic_primary_key` at one value per contentful space record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `spaces.name`
Name records human-readable name of the space. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Contentful space record.
* **Interpretation:** The value covers only the spaces content returned by this Contentful operation; omitted locales and fields are not inferred.
Developer identifier: `spaces.sys`
Sys records system metadata for the space. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested sys object into its declared child fields for each contentful space record.
* **Interpretation:** The provider returns `sys` as a nested object or reference on `ContentfulSpace`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `spaces.sys.createdAt`
Created At records creation timestamp. It anchors the named event or boundary on the record's timeline.
* **Enables:** place space records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per contentful sys metadata record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `spaces.sys.id`
ID identifies resource unique identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match space records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ContentfulSysMetadata`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `spaces.sys.type`
Type states resource type. It preserves the provider's current classification of this record.
* **Enables:** separate space records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per contentful sys metadata record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `spaces.sys.updatedAt`
Updated At records last update timestamp. It anchors the named event or boundary on the record's timeline.
* **Enables:** place space records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per contentful sys metadata record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `spaces.sys.version`
Version identifies the current provider-managed version of the space metadata. It correlates successive snapshots with the configuration revision they represent.
* **Enables:** detect intervening space changes and order snapshots of the same space.
* **Interpretation:** The provider supplies `version` as a sequence scoped to one Contentful resource, not a measure comparable across different spaces.
Developer identifier: `sync_initial`
Sync Initial contains the Contentful sync initial collection returned by the configured operation.
* **Enables:** capture the initial Contentful synchronization collection and continuation token.
* **Scope:** Reads the declared collection through `GET /sync-initial` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `sync_initial.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful sync initial source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful sync initial record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `tags`
Tags contain the Contentful tags collection returned by the configured operation.
* **Enables:** categorize Contentful resources using the tags records they reference.
* **Scope:** Reads the declared collection through `GET /tags` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `tags.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful tag source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful tag record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `tasks`
Tasks contain the Contentful tasks collection returned by the configured operation.
* **Enables:** review content-management tasks, assignments, status, and target entity.
* **Scope:** Reads the declared collection through `GET /tasks` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `tasks.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful task source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful task record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `taxonomy_concept_schemes`
Taxonomy Concept Schemes contain the Contentful taxonomy concept schemes collection returned by the configured operation.
* **Enables:** catalog the concept schemes that organize Contentful taxonomy concepts.
* **Scope:** Reads the declared collection through `GET /taxonomy-concept-schemes` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `taxonomy_concept_schemes.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful taxonomy concept scheme source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful taxonomy concept scheme record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `taxonomy_concepts`
Taxonomy Concepts contain the Contentful taxonomy concepts collection returned by the configured operation.
* **Enables:** catalog taxonomy concepts and their parent or related concepts.
* **Scope:** Reads the declared collection through `GET /taxonomy-concepts` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `taxonomy_concepts.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful taxonomy concept source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful taxonomy concept record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `team_memberships`
Team Memberships contain the Contentful team memberships collection returned by the configured operation.
* **Enables:** map team memberships to the organizations, spaces, teams, roles, or accounts named by each membership record.
* **Scope:** Reads the declared collection through `GET /team-memberships` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `team_memberships.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful team membership source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful team membership record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `team_space_memberships`
Team Space Memberships contain the Contentful team space memberships collection returned by the configured operation.
* **Enables:** map team space memberships to the organizations, spaces, teams, roles, or accounts named by each membership record.
* **Scope:** Reads the declared collection through `GET /team-space-memberships` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `team_space_memberships.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful team space membership source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful team space membership record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `teams`
Teams contain the Contentful teams collection returned by the configured operation.
* **Enables:** catalog Contentful teams used as membership and content-administration containers.
* **Scope:** Reads the declared collection through `GET /teams` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `teams.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful team source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful team record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `ui_extensions`
UI Extensions contain the Contentful UI extensions collection returned by the configured operation.
* **Enables:** review the Contentful extension or application configuration represented by ui extensions.
* **Scope:** Reads the declared collection through `GET /ui-extensions` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `ui_extensions.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful ui extension source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful ui extension record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `usage_periods`
Usage Periods contain the Contentful usage periods collection returned by the configured operation.
* **Enables:** interpret usage measurements against their reported billing period boundaries.
* **Scope:** Reads the declared collection through `GET /usage-periods` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `usage_periods.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful usage period source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful usage period record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `webhook_call_details`
Webhook Call Details contain the Contentful webhook call details collection returned by the configured operation.
* **Enables:** inspect request and response details recorded for a webhook delivery.
* **Scope:** Reads the declared collection through `GET /webhook-call-details` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `webhook_call_details.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful webhook call detail source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful webhook call detail record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `webhook_calls`
Webhook Calls contain the Contentful webhook calls collection returned by the configured operation.
* **Enables:** track webhook delivery attempts by status and timestamp.
* **Scope:** Reads the declared collection through `GET /webhook-calls` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `webhook_calls.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful webhook call source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful webhook call record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `webhooks`
Webhooks contain the Contentful webhooks collection returned by the configured operation.
* **Enables:** review webhook targets, event filters, headers, and enabled state.
* **Scope:** Reads the declared collection through `GET /webhooks` as a full snapshot. Results contain only records the configured Contentful token can retrieve; inaccessible spaces, environments, and content are absent.
Developer identifier: `webhooks.id`
ID identifies record identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same contentful webhook source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per contentful webhook record, and `x-transformDedupKey` explicitly marks it as the record key.
| Error | Meaning | Solution |
| - | - | - |
| `AccessTokenInvalid` | Invalid token | Verify token is correct |
| `NotFound` | Wrong space/environment | Check Space ID |
| `RateLimitExceeded` | Too many requests | If this occurs during setup, wait briefly, then click **Save & test connection** again. If this occurs during syncing, Parable retries automatically for a limited time. If the sync still fails, review the connection error before retrying. |
**[Contentful API](https://www.contentful.com/developers/docs/references/content-management-api/)** — Official API documentation
# Databricks
Source: https://docs.parable.work/plugins/provider-plugins/databricks
Databricks is a unified data lakehouse platform that provides data engineering, data science, machine learning, and analytics capabilities. It exposes a SQL Statement Execution REST API for querying data via SQL over HTTP, Unity Catalog APIs for metadata discovery, and workspace management APIs for compute, jobs, pipelines, identity, and audit operations.
Databricks is a unified data lakehouse platform that provides data engineering, data science, machine learning, and analytics capabilities. It exposes a SQL Statement Execution REST API for querying data via SQL over HTTP, Unity Catalog APIs for metadata discovery, and workspace management APIs for compute, jobs, pipelines, identity, and audit operations.
Connect Parable to Databricks using a **service principal** and the **OAuth 2.0 client credentials** flow. Parable uses the workspace REST APIs for metadata and identity taps, and the **SQL Statement Execution API** for user-activity taps (`audit_logs`, `query_history`) against Unity Catalog system tables.
This integration uses **OAuth 2.0 Client Credentials** flow for server-to-server authentication.
#### How It Works
1. Parable sends **Client ID** and **Client Secret** to the token endpoint
2. Databricks returns a short-lived **access token** (typically 1 hour)
3. Use the access token in API requests
4. When expired, request a new token (automatic in Parable)
#### Token Request
```bash cURL theme={null}
curl -X POST "https://<workspace-host>/oidc/v1/token" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "client_id=YOUR_CLIENT_ID" \
-d "client_secret=YOUR_CLIENT_SECRET"
```
```python Python theme={null}
response = requests.post(
"https://<workspace-host>/oidc/v1/token",
data={
"grant_type": "client_credentials",
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET"
}
)
access_token = response.json()["access_token"]
print(f"Access Token: {access_token}")
```
#### Using the Access Token
```http theme={null}
Authorization: Bearer {access_token}
```
> **Info:** Parable automatically handles token refresh, so you don't need to manage token expiration manually.
#### Metadata & identity
Unity Catalog catalogs, schemas, tables; SCIM users and groups
#### User activity
Audit events and SQL query history from `system.access.audit` and `system.query.history`
| Tap | Source | Enabled by default |
| - | - | - |
| `users`, `groups` | SCIM API | Yes |
| `catalogs`, `schemas`, `tables` | Unity Catalog API | Yes |
| `audit_logs` | `system.access.audit` | Yes |
| `query_history` | `system.query.history` | Yes |
| `jobs`, `job_runs`, `clusters`, `pipelines`, etc. | Workspace APIs | Opt-in |
* [Audit log system table](https://docs.databricks.com/aws/en/admin/system-tables/audit-logs)
* [Query history system table](https://docs.databricks.com/aws/en/admin/system-tables/query-history)
* [Statement Execution API](https://docs.databricks.com/api/workspace/statementexecution)
## Data streams
This Provider Plugin defines 14 data streams.
| Stream | Description | Sync |
| - | - | - |
| `catalogs` | Lists all Unity Catalog catalogs available in the Databricks workspace. Provides metadata about each catalog including name, owner, comment, and properties. | full |
| `schemas` | Lists all schemas within a specified Unity Catalog catalog. Requires catalog\_name as a parent context field. Provides schema metadata including name, owner, and properties. | full |
| `tables` | Lists all tables within a specified Unity Catalog catalog and schema. Requires catalog\_name and schema\_name as parent context fields. Provides table metadata including columns, data types, and storage info. | full |
| `table_summaries` | Lists table summaries within a catalog, providing a lightweight view of available tables with optional LIKE pattern filtering. | full |
| `clusters` | Lists all clusters in the Databricks workspace. Provides compute cluster metadata including configuration, state, and resource allocation details. | full |
| `sql_warehouses` | Lists all SQL warehouses in the Databricks workspace. Provides SQL warehouse configuration, state, and sizing details. | full |
| `jobs` | Lists all jobs defined in the Databricks workspace. Provides job configuration, schedule, and metadata. Paginated via next\_page\_token. | full |
| `job_runs` | Lists job runs in the Databricks workspace. Provides run execution details including status, duration, and task results. Paginated via next\_page\_token. | full |
| `pipelines` | Lists all Delta Live Tables (DLT) pipelines in the Databricks workspace. Provides pipeline configuration, state, and metadata. | full |
| `users` | Lists all users in the Databricks workspace via the SCIM v2 API. Provides user identity, email, and group membership information. | full |
| `groups` | Lists all groups in the Databricks workspace via the SCIM v2 API. Provides group membership and role information. | full |
| `service_principals` | Lists all service principals in the Databricks workspace via the SCIM v2 API. Provides service principal identity and entitlement information. | full |
| `audit_logs` | Human workspace audit events from system.access.audit (Unity Catalog). Keeps rows with a real user email and drops service-principal / System-User firehose plus token-login, Unity Catalog internals, filesystem signed-URL churn, secrets polling, and lineage/optimization noise. Queried via the SQL Statement Execution API. Requires USE CATALOG on system, USE SCHEMA on system.access, and SELECT on system.access.audit. | incremental |
| `query_history` | SQL and serverless compute query execution history from system.query.history. Includes executor identity, statement text, timing, client application, and query\_source linkage to notebooks, jobs, and dashboards. Queried via the SQL Statement Execution API. Requires USE CATALOG on system, USE SCHEMA on system.query, and SELECT on system.query.history. | incremental |
### Databricks
#### What You'll Need
| Credential | What it is |
| - | - |
| **Client ID** | Service principal application (client) ID |
| **Client Secret** | OAuth secret generated for the service principal |
| **Workspace hostname** | Workspace URL host only (no `https://`) |
| **SQL warehouse ID** | Warehouse used for SQL Statement Execution API calls |
| **Token endpoint** | Account- or workspace-level OAuth token URL |
> **Info:** **Setup access in Databricks.** These steps require **Account admin or workspace admin**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Databricks administrator.
* A Databricks workspace on AWS, Azure, or GCP with **Unity Catalog** enabled
* At least one **SQL warehouse** (running or auto-start enabled)
* **System tables** enabled for the account ([Enable system tables](https://docs.databricks.com/aws/en/admin/system-tables/))
* Network access from Parable to the workspace hostname
#### Step 1: Create a service principal
1. Open the Databricks **Account Console**:
* AWS: [accounts.cloud.databricks.com](https://accounts.cloud.databricks.com)
* Azure: [accounts.azuredatabricks.net](https://accounts.azuredatabricks.net)
* GCP: [accounts.gcp.databricks.com](https://accounts.gcp.databricks.com)
2. Go to **User management → Service principals**.
3. Click **Add service principal** (for example, `parable-integration`).
4. Copy the **Application (client) ID**.
#### Step 2: Assign the service principal to the workspace
1. In the Account Console, open the service principal → **Workspaces** tab.
2. Add the target workspace.
3. Set permission level to **User** (recommended starting point).
Parable reads users and groups through the workspace SCIM API. If connection tests return **403** on identity taps, change this assignment to **Admin** for this workspace only. Do not grant **account admin** on the service principal.
#### Step 3: Generate an OAuth secret
1. Open the service principal in the Account Console.
2. Go to **OAuth secrets**.
3. Click **Generate secret**.
4. Copy the **Client secret** immediately — it is shown only once.
Save both the **Client ID** and **Client secret** for the Parable connection form.
#### Step 4: Grant SQL warehouse access
1. In the workspace, open **SQL → SQL warehouses**.
2. Select the warehouse Parable will use.
3. Open **Permissions**.
4. Grant the service principal **CAN USE** on the warehouse.
#### Step 5: Grant Unity Catalog metadata access
Parable lists catalog, schema, and table **metadata** only. Grant **BROWSE** on each catalog Parable should inventory. This allows discovery via the Unity Catalog API without read access to table data.
Run as a metastore admin or account admin from a Unity Catalog-enabled workspace SQL editor. Replace `` `` `` with the service principal display name (for example, `` `parable-integration` ``):
```sql theme={null}
GRANT BROWSE ON CATALOG main TO ``;
GRANT BROWSE ON CATALOG analytics TO ``;
```
Repeat for each catalog you want Parable to scan. Do not grant `SELECT`, `MODIFY`, `MANAGE`, or `ALL PRIVILEGES` on customer tables unless you have a separate requirement.
Catalogs bound only to other workspaces are not visible from this workspace even with `BROWSE`. See [Unity Catalog privileges](https://docs.databricks.com/aws/en/data-governance/unity-catalog/access-control/privileges-reference).
#### Step 6: Grant system table access (user activity taps)
Required for **`audit_logs`** and **`query_history`**. Run from a Unity Catalog-enabled workspace as a metastore admin or account admin:
```sql theme={null}
GRANT USE CATALOG ON CATALOG system TO ``;
GRANT USE SCHEMA ON SCHEMA system.access TO ``;
GRANT SELECT ON TABLE system.access.audit TO ``;
GRANT USE SCHEMA ON SCHEMA system.query TO ``;
GRANT SELECT ON TABLE system.query.history TO ``;
```
See [Grant access to system tables](https://docs.databricks.com/aws/en/admin/system-tables/#grant-access-to-system-tables).
#### Step 7: Enter values in Parable
| Field | Value |
| - | - |
| **Client ID** (`clientId`) | Service principal application ID |
| **Client secret** (`clientSecret`) | OAuth secret from the previous step |
| **Token endpoint** (`tokenEndpoint`) | Full HTTPS OAuth token URL (see examples below) |
| **Workspace instance** (`workspace_instance`) | Hostname only, e.g. `dbc-abc123.cloud.databricks.com` |
| **SQL warehouse ID** (`warehouse_id`) | From SQL warehouse **Connection details** |
| **Account ID** (`account_id`) | Optional; required for account-level OAuth token URLs |
| **Cloud provider** (`cloud_provider`) | Optional; `aws`, `azure`, or `gcp` — used with account-level OAuth |
| **Activity workspace ID** (`activity_workspace_id`) | Optional numeric filter for activity taps; leave blank for all workspaces in the region |
**Token endpoint** is the URL Parable POSTs to for OAuth tokens. Paste the **full URL**, not just the workspace hostname.
**Workspace-level** (most common — same host as workspace instance):
```text theme={null}
https://dbc-abc123.cloud.databricks.com/oidc/v1/token
```
Pattern: `https:///oidc/v1/token`
**Account-level** (multi-workspace; replace ``):
| Cloud | Token endpoint |
| - | - |
| AWS | `https://accounts.cloud.databricks.com/oidc/accounts//v1/token` |
| Azure | `https://accounts.azuredatabricks.net/oidc/accounts//v1/token` |
| GCP | `https://accounts.gcp.databricks.com/oidc/accounts//v1/token` |
OAuth scope: `all-apis` (configured on the Provider; you do not enter it separately).
#### Step 8: Test connection
Parable verifies connectivity by executing a SQL statement against the configured warehouse (for example, `SELECT 1` via `/api/2.0/sql/statements`).
> **Success:** If you received a `200 OK` response with valid data, your credentials are configured correctly. You can now configure this Provider in Parable.
> **Tip:** Databricks enforces rate limits of **varies by endpoint; Parable defaults to 2–10 requests per second depending on the tap**.
>
> Parable handles rate limiting automatically with exponential backoff, but initial syncs of large datasets may take longer due to these limits.
| Cloud | Account-level token endpoint |
| - | - |
| AWS | `https://accounts.cloud.databricks.com/oidc/accounts//v1/token` |
| Azure | `https://accounts.azuredatabricks.net/oidc/accounts//v1/token` |
| GCP | `https://accounts.gcp.databricks.com/oidc/accounts//v1/token` |
Workspace-level token endpoints also work when the service principal is assigned to that workspace.
### Databricks
Parable uses the OAuth scope **`all-apis`** for service principal authentication. That scope is coarse: it allows the service principal to call Databricks REST APIs **for which it has been granted permission** in the workspace and Unity Catalog. Least privilege is enforced with workspace roles, SQL warehouse permissions, and Unity Catalog grants — not with a finer OAuth scope.
#### Permission layers
| Layer | Where to configure | What Parable needs |
| - | - | - |
| **Account** | Account Console → Service principals | Dedicated SP, OAuth secret, workspace assignment |
| **Workspace** | Workspace permissions + SQL warehouses | **User** (or **Admin** if SCIM returns 403); **CAN USE** on one SQL warehouse |
| **Unity Catalog** | SQL grants or Catalog Explorer | `BROWSE` on named customer catalogs; read-only grants on `system` tables |
Do **not** grant account admin, metastore admin, or **CAN MANAGE** on the SQL warehouse.
#### Grants by default tap
| Tap | Permission |
| - | - |
| `audit_logs` | **CAN USE** on SQL warehouse + `SELECT` on `system.access.audit` |
| `query_history` | **CAN USE** on SQL warehouse + `SELECT` on `system.query.history` |
| `catalogs`, `schemas`, `tables` | `BROWSE` on each target customer catalog |
| `users`, `groups` | Workspace **User**; **Admin** on this workspace if SCIM list returns 403 |
#### System table grants (reference)
```sql theme={null}
GRANT USE CATALOG ON CATALOG system TO ``;
GRANT USE SCHEMA ON SCHEMA system.access TO ``;
GRANT SELECT ON TABLE system.access.audit TO ``;
GRANT USE SCHEMA ON SCHEMA system.query TO ``;
GRANT SELECT ON TABLE system.query.history TO ``;
```
#### Verify permissions
After generating an OAuth token for the service principal, run these checks (replace placeholders):
```bash theme={null}
TOKEN=
HOST=https://
WAREHOUSE_ID=
```
```bash cURL SQL warehouse theme={null}
curl -s -H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d "{\"statement\":\"SELECT 1\",\"warehouse_id\":\"$WAREHOUSE_ID\"}" \
"$HOST/api/2.0/sql/statements"
```
```bash cURL Unity Catalog theme={null}
curl -s -H "Authorization: Bearer $TOKEN" \
"$HOST/api/2.1/unity-catalog/catalogs?include_browse=true"
```
```bash cURL SCIM theme={null}
curl -s -H "Authorization: Bearer $TOKEN" \
"$HOST/api/2.0/preview/scim/v2/Users?count=1"
```
A **403** on the SCIM call means the service principal needs workspace **Admin** on this workspace, or identity taps should be disabled in Parable.
#### Large workspace notes (`tables` tap)
The `tables` tap fans out from every catalog and schema. In large Unity Catalog estates the first sync can take **15-30+ minutes** and produce **tens of thousands of table metadata rows** (multi-GB bronze). This is expected: Parable paginates the Unity Catalog API and writes one bronze row per table.
* **First sync:** allow a longer sync window; disable `tables` initially if you only need catalogs/schemas.
* **Ongoing syncs:** full refresh re-lists table metadata; row counts track catalog growth.
* **Deadlines:** if your orchestrator enforces a hard per-sync timeout, raise it for the first `tables` run or keep the tap disabled until a maintenance window.
#### Security review notes
* **SCIM and workspace Admin (by design):** Parable recommends starting with workspace **User**. If SCIM list calls return **403**, granting **Admin** on this workspace only is the supported escalation so `users` and `groups` taps can sync. Alternatively, leave the service principal at **User** and disable those identity taps in Parable if you do not need them.
* **`all-apis` is not full admin.** The service principal can only access APIs and data allowed by workspace and Unity Catalog grants.
* **Customer table data:** `BROWSE` exposes metadata (names, comments, structure), not row contents. Activity taps read platform audit and SQL history tables, not arbitrary customer tables.
* **No write path:** The grants above do not allow modifying data, jobs, clusters, or permissions.
Developer identifier: `audit_logs`
Audit Logs covers human workspace audit events from system.access.audit (Unity Catalog). Keeps rows with a real user email and drops service-principal / System-User firehose plus token-login, Unity Catalog internals, filesystem signed-URL churn, secrets polling, and lineage/optimization noise. Queried via the SQL Statement Execution API. Requires USE CATALOG on system, USE SCHEMA on system.access, and SELECT on system.access.audit.
* **Enables:** reconstruct an Audit Logs timeline and correlate each returned actor, target, action, and timestamp during an investigation.
* **Scope:** Human workspace audit events from system.access.audit (Unity Catalog). Keeps rows with a real user email and drops service-principal / System-User firehose plus token-login, Unity Catalog internals, filesystem signed-URL churn, secrets polling, and lineage/optimization noise. Queried via the SQL Statement Execution API. Requires USE CATALOG on system, USE SCHEMA on system.access, and SELECT on system.access.audit; the connector reads `/api/2.0/sql/statements` as an event stream in incremental mode. The configured credential must grant the declared `all-apis` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the Databricks record was deleted.
Developer identifier: `audit_logs.account_id`
Account ID records Databricks account ID. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `account_id` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.action_name`
Action Name records action performed (e.g. login, runNow, commandSubmit). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `action_name` result, permission, or Databricks classification being examined.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is interpreted at one Databricks Audit Log Event record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.audit_level`
Audit Level records `WORKSPACE_LEVEL` or `ACCOUNT_LEVEL`. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `audit_level` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is interpreted at one Databricks Audit Log Event record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.event_date`
Event Date records calendar date of the event. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `event_date` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is interpreted at one Databricks Audit Log Event record per row; the schema uses the `Temporal.Date` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.event_id`
Event ID records unique identifier for the audit event. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `event_id` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.event_time`
Event Time records UTC timestamp when the event occurred. Used as the incremental sync cursor. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `event_time` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is interpreted at one Databricks Audit Log Event record per row; the connector also declares it for record ordering; the schema assigns the `event_time` semantic role; the schema uses the `Temporal.DateTime` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.identity_metadata`
Identity Metadata records run-as and run-by identity metadata for impersonation scenarios. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `identity_metadata` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is one nested object per containing Databricks Audit Log Event object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `audit_logs.identity_metadata.run_as`
Run As records principal whose privileges were used. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `run_as` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Identity Metadata object returned for Audit Logs; it is interpreted at one Databricks Audit Identity Metadata record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.identity_metadata.run_by`
Run By records principal that initiated the action. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `run_by` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Identity Metadata object returned for Audit Logs; it is interpreted at one Databricks Audit Identity Metadata record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.request_id`
Request ID records unique request identifier. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `request_id` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.request_params`
Request Params records action-specific request parameters. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `request_params` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is interpreted at one Databricks Audit Log Event record per row; the schema uses the `Generic.JSON` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.response`
Response records HTTP response metadata for the audited action (JSON string under the `JSON_ARRAY` result format). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `response` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is interpreted at one Databricks Audit Log Event record per row; the schema uses the `Generic.JSON` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.service_name`
Service Name records service that handled the request (e.g. notebook, jobs, accounts). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `service_name` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is interpreted at one Databricks Audit Log Event record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.session_id`
Session ID records session ID associated with the request. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `session_id` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.source_ip_address`
Source IP Address records source IP address of the request. It is needed to preserve the Databricks-reported network address context for the same record.
* **Enables:** correlate `source_ip_address` with the actor, request, or session on the same Databricks event without treating it as proof of physical presence.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is interpreted at one Databricks Audit Log Event record per row; the schema uses the `Network.IpAddress` scalar; the value is network address context; this Databricks-reported or configured context does not establish residency or verified physical presence; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.user_agent`
User Agent records user agent string from the request. It is needed to preserve the Databricks-reported client device or software context for the same record.
* **Enables:** correlate `user_agent` with the actor, request, or session on the same Databricks event without treating it as proof of physical presence.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is interpreted at one Databricks Audit Log Event record per row; the value is client device or software context; this Databricks-reported or configured context does not establish residency or verified physical presence; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.user_identity`
User Identity records identity of the user who initiated the request (JSON string under the `JSON_ARRAY` result format). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `user_identity` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is interpreted at one Databricks Audit Log Event record per row; the schema uses the `Generic.JSON` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.version`
Version records audit log schema version. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `version` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is interpreted at one Databricks Audit Log Event record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.workspace_id`
Workspace ID records workspace ID where the event occurred. Account-level events use 0. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `workspace_id` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Databricks reports this value on the Databricks Audit Log Event object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `catalogs`
Catalogs covers Unity Catalog catalogs available in the Databricks workspace. Provides metadata about each catalog including name, owner, comment, and properties.
* **Enables:** inventory returned Unity Catalog catalogs and compare their owner, catalog kind, storage reference, and browse-only or Workspace-access flags.
* **Scope:** Lists all Unity Catalog catalogs available in the Databricks workspace. Provides metadata about each catalog including name, owner, comment, and properties; the connector reads `/api/2.1/unity-catalog/catalogs` as a snapshot stream in full mode. The configured credential must grant the declared `all-apis` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the Databricks record was deleted.
Developer identifier: `catalogs.accessible_in_current_workspace`
Accessible In Current Workspace records whether the catalog is accessible in the current workspace context. It is needed to distinguish Catalogs rows by the exact Databricks-returned accessible in current workspace value.
* **Enables:** select Catalogs rows where `accessible_in_current_workspace` is true or false when comparing the condition described by Accessible In Current Workspace.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `catalogs.browse_only`
Browse Only records whether the catalog is browse-only (no data access, metadata only). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Catalogs rows with the exact `browse_only` access-related value being investigated.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `catalogs.cache_version_info`
Cache Version Info records cache version metadata for the catalog. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `cache_version_info` and associate them with the containing Catalogs record.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is one nested object per containing Catalog object when present; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `catalogs.cache_version_info.metastore_version`
Metastore Version records metastore version cached for this catalog. It is needed to compare the exact metastore version configuration returned for this Cache Version Info record.
* **Enables:** compare the exact `metastore_version` configuration returned for each Cache Version Info record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Cache Version Info object returned for Catalogs; it is interpreted at one Cache Version Info record per row.
Developer identifier: `catalogs.catalog_type`
Catalog Type records type of catalog (e.g., `MANAGED_CATALOG`, `DELTASHARING_CATALOG`). It is needed to distinguish Catalogs rows by the exact Databricks-returned catalog type value.
* **Enables:** separate Catalogs rows by the exact Databricks-returned `catalog_type` label when comparing catalog type.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `catalogs.comment`
Comment records comment or description for the catalog. It is needed to inspect the exact comment or journal text included with this record.
* **Enables:** inspect the comment or journal text returned in `comment` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is comment or journal text at one Catalog record per row; this is only the content included in the Databricks response for this record.
Developer identifier: `catalogs.connection_name`
Connection Name records name of the connection, applicable for foreign catalogs. It is needed to compare the returned connection name for individual Catalogs rows and select rows with a specific `connection_name` value.
* **Enables:** locate Catalogs rows whose returned connection name exactly matches `connection_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row.
Developer identifier: `catalogs.created_at`
Created At records timestamp when the catalog was created, in epoch milliseconds. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Catalogs records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `catalogs.created_by`
Created By records user or principal who created the catalog. It is needed to attribute this Catalogs row to the returned person, account, or organization reference.
* **Enables:** attribute the Catalogs row to the returned person or account and match the exact `created_by` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row.
Developer identifier: `catalogs.effective_predictive_optimization_flag`
Effective Predictive Optimization Flag records effective predictive optimization flag details including value and source. It is needed to preserve the nested effective predictive optimization flag relationship or details on the parent Catalog record.
* **Enables:** expand `effective_predictive_optimization_flag` to connect the containing Catalog row to its returned effective predictive optimization flag entries.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is one nested object per containing Catalog object when present.
Developer identifier: `catalogs.effective_predictive_optimization_flag.inherited_from_name`
Inherited From Name records the name of the object from which this flag was inherited. It is needed to compare the returned inherited from name for individual Catalogs rows and select rows with a specific `inherited_from_name` value.
* **Enables:** locate Catalogs rows whose returned inherited from name exactly matches `inherited_from_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Effective Predictive Optimization Flag object returned for Catalogs; it is interpreted at one Effective Predictive Optimization Flag record per row.
Developer identifier: `catalogs.effective_predictive_optimization_flag.inherited_from_type`
Inherited From Type records the type of object from which this flag was inherited (e.g., CATALOG, SCHEMA, ACCOUNT). It is needed to distinguish Catalogs rows by the exact Databricks-returned inherited from type value.
* **Enables:** separate Catalogs rows by the exact Databricks-returned `inherited_from_type` label when comparing inherited from type.
* **Interpretation:** Databricks reports this value on the Effective Predictive Optimization Flag object returned for Catalogs; it is interpreted at one Effective Predictive Optimization Flag record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `catalogs.effective_predictive_optimization_flag.value`
Value records the resolved effective value of predictive optimization. It is needed to distinguish Catalogs rows by the exact Databricks-returned value value.
* **Enables:** separate Catalogs rows by the exact Databricks-returned `value` label when comparing value.
* **Interpretation:** Databricks reports this value on the Effective Predictive Optimization Flag object returned for Catalogs; it is interpreted at one Effective Predictive Optimization Flag record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `catalogs.enable_predictive_optimization`
Enable Predictive Optimization records whether predictive optimization is enabled for the catalog. It is needed to distinguish Catalogs rows by the exact Databricks-returned enable predictive optimization value.
* **Enables:** select Catalogs rows where `enable_predictive_optimization` is true or false when comparing the condition described by Enable Predictive Optimization.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `catalogs.etag`
ETag records entity tag for optimistic concurrency on catalog updates. It is needed to compare the returned e tag for individual Catalogs rows and select rows with a specific `etag` value.
* **Enables:** trace the e tag relationship returned in `etag` from the Catalog row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row.
Developer identifier: `catalogs.full_name`
Full Name records full name of the catalog, typically the same as name for top-level catalogs. It is needed to compare the returned full name for individual Catalogs rows and select rows with a specific `full_name` value.
* **Enables:** locate Catalogs rows whose returned full name exactly matches `full_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row.
Developer identifier: `catalogs.id`
ID records Unity Catalog catalog UUID. It is needed to refer to the same catalog across records without relying on display text.
* **Enables:** match `id` to catalog references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is an identifier, not a measured quantity; the schema uses the `Identity.UUID` scalar.
Developer identifier: `catalogs.isolation_mode`
Isolation Mode records isolation mode of the catalog. It is needed to distinguish Catalogs rows by the exact Databricks-returned isolation mode value.
* **Enables:** separate Catalogs rows by the exact Databricks-returned `isolation_mode` label when comparing isolation mode.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `catalogs.metastore_id`
Metastore ID records ID of the metastore this catalog belongs to. It is needed to refer to the same metastore across records without relying on display text.
* **Enables:** match `metastore_id` to metastore references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is an identifier, not a measured quantity.
Developer identifier: `catalogs.metastore_version`
Metastore Version records metastore version associated with this catalog record. It is needed to compare the exact metastore version configuration returned for this Catalog record.
* **Enables:** compare the exact `metastore_version` configuration returned for each Catalog record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row.
Developer identifier: `catalogs.name`
Name records name of the catalog. Serves as the primary key. It is needed to distinguish repeated deliveries of the same Catalogs row using the declared ingestion key.
* **Enables:** use `name` as the declared ingestion deduplication key for Catalogs and match repeated rows carrying the same Databricks identifier.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `catalogs.options`
Options records options for configuring the catalog, such as connection options for foreign catalogs. It is needed to compare the exact options configuration returned for this Catalog record.
* **Enables:** compare the exact `options` configuration returned for each Catalog record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `catalogs.owner`
Owner records owner of the catalog. It is needed to attribute this Catalogs row to the returned person, account, or organization reference.
* **Enables:** attribute the Catalogs row to the returned person or account and match the exact `owner` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row.
Developer identifier: `catalogs.properties`
Properties records key-value properties associated with the catalog. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `properties` and associate them with the containing Catalogs record.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row; the schema uses the `Generic.JSON` scalar; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `catalogs.provider_name`
Provider Name records name of the provider, applicable for Delta Sharing catalogs. It is needed to compare the returned provider name for individual Catalogs rows and select rows with a specific `provider_name` value.
* **Enables:** locate Catalogs rows whose returned provider name exactly matches `provider_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row.
Developer identifier: `catalogs.provisioning_info`
Provisioning Info records provisioning state information for the catalog. It is needed to preserve the nested provisioning info relationship or details on the parent Catalog record.
* **Enables:** expand `provisioning_info` to connect the containing Catalog row to its returned provisioning info entries.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is one nested object per containing Catalog object when present.
Developer identifier: `catalogs.provisioning_info.state`
State records current provisioning state of the catalog. It is needed to distinguish Catalogs rows by the exact Databricks-returned state value.
* **Enables:** separate Catalogs rows by the exact Databricks-returned `state` label when comparing state.
* **Interpretation:** Databricks reports this value on the Provisioning Info object returned for Catalogs; it is interpreted at one Provisioning Info record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `catalogs.query_federation_attributes`
Query Federation Attributes records foreign-catalog federation metadata when `catalog_type` is `FOREIGN_CATALOG`. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `query_federation_attributes` and associate them with the containing Catalogs record.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is one nested object per containing Catalog object when present; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `catalogs.query_federation_attributes.connection_id`
Connection ID records foreign connection UUID backing the catalog. It is needed to refer to the same connection across records without relying on display text.
* **Enables:** match `connection_id` to connection references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Query Federation Attributes object returned for Catalogs; it is an identifier, not a measured quantity; the schema uses the `Identity.UUID` scalar.
Developer identifier: `catalogs.query_federation_attributes.last_refreshed_timestamp`
Last Refreshed Timestamp records epoch milliseconds when federation metadata was last refreshed. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Catalogs records by `last_refreshed_timestamp`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Query Federation Attributes object returned for Catalogs; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `catalogs.resource_name`
Resource Name records metastore-relative resource path for the catalog. It is needed to compare the returned resource name for individual Catalogs rows and select rows with a specific `resource_name` value.
* **Enables:** locate Catalogs rows whose returned resource name exactly matches `resource_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row.
Developer identifier: `catalogs.securable_kind`
Securable Kind records the kind of securable, such as `CATALOG_STANDARD` or `CATALOG_DELTASHARING`. It is needed to distinguish Catalogs rows by the exact Databricks-returned securable kind value.
* **Enables:** separate Catalogs rows by the exact Databricks-returned `securable_kind` label when comparing securable kind.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `catalogs.securable_type`
Securable Type records the securable type of this object, typically CATALOG. It is needed to distinguish Catalogs rows by the exact Databricks-returned securable type value.
* **Enables:** separate Catalogs rows by the exact Databricks-returned `securable_type` label when comparing securable type.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `catalogs.share_name`
Share Name records name of the share, applicable for Delta Sharing catalogs. It is needed to compare the returned share name for individual Catalogs rows and select rows with a specific `share_name` value.
* **Enables:** locate Catalogs rows whose returned share name exactly matches `share_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row.
Developer identifier: `catalogs.storage_location`
Storage Location records storage location URL for the catalog. It is needed to preserve the Databricks-reported resource location link for the same record.
* **Enables:** correlate the Databricks resource link in `storage_location` with its containing Catalog row without treating the resource path as a statement of data residency.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row; the schema uses the `Network.Uri` scalar; the value is resource location link; this Databricks-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `catalogs.storage_root`
Storage Root records root storage location for managed tables in this catalog. It is needed to compare the returned storage root for individual Catalogs rows and select rows with a specific `storage_root` value.
* **Enables:** trace the storage root relationship returned in `storage_root` from the Catalog row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row.
Developer identifier: `catalogs.updated_at`
Updated At records timestamp when the catalog was last updated, in epoch milliseconds. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Catalogs records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; its unit or granularity is epoch milliseconds; the connector also declares it for record ordering; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `catalogs.updated_by`
Updated By records user or principal who last updated the catalog. It is needed to attribute this Catalogs row to the returned person, account, or organization reference.
* **Enables:** attribute the Catalogs row to the returned person or account and match the exact `updated_by` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Catalog object returned for Catalogs; it is interpreted at one Catalog record per row.
Developer identifier: `clusters`
Clusters covers clusters in the Databricks workspace. Provides compute cluster metadata including configuration, state, and resource allocation details.
* **Enables:** compare returned cluster configuration, lifecycle state, worker allocation, creator, and activity times.
* **Scope:** Lists all clusters in the Databricks workspace. Provides compute cluster metadata including configuration, state, and resource allocation details; the connector reads `/api/{apiVersion}/clusters/list` as a snapshot stream in full mode. The configured credential must grant the declared `all-apis` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the Databricks record was deleted.
Developer identifier: `clusters.autoscale`
Autoscale records autoscale configuration specifying min and max workers. It is needed to measure the Databricks-reported number of autoscale at one Databricks Cluster record per row.
* **Enables:** measure and compare the Databricks-reported number of autoscale in `autoscale` at one Databricks Cluster record per row.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is a Databricks-reported count at one Databricks Cluster record per row.
Developer identifier: `clusters.autoscale.max_workers`
Max Workers records maximum number of workers the cluster can scale up to. It is needed to measure the Databricks-reported number of max workers at one Autoscale Config record per row.
* **Enables:** measure and compare the Databricks-reported number of max workers in `max_workers` at one Autoscale Config record per row.
* **Interpretation:** Databricks reports this value on the Autoscale Config object returned for Clusters; it is a Databricks-reported count at one Autoscale Config record per row.
Developer identifier: `clusters.autoscale.min_workers`
Min Workers records minimum number of workers the cluster can scale down to. It is needed to measure the Databricks-reported number of min workers at one Autoscale Config record per row.
* **Enables:** measure and compare the Databricks-reported number of min workers in `min_workers` at one Autoscale Config record per row.
* **Interpretation:** Databricks reports this value on the Autoscale Config object returned for Clusters; it is a Databricks-reported count at one Autoscale Config record per row.
Developer identifier: `clusters.aws_attributes`
AWS Attributes records AWS-specific cluster attributes (present for AWS workspaces). It is needed to preserve the nested aws attributes relationship or details on the parent Databricks Cluster record.
* **Enables:** expand `aws_attributes` to connect the containing Databricks Cluster row to its returned aws attributes entries.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is one nested object per containing Databricks Cluster object when present.
Developer identifier: `clusters.aws_attributes.availability`
Availability records availability type for the cluster. It is needed to distinguish Clusters rows by the exact Databricks-returned availability value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `availability` label when comparing availability.
* **Interpretation:** Databricks reports this value on the AWS Attributes object returned for Clusters; it is interpreted at one AWS Attributes record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.aws_attributes.ebs_volume_count`
Ebs Volume Count records number of EBS volumes attached to each node. It is needed to measure the Databricks-reported number of eBS volumes attached to each node at one AWS Attributes record per row.
* **Enables:** measure and compare the Databricks-reported number of eBS volumes attached to each node in `ebs_volume_count` at one AWS Attributes record per row.
* **Interpretation:** Databricks reports this value on the AWS Attributes object returned for Clusters; it is a Databricks-reported count at one AWS Attributes record per row.
Developer identifier: `clusters.aws_attributes.ebs_volume_iops`
Ebs Volume Iops records IOPS for provisioned IOPS EBS volumes. It is needed to compare the numeric ebs volume iops reported for one AWS Attributes record without assuming an unstated unit.
* **Enables:** compare the numeric `ebs_volume_iops` value per AWS Attributes record without assigning a unit not declared by the schema description.
* **Interpretation:** Databricks reports this value on the AWS Attributes object returned for Clusters; it is interpreted at one AWS Attributes record per row.
Developer identifier: `clusters.aws_attributes.ebs_volume_size`
Ebs Volume Size records size of each EBS volume in GiB. It is needed to compare the numeric ebs volume size reported for one AWS Attributes record without assuming an unstated unit.
* **Enables:** compare the numeric `ebs_volume_size` value per AWS Attributes record without assigning a unit not declared by the schema description.
* **Interpretation:** Databricks reports this value on the AWS Attributes object returned for Clusters; it is interpreted at one AWS Attributes record per row.
Developer identifier: `clusters.aws_attributes.ebs_volume_throughput`
Ebs Volume Throughput records throughput for gp3 EBS volumes in MiB/s. It is needed to compare the numeric ebs volume throughput reported for one AWS Attributes record without assuming an unstated unit.
* **Enables:** compare the numeric `ebs_volume_throughput` value per AWS Attributes record without assigning a unit not declared by the schema description.
* **Interpretation:** Databricks reports this value on the AWS Attributes object returned for Clusters; it is interpreted at one AWS Attributes record per row.
Developer identifier: `clusters.aws_attributes.ebs_volume_type`
Ebs Volume Type records EBS volume type (e.g. `GENERAL_PURPOSE_SSD`, `THROUGHPUT_OPTIMIZED_HDD`). It is needed to distinguish Clusters rows by the exact Databricks-returned ebs volume type value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `ebs_volume_type` label when comparing ebs volume type.
* **Interpretation:** Databricks reports this value on the AWS Attributes object returned for Clusters; it is interpreted at one AWS Attributes record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.aws_attributes.first_on_demand`
First On Demand records number of nodes placed on on-demand instances first. It is needed to measure the Databricks-reported number of nodes placed on on-demand instances first at one AWS Attributes record per row.
* **Enables:** measure and compare the Databricks-reported number of nodes placed on on-demand instances first in `first_on_demand` at one AWS Attributes record per row.
* **Interpretation:** Databricks reports this value on the AWS Attributes object returned for Clusters; it is a Databricks-reported count at one AWS Attributes record per row.
Developer identifier: `clusters.aws_attributes.instance_profile_arn`
Instance Profile Arn records ARN of the instance profile for the cluster. It is needed to inventory the exact Databricks-reported configuration or classification represented by this field.
* **Enables:** compare `instance_profile_arn` among Clusters records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Databricks reports this value on the AWS Attributes object returned for Clusters; it is interpreted at one AWS Attributes record per row; the value is a Databricks-returned or configured label at the Aws Attributes grain rather than a universal taxonomy.
Developer identifier: `clusters.aws_attributes.spot_bid_price_percent`
Spot Bid Price Percent records max bid price as a percentage of on-demand price for spot instances. It is needed to measure the reported spot bid price percent for one aws attributes record.
* **Enables:** measure and compare `spot_bid_price_percent` per AWS Attributes record in percent.
* **Interpretation:** Databricks reports this value on the AWS Attributes object returned for Clusters; its unit or granularity is percent.
Developer identifier: `clusters.aws_attributes.zone_id`
Zone ID records AWS availability zone ID. It is needed to refer to the same zone across records without relying on display text.
* **Enables:** match `zone_id` to zone references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the AWS Attributes object returned for Clusters; it is an identifier, not a measured quantity.
Developer identifier: `clusters.azure_attributes`
Azure Attributes records azure-specific cluster attributes (present for Azure workspaces). It is needed to preserve the nested azure attributes relationship or details on the parent Databricks Cluster record.
* **Enables:** expand `azure_attributes` to connect the containing Databricks Cluster row to its returned azure attributes entries.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is one nested object per containing Databricks Cluster object when present.
Developer identifier: `clusters.azure_attributes.availability`
Availability records availability type for the cluster. It is needed to distinguish Clusters rows by the exact Databricks-returned availability value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `availability` label when comparing availability.
* **Interpretation:** Databricks reports this value on the Azure Attributes object returned for Clusters; it is interpreted at one Azure Attributes record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.azure_attributes.first_on_demand`
First On Demand records number of nodes placed on on-demand instances first. It is needed to measure the Databricks-reported number of nodes placed on on-demand instances first at one Azure Attributes record per row.
* **Enables:** measure and compare the Databricks-reported number of nodes placed on on-demand instances first in `first_on_demand` at one Azure Attributes record per row.
* **Interpretation:** Databricks reports this value on the Azure Attributes object returned for Clusters; it is a Databricks-reported count at one Azure Attributes record per row.
Developer identifier: `clusters.azure_attributes.log_analytics_info`
Log Analytics Info records log Analytics workspace configuration. It is needed to compare the exact log analytics info configuration returned for this Azure Attributes record.
* **Enables:** compare the exact `log_analytics_info` configuration returned for each Azure Attributes record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Azure Attributes object returned for Clusters; it is interpreted at one Azure Attributes record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `clusters.azure_attributes.spot_bid_max_price`
Spot Bid Max Price records max bid price for Azure spot instances (-1 for on-demand price). It is needed to measure the exact commercial amount reported on this record.
* **Enables:** measure and compare the reported `spot_bid_max_price` amount for Clusters records, using the record's currency code when one is returned.
* **Interpretation:** Databricks reports this value on the Azure Attributes object returned for Clusters; it is interpreted at one Azure Attributes record per row; the Databricks response determines the currency or pricing basis; do not infer one when it is absent.
Developer identifier: `clusters.cluster_cores`
Cluster Cores records total number of cores available across the cluster. It is needed to measure the Databricks-reported number of cores available across the cluster at one Databricks Cluster record per row.
* **Enables:** measure and compare the Databricks-reported number of cores available across the cluster in `cluster_cores` at one Databricks Cluster record per row.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is a Databricks-reported count at one Databricks Cluster record per row.
Developer identifier: `clusters.cluster_id`
Cluster ID records unique identifier for the cluster. It is needed to distinguish repeated deliveries of the same Clusters row using the declared ingestion key.
* **Enables:** use `cluster_id` as the declared ingestion deduplication key for Clusters and match repeated rows carrying the same Databricks identifier.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `clusters.cluster_log_conf`
Cluster Log Conf records configuration for delivering Spark logs to a destination. It is needed to preserve the nested cluster log conf relationship or details on the parent Databricks Cluster record.
* **Enables:** expand `cluster_log_conf` to connect the containing Databricks Cluster row to its returned cluster log conf entries.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is one nested object per containing Databricks Cluster object when present.
Developer identifier: `clusters.cluster_log_conf.dbfs`
Dbfs records DBFS destination for logs. It is needed to preserve the nested dbfs relationship or details on the parent Cluster Log Conf record.
* **Enables:** expand `dbfs` to connect the containing Cluster Log Conf row to its returned dbfs entries.
* **Interpretation:** Databricks reports this value on the Cluster Log Conf object returned for Clusters; it is one nested object per containing Cluster Log Conf object when present.
Developer identifier: `clusters.cluster_log_conf.dbfs.destination`
Destination records DBFS path. It is needed to compare the returned destination for individual Clusters rows and select rows with a specific `destination` value.
* **Enables:** trace the destination relationship returned in `destination` from the Dbfs Storage Info row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Dbfs Storage Info object returned for Clusters; it is interpreted at one Dbfs Storage Info record per row.
Developer identifier: `clusters.cluster_log_conf.s3`
S3 records s3 destination for logs. It is needed to preserve the nested s3 relationship or details on the parent Cluster Log Conf record.
* **Enables:** expand `s3` to connect the containing Cluster Log Conf row to its returned s3 entries.
* **Interpretation:** Databricks reports this value on the Cluster Log Conf object returned for Clusters; it is one nested object per containing Cluster Log Conf object when present.
Developer identifier: `clusters.cluster_log_conf.s3.canned_acl`
Canned Acl records canned ACL to apply. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Clusters rows with the exact `canned_acl` access-related value being investigated.
* **Interpretation:** Databricks reports this value on the S3 Storage Info object returned for Clusters; it is interpreted at one S3 Storage Info record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.cluster_log_conf.s3.destination`
Destination records s3 URI. It is needed to retain the exact Databricks resource or external link reported for this Clusters record.
* **Enables:** open or correlate the resource named by `destination` while retaining the containing S3 Storage Info row as provenance.
* **Interpretation:** Databricks reports this value on the S3 Storage Info object returned for Clusters; it is interpreted at one S3 Storage Info record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `clusters.cluster_log_conf.s3.enable_encryption`
Enable Encryption records whether server-side encryption is enabled. It is needed to distinguish Clusters rows by the exact Databricks-returned enable encryption value.
* **Enables:** select Clusters rows where `enable_encryption` is true or false when comparing the condition described by Enable Encryption.
* **Interpretation:** Databricks reports this value on the S3 Storage Info object returned for Clusters; it is interpreted at one S3 Storage Info record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.cluster_log_conf.s3.encryption_type`
Encryption Type records encryption type (e.g. sse-s3). It is needed to distinguish Clusters rows by the exact Databricks-returned encryption type value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `encryption_type` label when comparing encryption type.
* **Interpretation:** Databricks reports this value on the S3 Storage Info object returned for Clusters; it is interpreted at one S3 Storage Info record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.cluster_log_conf.s3.endpoint`
Endpoint records s3 endpoint URL. It is needed to retain the exact Databricks resource or external link reported for this Clusters record.
* **Enables:** open or correlate the resource named by `endpoint` while retaining the containing S3 Storage Info row as provenance.
* **Interpretation:** Databricks reports this value on the S3 Storage Info object returned for Clusters; it is interpreted at one S3 Storage Info record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `clusters.cluster_log_conf.s3.kms_key`
Kms Key records KMS key for encryption. It is needed to refer to the same kms across records without relying on display text.
* **Enables:** match `kms_key` to kms references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the S3 Storage Info object returned for Clusters; it is an identifier, not a measured quantity.
Developer identifier: `clusters.cluster_log_conf.s3.region`
Region records AWS region of the S3 bucket. It is needed to scope the returned S3 storage configuration to the AWS region named for its bucket.
* **Enables:** combine `region` with the sibling S3 destination and endpoint when reproducing or investigating the same log-storage configuration.
* **Interpretation:** Databricks reports this value on the S3 Storage Info object returned for Clusters; it is one AWS region label per S3 storage configuration; the label scopes the configured bucket endpoint and does not establish data residency or verified physical storage.
Developer identifier: `clusters.cluster_log_status`
Cluster Log Status records status of log delivery for the cluster. It is needed to preserve the nested cluster log status relationship or details on the parent Databricks Cluster record.
* **Enables:** expand `cluster_log_status` to connect the containing Databricks Cluster row to its returned cluster log status entries.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is one nested object per containing Databricks Cluster object when present.
Developer identifier: `clusters.cluster_log_status.last_attempted`
Last Attempted records timestamp (epoch ms) of the last log sync attempt. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Clusters records by `last_attempted`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Log Sync Status object returned for Clusters; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `clusters.cluster_log_status.last_exception`
Last Exception records exception message from the last failed sync attempt. It is needed to inspect the exact exception message returned for this Log Sync Status record.
* **Enables:** attribute the exception message in `last_exception` to the containing Clusters identifier, owner or author, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Log Sync Status object returned for Clusters; it is interpreted at one Log Sync Status record per row; this is only the exception message included in the Databricks response for this record.
Developer identifier: `clusters.cluster_memory_mb`
Cluster Memory Mb records total cluster memory in megabytes. It is needed to measure the reported cluster memory mb for one databricks cluster record.
* **Enables:** measure and compare `cluster_memory_mb` per Databricks Cluster record in megabytes.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; its unit or granularity is megabytes.
Developer identifier: `clusters.cluster_name`
Cluster Name records human-readable name of the cluster. It is needed to compare the returned cluster name for individual Clusters rows and select rows with a specific `cluster_name` value.
* **Enables:** locate Clusters rows whose returned cluster name exactly matches `cluster_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row.
Developer identifier: `clusters.cluster_source`
Cluster Source records source that created the cluster (UI, API, JOB, etc.). It is needed to distinguish Clusters rows by the exact Databricks-returned cluster source value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `cluster_source` label when comparing cluster source.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.creator_user_name`
Creator User Name records username of the user who created the cluster. It is needed to attribute this Clusters row to the returned person, account, or organization reference.
* **Enables:** attribute the Clusters row to the returned person or account and match the exact `creator_user_name` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row.
Developer identifier: `clusters.custom_tags`
Custom Tags records custom user-defined tags applied to the cluster. It is needed to distinguish Clusters rows by the exact Databricks-returned custom tags value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `custom_tags` label when comparing custom tags.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row; the schema uses the `Generic.JSON` scalar; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.data_security_mode`
Data Security Mode records data security mode for the cluster (Unity Catalog access mode). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Clusters rows with the exact `data_security_mode` access-related value being investigated.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.default_tags`
Default Tags records default tags automatically applied to the cluster by Databricks. It is needed to distinguish Clusters rows by the exact Databricks-returned default tags value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `default_tags` label when comparing default tags.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row; the schema uses the `Generic.JSON` scalar; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.disk_spec`
Disk Spec records disk specification for worker nodes. It is needed to preserve the nested disk spec relationship or details on the parent Databricks Cluster record.
* **Enables:** expand `disk_spec` to connect the containing Databricks Cluster row to its returned disk spec entries.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is one nested object per containing Databricks Cluster object when present.
Developer identifier: `clusters.disk_spec.disk_count`
Disk Count records number of disks per node. It is needed to measure the Databricks-reported number of disks per node at one Disk Spec record per row.
* **Enables:** measure and compare the Databricks-reported number of disks per node in `disk_count` at one Disk Spec record per row.
* **Interpretation:** Databricks reports this value on the Disk Spec object returned for Clusters; it is a Databricks-reported count at one Disk Spec record per row.
Developer identifier: `clusters.disk_spec.disk_iops`
Disk Iops records IOPS for the disk. It is needed to compare the numeric disk iops reported for one Disk Spec record without assuming an unstated unit.
* **Enables:** compare the numeric `disk_iops` value per Disk Spec record without assigning a unit not declared by the schema description.
* **Interpretation:** Databricks reports this value on the Disk Spec object returned for Clusters; it is interpreted at one Disk Spec record per row.
Developer identifier: `clusters.disk_spec.disk_size`
Disk Size records size of each disk in GiB. It is needed to compare the numeric disk size reported for one Disk Spec record without assuming an unstated unit.
* **Enables:** compare the numeric `disk_size` value per Disk Spec record without assigning a unit not declared by the schema description.
* **Interpretation:** Databricks reports this value on the Disk Spec object returned for Clusters; it is interpreted at one Disk Spec record per row.
Developer identifier: `clusters.disk_spec.disk_throughput`
Disk Throughput records throughput for the disk in MiB/s. It is needed to compare the numeric disk throughput reported for one Disk Spec record without assuming an unstated unit.
* **Enables:** compare the numeric `disk_throughput` value per Disk Spec record without assigning a unit not declared by the schema description.
* **Interpretation:** Databricks reports this value on the Disk Spec object returned for Clusters; it is interpreted at one Disk Spec record per row.
Developer identifier: `clusters.disk_spec.disk_type`
Disk Type records disk type configuration. It is needed to preserve the nested disk type relationship or details on the parent Disk Spec record.
* **Enables:** expand `disk_type` to connect the containing Disk Spec row to its returned disk type entries.
* **Interpretation:** Databricks reports this value on the Disk Spec object returned for Clusters; it is one nested object per containing Disk Spec object when present.
Developer identifier: `clusters.disk_spec.disk_type.azure_disk_volume_type`
Azure Disk Volume Type records azure managed disk type. It is needed to distinguish Clusters rows by the exact Databricks-returned azure disk volume type value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `azure_disk_volume_type` label when comparing azure disk volume type.
* **Interpretation:** Databricks reports this value on the Disk Type object returned for Clusters; it is interpreted at one Disk Type record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.disk_spec.disk_type.ebs_volume_type`
Ebs Volume Type records EBS volume type (AWS). It is needed to distinguish Clusters rows by the exact Databricks-returned ebs volume type value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `ebs_volume_type` label when comparing ebs volume type.
* **Interpretation:** Databricks reports this value on the Disk Type object returned for Clusters; it is interpreted at one Disk Type record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.docker_image`
Docker Image records custom Docker image for the cluster (Databricks Container Services). It is needed to preserve the nested docker image relationship or details on the parent Databricks Cluster record.
* **Enables:** expand `docker_image` to connect the containing Databricks Cluster row to its returned docker image entries.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is one nested object per containing Databricks Cluster object when present.
Developer identifier: `clusters.docker_image.basic_auth`
Basic Auth records basic authentication credentials for the Docker registry. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `basic_auth` to examine the returned basic auth details for the containing Docker Image record.
* **Interpretation:** Databricks reports this value on the Docker Image object returned for Clusters; it is one nested object per containing Docker Image object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `clusters.docker_image.basic_auth.password`
Password records docker registry password. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `password` access value with the resource, account, or membership represented by the same Clusters row.
* **Interpretation:** Databricks reports this value on the Docker Basic Auth object returned for Clusters; it is interpreted at one Docker Basic Auth record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `clusters.docker_image.basic_auth.username`
User Name records docker registry username. It is needed to attribute this Clusters row to the returned person, account, or organization reference.
* **Enables:** attribute the Clusters row to the returned person or account and match the exact `username` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Docker Basic Auth object returned for Clusters; it is interpreted at one Docker Basic Auth record per row.
Developer identifier: `clusters.docker_image.url`
URL records docker image URL. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Databricks resource referenced by `url` while retaining the containing Clusters record as provenance.
* **Interpretation:** Databricks reports this value on the Docker Image object returned for Clusters; it is link at one Docker Image record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `clusters.driver`
Driver records information about the driver node. It is needed to preserve the nested driver relationship or details on the parent Databricks Cluster record.
* **Enables:** expand `driver` to connect the containing Databricks Cluster row to its returned driver entries.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is one nested object per containing Databricks Cluster object when present.
Developer identifier: `clusters.driver.host_private_ip`
Host Private IP records the private network address of the host underlying the Spark node. It is needed to correlate that host address with the containing cluster and node inventory.
* **Enables:** compare `host_private_ip` with `private_ip`, `node_id`, `instance_id`, and the containing Clusters record when reconciling returned hosts and Spark nodes.
* **Interpretation:** Databricks reports this value on the Spark Node object returned for Clusters; it identifies the host's private network address in that cluster inventory.
Developer identifier: `clusters.driver.instance_id`
Instance ID records cloud provider instance ID. It is needed to refer to the same instance across records without relying on display text.
* **Enables:** match `instance_id` to instance references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Spark Node object returned for Clusters; it is an identifier, not a measured quantity.
Developer identifier: `clusters.driver.node_aws_attributes`
Node AWS Attributes records AWS-specific node attributes. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `node_aws_attributes` and associate them with the containing Clusters record.
* **Interpretation:** Databricks reports this value on the Spark Node object returned for Clusters; it is interpreted at one Spark Node record per row; the schema uses the `Generic.JSON` scalar; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `clusters.driver.node_id`
Node ID records unique identifier for the node. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Spark Node object returned for Clusters; it is an identifier, not a measured quantity.
Developer identifier: `clusters.driver.private_ip`
Private IP records the private network address assigned to the Spark node. It is needed to correlate that node address with the containing cluster and node inventory.
* **Enables:** match `private_ip` with `node_id`, `instance_id`, and the containing Clusters record when reconciling returned Spark nodes.
* **Interpretation:** Databricks reports this value on the Spark Node object returned for Clusters; it identifies the node's private network address in that cluster inventory.
Developer identifier: `clusters.driver.public_dns`
Public DNS records public DNS name of the node. It is needed to distinguish Clusters rows by the exact Databricks-returned public dns value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `public_dns` label when comparing public dns.
* **Interpretation:** Databricks reports this value on the Spark Node object returned for Clusters; it is interpreted at one Spark Node record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.driver.start_timestamp`
Start Timestamp records timestamp (epoch ms) when the node was started. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Clusters records by `start_timestamp`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Spark Node object returned for Clusters; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `clusters.driver_instance_pool_id`
Driver Instance Pool ID records ID of the instance pool used for the driver node. It is needed to refer to the same driver instance pool across records without relying on display text.
* **Enables:** match `driver_instance_pool_id` to driver instance pool references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is an identifier, not a measured quantity.
Developer identifier: `clusters.driver_node_type_id`
Driver Node Type ID records instance type identifier for the driver node. It is needed to refer to the same driver node type across records without relying on display text.
* **Enables:** match `driver_node_type_id` to driver node type references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is an identifier, not a measured quantity; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.effective_spark_version`
Effective Spark Version records the effective Spark version after resolution. It is needed to compare the exact effective spark version configuration returned for this Databricks Cluster record.
* **Enables:** compare the exact `effective_spark_version` configuration returned for each Databricks Cluster record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row.
Developer identifier: `clusters.enable_elastic_disk`
Enable Elastic Disk records whether autoscaling local storage is enabled. It is needed to distinguish Clusters rows by the exact Databricks-returned enable elastic disk value.
* **Enables:** select Clusters rows where `enable_elastic_disk` is true or false when comparing the condition described by Enable Elastic Disk.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.enable_local_disk_encryption`
Enable Local Disk Encryption records whether local disk encryption is enabled. It is needed to distinguish Clusters rows by the exact Databricks-returned enable local disk encryption value.
* **Enables:** select Clusters rows where `enable_local_disk_encryption` is true or false when comparing the condition described by Enable Local Disk Encryption.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.executors`
Executors records list of executor/worker node information. It is needed to preserve the nested executors relationship or details on the parent Databricks Cluster record.
* **Enables:** expand `executors` to connect the containing Databricks Cluster row to its returned executors entries.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is one returned collection per containing Databricks Cluster object.
Developer identifier: `clusters.gcp_attributes`
GCP Attributes records GCP-specific cluster attributes (present for GCP workspaces). It is needed to preserve the nested gcp attributes relationship or details on the parent Databricks Cluster record.
* **Enables:** expand `gcp_attributes` to connect the containing Databricks Cluster row to its returned gcp attributes entries.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is one nested object per containing Databricks Cluster object when present.
Developer identifier: `clusters.gcp_attributes.availability`
Availability records availability type for the cluster. It is needed to distinguish Clusters rows by the exact Databricks-returned availability value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `availability` label when comparing availability.
* **Interpretation:** Databricks reports this value on the GCP Attributes object returned for Clusters; it is interpreted at one GCP Attributes record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.gcp_attributes.boot_disk_size`
Boot Disk Size records boot disk size in GiB. It is needed to compare the numeric boot disk size reported for one GCP Attributes record without assuming an unstated unit.
* **Enables:** compare the numeric `boot_disk_size` value per GCP Attributes record without assigning a unit not declared by the schema description.
* **Interpretation:** Databricks reports this value on the GCP Attributes object returned for Clusters; it is interpreted at one GCP Attributes record per row.
Developer identifier: `clusters.gcp_attributes.google_service_account`
Google Service Account records google service account email for the cluster. It is needed to attribute this Clusters row to the returned person, account, or organization reference.
* **Enables:** attribute the Clusters row to the returned person or account and match the exact `google_service_account` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the GCP Attributes object returned for Clusters; it is interpreted at one GCP Attributes record per row.
Developer identifier: `clusters.gcp_attributes.local_ssd_count`
Local Ssd Count records number of local SSDs attached to each node. It is needed to measure the Databricks-reported number of local SSDs attached to each node at one GCP Attributes record per row.
* **Enables:** measure and compare the Databricks-reported number of local SSDs attached to each node in `local_ssd_count` at one GCP Attributes record per row.
* **Interpretation:** Databricks reports this value on the GCP Attributes object returned for Clusters; it is a Databricks-reported count at one GCP Attributes record per row.
Developer identifier: `clusters.gcp_attributes.use_preemptible_executors`
Use Preemptible Executors records whether to use preemptible VMs for executors. It is needed to distinguish Clusters rows by the exact Databricks-returned use preemptible executors value.
* **Enables:** select Clusters rows where `use_preemptible_executors` is true or false when comparing the condition described by Use Preemptible Executors.
* **Interpretation:** Databricks reports this value on the GCP Attributes object returned for Clusters; it is interpreted at one GCP Attributes record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.gcp_attributes.zone_id`
Zone ID records GCP zone ID for the cluster. It is needed to refer to the same zone across records without relying on display text.
* **Enables:** match `zone_id` to zone references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the GCP Attributes object returned for Clusters; it is an identifier, not a measured quantity.
Developer identifier: `clusters.init_scripts`
Init Scripts records list of init scripts configured for the cluster. It is needed to preserve the nested init scripts relationship or details on the parent Databricks Cluster record.
* **Enables:** expand `init_scripts` to connect the containing Databricks Cluster row to its returned init scripts entries.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is one returned collection per containing Databricks Cluster object.
Developer identifier: `clusters.init_scripts.abfss`
Abfss records azure ABFSS location for the init script. It is needed to preserve the nested abfss relationship or details on the parent Init Script Info record.
* **Enables:** expand `abfss` to connect the containing Init Script Info row to its returned abfss entries.
* **Interpretation:** Databricks reports this value on the Init Script Info object returned for Clusters; it is one nested object per containing Init Script Info object when present.
Developer identifier: `clusters.init_scripts.abfss.destination`
Destination records ABFSS URI. It is needed to retain the exact Databricks resource or external link reported for this Clusters record.
* **Enables:** open or correlate the resource named by `destination` while retaining the containing Abfss Storage Info row as provenance.
* **Interpretation:** Databricks reports this value on the Abfss Storage Info object returned for Clusters; it is interpreted at one Abfss Storage Info record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `clusters.init_scripts.dbfs`
Dbfs records DBFS path for the init script. It is needed to preserve the nested dbfs relationship or details on the parent Init Script Info record.
* **Enables:** expand `dbfs` to connect the containing Init Script Info row to its returned dbfs entries.
* **Interpretation:** Databricks reports this value on the Init Script Info object returned for Clusters; it is one nested object per containing Init Script Info object when present.
Developer identifier: `clusters.init_scripts.gcs`
Gcs records GCS location for the init script. It is needed to preserve the nested gcs relationship or details on the parent Init Script Info record.
* **Enables:** expand `gcs` to connect the containing Init Script Info row to its returned gcs entries.
* **Interpretation:** Databricks reports this value on the Init Script Info object returned for Clusters; it is one nested object per containing Init Script Info object when present.
Developer identifier: `clusters.init_scripts.gcs.destination`
Destination records GCS URI. It is needed to retain the exact Databricks resource or external link reported for this Clusters record.
* **Enables:** open or correlate the resource named by `destination` while retaining the containing Gcs Storage Info row as provenance.
* **Interpretation:** Databricks reports this value on the Gcs Storage Info object returned for Clusters; it is interpreted at one Gcs Storage Info record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `clusters.init_scripts.s3`
S3 records s3 location for the init script. It is needed to preserve the nested s3 relationship or details on the parent Init Script Info record.
* **Enables:** expand `s3` to connect the containing Init Script Info row to its returned s3 entries.
* **Interpretation:** Databricks reports this value on the Init Script Info object returned for Clusters; it is one nested object per containing Init Script Info object when present.
Developer identifier: `clusters.init_scripts.volumes`
Volumes records Unity Catalog volumes path for the init script. It is needed to preserve the nested volumes relationship or details on the parent Init Script Info record.
* **Enables:** expand `volumes` to connect the containing Init Script Info row to its returned volumes entries.
* **Interpretation:** Databricks reports this value on the Init Script Info object returned for Clusters; it is one nested object per containing Init Script Info object when present.
Developer identifier: `clusters.init_scripts.volumes.destination`
Destination records volumes path. It is needed to compare the returned destination for individual Clusters rows and select rows with a specific `destination` value.
* **Enables:** trace the destination relationship returned in `destination` from the Volumes Storage Info row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Volumes Storage Info object returned for Clusters; it is interpreted at one Volumes Storage Info record per row.
Developer identifier: `clusters.init_scripts.workspace`
Workspace records workspace file system path for the init script. It is needed to preserve the nested workspace relationship or details on the parent Init Script Info record.
* **Enables:** expand `workspace` to connect the containing Init Script Info row to its returned workspace entries.
* **Interpretation:** Databricks reports this value on the Init Script Info object returned for Clusters; it is one nested object per containing Init Script Info object when present.
Developer identifier: `clusters.init_scripts.workspace.destination`
Destination records workspace file path. It is needed to compare the returned destination for individual Clusters rows and select rows with a specific `destination` value.
* **Enables:** trace the destination relationship returned in `destination` from the Workspace Storage Info row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Workspace Storage Info object returned for Clusters; it is interpreted at one Workspace Storage Info record per row.
Developer identifier: `clusters.instance_pool_id`
Instance Pool ID records ID of the instance pool used for worker nodes. It is needed to refer to the same instance pool across records without relying on display text.
* **Enables:** match `instance_pool_id` to instance pool references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is an identifier, not a measured quantity.
Developer identifier: `clusters.last_activity_time`
Last Activity Time records timestamp (epoch milliseconds) of the last activity on the cluster. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Clusters records by `last_activity_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; its unit or granularity is epoch milliseconds; the connector also declares it for record ordering; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `clusters.last_restarted_time`
Last Restarted Time records timestamp (epoch milliseconds) when the cluster was last restarted. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Clusters records by `last_restarted_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `clusters.last_state_loss_time`
Last State Loss Time records timestamp (epoch milliseconds) of the last state loss event. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Clusters records by `last_state_loss_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.node_type_id`
Node Type ID records instance type identifier for worker nodes. It is needed to refer to the same node type across records without relying on display text.
* **Enables:** match `node_type_id` to node type references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is an identifier, not a measured quantity; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.num_workers`
Num Workers records fixed number of worker nodes (mutually exclusive with autoscale). It is needed to measure the Databricks-reported number of num workers at one Databricks Cluster record per row.
* **Enables:** measure and compare the Databricks-reported number of num workers in `num_workers` at one Databricks Cluster record per row.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is a Databricks-reported count at one Databricks Cluster record per row.
Developer identifier: `clusters.policy_id`
Policy ID records ID of the cluster policy used to create this cluster. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `policy_id` access value with the resource, account, or membership represented by the same Clusters row.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `clusters.runtime_engine`
Runtime Engine records runtime engine type (STANDARD or PHOTON). It is needed to distinguish Clusters rows by the exact Databricks-returned runtime engine value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `runtime_engine` label when comparing runtime engine.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.single_user_name`
Single User Name records single user name for single-user access mode clusters. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `single_user_name` access value with the resource, account, or membership represented by the same Clusters row.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `clusters.spark_conf`
Spark Conf records spark configuration key-value pairs set on the cluster. It is needed to compare the exact spark conf configuration returned for this Databricks Cluster record.
* **Enables:** compare the exact `spark_conf` configuration returned for each Databricks Cluster record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `clusters.spark_env_vars`
Spark Env Vars records environment variables set for Spark processes. It is needed to preserve the exact Databricks configuration or execution metadata attached to this Databricks Cluster record.
* **Enables:** inspect the keys in `spark_env_vars` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Databricks response and can vary by resource type or configuration.
Developer identifier: `clusters.spark_version`
Spark Version records spark runtime version string (e.g. 13.3.x-scala2.12). It is needed to compare the exact spark version configuration returned for this Databricks Cluster record.
* **Enables:** compare the exact `spark_version` configuration returned for each Databricks Cluster record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row.
Developer identifier: `clusters.spec`
Spec records the original cluster specification used to create or edit the cluster. It is needed to preserve the exact Databricks configuration or execution metadata attached to this Databricks Cluster record.
* **Enables:** inspect the keys in `spec` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Databricks response and can vary by resource type or configuration.
Developer identifier: `clusters.ssh_public_keys`
SSH Public Keys records SSH public keys added to the cluster for access. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `ssh_public_keys` to examine the returned ssh public keys details for the containing Databricks Cluster record.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is one returned collection per containing Databricks Cluster object; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `clusters.start_time`
Start Time records timestamp (epoch milliseconds) when the cluster was started. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Clusters records by `start_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `clusters.state`
State records current lifecycle state of the cluster. It is needed to distinguish Clusters rows by the exact Databricks-returned state value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `state` label when comparing state.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is interpreted at one Databricks Cluster record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.state_message`
State Message records informational message associated with the current cluster state. It is needed to inspect the exact message text included with this record.
* **Enables:** inspect the message text returned in `state_message` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is message text at one Databricks Cluster record per row; this is only the content included in the Databricks response for this record; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.terminated_time`
Terminated Time records timestamp (epoch milliseconds) when the cluster was terminated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Clusters records by `terminated_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `clusters.termination_reason`
Termination Reason records details about why the cluster was terminated. It is needed to preserve the nested termination reason relationship or details on the parent Databricks Cluster record.
* **Enables:** expand `termination_reason` to connect the containing Databricks Cluster row to its returned termination reason entries.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is one nested object per containing Databricks Cluster object when present.
Developer identifier: `clusters.termination_reason.code`
Code records termination reason code (e.g. `USER_REQUEST`, INACTIVITY). It is needed to distinguish Clusters rows by the exact Databricks-returned code value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `code` label when comparing code.
* **Interpretation:** Databricks reports this value on the Termination Reason object returned for Clusters; it is interpreted at one Termination Reason record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.termination_reason.parameters`
Parameters records additional parameters providing context for the termination. It is needed to preserve the exact Databricks configuration or execution metadata attached to this Termination Reason record.
* **Enables:** inspect the keys in `parameters` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Databricks reports this value on the Termination Reason object returned for Clusters; it is interpreted at one Termination Reason record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Databricks response and can vary by resource type or configuration.
Developer identifier: `clusters.termination_reason.type`
Type records termination type (e.g. SUCCESS, `CLIENT_ERROR`, `SERVICE_FAULT`). It is needed to distinguish Clusters rows by the exact Databricks-returned type value.
* **Enables:** separate Clusters rows by the exact Databricks-returned `type` label when comparing type.
* **Interpretation:** Databricks reports this value on the Termination Reason object returned for Clusters; it is interpreted at one Termination Reason record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.workload_type`
Workload Type records workload type configuration for the cluster. It is needed to preserve the nested workload type relationship or details on the parent Databricks Cluster record.
* **Enables:** expand `workload_type` to connect the containing Databricks Cluster row to its returned workload type entries.
* **Interpretation:** Databricks reports this value on the Databricks Cluster object returned for Clusters; it is one nested object per containing Databricks Cluster object when present.
Developer identifier: `clusters.workload_type.clients`
Clients records client workload types enabled on the cluster. It is needed to preserve the nested clients relationship or details on the parent Workload Type record.
* **Enables:** expand `clients` to connect the containing Workload Type row to its returned clients entries.
* **Interpretation:** Databricks reports this value on the Workload Type object returned for Clusters; it is one nested object per containing Workload Type object when present.
Developer identifier: `clusters.workload_type.clients.jobs`
Jobs records whether job workloads are enabled. It is needed to distinguish Clusters rows by the exact Databricks-returned jobs value.
* **Enables:** select Clusters rows where `jobs` is true or false when comparing the condition described by Jobs.
* **Interpretation:** Databricks reports this value on the Workload Type Clients object returned for Clusters; it is interpreted at one Workload Type Clients record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `clusters.workload_type.clients.notebooks`
Notebooks records whether notebook workloads are enabled. It is needed to distinguish Clusters rows by the exact Databricks-returned notebooks value.
* **Enables:** select Clusters rows where `notebooks` is true or false when comparing the condition described by Notebooks.
* **Interpretation:** Databricks reports this value on the Workload Type Clients object returned for Clusters; it is interpreted at one Workload Type Clients record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `groups`
Groups covers groups in the Databricks workspace via the SCIM v2 API. Provides group membership and role information.
* **Enables:** map the Databricks accounts and memberships represented by Groups records and trace a returned access assignment to its account or group.
* **Scope:** Lists all groups in the Databricks workspace via the SCIM v2 API. Provides group membership and role information; the connector reads `/api/{apiVersion}/preview/scim/v2/Groups` as a snapshot stream in full mode. The configured credential must grant the declared `all-apis` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the Databricks record was deleted.
Developer identifier: `groups.displayName`
Display Name records display name of the group. It is needed to compare the returned display name for individual Groups rows and select rows with a specific `displayName` value.
* **Enables:** locate Groups rows whose returned display name exactly matches `displayName` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Databricks Group object returned for Groups; it is interpreted at one Databricks Group record per row.
Developer identifier: `groups.entitlements`
Entitlements records array of entitlements assigned to the group, such as workspace-level permissions. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `entitlements` to examine the returned entitlements details for the containing Databricks Group record.
* **Interpretation:** Databricks reports this value on the Databricks Group object returned for Groups; it is one returned collection per containing Databricks Group object; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `groups.entitlements.value`
Value records the entitlement value, e.g., 'allow-cluster-create', 'allow-instance-pool-create', 'databricks-sql-access', 'workspace-access'. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `value` access value with the resource, account, or membership represented by the same Groups row.
* **Interpretation:** Databricks reports this value on the Group Entitlement object returned for Groups; it is interpreted at one Group Entitlement record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `groups.externalId`
External ID records external ID from the identity provider (e.g., Azure AD, Okta). It is needed to refer to the same external across records without relying on display text.
* **Enables:** match `externalId` to external references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Group object returned for Groups; it is an identifier, not a measured quantity.
Developer identifier: `groups.groups`
Groups records parent groups that this group belongs to (nested group membership). It is needed to preserve the nested groups relationship or details on the parent Databricks Group record.
* **Enables:** expand `groups` to connect the containing Databricks Group row to its returned groups entries.
* **Interpretation:** Databricks reports this value on the Databricks Group object returned for Groups; it is one returned collection per containing Databricks Group object.
Developer identifier: `groups.groups.$ref`
Resource Reference records URI reference to the parent group resource. It is needed to refer to the same `the` across records without relying on display text.
* **Enables:** match `$ref` to `the` references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Group Reference object returned for Groups; it is an identifier, not a measured quantity.
Developer identifier: `groups.groups.display`
Display records the display name of the parent group. It is needed to compare the returned display for individual Groups rows and select rows with a specific `display` value.
* **Enables:** locate Groups rows whose returned display exactly matches `display` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Group Reference object returned for Groups; it is interpreted at one Group Reference record per row.
Developer identifier: `groups.groups.type`
Type records the type of the reference, typically 'direct' or 'indirect'. It is needed to distinguish Groups rows by the exact Databricks-returned type value.
* **Enables:** separate Groups rows by the exact Databricks-returned `type` label when comparing type.
* **Interpretation:** Databricks reports this value on the Group Reference object returned for Groups; it is interpreted at one Group Reference record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `groups.groups.value`
Value records the SCIM ID of the parent group. It is needed to compare the returned value for individual Groups rows and select rows with a specific `value` value.
* **Enables:** trace the value relationship returned in `value` from the Group Reference row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Group Reference object returned for Groups; it is interpreted at one Group Reference record per row.
Developer identifier: `groups.id`
ID records unique SCIM identifier for the group. It is needed to distinguish repeated deliveries of the same Groups row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Groups and match repeated rows carrying the same Databricks identifier.
* **Interpretation:** Databricks reports this value on the Databricks Group object returned for Groups; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `groups.members`
Members records array of group members. Each entry references a user or service principal by SCIM ID. It is needed to preserve the nested members relationship or details on the parent Databricks Group record.
* **Enables:** expand `members` to connect the containing Databricks Group row to its returned members entries.
* **Interpretation:** Databricks reports this value on the Databricks Group object returned for Groups; it is one returned collection per containing Databricks Group object.
Developer identifier: `groups.members.$ref`
Resource Reference records the URI reference to the group member resource (for example, `Users/` or `Groups/`). It is needed to identify the exact Databricks user or group represented by each membership.
* **Enables:** use `$ref` to correlate the membership with the matching Users or Groups record.
* **Interpretation:** Databricks reports this SCIM resource reference on the Group Member object returned for Groups; it is a relative resource identifier, not a measured quantity.
Developer identifier: `groups.members.display`
Display records the display name of the member. It is needed to attribute this Groups row to the returned person, account, or organization reference.
* **Enables:** attribute the Groups row to the returned person or account and match the exact `display` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Group Member object returned for Groups; it is interpreted at one Group Member record per row.
Developer identifier: `groups.members.type`
Type records the type of the member resource. It is needed to distinguish Groups rows by the exact Databricks-returned type value.
* **Enables:** separate Groups rows by the exact Databricks-returned `type` label when comparing type.
* **Interpretation:** Databricks reports this value on the Group Member object returned for Groups; it is interpreted at one Group Member record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `groups.members.value`
Value records the SCIM ID of the member (user, service principal, or group). It is needed to attribute this Groups row to the returned person, account, or organization reference.
* **Enables:** attribute the Groups row to the returned person or account and match the exact `value` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Group Member object returned for Groups; it is interpreted at one Group Member record per row.
Developer identifier: `groups.meta`
Meta records SCIM metadata for the group resource, including resource type and timestamps. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `meta` and associate them with the containing Groups record.
* **Interpretation:** Databricks reports this value on the Databricks Group object returned for Groups; it is one nested object per containing Databricks Group object when present; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `groups.meta.created`
Created records ISO 8601 timestamp when the resource was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Groups records by `created`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Scim Meta object returned for Groups; it is interpreted at one Scim Meta record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `groups.meta.lastModified`
Last Modified records ISO 8601 timestamp when the resource was last modified. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Groups records by `lastModified`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Scim Meta object returned for Groups; it is interpreted at one Scim Meta record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `groups.meta.location`
Location records URI location of the resource. It is needed to preserve the Databricks-reported resource location link for the same record.
* **Enables:** correlate the Databricks resource link in `location` with its containing Scim Meta row without treating the resource path as a statement of data residency.
* **Interpretation:** Databricks reports this value on the Scim Meta object returned for Groups; it is interpreted at one Scim Meta record per row; the schema uses the `Network.Url` scalar; the value is resource location link; this Databricks-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `groups.meta.resourceType`
Resource Type records the SCIM resource type (e.g., User, Group). It is needed to distinguish Groups rows by the exact Databricks-returned resource type value.
* **Enables:** separate Groups rows by the exact Databricks-returned `resourceType` label when comparing resource type.
* **Interpretation:** Databricks reports this value on the Scim Meta object returned for Groups; it is interpreted at one Scim Meta record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `groups.meta.version`
Version records version identifier (ETag) of the resource. It is needed to refer to the same version across records without relying on display text.
* **Enables:** match `version` to version references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Scim Meta object returned for Groups; it is an identifier, not a measured quantity.
Developer identifier: `groups.roles`
Roles records array of roles assigned to the group. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `roles` to examine the returned roles details for the containing Databricks Group record.
* **Interpretation:** Databricks reports this value on the Databricks Group object returned for Groups; it is one returned collection per containing Databricks Group object; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `groups.roles.type`
Type records the type of the role assignment. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Groups rows with the exact `type` access-related value being investigated.
* **Interpretation:** Databricks reports this value on the Group Role object returned for Groups; it is interpreted at one Group Role record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `groups.roles.value`
Value records the role value string, e.g., an instance profile ARN or role identifier. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `value` access value with the resource, account, or membership represented by the same Groups row.
* **Interpretation:** Databricks reports this value on the Group Role object returned for Groups; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `groups.schemas`
Schemas records SCIM schema URNs that apply to this resource. It is needed to preserve the nested schemas relationship or details on the parent Databricks Group record.
* **Enables:** expand `schemas` to connect the containing Databricks Group row to its returned schemas entries.
* **Interpretation:** Databricks reports this value on the Databricks Group object returned for Groups; it is one returned collection per containing Databricks Group object.
Developer identifier: `job_runs`
Job Runs covers job runs in the Databricks workspace. Provides run execution details including status, duration, and task results. Paginated via `next_page_token`.
* **Enables:** trace each returned job run through its job, trigger, tasks, lifecycle result, start time, and duration.
* **Scope:** Lists job runs in the Databricks workspace. Provides run execution details including status, duration, and task results. Paginated via `next_page_token`; the connector reads `/api/2.1/jobs/runs/list` as a snapshot stream in full mode. The configured credential must grant the declared `all-apis` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the Databricks record was deleted.
Developer identifier: `job_runs._parent_job_id`
Parent Job ID records parent key injected by the ingestor from the jobs to `job_runs` traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to refer to the same parent job across records without relying on display text.
* **Enables:** match `_parent_job_id` to parent job references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks's child response does not supply this field; the connector injects parent context into each child row; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.attempt_number`
Attempt Number records attempt number of the run, starting from 0. It is needed to measure the Databricks-reported number of attempt number at one Job Run record per row.
* **Enables:** measure and compare the Databricks-reported number of attempt number in `attempt_number` at one Job Run record per row.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is a Databricks-reported count at one Job Run record per row.
Developer identifier: `job_runs.cleanup_duration`
Cleanup Duration records duration of cleanup phase in milliseconds. It is needed to measure the exact duration reported for one Job Run record using the Databricks duration encoding described by the field.
* **Enables:** measure and compare `cleanup_duration` per Job Run record in milliseconds.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; its unit or granularity is milliseconds.
Developer identifier: `job_runs.cluster_instance`
Cluster Instance records the cluster instance details attached to this Job Runs record. It is needed to preserve the nested cluster instance relationship or details on the parent Job Run record.
* **Enables:** expand `cluster_instance` to connect the containing Job Run row to its returned cluster instance entries.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is one nested object per containing Job Run object when present.
Developer identifier: `job_runs.cluster_instance.cluster_id`
Cluster ID records ID of the cluster. It is needed to refer to the same cluster across records without relying on display text.
* **Enables:** match `cluster_id` to cluster references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Cluster Instance object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.cluster_instance.spark_context_id`
Spark Context ID records ID of the Spark context. It is needed to refer to the same spark context across records without relying on display text.
* **Enables:** match `spark_context_id` to spark context references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Cluster Instance object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.cluster_spec`
Cluster Spec records the cluster spec details attached to this Job Runs record. It is needed to preserve the nested cluster spec relationship or details on the parent Job Run record.
* **Enables:** expand `cluster_spec` to connect the containing Job Run row to its returned cluster spec entries.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is one nested object per containing Job Run object when present.
Developer identifier: `job_runs.cluster_spec.existing_cluster_id`
Existing Cluster ID records ID of an existing cluster. It is needed to refer to the same existing cluster across records without relying on display text.
* **Enables:** match `existing_cluster_id` to existing cluster references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Cluster Spec object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.cluster_spec.libraries`
Libraries records libraries to install. It is needed to preserve the nested libraries relationship or details on the parent Cluster Spec record.
* **Enables:** expand `libraries` to connect the containing Cluster Spec row to its returned libraries entries.
* **Interpretation:** Databricks reports this value on the Cluster Spec object returned for Job Runs; it is one returned collection per containing Cluster Spec object.
Developer identifier: `job_runs.cluster_spec.libraries.cran`
Cran records the cran details attached to this Job Runs record. It is needed to preserve the nested cran relationship or details on the parent Library record.
* **Enables:** expand `cran` to connect the containing Library row to its returned cran entries.
* **Interpretation:** Databricks reports this value on the Library object returned for Job Runs; it is one nested object per containing Library object when present.
Developer identifier: `job_runs.cluster_spec.libraries.cran.package`
Package records CRAN package name. It is needed to reproduce the exact package or entry-point configuration used by this job task.
* **Enables:** combine `package` with the sibling library type and repository fields to resolve the configured dependency or executable entry point.
* **Interpretation:** Databricks reports this value on the Cran Library object returned for Job Runs; it is interpreted at one Cran Library record per row; the value names Databricks job configuration and does not prove that the dependency is still available.
Developer identifier: `job_runs.cluster_spec.libraries.cran.repo`
Repo records custom CRAN repository URL. It is needed to reproduce the returned code or dependency configuration for this Job Runs record.
* **Enables:** use `repo` to locate the configured source, package, or repository when reproducing the same job or repository setup.
* **Interpretation:** Databricks reports this value on the Cran Library object returned for Job Runs; it is interpreted at one Cran Library record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `job_runs.cluster_spec.libraries.egg`
Egg records URI of the egg. It is needed to reproduce the returned code or dependency configuration for this Job Runs record.
* **Enables:** use `egg` to locate the configured source, package, or repository when reproducing the same job or repository setup.
* **Interpretation:** Databricks reports this value on the Library object returned for Job Runs; it is interpreted at one Library record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `job_runs.cluster_spec.libraries.jar`
Jar records URI of the JAR. It is needed to reproduce the returned code or dependency configuration for this Job Runs record.
* **Enables:** use `jar` to locate the configured source, package, or repository when reproducing the same job or repository setup.
* **Interpretation:** Databricks reports this value on the Library object returned for Job Runs; it is interpreted at one Library record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `job_runs.cluster_spec.libraries.maven`
Maven records the maven details attached to this Job Runs record. It is needed to preserve the nested maven relationship or details on the parent Library record.
* **Enables:** expand `maven` to connect the containing Library row to its returned maven entries.
* **Interpretation:** Databricks reports this value on the Library object returned for Job Runs; it is one nested object per containing Library object when present.
Developer identifier: `job_runs.cluster_spec.libraries.maven.coordinates`
Coordinates records maven coordinates. It is needed to reproduce the exact package or entry-point configuration used by this job task.
* **Enables:** combine `coordinates` with the sibling library type and repository fields to resolve the configured dependency or executable entry point.
* **Interpretation:** Databricks reports this value on the Maven Library object returned for Job Runs; its unit or granularity is provider-reported geographic coordinates; the value names Databricks job configuration and does not prove that the dependency is still available.
Developer identifier: `job_runs.cluster_spec.libraries.maven.exclusions`
Exclusions records maven dependency exclusions. It is needed to preserve the nested exclusions relationship or details on the parent Maven Library record.
* **Enables:** expand `exclusions` to connect the containing Maven Library row to its returned exclusions entries.
* **Interpretation:** Databricks reports this value on the Maven Library object returned for Job Runs; it is one returned collection per containing Maven Library object.
Developer identifier: `job_runs.cluster_spec.libraries.maven.repo`
Repo records custom Maven repository URL. It is needed to reproduce the returned code or dependency configuration for this Job Runs record.
* **Enables:** use `repo` to locate the configured source, package, or repository when reproducing the same job or repository setup.
* **Interpretation:** Databricks reports this value on the Maven Library object returned for Job Runs; it is interpreted at one Maven Library record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `job_runs.cluster_spec.libraries.pypi`
Pypi records the pypi details attached to this Job Runs record. It is needed to preserve the nested pypi relationship or details on the parent Library record.
* **Enables:** expand `pypi` to connect the containing Library row to its returned pypi entries.
* **Interpretation:** Databricks reports this value on the Library object returned for Job Runs; it is one nested object per containing Library object when present.
Developer identifier: `job_runs.cluster_spec.libraries.pypi.package`
Package records pyPI package name. It is needed to reproduce the exact package or entry-point configuration used by this job task.
* **Enables:** combine `package` with the sibling library type and repository fields to resolve the configured dependency or executable entry point.
* **Interpretation:** Databricks reports this value on the Python Py Pi Library object returned for Job Runs; it is interpreted at one Python Py Pi Library record per row; the value names Databricks job configuration and does not prove that the dependency is still available.
Developer identifier: `job_runs.cluster_spec.libraries.pypi.repo`
Repo records custom PyPI repository URL. It is needed to reproduce the returned code or dependency configuration for this Job Runs record.
* **Enables:** use `repo` to locate the configured source, package, or repository when reproducing the same job or repository setup.
* **Interpretation:** Databricks reports this value on the Python Py Pi Library object returned for Job Runs; it is interpreted at one Python Py Pi Library record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `job_runs.cluster_spec.libraries.whl`
Whl records URI of the wheel. It is needed to reproduce the returned code or dependency configuration for this Job Runs record.
* **Enables:** use `whl` to locate the configured source, package, or repository when reproducing the same job or repository setup.
* **Interpretation:** Databricks reports this value on the Library object returned for Job Runs; it is interpreted at one Library record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `job_runs.cluster_spec.new_cluster`
New Cluster records the new cluster details attached to this Job Runs record. It is needed to preserve the nested new cluster relationship or details on the parent Cluster Spec record.
* **Enables:** expand `new_cluster` to connect the containing Cluster Spec row to its returned new cluster entries.
* **Interpretation:** Databricks reports this value on the Cluster Spec object returned for Job Runs; it is one nested object per containing Cluster Spec object when present.
Developer identifier: `job_runs.cluster_spec.new_cluster.autoscale`
Autoscale records the autoscale details attached to this Job Runs record. It is needed to preserve the nested autoscale relationship or details on the parent New Cluster record.
* **Enables:** expand `autoscale` to connect the containing New Cluster row to its returned autoscale entries.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is one nested object per containing New Cluster object when present.
Developer identifier: `job_runs.cluster_spec.new_cluster.autoscale.max_workers`
Max Workers records maximum number of workers. It is needed to measure the Databricks-reported number of max workers at one Auto Scale record per row.
* **Enables:** measure and compare the Databricks-reported number of max workers in `max_workers` at one Auto Scale record per row.
* **Interpretation:** Databricks reports this value on the Auto Scale object returned for Job Runs; it is a Databricks-reported count at one Auto Scale record per row.
Developer identifier: `job_runs.cluster_spec.new_cluster.autoscale.min_workers`
Min Workers records minimum number of workers. It is needed to measure the Databricks-reported number of min workers at one Auto Scale record per row.
* **Enables:** measure and compare the Databricks-reported number of min workers in `min_workers` at one Auto Scale record per row.
* **Interpretation:** Databricks reports this value on the Auto Scale object returned for Job Runs; it is a Databricks-reported count at one Auto Scale record per row.
Developer identifier: `job_runs.cluster_spec.new_cluster.aws_attributes`
AWS Attributes records AWS-specific attributes. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `aws_attributes` and associate them with the containing Job Runs record.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is interpreted at one New Cluster record per row; the schema uses the `Generic.JSON` scalar; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `job_runs.cluster_spec.new_cluster.azure_attributes`
Azure Attributes records azure-specific attributes. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `azure_attributes` and associate them with the containing Job Runs record.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is interpreted at one New Cluster record per row; the schema uses the `Generic.JSON` scalar; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `job_runs.cluster_spec.new_cluster.cluster_log_conf`
Cluster Log Conf records cluster log delivery configuration. It is needed to compare the exact cluster log conf configuration returned for this New Cluster record.
* **Enables:** compare the exact `cluster_log_conf` configuration returned for each New Cluster record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is interpreted at one New Cluster record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `job_runs.cluster_spec.new_cluster.custom_tags`
Custom Tags records custom tags. It is needed to distinguish Job Runs rows by the exact Databricks-returned custom tags value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `custom_tags` label when comparing custom tags.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is interpreted at one New Cluster record per row; the schema uses the `Generic.JSON` scalar; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.cluster_spec.new_cluster.data_security_mode`
Data Security Mode records data security mode. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Job Runs rows with the exact `data_security_mode` access-related value being investigated.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is interpreted at one New Cluster record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.cluster_spec.new_cluster.driver_instance_pool_id`
Driver Instance Pool ID records driver instance pool ID. It is needed to refer to the same driver instance pool across records without relying on display text.
* **Enables:** match `driver_instance_pool_id` to driver instance pool references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.cluster_spec.new_cluster.driver_node_type_id`
Driver Node Type ID records driver node type ID. It is needed to refer to the same driver node type across records without relying on display text.
* **Enables:** match `driver_node_type_id` to driver node type references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is an identifier, not a measured quantity; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.cluster_spec.new_cluster.enable_elastic_disk`
Enable Elastic Disk records whether elastic disk is enabled. It is needed to distinguish Job Runs rows by the exact Databricks-returned enable elastic disk value.
* **Enables:** select Job Runs rows where `enable_elastic_disk` is true or false when comparing the condition described by Enable Elastic Disk.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is interpreted at one New Cluster record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.cluster_spec.new_cluster.gcp_attributes`
GCP Attributes records GCP-specific attributes. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `gcp_attributes` and associate them with the containing Job Runs record.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is interpreted at one New Cluster record per row; the schema uses the `Generic.JSON` scalar; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `job_runs.cluster_spec.new_cluster.init_scripts`
Init Scripts records init scripts. It is needed to preserve the nested init scripts relationship or details on the parent New Cluster record.
* **Enables:** expand `init_scripts` to connect the containing New Cluster row to its returned init scripts entries.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is one returned collection per containing New Cluster object.
Developer identifier: `job_runs.cluster_spec.new_cluster.instance_pool_id`
Instance Pool ID records instance pool ID. It is needed to refer to the same instance pool across records without relying on display text.
* **Enables:** match `instance_pool_id` to instance pool references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.cluster_spec.new_cluster.node_type_id`
Node Type ID records node type ID. It is needed to refer to the same node type across records without relying on display text.
* **Enables:** match `node_type_id` to node type references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is an identifier, not a measured quantity; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.cluster_spec.new_cluster.num_workers`
Num Workers records number of worker nodes. It is needed to measure the Databricks-reported number of worker nodes at one New Cluster record per row.
* **Enables:** measure and compare the Databricks-reported number of worker nodes in `num_workers` at one New Cluster record per row.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is a Databricks-reported count at one New Cluster record per row.
Developer identifier: `job_runs.cluster_spec.new_cluster.policy_id`
Policy ID records cluster policy ID. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `policy_id` access value with the resource, account, or membership represented by the same Job Runs row.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `job_runs.cluster_spec.new_cluster.runtime_engine`
Runtime Engine records runtime engine (STANDARD or PHOTON). It is needed to compare the exact runtime engine configuration returned for this New Cluster record.
* **Enables:** compare the exact `runtime_engine` configuration returned for each New Cluster record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is interpreted at one New Cluster record per row.
Developer identifier: `job_runs.cluster_spec.new_cluster.spark_conf`
Spark Conf records spark configuration key-value pairs. It is needed to compare the exact spark conf configuration returned for this New Cluster record.
* **Enables:** compare the exact `spark_conf` configuration returned for each New Cluster record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is interpreted at one New Cluster record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `job_runs.cluster_spec.new_cluster.spark_env_vars`
Spark Env Vars records spark environment variables. It is needed to preserve the exact Databricks configuration or execution metadata attached to this New Cluster record.
* **Enables:** inspect the keys in `spark_env_vars` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is interpreted at one New Cluster record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Databricks response and can vary by resource type or configuration.
Developer identifier: `job_runs.cluster_spec.new_cluster.spark_version`
Spark Version records Databricks Runtime version. It is needed to compare the exact spark version configuration returned for this New Cluster record.
* **Enables:** compare the exact `spark_version` configuration returned for each New Cluster record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the New Cluster object returned for Job Runs; it is interpreted at one New Cluster record per row.
Developer identifier: `job_runs.creator_user_name`
Creator User Name records user who created or triggered the run. It is needed to attribute this Job Runs row to the returned person, account, or organization reference.
* **Enables:** attribute the Job Runs row to the returned person or account and match the exact `creator_user_name` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is interpreted at one Job Run record per row.
Developer identifier: `job_runs.description`
Description records description of the run or job. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is description text at one Job Run record per row; this is only the content included in the Databricks response for this record.
Developer identifier: `job_runs.end_time`
End Time records timestamp in epoch ms when the run ended. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Job Runs records by `end_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `job_runs.execution_duration`
Execution Duration records duration of execution phase in milliseconds. It is needed to measure the exact duration reported for one Job Run record using the Databricks duration encoding described by the field.
* **Enables:** measure and compare `execution_duration` per Job Run record in milliseconds.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; its unit or granularity is milliseconds.
Developer identifier: `job_runs.format`
Format records the format supplied for this Job Runs record by Databricks. It is needed to distinguish Job Runs rows by the exact Databricks-returned format value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `format` label when comparing format.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is interpreted at one Job Run record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.git_source`
Git Source records the git source details attached to this Job Runs record. It is needed to preserve the nested git source relationship or details on the parent Job Run record.
* **Enables:** expand `git_source` to connect the containing Job Run row to its returned git source entries.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is one nested object per containing Job Run object when present.
Developer identifier: `job_runs.git_source.git_branch`
Git Branch records git branch name. It is needed to link the row to the exact Databricks branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `git_branch` to the returned branch, tag, commit SHA, or work-item reference on related Databricks records.
* **Interpretation:** Databricks reports this value on the Git Source object returned for Job Runs; it is interpreted at one Git Source record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `job_runs.git_source.git_commit`
Git Commit records git commit hash. It is needed to link the row to the exact Databricks branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `git_commit` to the returned branch, tag, commit SHA, or work-item reference on related Databricks records.
* **Interpretation:** Databricks reports this value on the Git Source object returned for Job Runs; it is interpreted at one Git Source record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `job_runs.git_source.git_provider`
Git Provider records git provider name. It is needed to inventory the exact Databricks-reported configuration or classification represented by this field.
* **Enables:** compare `git_provider` among Job Runs records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Databricks reports this value on the Git Source object returned for Job Runs; it is interpreted at one Git Source record per row; the value is a Databricks-returned or configured label at the Git Source grain rather than a universal taxonomy.
Developer identifier: `job_runs.git_source.git_snapshot`
Git Snapshot records the git snapshot details attached to this Job Runs record. It is needed to preserve the nested git snapshot relationship or details on the parent Git Source record.
* **Enables:** expand `git_snapshot` to connect the containing Git Source row to its returned git snapshot entries.
* **Interpretation:** Databricks reports this value on the Git Source object returned for Job Runs; it is one nested object per containing Git Source object when present.
Developer identifier: `job_runs.git_source.git_snapshot.used_commit`
Used Commit records the commit hash actually used for the run. It is needed to link the row to the exact Databricks branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `used_commit` to the returned branch, tag, commit SHA, or work-item reference on related Databricks records.
* **Interpretation:** Databricks reports this value on the Git Snapshot object returned for Job Runs; it is interpreted at one Git Snapshot record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `job_runs.git_source.git_tag`
Git Tag records git tag. It is needed to link the row to the exact Databricks branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `git_tag` to the returned branch, tag, commit SHA, or work-item reference on related Databricks records.
* **Interpretation:** Databricks reports this value on the Git Source object returned for Job Runs; it is interpreted at one Git Source record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `job_runs.git_source.git_url`
Git URL records URL of the Git repository. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Databricks resource referenced by `git_url` while retaining the containing Job Runs record as provenance.
* **Interpretation:** Databricks reports this value on the Git Source object returned for Job Runs; it is link at one Git Source record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `job_runs.job_clusters`
Job Clusters records job-level cluster specifications shared across tasks. It is needed to preserve the nested job clusters relationship or details on the parent Job Run record.
* **Enables:** expand `job_clusters` to connect the containing Job Run row to its returned job clusters entries.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is one returned collection per containing Job Run object.
Developer identifier: `job_runs.job_clusters.job_cluster_key`
Job Cluster Key records unique key for this job cluster. It is needed to refer to the same job cluster across records without relying on display text.
* **Enables:** match `job_cluster_key` to job cluster references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Job Cluster object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.job_clusters.new_cluster`
New Cluster records the new cluster details attached to this Job Runs record. It is needed to preserve the nested new cluster relationship or details on the parent Job Cluster record.
* **Enables:** expand `new_cluster` to connect the containing Job Cluster row to its returned new cluster entries.
* **Interpretation:** Databricks reports this value on the Job Cluster object returned for Job Runs; it is one nested object per containing Job Cluster object when present.
Developer identifier: `job_runs.job_id`
Job ID records ID of the job this run belongs to. It is needed to refer to the same job across records without relying on display text.
* **Enables:** match `job_id` to job references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.job_parameters`
Job Parameters records job-level parameters. It is needed to preserve the nested job parameters relationship or details on the parent Job Run record.
* **Enables:** expand `job_parameters` to connect the containing Job Run row to its returned job parameters entries.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is one returned collection per containing Job Run object.
Developer identifier: `job_runs.job_parameters.default`
Default records default value of the parameter. It is needed to distinguish Job Runs rows by the exact Databricks-returned default value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `default` label when comparing default.
* **Interpretation:** Databricks reports this value on the Job Parameter object returned for Job Runs; it is interpreted at one Job Parameter record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.job_parameters.name`
Name records name of the parameter. It is needed to compare the returned name for individual Job Runs rows and select rows with a specific `name` value.
* **Enables:** locate Job Runs rows whose returned name exactly matches `name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Job Parameter object returned for Job Runs; it is interpreted at one Job Parameter record per row.
Developer identifier: `job_runs.job_parameters.value`
Value records value of the parameter for this run. It is needed to preserve the exact Databricks configuration or execution metadata attached to this Job Parameter record.
* **Enables:** inspect the keys in `value` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Databricks reports this value on the Job Parameter object returned for Job Runs; it is interpreted at one Job Parameter record per row; metadata keys and availability follow the Databricks response and can vary by resource type or configuration.
Developer identifier: `job_runs.number_in_job`
Number In Job records sequence number of this run within the job. It is needed to measure the Databricks-reported number of number in job at one Job Run record per row.
* **Enables:** measure and compare the Databricks-reported number of number in job in `number_in_job` at one Job Run record per row.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is a Databricks-reported count at one Job Run record per row.
Developer identifier: `job_runs.original_attempt_run_id`
Original Attempt Run ID records the `run_id` of the original attempt if this is a retry. It is needed to refer to the same original attempt run across records without relying on display text.
* **Enables:** match `original_attempt_run_id` to original attempt run references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.overriding_parameters`
Overriding Parameters records the overriding parameters details attached to this Job Runs record. It is needed to preserve the nested overriding parameters relationship or details on the parent Job Run record.
* **Enables:** expand `overriding_parameters` to connect the containing Job Run row to its returned overriding parameters entries.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is one nested object per containing Job Run object when present.
Developer identifier: `job_runs.overriding_parameters.dbt_commands`
Dbt Commands records dbt commands. It is needed to preserve the nested dbt commands relationship or details on the parent Run Parameters record.
* **Enables:** expand `dbt_commands` to connect the containing Run Parameters row to its returned dbt commands entries.
* **Interpretation:** Databricks reports this value on the Run Parameters object returned for Job Runs; it is one returned collection per containing Run Parameters object.
Developer identifier: `job_runs.overriding_parameters.jar_params`
Jar Params records JAR parameters. It is needed to preserve the nested jar params relationship or details on the parent Run Parameters record.
* **Enables:** expand `jar_params` to connect the containing Run Parameters row to its returned jar params entries.
* **Interpretation:** Databricks reports this value on the Run Parameters object returned for Job Runs; it is one returned collection per containing Run Parameters object.
Developer identifier: `job_runs.overriding_parameters.job_parameters`
Job Parameters records job-level parameters. It is needed to preserve the exact Databricks configuration or execution metadata attached to this Run Parameters record.
* **Enables:** inspect the keys in `job_parameters` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Databricks reports this value on the Run Parameters object returned for Job Runs; it is interpreted at one Run Parameters record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Databricks response and can vary by resource type or configuration.
Developer identifier: `job_runs.overriding_parameters.notebook_params`
Notebook Params records notebook parameters. It is needed to preserve the exact Databricks configuration or execution metadata attached to this Run Parameters record.
* **Enables:** inspect the keys in `notebook_params` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Databricks reports this value on the Run Parameters object returned for Job Runs; it is interpreted at one Run Parameters record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Databricks response and can vary by resource type or configuration.
Developer identifier: `job_runs.overriding_parameters.pipeline_params`
Pipeline Params records pipeline parameters. It is needed to preserve the exact Databricks configuration or execution metadata attached to this Run Parameters record.
* **Enables:** inspect the keys in `pipeline_params` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Databricks reports this value on the Run Parameters object returned for Job Runs; it is interpreted at one Run Parameters record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Databricks response and can vary by resource type or configuration.
Developer identifier: `job_runs.overriding_parameters.python_named_params`
Python Named Params records named Python parameters. It is needed to compare the returned python named params for individual Job Runs rows and select rows with a specific `python_named_params` value.
* **Enables:** locate Job Runs rows whose returned python named params exactly matches `python_named_params` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Run Parameters object returned for Job Runs; it is interpreted at one Run Parameters record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `job_runs.overriding_parameters.python_params`
Python Params records python parameters. It is needed to preserve the nested python params relationship or details on the parent Run Parameters record.
* **Enables:** expand `python_params` to connect the containing Run Parameters row to its returned python params entries.
* **Interpretation:** Databricks reports this value on the Run Parameters object returned for Job Runs; it is one returned collection per containing Run Parameters object.
Developer identifier: `job_runs.overriding_parameters.spark_submit_params`
Spark Submit Params records spark submit parameters. It is needed to preserve the nested spark submit params relationship or details on the parent Run Parameters record.
* **Enables:** expand `spark_submit_params` to connect the containing Run Parameters row to its returned spark submit params entries.
* **Interpretation:** Databricks reports this value on the Run Parameters object returned for Job Runs; it is one returned collection per containing Run Parameters object.
Developer identifier: `job_runs.overriding_parameters.sql_params`
SQL Params records SQL parameters. It is needed to preserve the exact Databricks configuration or execution metadata attached to this Run Parameters record.
* **Enables:** inspect the keys in `sql_params` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Databricks reports this value on the Run Parameters object returned for Job Runs; it is interpreted at one Run Parameters record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Databricks response and can vary by resource type or configuration.
Developer identifier: `job_runs.queue_duration`
Queue Duration records time in ms the run spent in the queue. It is needed to measure the exact duration reported for one Job Run record using the Databricks duration encoding described by the field.
* **Enables:** measure and compare `queue_duration` per Job Run record in milliseconds.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; its unit or granularity is milliseconds.
Developer identifier: `job_runs.repair_history`
Repair History records history of repair attempts. It is needed to preserve the nested repair history relationship or details on the parent Job Run record.
* **Enables:** expand `repair_history` to connect the containing Job Run row to its returned repair history entries.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is one returned collection per containing Job Run object.
Developer identifier: `job_runs.repair_history.end_time`
End Time records timestamp in epoch ms when the repair ended. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Job Runs records by `end_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Repair History Item object returned for Job Runs; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `job_runs.repair_history.id`
ID records ID of the repair attempt. It is needed to refer to the same repair history item across records without relying on display text.
* **Enables:** match `id` to repair history item references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Repair History Item object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.repair_history.start_time`
Start Time records timestamp in epoch ms when the repair started. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Job Runs records by `start_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Repair History Item object returned for Job Runs; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `job_runs.repair_history.state`
State records the state details attached to this Job Runs record. It is needed to preserve the nested state relationship or details on the parent Repair History Item record.
* **Enables:** expand `state` to connect the containing Repair History Item row to its returned state entries.
* **Interpretation:** Databricks reports this value on the Repair History Item object returned for Job Runs; it is one nested object per containing Repair History Item object when present.
Developer identifier: `job_runs.repair_history.state.life_cycle_state`
Life Cycle State records the life cycle state supplied for this Job Runs record by Databricks. It is needed to distinguish Job Runs rows by the exact Databricks-returned life cycle state value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `life_cycle_state` label when comparing life cycle state.
* **Interpretation:** Databricks reports this value on the Run State object returned for Job Runs; it is interpreted at one Run State record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.repair_history.state.queue_reason`
Queue Reason records reason the run is queued. It is needed to distinguish Job Runs rows by the exact Databricks-returned queue reason value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `queue_reason` label when comparing queue reason.
* **Interpretation:** Databricks reports this value on the Run State object returned for Job Runs; it is interpreted at one Run State record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.repair_history.state.result_state`
Result State records the result state supplied for this Job Runs record by Databricks. It is needed to distinguish Job Runs rows by the exact Databricks-returned result state value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `result_state` label when comparing result state.
* **Interpretation:** Databricks reports this value on the Run State object returned for Job Runs; it is interpreted at one Run State record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.repair_history.state.state_message`
State Message records descriptive message for the current state. It is needed to inspect the exact message text included with this record.
* **Enables:** inspect the message text returned in `state_message` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Run State object returned for Job Runs; it is message text at one Run State record per row; this is only the content included in the Databricks response for this record; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.repair_history.state.user_cancelled_or_timedout`
User Cancelled Or Timedout records whether the run was cancelled by the user or timed out. It is needed to distinguish Job Runs rows by the exact Databricks-returned user cancelled or timedout value.
* **Enables:** select Job Runs rows where `user_cancelled_or_timedout` is true or false when comparing the condition described by User Cancelled Or Timedout.
* **Interpretation:** Databricks reports this value on the Run State object returned for Job Runs; it is interpreted at one Run State record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.repair_history.task_run_ids`
Task Run IDs records task run IDs included in this repair. It is needed to preserve the nested task run i ds relationship or details on the parent Repair History Item record.
* **Enables:** expand `task_run_ids` to connect the containing Repair History Item row to its returned task run i ds entries.
* **Interpretation:** Databricks reports this value on the Repair History Item object returned for Job Runs; it is one returned collection per containing Repair History Item object.
Developer identifier: `job_runs.repair_history.type`
Type records type of repair (ORIGINAL or REPAIR). It is needed to distinguish Job Runs rows by the exact Databricks-returned type value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `type` label when comparing type.
* **Interpretation:** Databricks reports this value on the Repair History Item object returned for Job Runs; it is interpreted at one Repair History Item record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.run_duration`
Run Duration records total duration of the run in milliseconds. It is needed to measure the exact duration reported for one Job Run record using the Databricks duration encoding described by the field.
* **Enables:** measure and compare `run_duration` per Job Run record in milliseconds.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; its unit or granularity is milliseconds.
Developer identifier: `job_runs.run_id`
Run ID records unique identifier for the run. It is needed to distinguish repeated deliveries of the same Job Runs row using the declared ingestion key.
* **Enables:** use `run_id` as the declared ingestion deduplication key for Job Runs and match repeated rows carrying the same Databricks identifier.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `job_runs.run_name`
Run Name records human-readable name of the run. It is needed to compare the returned run name for individual Job Runs rows and select rows with a specific `run_name` value.
* **Enables:** locate Job Runs rows whose returned run name exactly matches `run_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is interpreted at one Job Run record per row.
Developer identifier: `job_runs.run_page_url`
Run Page URL records URL to the run details page in the workspace. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Databricks resource referenced by `run_page_url` while retaining the containing Job Runs record as provenance.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is link at one Job Run record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `job_runs.run_type`
Run Type records the run type supplied for this Job Runs record by Databricks. It is needed to distinguish Job Runs rows by the exact Databricks-returned run type value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `run_type` label when comparing run type.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is interpreted at one Job Run record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.schedule`
Schedule records the schedule details attached to this Job Runs record. It is needed to preserve the nested schedule relationship or details on the parent Job Run record.
* **Enables:** expand `schedule` to connect the containing Job Run row to its returned schedule entries.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is one nested object per containing Job Run object when present.
Developer identifier: `job_runs.schedule.pause_status`
Pause Status records whether the schedule is paused (PAUSED or UNPAUSED). It is needed to distinguish Job Runs rows by the exact Databricks-returned pause status value.
* **Enables:** select Job Runs rows where `pause_status` is true or false when comparing the condition described by Pause Status.
* **Interpretation:** Databricks reports this value on the Cron Schedule object returned for Job Runs; it is interpreted at one Cron Schedule record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.schedule.quartz_cron_expression`
Quartz Cron Expression records quartz cron expression. It is needed to reconstruct the exact schedule or recurrence rule reported for this Cron Schedule record.
* **Enables:** combine `quartz_cron_expression` with the sibling start time, timezone, interval, or recurrence fields to reproduce the reported schedule.
* **Interpretation:** Databricks reports this value on the Cron Schedule object returned for Job Runs; it is interpreted at one Cron Schedule record per row; the schema uses the `Temporal.CronExpression` scalar; the value describes a Databricks schedule rule at the containing record grain and does not show whether a future occurrence actually ran.
Developer identifier: `job_runs.schedule.timezone_id`
Timezone ID records java timezone ID. It is needed to preserve the Databricks-reported timezone or locale setting for the same record.
* **Enables:** compare the Databricks-reported timezone or locale setting in `timezone_id` for individual Job Runs rows without treating it as a verified physical location.
* **Interpretation:** Databricks reports this value on the Cron Schedule object returned for Job Runs; it is an identifier, not a measured quantity; the value is timezone or locale setting; this Databricks-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `job_runs.setup_duration`
Setup Duration records duration of setup phase in milliseconds. It is needed to measure the exact duration reported for one Job Run record using the Databricks duration encoding described by the field.
* **Enables:** measure and compare `setup_duration` per Job Run record in milliseconds.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; its unit or granularity is milliseconds.
Developer identifier: `job_runs.start_time`
Start Time records timestamp in epoch ms when the run started. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Job Runs records by `start_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; its unit or granularity is epoch milliseconds; the connector also declares it for record ordering; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `job_runs.state`
State records the state details attached to this Job Runs record. It is needed to preserve the nested state relationship or details on the parent Job Run record.
* **Enables:** expand `state` to connect the containing Job Run row to its returned state entries.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is one nested object per containing Job Run object when present.
Developer identifier: `job_runs.tasks`
Tasks records array of task run details. It is needed to preserve the nested tasks relationship or details on the parent Job Run record.
* **Enables:** expand `tasks` to connect the containing Job Run row to its returned tasks entries.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is one returned collection per containing Job Run object.
Developer identifier: `job_runs.tasks.attempt_number`
Attempt Number records attempt number for this task. It is needed to refer to the same attempt number across records without relying on display text.
* **Enables:** match `attempt_number` to attempt number references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.tasks.cleanup_duration`
Cleanup Duration records cleanup phase duration in ms. It is needed to measure the exact duration reported for one Run Task record using the Databricks duration encoding described by the field.
* **Enables:** measure and compare `cleanup_duration` per Run Task record in milliseconds.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; its unit or granularity is milliseconds.
Developer identifier: `job_runs.tasks.cluster_instance`
Cluster Instance records the cluster instance details attached to this Job Runs record. It is needed to preserve the nested cluster instance relationship or details on the parent Run Task record.
* **Enables:** expand `cluster_instance` to connect the containing Run Task row to its returned cluster instance entries.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is one nested object per containing Run Task object when present.
Developer identifier: `job_runs.tasks.dbt_task`
Dbt Task records the dbt task details attached to this Job Runs record. It is needed to preserve the nested dbt task relationship or details on the parent Run Task record.
* **Enables:** expand `dbt_task` to connect the containing Run Task row to its returned dbt task entries.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is one nested object per containing Run Task object when present.
Developer identifier: `job_runs.tasks.dbt_task.catalog`
Catalog records Unity Catalog name. It is needed to compare the returned catalog for individual Job Runs rows and select rows with a specific `catalog` value.
* **Enables:** trace the catalog relationship returned in `catalog` from the dbt Task row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the dbt Task object returned for Job Runs; it is interpreted at one dbt Task record per row.
Developer identifier: `job_runs.tasks.dbt_task.commands`
Commands records dbt commands to execute. It is needed to preserve the nested commands relationship or details on the parent dbt Task record.
* **Enables:** expand `commands` to connect the containing dbt Task row to its returned commands entries.
* **Interpretation:** Databricks reports this value on the dbt Task object returned for Job Runs; it is one returned collection per containing dbt Task object.
Developer identifier: `job_runs.tasks.dbt_task.profiles_directory`
Profiles Directory records path to the dbt profiles directory. It is needed to compare the returned profiles directory for individual Job Runs rows and select rows with a specific `profiles_directory` value.
* **Enables:** trace the profiles directory relationship returned in `profiles_directory` from the dbt Task row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the dbt Task object returned for Job Runs; it is interpreted at one dbt Task record per row.
Developer identifier: `job_runs.tasks.dbt_task.project_directory`
Project Directory records path to the dbt project directory. It is needed to compare the returned project directory for individual Job Runs rows and select rows with a specific `project_directory` value.
* **Enables:** trace the project directory relationship returned in `project_directory` from the dbt Task row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the dbt Task object returned for Job Runs; it is interpreted at one dbt Task record per row.
Developer identifier: `job_runs.tasks.dbt_task.schema`
Schema records dbt schema. It is needed to inventory the exact Databricks-reported configuration or classification represented by this field.
* **Enables:** compare `schema` among Job Runs records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Databricks reports this value on the dbt Task object returned for Job Runs; it is interpreted at one dbt Task record per row; the value is a Databricks-returned or configured label at the Dbt Task grain rather than a universal taxonomy.
Developer identifier: `job_runs.tasks.dbt_task.source`
Source records source of the project (WORKSPACE or GIT). It is needed to distinguish Job Runs rows by the exact Databricks-returned source value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `source` label when comparing source.
* **Interpretation:** Databricks reports this value on the dbt Task object returned for Job Runs; it is interpreted at one dbt Task record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.tasks.dbt_task.warehouse_id`
Warehouse ID records SQL warehouse ID for dbt. It is needed to refer to the same warehouse across records without relying on display text.
* **Enables:** match `warehouse_id` to warehouse references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the dbt Task object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.tasks.depends_on`
Depends On records tasks this task depends on. It is needed to preserve the nested depends on relationship or details on the parent Run Task record.
* **Enables:** expand `depends_on` to connect the containing Run Task row to its returned depends on entries.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is one returned collection per containing Run Task object.
Developer identifier: `job_runs.tasks.depends_on.outcome`
Outcome records expected outcome of the dependency. It is needed to distinguish Job Runs rows by the exact Databricks-returned outcome value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `outcome` label when comparing outcome.
* **Interpretation:** Databricks reports this value on the Task Dependency object returned for Job Runs; it is interpreted at one Task Dependency record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.tasks.depends_on.task_key`
Task Key records task key of the dependency. It is needed to refer to the same task across records without relying on display text.
* **Enables:** match `task_key` to task references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Task Dependency object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.tasks.description`
Description records description of the task. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is description text at one Run Task record per row; this is only the content included in the Databricks response for this record.
Developer identifier: `job_runs.tasks.end_time`
End Time records timestamp in epoch ms when the task ended. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Job Runs records by `end_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `job_runs.tasks.execution_duration`
Execution Duration records execution phase duration in ms. It is needed to measure the exact duration reported for one Run Task record using the Databricks duration encoding described by the field.
* **Enables:** measure and compare `execution_duration` per Run Task record in milliseconds.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; its unit or granularity is milliseconds.
Developer identifier: `job_runs.tasks.existing_cluster_id`
Existing Cluster ID records ID of an existing cluster. It is needed to refer to the same existing cluster across records without relying on display text.
* **Enables:** match `existing_cluster_id` to existing cluster references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.tasks.job_cluster_key`
Job Cluster Key records key of the job cluster to use. It is needed to refer to the same job cluster across records without relying on display text.
* **Enables:** match `job_cluster_key` to job cluster references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.tasks.libraries`
Libraries records libraries installed on the cluster. It is needed to preserve the nested libraries relationship or details on the parent Run Task record.
* **Enables:** expand `libraries` to connect the containing Run Task row to its returned libraries entries.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is one returned collection per containing Run Task object.
Developer identifier: `job_runs.tasks.new_cluster`
New Cluster records the new cluster details attached to this Job Runs record. It is needed to preserve the nested new cluster relationship or details on the parent Run Task record.
* **Enables:** expand `new_cluster` to connect the containing Run Task row to its returned new cluster entries.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is one nested object per containing Run Task object when present.
Developer identifier: `job_runs.tasks.notebook_task`
Notebook Task records the notebook task details attached to this Job Runs record. It is needed to preserve the nested notebook task relationship or details on the parent Run Task record.
* **Enables:** expand `notebook_task` to connect the containing Run Task row to its returned notebook task entries.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is one nested object per containing Run Task object when present.
Developer identifier: `job_runs.tasks.notebook_task.base_parameters`
Base Parameters records base parameters. It is needed to preserve the exact Databricks configuration or execution metadata attached to this Notebook Task record.
* **Enables:** inspect the keys in `base_parameters` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Databricks reports this value on the Notebook Task object returned for Job Runs; it is interpreted at one Notebook Task record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Databricks response and can vary by resource type or configuration.
Developer identifier: `job_runs.tasks.notebook_task.notebook_path`
Notebook Path records absolute path of the notebook. It is needed to compare the returned notebook path for individual Job Runs rows and select rows with a specific `notebook_path` value.
* **Enables:** trace the notebook path relationship returned in `notebook_path` from the Notebook Task row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Notebook Task object returned for Job Runs; it is interpreted at one Notebook Task record per row.
Developer identifier: `job_runs.tasks.notebook_task.source`
Source records source of the notebook (WORKSPACE or GIT). It is needed to distinguish Job Runs rows by the exact Databricks-returned source value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `source` label when comparing source.
* **Interpretation:** Databricks reports this value on the Notebook Task object returned for Job Runs; it is interpreted at one Notebook Task record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.tasks.pipeline_task`
Pipeline Task records the pipeline task details attached to this Job Runs record. It is needed to preserve the nested pipeline task relationship or details on the parent Run Task record.
* **Enables:** expand `pipeline_task` to connect the containing Run Task row to its returned pipeline task entries.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is one nested object per containing Run Task object when present.
Developer identifier: `job_runs.tasks.pipeline_task.full_refresh`
Full Refresh records whether to perform a full refresh. It is needed to distinguish Job Runs rows by the exact Databricks-returned full refresh value.
* **Enables:** select Job Runs rows where `full_refresh` is true or false when comparing the condition described by Full Refresh.
* **Interpretation:** Databricks reports this value on the Pipeline Task object returned for Job Runs; it is interpreted at one Pipeline Task record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.tasks.pipeline_task.pipeline_id`
Pipeline ID records ID of the pipeline. It is needed to refer to the same pipeline across records without relying on display text.
* **Enables:** match `pipeline_id` to pipeline references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Pipeline Task object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.tasks.python_wheel_task`
Python Wheel Task records the python wheel task details attached to this Job Runs record. It is needed to preserve the nested python wheel task relationship or details on the parent Run Task record.
* **Enables:** expand `python_wheel_task` to connect the containing Run Task row to its returned python wheel task entries.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is one nested object per containing Run Task object when present.
Developer identifier: `job_runs.tasks.python_wheel_task.entry_point`
Entry Point records entry point of the package. It is needed to reproduce the exact package or entry-point configuration used by this job task.
* **Enables:** combine `entry_point` with the sibling library type and repository fields to resolve the configured dependency or executable entry point.
* **Interpretation:** Databricks reports this value on the Python Wheel Task object returned for Job Runs; it is interpreted at one Python Wheel Task record per row; the value names Databricks job configuration and does not prove that the dependency is still available.
Developer identifier: `job_runs.tasks.python_wheel_task.named_parameters`
Named Parameters records named parameters as key-value pairs. It is needed to compare the returned named parameters for individual Job Runs rows and select rows with a specific `named_parameters` value.
* **Enables:** locate Job Runs rows whose returned named parameters exactly matches `named_parameters` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Python Wheel Task object returned for Job Runs; it is interpreted at one Python Wheel Task record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `job_runs.tasks.python_wheel_task.package_name`
Package Name records name of the Python wheel package. It is needed to compare the returned package name for individual Job Runs rows and select rows with a specific `package_name` value.
* **Enables:** locate Job Runs rows whose returned package name exactly matches `package_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Python Wheel Task object returned for Job Runs; it is interpreted at one Python Wheel Task record per row.
Developer identifier: `job_runs.tasks.python_wheel_task.parameters`
Parameters records command-line parameters. It is needed to preserve the nested parameters relationship or details on the parent Python Wheel Task record.
* **Enables:** expand `parameters` to connect the containing Python Wheel Task row to its returned parameters entries.
* **Interpretation:** Databricks reports this value on the Python Wheel Task object returned for Job Runs; it is one returned collection per containing Python Wheel Task object.
Developer identifier: `job_runs.tasks.run_id`
Run ID records unique identifier for this task run. It is needed to refer to the same run across records without relying on display text.
* **Enables:** match `run_id` to run references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.tasks.run_job_task`
Run Job Task records the run job task details attached to this Job Runs record. It is needed to preserve the nested run job task relationship or details on the parent Run Task record.
* **Enables:** expand `run_job_task` to connect the containing Run Task row to its returned run job task entries.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is one nested object per containing Run Task object when present.
Developer identifier: `job_runs.tasks.run_job_task.job_id`
Job ID records ID of the job to trigger. It is needed to refer to the same job across records without relying on display text.
* **Enables:** match `job_id` to job references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Run Job Task object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.tasks.run_job_task.job_parameters`
Job Parameters records parameters for the triggered job. It is needed to preserve the exact Databricks configuration or execution metadata attached to this Run Job Task record.
* **Enables:** inspect the keys in `job_parameters` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Databricks reports this value on the Run Job Task object returned for Job Runs; it is interpreted at one Run Job Task record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Databricks response and can vary by resource type or configuration.
Developer identifier: `job_runs.tasks.run_page_url`
Run Page URL records URL to the task run page. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Databricks resource referenced by `run_page_url` while retaining the containing Job Runs record as provenance.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is link at one Run Task record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `job_runs.tasks.setup_duration`
Setup Duration records setup phase duration in ms. It is needed to measure the exact duration reported for one Run Task record using the Databricks duration encoding described by the field.
* **Enables:** measure and compare `setup_duration` per Run Task record in milliseconds.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; its unit or granularity is milliseconds.
Developer identifier: `job_runs.tasks.spark_jar_task`
Spark Jar Task records the spark jar task details attached to this Job Runs record. It is needed to preserve the nested spark jar task relationship or details on the parent Run Task record.
* **Enables:** expand `spark_jar_task` to connect the containing Run Task row to its returned spark jar task entries.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is one nested object per containing Run Task object when present.
Developer identifier: `job_runs.tasks.spark_jar_task.jar_uri`
Jar URI records URI of the JAR. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Databricks resource referenced by `jar_uri` while retaining the containing Job Runs record as provenance.
* **Interpretation:** Databricks reports this value on the Spark Jar Task object returned for Job Runs; it is link at one Spark Jar Task record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `job_runs.tasks.spark_jar_task.main_class_name`
Main Class Name records full name of the main class. It is needed to distinguish Job Runs rows by the exact Databricks-returned main class name value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `main_class_name` label when comparing main class name.
* **Interpretation:** Databricks reports this value on the Spark Jar Task object returned for Job Runs; it is interpreted at one Spark Jar Task record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.tasks.spark_jar_task.parameters`
Parameters records parameters passed to the main method. It is needed to preserve the nested parameters relationship or details on the parent Spark Jar Task record.
* **Enables:** expand `parameters` to connect the containing Spark Jar Task row to its returned parameters entries.
* **Interpretation:** Databricks reports this value on the Spark Jar Task object returned for Job Runs; it is one returned collection per containing Spark Jar Task object.
Developer identifier: `job_runs.tasks.spark_python_task`
Spark Python Task records the spark python task details attached to this Job Runs record. It is needed to preserve the nested spark python task relationship or details on the parent Run Task record.
* **Enables:** expand `spark_python_task` to connect the containing Run Task row to its returned spark python task entries.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is one nested object per containing Run Task object when present.
Developer identifier: `job_runs.tasks.spark_python_task.parameters`
Parameters records command-line parameters. It is needed to preserve the nested parameters relationship or details on the parent Spark Python Task record.
* **Enables:** expand `parameters` to connect the containing Spark Python Task row to its returned parameters entries.
* **Interpretation:** Databricks reports this value on the Spark Python Task object returned for Job Runs; it is one returned collection per containing Spark Python Task object.
Developer identifier: `job_runs.tasks.spark_python_task.python_file`
Python File records URI of the Python file. It is needed to reproduce the returned code or dependency configuration for this Job Runs record.
* **Enables:** use `python_file` to locate the configured source, package, or repository when reproducing the same job or repository setup.
* **Interpretation:** Databricks reports this value on the Spark Python Task object returned for Job Runs; it is interpreted at one Spark Python Task record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `job_runs.tasks.spark_python_task.source`
Source records source of the Python file. It is needed to distinguish Job Runs rows by the exact Databricks-returned source value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `source` label when comparing source.
* **Interpretation:** Databricks reports this value on the Spark Python Task object returned for Job Runs; it is interpreted at one Spark Python Task record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.tasks.spark_submit_task`
Spark Submit Task records the spark submit task details attached to this Job Runs record. It is needed to preserve the nested spark submit task relationship or details on the parent Run Task record.
* **Enables:** expand `spark_submit_task` to connect the containing Run Task row to its returned spark submit task entries.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is one nested object per containing Run Task object when present.
Developer identifier: `job_runs.tasks.spark_submit_task.parameters`
Parameters records parameters for spark-submit. It is needed to preserve the nested parameters relationship or details on the parent Spark Submit Task record.
* **Enables:** expand `parameters` to connect the containing Spark Submit Task row to its returned parameters entries.
* **Interpretation:** Databricks reports this value on the Spark Submit Task object returned for Job Runs; it is one returned collection per containing Spark Submit Task object.
Developer identifier: `job_runs.tasks.sql_task`
SQL Task records the sql task details attached to this Job Runs record. It is needed to preserve the nested sql task relationship or details on the parent Run Task record.
* **Enables:** expand `sql_task` to connect the containing Run Task row to its returned sql task entries.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is one nested object per containing Run Task object when present.
Developer identifier: `job_runs.tasks.sql_task.alert`
Alert records the alert details attached to this Job Runs record. It is needed to preserve the nested alert relationship or details on the parent SQL Task record.
* **Enables:** expand `alert` to connect the containing SQL Task row to its returned alert entries.
* **Interpretation:** Databricks reports this value on the SQL Task object returned for Job Runs; it is one nested object per containing SQL Task object when present.
Developer identifier: `job_runs.tasks.sql_task.alert.alert_id`
Alert ID records ID of the SQL alert. It is needed to refer to the same alert across records without relying on display text.
* **Enables:** match `alert_id` to alert references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the SQL Task Alert object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.tasks.sql_task.dashboard`
Dashboard records the dashboard details attached to this Job Runs record. It is needed to preserve the nested dashboard relationship or details on the parent SQL Task record.
* **Enables:** expand `dashboard` to connect the containing SQL Task row to its returned dashboard entries.
* **Interpretation:** Databricks reports this value on the SQL Task object returned for Job Runs; it is one nested object per containing SQL Task object when present.
Developer identifier: `job_runs.tasks.sql_task.dashboard.dashboard_id`
Dashboard ID records ID of the SQL dashboard. It is needed to refer to the same dashboard across records without relying on display text.
* **Enables:** match `dashboard_id` to dashboard references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the SQL Task Dashboard object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.tasks.sql_task.file`
File records the file details attached to this Job Runs record. It is needed to preserve the nested file relationship or details on the parent SQL Task record.
* **Enables:** expand `file` to connect the containing SQL Task row to its returned file entries.
* **Interpretation:** Databricks reports this value on the SQL Task object returned for Job Runs; it is one nested object per containing SQL Task object when present.
Developer identifier: `job_runs.tasks.sql_task.file.path`
Path records path to the SQL file. It is needed to compare the returned path for individual Job Runs rows and select rows with a specific `path` value.
* **Enables:** trace the path relationship returned in `path` from the SQL Task File row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the SQL Task File object returned for Job Runs; it is interpreted at one SQL Task File record per row.
Developer identifier: `job_runs.tasks.sql_task.file.source`
Source records source of the file. It is needed to distinguish Job Runs rows by the exact Databricks-returned source value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `source` label when comparing source.
* **Interpretation:** Databricks reports this value on the SQL Task File object returned for Job Runs; it is interpreted at one SQL Task File record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.tasks.sql_task.parameters`
Parameters records parameters for the SQL task. It is needed to preserve the exact Databricks configuration or execution metadata attached to this SQL Task record.
* **Enables:** inspect the keys in `parameters` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Databricks reports this value on the SQL Task object returned for Job Runs; it is interpreted at one SQL Task record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Databricks response and can vary by resource type or configuration.
Developer identifier: `job_runs.tasks.sql_task.query`
Query records the query details attached to this Job Runs record. It is needed to preserve the nested query relationship or details on the parent SQL Task record.
* **Enables:** expand `query` to connect the containing SQL Task row to its returned query entries.
* **Interpretation:** Databricks reports this value on the SQL Task object returned for Job Runs; it is one nested object per containing SQL Task object when present.
Developer identifier: `job_runs.tasks.sql_task.query.query_id`
Query ID records ID of the SQL query. It is needed to refer to the same query across records without relying on display text.
* **Enables:** match `query_id` to query references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the SQL Task Query object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.tasks.sql_task.warehouse_id`
Warehouse ID records ID of the SQL warehouse. It is needed to refer to the same warehouse across records without relying on display text.
* **Enables:** match `warehouse_id` to warehouse references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the SQL Task object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.tasks.start_time`
Start Time records timestamp in epoch ms when the task started. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Job Runs records by `start_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `job_runs.tasks.state`
State records the state details attached to this Job Runs record. It is needed to preserve the nested state relationship or details on the parent Run Task record.
* **Enables:** expand `state` to connect the containing Run Task row to its returned state entries.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is one nested object per containing Run Task object when present.
Developer identifier: `job_runs.tasks.task_key`
Task Key records unique key identifying the task within the job. It is needed to refer to the same task across records without relying on display text.
* **Enables:** match `task_key` to task references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Run Task object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `job_runs.trigger`
Trigger records the trigger supplied for this Job Runs record by Databricks. It is needed to distinguish Job Runs rows by the exact Databricks-returned trigger value.
* **Enables:** separate Job Runs rows by the exact Databricks-returned `trigger` label when comparing trigger.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is interpreted at one Job Run record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `job_runs.trigger_info`
Trigger Info records the trigger info details attached to this Job Runs record. It is needed to preserve the nested trigger info relationship or details on the parent Job Run record.
* **Enables:** expand `trigger_info` to connect the containing Job Run row to its returned trigger info entries.
* **Interpretation:** Databricks reports this value on the Job Run object returned for Job Runs; it is one nested object per containing Job Run object when present.
Developer identifier: `job_runs.trigger_info.run_id`
Run ID records run ID of the triggering run. It is needed to refer to the same run across records without relying on display text.
* **Enables:** match `run_id` to run references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Trigger Info object returned for Job Runs; it is an identifier, not a measured quantity.
Developer identifier: `jobs`
Jobs covers jobs defined in the Databricks workspace. Provides job configuration, schedule, and metadata. Paginated via `next_page_token`.
* **Enables:** inventory defined jobs and connect each job to its creator, schedule, tasks, and run-as identity where returned.
* **Scope:** Lists all jobs defined in the Databricks workspace. Provides job configuration, schedule, and metadata. Paginated via `next_page_token`; the connector reads `/api/2.1/jobs/list` as a snapshot stream in full mode. The configured credential must grant the declared `all-apis` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the Databricks record was deleted.
Developer identifier: `jobs.created_time`
Created Time records timestamp when the job was created (epoch ms). It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Jobs records by `created_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Databricks Jobs object returned for Jobs; its unit or granularity is epoch milliseconds; the connector also declares it for record ordering; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `jobs.creator_user_name`
Creator User Name records user who created the job. It is needed to attribute this Jobs row to the returned person, account, or organization reference.
* **Enables:** attribute the Jobs row to the returned person or account and match the exact `creator_user_name` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Databricks Jobs object returned for Jobs; it is interpreted at one Databricks Jobs record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `jobs.format`
Format records format of the job (`SINGLE_TASK`, `MULTI_TASK`). It is needed to distinguish Jobs rows by the exact Databricks-returned format value.
* **Enables:** separate Jobs rows by the exact Databricks-returned `format` label when comparing format.
* **Interpretation:** Databricks reports this value on the Databricks Jobs object returned for Jobs; it is interpreted at one Databricks Jobs record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `jobs.job_id`
Job ID records unique identifier for the job. It is needed to distinguish repeated deliveries of the same Jobs row using the declared ingestion key.
* **Enables:** use `job_id` as the declared ingestion deduplication key for Jobs and match repeated rows carrying the same Databricks identifier.
* **Interpretation:** Databricks reports this value on the Databricks Jobs object returned for Jobs; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `jobs.run_as_owner`
Run As Owner records whether the job runs as the owner. It is needed to distinguish Jobs rows by the exact Databricks-returned run as owner value.
* **Enables:** select Jobs rows where `run_as_owner` is true or false when comparing the condition described by Run As Owner.
* **Interpretation:** Databricks reports this value on the Databricks Jobs object returned for Jobs; it is interpreted at one Databricks Jobs record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `jobs.run_as_user_name`
Run As User Name records user the job runs as. It is needed to attribute this Jobs row to the returned person, account, or organization reference.
* **Enables:** attribute the Jobs row to the returned person or account and match the exact `run_as_user_name` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Databricks Jobs object returned for Jobs; it is interpreted at one Databricks Jobs record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `jobs.settings`
Settings records job settings including tasks, schedule, clusters, and notifications. It is needed to compare the exact settings configuration returned for this Databricks Jobs record.
* **Enables:** compare the exact `settings` configuration returned for each Databricks Jobs record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Databricks Jobs object returned for Jobs; it is interpreted at one Databricks Jobs record per row.
Developer identifier: `jobs.trigger`
Trigger records trigger configuration for the job. It is needed to distinguish Jobs rows by the exact Databricks-returned trigger value.
* **Enables:** separate Jobs rows by the exact Databricks-returned `trigger` label when comparing trigger.
* **Interpretation:** Databricks reports this value on the Databricks Jobs object returned for Jobs; it is interpreted at one Databricks Jobs record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines`
Pipelines covers delta Live Tables (DLT) pipelines in the Databricks workspace. Provides pipeline configuration, state, and metadata.
* **Enables:** inventory returned pipeline definitions and compare their creator, configuration, state, and last reported update.
* **Scope:** Lists all Delta Live Tables (DLT) pipelines in the Databricks workspace. Provides pipeline configuration, state, and metadata; the connector reads `/api/{apiVersion}/pipelines` as a snapshot stream in full mode. The configured credential must grant the declared `all-apis` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the Databricks record was deleted.
Developer identifier: `pipelines.budget_policy_id`
Budget Policy ID records ID of the budget policy associated with the pipeline. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `budget_policy_id` access value with the resource, account, or membership represented by the same Pipelines row.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `pipelines.catalog`
Catalog records Unity Catalog name associated with the pipeline. It is needed to compare the returned catalog for individual Pipelines rows and select rows with a specific `catalog` value.
* **Enables:** trace the catalog relationship returned in `catalog` from the Pipeline row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row.
Developer identifier: `pipelines.cause`
Cause records cause of the current pipeline state (e.g., `USER_ACTION`, `API_CALL`). It is needed to inventory the exact Databricks-reported configuration or classification represented by this field.
* **Enables:** compare `cause` among Pipelines records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row; the value is a Databricks-returned or configured label at the Pipeline grain rather than a universal taxonomy.
Developer identifier: `pipelines.channel`
Channel records release channel for the pipeline runtime (e.g., CURRENT, PREVIEW). It is needed to inventory the exact Databricks-reported configuration or classification represented by this field.
* **Enables:** compare `channel` among Pipelines records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row; the value is a Databricks-returned or configured label at the Pipeline grain rather than a universal taxonomy.
Developer identifier: `pipelines.cluster_id`
Cluster ID records ID of the cluster used by the pipeline. It is needed to refer to the same cluster across records without relying on display text.
* **Enables:** match `cluster_id` to cluster references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is an identifier, not a measured quantity.
Developer identifier: `pipelines.clusters`
Clusters records cluster configurations for the pipeline. It is needed to preserve the nested clusters relationship or details on the parent Pipeline record.
* **Enables:** expand `clusters` to connect the containing Pipeline row to its returned clusters entries.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is one returned collection per containing Pipeline object.
Developer identifier: `pipelines.clusters.apply_policy_default_values`
Apply Policy Default Values records whether to apply default values from the cluster policy. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Pipelines rows with the exact `apply_policy_default_values` access-related value being investigated.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is interpreted at one Pipeline Cluster record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.clusters.autoscale`
Autoscale records autoscaling configuration for the cluster. It is needed to preserve the nested autoscale relationship or details on the parent Pipeline Cluster record.
* **Enables:** expand `autoscale` to connect the containing Pipeline Cluster row to its returned autoscale entries.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is one nested object per containing Pipeline Cluster object when present.
Developer identifier: `pipelines.clusters.autoscale.max_workers`
Max Workers records maximum number of workers. It is needed to measure the Databricks-reported number of max workers at one Autoscale Config record per row.
* **Enables:** measure and compare the Databricks-reported number of max workers in `max_workers` at one Autoscale Config record per row.
* **Interpretation:** Databricks reports this value on the Autoscale Config object returned for Pipelines; it is a Databricks-reported count at one Autoscale Config record per row.
Developer identifier: `pipelines.clusters.autoscale.min_workers`
Min Workers records minimum number of workers. It is needed to measure the Databricks-reported number of min workers at one Autoscale Config record per row.
* **Enables:** measure and compare the Databricks-reported number of min workers in `min_workers` at one Autoscale Config record per row.
* **Interpretation:** Databricks reports this value on the Autoscale Config object returned for Pipelines; it is a Databricks-reported count at one Autoscale Config record per row.
Developer identifier: `pipelines.clusters.autoscale.mode`
Mode records autoscale mode (e.g., LEGACY, ENHANCED). It is needed to distinguish Pipelines rows by the exact Databricks-returned mode value.
* **Enables:** separate Pipelines rows by the exact Databricks-returned `mode` label when comparing mode.
* **Interpretation:** Databricks reports this value on the Autoscale Config object returned for Pipelines; it is interpreted at one Autoscale Config record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.clusters.aws_attributes`
AWS Attributes records AWS-specific cluster attributes. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `aws_attributes` and associate them with the containing Pipelines record.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is interpreted at one Pipeline Cluster record per row; the schema uses the `Generic.JSON` scalar; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `pipelines.clusters.azure_attributes`
Azure Attributes records azure-specific cluster attributes. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `azure_attributes` and associate them with the containing Pipelines record.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is interpreted at one Pipeline Cluster record per row; the schema uses the `Generic.JSON` scalar; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `pipelines.clusters.custom_tags`
Custom Tags records custom tags applied to the cluster. It is needed to distinguish Pipelines rows by the exact Databricks-returned custom tags value.
* **Enables:** separate Pipelines rows by the exact Databricks-returned `custom_tags` label when comparing custom tags.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is interpreted at one Pipeline Cluster record per row; the schema uses the `Generic.JSON` scalar; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.clusters.driver_instance_pool_id`
Driver Instance Pool ID records instance pool ID for the driver. It is needed to refer to the same driver instance pool across records without relying on display text.
* **Enables:** match `driver_instance_pool_id` to driver instance pool references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is an identifier, not a measured quantity.
Developer identifier: `pipelines.clusters.driver_node_type_id`
Driver Node Type ID records node type ID for the cluster driver. It is needed to refer to the same driver node type across records without relying on display text.
* **Enables:** match `driver_node_type_id` to driver node type references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is an identifier, not a measured quantity; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.clusters.gcp_attributes`
GCP Attributes records GCP-specific cluster attributes. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `gcp_attributes` and associate them with the containing Pipelines record.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is interpreted at one Pipeline Cluster record per row; the schema uses the `Generic.JSON` scalar; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `pipelines.clusters.init_scripts`
Init Scripts records init scripts for the cluster. It is needed to preserve the nested init scripts relationship or details on the parent Pipeline Cluster record.
* **Enables:** expand `init_scripts` to connect the containing Pipeline Cluster row to its returned init scripts entries.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is one returned collection per containing Pipeline Cluster object.
Developer identifier: `pipelines.clusters.instance_pool_id`
Instance Pool ID records instance pool ID for the cluster. It is needed to refer to the same instance pool across records without relying on display text.
* **Enables:** match `instance_pool_id` to instance pool references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is an identifier, not a measured quantity.
Developer identifier: `pipelines.clusters.label`
Label records label for the cluster configuration (e.g., default, maintenance). It is needed to compare the exact label configuration returned for this Pipeline Cluster record.
* **Enables:** compare the exact `label` configuration returned for each Pipeline Cluster record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is interpreted at one Pipeline Cluster record per row.
Developer identifier: `pipelines.clusters.node_type_id`
Node Type ID records node type ID for the cluster workers. It is needed to measure the Databricks-reported number of node type id at one Pipeline Cluster record per row.
* **Enables:** measure and compare the Databricks-reported number of node type id in `node_type_id` at one Pipeline Cluster record per row.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is a Databricks-reported count at one Pipeline Cluster record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.clusters.num_workers`
Num Workers records fixed number of workers for the cluster. It is needed to measure the Databricks-reported number of num workers at one Pipeline Cluster record per row.
* **Enables:** measure and compare the Databricks-reported number of num workers in `num_workers` at one Pipeline Cluster record per row.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is a Databricks-reported count at one Pipeline Cluster record per row.
Developer identifier: `pipelines.clusters.policy_id`
Policy ID records cluster policy ID. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `policy_id` access value with the resource, account, or membership represented by the same Pipelines row.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `pipelines.clusters.spark_conf`
Spark Conf records spark configuration key-value pairs. It is needed to compare the exact spark conf configuration returned for this Pipeline Cluster record.
* **Enables:** compare the exact `spark_conf` configuration returned for each Pipeline Cluster record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is interpreted at one Pipeline Cluster record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `pipelines.clusters.spark_env_vars`
Spark Env Vars records spark environment variables. It is needed to preserve the exact Databricks configuration or execution metadata attached to this Pipeline Cluster record.
* **Enables:** inspect the keys in `spark_env_vars` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is interpreted at one Pipeline Cluster record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Databricks response and can vary by resource type or configuration.
Developer identifier: `pipelines.clusters.ssh_public_keys`
SSH Public Keys records SSH public keys for the cluster. It is needed to preserve the nested ssh public keys relationship or details on the parent Pipeline Cluster record.
* **Enables:** expand `ssh_public_keys` to connect the containing Pipeline Cluster row to its returned ssh public keys entries.
* **Interpretation:** Databricks reports this value on the Pipeline Cluster object returned for Pipelines; it is one returned collection per containing Pipeline Cluster object.
Developer identifier: `pipelines.configuration`
Configuration records arbitrary key-value configuration settings for the pipeline. It is needed to compare the exact configuration configuration returned for this Pipeline record.
* **Enables:** compare the exact `configuration` configuration returned for each Pipeline record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `pipelines.continuous`
Continuous records whether the pipeline runs in continuous mode. It is needed to distinguish Pipelines rows by the exact Databricks-returned continuous value.
* **Enables:** select Pipelines rows where `continuous` is true or false when comparing the condition described by Continuous.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.creation_time`
Creation Time records timestamp when the pipeline was created, in epoch milliseconds. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pipelines records by `creation_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pipelines.creator_user_name`
Creator User Name records username of the user who created the pipeline. It is needed to attribute this Pipelines row to the returned person, account, or organization reference.
* **Enables:** attribute the Pipelines row to the returned person or account and match the exact `creator_user_name` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row.
Developer identifier: `pipelines.development`
Development records whether the pipeline is in development mode. It is needed to distinguish Pipelines rows by the exact Databricks-returned development value.
* **Enables:** select Pipelines rows where `development` is true or false when comparing the condition described by Development.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.edition`
Edition records product edition of the pipeline (e.g., CORE, PRO, ADVANCED). It is needed to compare the exact edition configuration returned for this Pipeline record.
* **Enables:** compare the exact `edition` configuration returned for each Pipeline record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row.
Developer identifier: `pipelines.filters`
Filters records filters applied to the pipeline datasets. It is needed to preserve the nested filters relationship or details on the parent Pipeline record.
* **Enables:** expand `filters` to connect the containing Pipeline row to its returned filters entries.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is one nested object per containing Pipeline object when present.
Developer identifier: `pipelines.filters.exclude`
Exclude records list of dataset name patterns to exclude. It is needed to preserve the nested exclude relationship or details on the parent Pipeline Filters record.
* **Enables:** expand `exclude` to connect the containing Pipeline Filters row to its returned exclude entries.
* **Interpretation:** Databricks reports this value on the Pipeline Filters object returned for Pipelines; it is one returned collection per containing Pipeline Filters object.
Developer identifier: `pipelines.filters.include`
Include records list of dataset name patterns to include. It is needed to preserve the nested include relationship or details on the parent Pipeline Filters record.
* **Enables:** expand `include` to connect the containing Pipeline Filters row to its returned include entries.
* **Interpretation:** Databricks reports this value on the Pipeline Filters object returned for Pipelines; it is one returned collection per containing Pipeline Filters object.
Developer identifier: `pipelines.health`
Health records health status of the pipeline. It is needed to distinguish Pipelines rows by the exact Databricks-returned health value.
* **Enables:** separate Pipelines rows by the exact Databricks-returned `health` label when comparing health.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.last_modified`
Last Modified records timestamp when the pipeline was last modified. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pipelines records by `last_modified`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row; the connector also declares it for record ordering.
Developer identifier: `pipelines.latest_updates`
Latest Updates records latest update details for the pipeline. It is needed to preserve the nested latest updates relationship or details on the parent Pipeline record.
* **Enables:** expand `latest_updates` to connect the containing Pipeline row to its returned latest updates entries.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is one returned collection per containing Pipeline object.
Developer identifier: `pipelines.latest_updates.cause`
Cause records cause that triggered the update. It is needed to inventory the exact Databricks-reported configuration or classification represented by this field.
* **Enables:** compare `cause` among Pipelines records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Databricks reports this value on the Pipeline Update object returned for Pipelines; it is interpreted at one Pipeline Update record per row; the value is a Databricks-returned or configured label at the Pipeline Update grain rather than a universal taxonomy.
Developer identifier: `pipelines.latest_updates.config`
Config records configuration overrides for this update. It is needed to compare the exact config configuration returned for this Pipeline Update record.
* **Enables:** compare the exact `config` configuration returned for each Pipeline Update record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Pipeline Update object returned for Pipelines; it is interpreted at one Pipeline Update record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `pipelines.latest_updates.creation_time`
Creation Time records timestamp when the update was created, in epoch milliseconds. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pipelines records by `creation_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Pipeline Update object returned for Pipelines; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pipelines.latest_updates.full_refresh`
Full Refresh records whether this update was a full refresh. It is needed to distinguish Pipelines rows by the exact Databricks-returned full refresh value.
* **Enables:** select Pipelines rows where `full_refresh` is true or false when comparing the condition described by Full Refresh.
* **Interpretation:** Databricks reports this value on the Pipeline Update object returned for Pipelines; it is interpreted at one Pipeline Update record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.latest_updates.full_refresh_selection`
Full Refresh Selection records list of tables selected for full refresh. It is needed to preserve the nested full refresh selection relationship or details on the parent Pipeline Update record.
* **Enables:** expand `full_refresh_selection` to connect the containing Pipeline Update row to its returned full refresh selection entries.
* **Interpretation:** Databricks reports this value on the Pipeline Update object returned for Pipelines; it is one returned collection per containing Pipeline Update object.
Developer identifier: `pipelines.latest_updates.refresh_selection`
Refresh Selection records list of tables selected for refresh. It is needed to preserve the nested refresh selection relationship or details on the parent Pipeline Update record.
* **Enables:** expand `refresh_selection` to connect the containing Pipeline Update row to its returned refresh selection entries.
* **Interpretation:** Databricks reports this value on the Pipeline Update object returned for Pipelines; it is one returned collection per containing Pipeline Update object.
Developer identifier: `pipelines.latest_updates.state`
State records state of the update. It is needed to distinguish Pipelines rows by the exact Databricks-returned state value.
* **Enables:** separate Pipelines rows by the exact Databricks-returned `state` label when comparing state.
* **Interpretation:** Databricks reports this value on the Pipeline Update object returned for Pipelines; it is interpreted at one Pipeline Update record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.latest_updates.update_id`
Update ID records unique identifier for the update. It is needed to refer to the same update across records without relying on display text.
* **Enables:** match `update_id` to update references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Pipeline Update object returned for Pipelines; it is an identifier, not a measured quantity.
Developer identifier: `pipelines.latest_updates.validate_only`
Validate Only records whether the update was a validation-only run. It is needed to distinguish Pipelines rows by the exact Databricks-returned validate only value.
* **Enables:** select Pipelines rows where `validate_only` is true or false when comparing the condition described by Validate Only.
* **Interpretation:** Databricks reports this value on the Pipeline Update object returned for Pipelines; it is interpreted at one Pipeline Update record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.libraries`
Libraries records list of library/notebook configurations for the pipeline. It is needed to preserve the nested libraries relationship or details on the parent Pipeline record.
* **Enables:** expand `libraries` to connect the containing Pipeline row to its returned libraries entries.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is one returned collection per containing Pipeline object.
Developer identifier: `pipelines.libraries.file`
File records file reference for the library. It is needed to preserve the nested file relationship or details on the parent Pipeline Library record.
* **Enables:** expand `file` to connect the containing Pipeline Library row to its returned file entries.
* **Interpretation:** Databricks reports this value on the Pipeline Library object returned for Pipelines; it is one nested object per containing Pipeline Library object when present.
Developer identifier: `pipelines.libraries.file.path`
Path records path to the file. It is needed to compare the returned path for individual Pipelines rows and select rows with a specific `path` value.
* **Enables:** trace the path relationship returned in `path` from the File Reference row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the File Reference object returned for Pipelines; it is interpreted at one File Reference record per row.
Developer identifier: `pipelines.libraries.jar`
Jar records path to a JAR library. It is needed to compare the returned jar for individual Pipelines rows and select rows with a specific `jar` value.
* **Enables:** trace the jar relationship returned in `jar` from the Pipeline Library row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Pipeline Library object returned for Pipelines; it is interpreted at one Pipeline Library record per row.
Developer identifier: `pipelines.libraries.maven`
Maven records maven library coordinates. It is needed to preserve the nested maven relationship or details on the parent Pipeline Library record.
* **Enables:** expand `maven` to connect the containing Pipeline Library row to its returned maven entries.
* **Interpretation:** Databricks reports this value on the Pipeline Library object returned for Pipelines; its unit or granularity is provider-reported geographic coordinates.
Developer identifier: `pipelines.libraries.maven.coordinates`
Coordinates records maven coordinates (groupId:artifactId:version). It is needed to compare the exact coordinates configuration returned for this Maven Library record.
* **Enables:** compare the exact `coordinates` configuration returned for each Maven Library record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Maven Library object returned for Pipelines; its unit or granularity is provider-reported geographic coordinates.
Developer identifier: `pipelines.libraries.maven.exclusions`
Exclusions records list of Maven dependency exclusions. It is needed to preserve the nested exclusions relationship or details on the parent Maven Library record.
* **Enables:** expand `exclusions` to connect the containing Maven Library row to its returned exclusions entries.
* **Interpretation:** Databricks reports this value on the Maven Library object returned for Pipelines; it is one returned collection per containing Maven Library object.
Developer identifier: `pipelines.libraries.maven.repo`
Repo records maven repository URL. It is needed to reproduce the returned code or dependency configuration for this Pipelines record.
* **Enables:** use `repo` to locate the configured source, package, or repository when reproducing the same job or repository setup.
* **Interpretation:** Databricks reports this value on the Maven Library object returned for Pipelines; it is interpreted at one Maven Library record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pipelines.libraries.notebook`
Notebook records notebook reference for the library. It is needed to preserve the nested notebook relationship or details on the parent Pipeline Library record.
* **Enables:** expand `notebook` to connect the containing Pipeline Library row to its returned notebook entries.
* **Interpretation:** Databricks reports this value on the Pipeline Library object returned for Pipelines; it is one nested object per containing Pipeline Library object when present.
Developer identifier: `pipelines.libraries.notebook.path`
Path records workspace path to the notebook. It is needed to compare the returned path for individual Pipelines rows and select rows with a specific `path` value.
* **Enables:** trace the path relationship returned in `path` from the Notebook Reference row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Notebook Reference object returned for Pipelines; it is interpreted at one Notebook Reference record per row.
Developer identifier: `pipelines.name`
Name records human-readable name of the pipeline. It is needed to compare the returned name for individual Pipelines rows and select rows with a specific `name` value.
* **Enables:** locate Pipelines rows whose returned name exactly matches `name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row.
Developer identifier: `pipelines.notifications`
Notifications records notification configurations for pipeline events. It is needed to preserve the nested notifications relationship or details on the parent Pipeline record.
* **Enables:** expand `notifications` to connect the containing Pipeline row to its returned notifications entries.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is one returned collection per containing Pipeline object.
Developer identifier: `pipelines.notifications.alerts`
Alerts records list of alert types that trigger notifications (e.g., on-update-failure, on-update-success, on-flow-failure). It is needed to preserve the nested alerts relationship or details on the parent Pipeline Notification record.
* **Enables:** expand `alerts` to connect the containing Pipeline Notification row to its returned alerts entries.
* **Interpretation:** Databricks reports this value on the Pipeline Notification object returned for Pipelines; it is one returned collection per containing Pipeline Notification object.
Developer identifier: `pipelines.notifications.email_recipients`
Email Recipients records list of email addresses to notify. It is needed to preserve the nested email recipients relationship or details on the parent Pipeline Notification record.
* **Enables:** expand `email_recipients` to connect the containing Pipeline Notification row to its returned email recipients entries.
* **Interpretation:** Databricks reports this value on the Pipeline Notification object returned for Pipelines; it is one returned collection per containing Pipeline Notification object.
Developer identifier: `pipelines.permissions`
Permissions records access control permissions for the pipeline. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `permissions` to examine the returned permissions details for the containing Pipeline record.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is one returned collection per containing Pipeline object; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `pipelines.permissions.group_name`
Group Name records group name granted the permission. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `group_name` access value with the resource, account, or membership represented by the same Pipelines row.
* **Interpretation:** Databricks reports this value on the Pipeline Permission object returned for Pipelines; it is interpreted at one Pipeline Permission record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `pipelines.permissions.permission_level`
Permission Level records permission level (e.g., `CAN_MANAGE`, `CAN_RUN`, `CAN_VIEW`, `IS_OWNER`). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `permission_level` access value with the resource, account, or membership represented by the same Pipelines row.
* **Interpretation:** Databricks reports this value on the Pipeline Permission object returned for Pipelines; it is interpreted at one Pipeline Permission record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `pipelines.permissions.service_principal_name`
Service Principal Name records service principal name granted the permission. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `service_principal_name` access value with the resource, account, or membership represented by the same Pipelines row.
* **Interpretation:** Databricks reports this value on the Pipeline Permission object returned for Pipelines; it is interpreted at one Pipeline Permission record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `pipelines.permissions.user_name`
User Name records username granted the permission. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `user_name` access value with the resource, account, or membership represented by the same Pipelines row.
* **Interpretation:** Databricks reports this value on the Pipeline Permission object returned for Pipelines; it is interpreted at one Pipeline Permission record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `pipelines.photon`
Photon records whether Photon acceleration is enabled for the pipeline. It is needed to distinguish Pipelines rows by the exact Databricks-returned photon value.
* **Enables:** select Pipelines rows where `photon` is true or false when comparing the condition described by Photon.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.pipeline_id`
Pipeline ID records unique identifier for the pipeline. It is needed to distinguish repeated deliveries of the same Pipelines row using the declared ingestion key.
* **Enables:** use `pipeline_id` as the declared ingestion deduplication key for Pipelines and match repeated rows carrying the same Databricks identifier.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `pipelines.run_as_user_name`
Run As User Name records username of the user the pipeline runs as. It is needed to attribute this Pipelines row to the returned person, account, or organization reference.
* **Enables:** attribute the Pipelines row to the returned person or account and match the exact `run_as_user_name` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row.
Developer identifier: `pipelines.serverless`
Serverless records whether the pipeline uses serverless compute. It is needed to distinguish Pipelines rows by the exact Databricks-returned serverless value.
* **Enables:** select Pipelines rows where `serverless` is true or false when comparing the condition described by Serverless.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.spec`
Spec records full pipeline specification/definition. It is needed to preserve the nested spec relationship or details on the parent Pipeline record.
* **Enables:** expand `spec` to connect the containing Pipeline row to its returned spec entries.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is one nested object per containing Pipeline object when present.
Developer identifier: `pipelines.spec.budget_policy_id`
Budget Policy ID records budget policy ID. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `budget_policy_id` access value with the resource, account, or membership represented by the same Pipelines row.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `pipelines.spec.catalog`
Catalog records Unity Catalog name. It is needed to compare the returned catalog for individual Pipelines rows and select rows with a specific `catalog` value.
* **Enables:** trace the catalog relationship returned in `catalog` from the Pipeline Spec row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is interpreted at one Pipeline Spec record per row.
Developer identifier: `pipelines.spec.channel`
Channel records release channel. It is needed to inventory the exact Databricks-reported configuration or classification represented by this field.
* **Enables:** compare `channel` among Pipelines records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is interpreted at one Pipeline Spec record per row; the value is a Databricks-returned or configured label at the Pipeline Spec grain rather than a universal taxonomy.
Developer identifier: `pipelines.spec.clusters`
Clusters records cluster configurations. It is needed to preserve the nested clusters relationship or details on the parent Pipeline Spec record.
* **Enables:** expand `clusters` to connect the containing Pipeline Spec row to its returned clusters entries.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is one returned collection per containing Pipeline Spec object.
Developer identifier: `pipelines.spec.configuration`
Configuration records pipeline configuration key-value pairs. It is needed to compare the exact configuration configuration returned for this Pipeline Spec record.
* **Enables:** compare the exact `configuration` configuration returned for each Pipeline Spec record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is interpreted at one Pipeline Spec record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `pipelines.spec.continuous`
Continuous records whether the pipeline runs continuously. It is needed to distinguish Pipelines rows by the exact Databricks-returned continuous value.
* **Enables:** select Pipelines rows where `continuous` is true or false when comparing the condition described by Continuous.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is interpreted at one Pipeline Spec record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.spec.development`
Development records whether the pipeline is in development mode. It is needed to distinguish Pipelines rows by the exact Databricks-returned development value.
* **Enables:** select Pipelines rows where `development` is true or false when comparing the condition described by Development.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is interpreted at one Pipeline Spec record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.spec.edition`
Edition records product edition. It is needed to compare the exact edition configuration returned for this Pipeline Spec record.
* **Enables:** compare the exact `edition` configuration returned for each Pipeline Spec record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is interpreted at one Pipeline Spec record per row.
Developer identifier: `pipelines.spec.filters`
Filters records dataset filters. It is needed to preserve the nested filters relationship or details on the parent Pipeline Spec record.
* **Enables:** expand `filters` to connect the containing Pipeline Spec row to its returned filters entries.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is one nested object per containing Pipeline Spec object when present.
Developer identifier: `pipelines.spec.id`
ID records pipeline ID in the spec. It is needed to refer to the same pipeline spec across records without relying on display text.
* **Enables:** match `id` to pipeline spec references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is an identifier, not a measured quantity.
Developer identifier: `pipelines.spec.libraries`
Libraries records library configurations. It is needed to preserve the nested libraries relationship or details on the parent Pipeline Spec record.
* **Enables:** expand `libraries` to connect the containing Pipeline Spec row to its returned libraries entries.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is one returned collection per containing Pipeline Spec object.
Developer identifier: `pipelines.spec.name`
Name records pipeline name in the spec. It is needed to compare the returned name for individual Pipelines rows and select rows with a specific `name` value.
* **Enables:** locate Pipelines rows whose returned name exactly matches `name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is interpreted at one Pipeline Spec record per row.
Developer identifier: `pipelines.spec.notifications`
Notifications records notification configurations. It is needed to preserve the nested notifications relationship or details on the parent Pipeline Spec record.
* **Enables:** expand `notifications` to connect the containing Pipeline Spec row to its returned notifications entries.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is one returned collection per containing Pipeline Spec object.
Developer identifier: `pipelines.spec.photon`
Photon records whether Photon is enabled. It is needed to distinguish Pipelines rows by the exact Databricks-returned photon value.
* **Enables:** select Pipelines rows where `photon` is true or false when comparing the condition described by Photon.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is interpreted at one Pipeline Spec record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.spec.serverless`
Serverless records whether serverless compute is used. It is needed to distinguish Pipelines rows by the exact Databricks-returned serverless value.
* **Enables:** select Pipelines rows where `serverless` is true or false when comparing the condition described by Serverless.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is interpreted at one Pipeline Spec record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.spec.storage`
Storage records root storage location. It is needed to retain the exact Databricks resource or external link reported for this Pipelines record.
* **Enables:** open or correlate the resource named by `storage` while retaining the containing Pipeline Spec row as provenance.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is interpreted at one Pipeline Spec record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pipelines.spec.target`
Target records target schema or database. It is needed to inventory the exact Databricks-reported configuration or classification represented by this field.
* **Enables:** compare `target` among Pipelines records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Databricks reports this value on the Pipeline Spec object returned for Pipelines; it is interpreted at one Pipeline Spec record per row; the value is a Databricks-returned or configured label at the Pipeline Spec grain rather than a universal taxonomy.
Developer identifier: `pipelines.state`
State records current state of the pipeline. It is needed to distinguish Pipelines rows by the exact Databricks-returned state value.
* **Enables:** separate Pipelines rows by the exact Databricks-returned `state` label when comparing state.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.storage`
Storage records root storage location for the pipeline data. It is needed to retain the exact Databricks resource or external link reported for this Pipelines record.
* **Enables:** open or correlate the resource named by `storage` while retaining the containing Pipeline row as provenance.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pipelines.target`
Target records target schema or database for the pipeline output. It is needed to inventory the exact Databricks-reported configuration or classification represented by this field.
* **Enables:** compare `target` among Pipelines records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is interpreted at one Pipeline record per row; the value is a Databricks-returned or configured label at the Pipeline grain rather than a universal taxonomy.
Developer identifier: `pipelines.url`
URL records URL to the pipeline in the Databricks workspace UI. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Databricks resource referenced by `url` while retaining the containing Pipelines record as provenance.
* **Interpretation:** Databricks reports this value on the Pipeline object returned for Pipelines; it is link at one Pipeline record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `query_history`
Query History covers SQL and serverless compute query execution history from system.query.history. Includes executor identity, statement text, timing, client application, and `query_source` linkage to notebooks, jobs, and dashboards. Queried via the SQL Statement Execution API. Requires USE CATALOG on system, USE SCHEMA on system.query, and SELECT on system.query.history.
* **Enables:** correlate each returned statement with its executor, compute resource, status, row counts, and execution times.
* **Scope:** SQL and serverless compute query execution history from system.query.history. Includes executor identity, statement text, timing, client application, and `query_source` linkage to notebooks, jobs, and dashboards. Queried via the SQL Statement Execution API. Requires USE CATALOG on system, USE SCHEMA on system.query, and SELECT on system.query.history; the connector reads `/api/2.0/sql/statements` as an event stream in incremental mode. The configured credential must grant the declared `all-apis` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the Databricks record was deleted.
Developer identifier: `query_history.account_id`
Account ID records Databricks account ID. It is needed to refer to the same account across records without relying on display text.
* **Enables:** match `account_id` to account references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is an identifier, not a measured quantity.
Developer identifier: `query_history.client_application`
Client Application records client application that submitted the query. It is needed to inventory the exact Databricks-reported configuration or classification represented by this field.
* **Enables:** compare `client_application` among Query History records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is interpreted at one Databricks Query History record per row; the value is a Databricks-returned or configured label at the Databricks Query History grain rather than a universal taxonomy.
Developer identifier: `query_history.client_driver`
Client Driver records connector or driver used to run the query. It is needed to inventory the exact Databricks-reported configuration or classification represented by this field.
* **Enables:** compare `client_driver` among Query History records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is interpreted at one Databricks Query History record per row; the value is a Databricks-returned or configured label at the Databricks Query History grain rather than a universal taxonomy.
Developer identifier: `query_history.compute`
Compute records compute resource used to run the statement. It is needed to preserve the nested compute relationship or details on the parent Databricks Query History record.
* **Enables:** expand `compute` to connect the containing Databricks Query History row to its returned compute entries.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is one nested object per containing Databricks Query History object when present.
Developer identifier: `query_history.compute.cluster_id`
Cluster ID records cluster ID when applicable. It is needed to refer to the same cluster across records without relying on display text.
* **Enables:** match `cluster_id` to cluster references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Query Compute object returned for Query History; it is an identifier, not a measured quantity.
Developer identifier: `query_history.compute.type`
Type records WAREHOUSE or `SERVERLESS_COMPUTE`. It is needed to distinguish Query History rows by the exact Databricks-returned type value.
* **Enables:** separate Query History rows by the exact Databricks-returned `type` label when comparing type.
* **Interpretation:** Databricks reports this value on the Databricks Query Compute object returned for Query History; it is interpreted at one Databricks Query Compute record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `query_history.compute.warehouse_id`
Warehouse ID records SQL warehouse ID when applicable. It is needed to refer to the same warehouse across records without relying on display text.
* **Enables:** match `warehouse_id` to warehouse references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Query Compute object returned for Query History; it is an identifier, not a measured quantity.
Developer identifier: `query_history.end_time`
End Time records UTC timestamp when execution ended. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Query History records by `end_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is interpreted at one Databricks Query History record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `query_history.error_message`
Error Message records error message when execution failed. It is needed to inspect the exact error message included with this record.
* **Enables:** inspect the error message returned in `error_message` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is error message at one Databricks Query History record per row; this is only the content included in the Databricks response for this record.
Developer identifier: `query_history.executed_as`
Executed As records user or service principal whose privilege was used. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `executed_as` access value with the resource, account, or membership represented by the same Query History row.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is interpreted at one Databricks Query History record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `query_history.executed_as_user_id`
Executed As User ID records ID of the executed-as principal. It is needed to refer to the same executed as user across records without relying on display text.
* **Enables:** match `executed_as_user_id` to executed as user references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is an identifier, not a measured quantity.
Developer identifier: `query_history.executed_by`
Executed By records email or username of the user who ran the statement. It is needed to attribute this Query History row to the returned person, account, or organization reference.
* **Enables:** attribute the Query History row to the returned person or account and match the exact `executed_by` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is interpreted at one Databricks Query History record per row.
Developer identifier: `query_history.executed_by_user_id`
Executed By User ID records user ID of the executor. It is needed to refer to the same executed by user across records without relying on display text.
* **Enables:** match `executed_by_user_id` to executed by user references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is an identifier, not a measured quantity.
Developer identifier: `query_history.execution_duration_ms`
Execution Duration Ms records time spent executing the statement in milliseconds. It is needed to measure the exact duration reported for one Databricks Query History record using the Databricks duration encoding described by the field.
* **Enables:** measure and compare `execution_duration_ms` per Databricks Query History record in milliseconds.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; its unit or granularity is milliseconds.
Developer identifier: `query_history.execution_status`
Execution Status records FINISHED, FAILED, or CANCELED. It is needed to distinguish Query History rows by the exact Databricks-returned execution status value.
* **Enables:** separate Query History rows by the exact Databricks-returned `execution_status` label when comparing execution status.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is interpreted at one Databricks Query History record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `query_history.produced_rows`
Produced Rows records rows returned by the statement. It is needed to measure the Databricks-reported number of produced rows at one Databricks Query History record per row.
* **Enables:** measure and compare the Databricks-reported number of produced rows in `produced_rows` at one Databricks Query History record per row.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is a Databricks-reported count at one Databricks Query History record per row.
Developer identifier: `query_history.query_source`
Query Source records Databricks entities involved in the query execution (JSON string under the `JSON_ARRAY` result format). It is needed to distinguish Query History rows by the exact Databricks-returned query source value.
* **Enables:** separate Query History rows by the exact Databricks-returned `query_source` label when comparing query source.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is interpreted at one Databricks Query History record per row; the schema uses the `Generic.JSON` scalar; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `query_history.query_tags`
Query Tags records custom key-value tags applied to the query. It is needed to distinguish Query History rows by the exact Databricks-returned query tags value.
* **Enables:** separate Query History rows by the exact Databricks-returned `query_tags` label when comparing query tags.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is interpreted at one Databricks Query History record per row; the schema uses the `Generic.JSON` scalar; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `query_history.read_rows`
Read Rows records rows read by the statement. It is needed to measure the Databricks-reported number of read rows at one Databricks Query History record per row.
* **Enables:** measure and compare the Databricks-reported number of read rows in `read_rows` at one Databricks Query History record per row.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is a Databricks-reported count at one Databricks Query History record per row.
Developer identifier: `query_history.session_id`
Session ID records spark session ID. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `session_id` access value with the resource, account, or membership represented by the same Query History row.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `query_history.start_time`
Start Time records UTC timestamp when execution started. Incremental sync cursor. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Query History records by `start_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is interpreted at one Databricks Query History record per row; the connector also declares it for record ordering; the schema assigns the `event_time` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `query_history.statement_id`
Statement ID records unique statement execution identifier. It is needed to distinguish repeated deliveries of the same Query History row using the declared ingestion key.
* **Enables:** use `statement_id` as the declared ingestion deduplication key for Query History and match repeated rows carrying the same Databricks identifier.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `query_history.statement_text`
Statement Text records SQL statement text. May be empty when customer-managed keys encrypt system table fields. It is needed to inspect the exact SQL statement text included with this record.
* **Enables:** inspect the SQL statement text returned in `statement_text` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is SQL statement text at one Databricks Query History record per row; availability and any truncation follow the limitation stated in the field description.
Developer identifier: `query_history.statement_type`
Statement Type records statement type such as SELECT or INSERT. It is needed to distinguish Query History rows by the exact Databricks-returned statement type value.
* **Enables:** separate Query History rows by the exact Databricks-returned `statement_type` label when comparing statement type.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is interpreted at one Databricks Query History record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `query_history.total_duration_ms`
Total Duration Ms records total execution duration in milliseconds. It is needed to measure the exact duration reported for one Databricks Query History record using the Databricks duration encoding described by the field.
* **Enables:** measure and compare `total_duration_ms` per Databricks Query History record in milliseconds.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; its unit or granularity is milliseconds.
Developer identifier: `query_history.update_time`
Update Time records last progress update timestamp. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Query History records by `update_time`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is interpreted at one Databricks Query History record per row; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `query_history.workspace_id`
Workspace ID records workspace where the query ran. It is needed to refer to the same workspace across records without relying on display text.
* **Enables:** match `workspace_id` to workspace references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Query History object returned for Query History; it is an identifier, not a measured quantity.
Developer identifier: `schemas`
Schemas covers schemas within a specified Unity Catalog catalog. Requires `catalog_name` as a parent context field. Provides schema metadata including name, owner, and properties.
* **Enables:** connect each returned schema to its parent catalog and compare its owner, storage reference, and browse-only or maintenance flags.
* **Scope:** Lists all schemas within a specified Unity Catalog catalog. Requires `catalog_name` as a parent context field. Provides schema metadata including name, owner, and properties; the connector reads `/api/2.1/unity-catalog/schemas` as a snapshot stream in full mode. The configured credential must grant the declared `all-apis` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the Databricks record was deleted.
Developer identifier: `schemas._parent_catalog_name`
Parent Catalog Name records parent catalog name injected by the catalogs to schemas traversal parentContextFields. Not part of the upstream API response. It is needed to compare the returned parent catalog name for individual Schemas rows and select rows with a specific `_parent_catalog_name` value.
* **Enables:** locate Schemas rows whose returned parent catalog name exactly matches `_parent_catalog_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks's child response does not supply this field; the connector injects parent context into each child row; it is interpreted at one Databricks Schema record per row.
Developer identifier: `schemas.browse_only`
Browse Only indicates whether the principal can only browse the schema metadata but cannot access its tables or views. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Schemas rows with the exact `browse_only` access-related value being investigated.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `schemas.cache_version_info`
Cache Version Info records the cache version info details attached to this Schemas record. It is needed to preserve the nested cache version info relationship or details on the parent Databricks Schema record.
* **Enables:** expand `cache_version_info` to connect the containing Databricks Schema row to its returned cache version info entries.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is one nested object per containing Databricks Schema object when present.
Developer identifier: `schemas.cache_version_info.metastore_version`
Metastore Version records metastore version cached for this object. It is needed to compare the exact metastore version configuration returned for this Cache Version Info record.
* **Enables:** compare the exact `metastore_version` configuration returned for each Cache Version Info record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Cache Version Info object returned for Schemas; it is interpreted at one Cache Version Info record per row.
Developer identifier: `schemas.catalog_name`
Catalog Name records name of the parent catalog that contains this schema. It is needed to compare the returned catalog name for individual Schemas rows and select rows with a specific `catalog_name` value.
* **Enables:** locate Schemas rows whose returned catalog name exactly matches `catalog_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row.
Developer identifier: `schemas.catalog_type`
Catalog Type records type of the parent catalog (e.g., `MANAGED_CATALOG`, `DELTASHARING_CATALOG`). It is needed to distinguish Schemas rows by the exact Databricks-returned catalog type value.
* **Enables:** separate Schemas rows by the exact Databricks-returned `catalog_type` label when comparing catalog type.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `schemas.comment`
Comment records user-provided comment or description for the schema. It is needed to inspect the exact comment or journal text included with this record.
* **Enables:** inspect the comment or journal text returned in `comment` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is comment or journal text at one Databricks Schema record per row; this is only the content included in the Databricks response for this record.
Developer identifier: `schemas.created_at`
Created At records timestamp in epoch milliseconds when the schema was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Schemas records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `schemas.created_by`
Created By records username or principal that created the schema. It is needed to attribute this Schemas row to the returned person, account, or organization reference.
* **Enables:** attribute the Schemas row to the returned person or account and match the exact `created_by` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row.
Developer identifier: `schemas.effective_auto_maintenance_flag`
Effective Auto Maintenance Flag records the effective auto maintenance flag details attached to this Schemas record. It is needed to preserve the nested effective auto maintenance flag relationship or details on the parent Databricks Schema record.
* **Enables:** expand `effective_auto_maintenance_flag` to connect the containing Databricks Schema row to its returned effective auto maintenance flag entries.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is one nested object per containing Databricks Schema object when present.
Developer identifier: `schemas.effective_auto_maintenance_flag.inherited_from_name`
Inherited From Name records the inherited from name supplied for this Schemas record by Databricks. It is needed to compare the returned inherited from name for individual Schemas rows and select rows with a specific `inherited_from_name` value.
* **Enables:** locate Schemas rows whose returned inherited from name exactly matches `inherited_from_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Effective Auto Maintenance Flag object returned for Schemas; it is interpreted at one Effective Auto Maintenance Flag record per row.
Developer identifier: `schemas.effective_auto_maintenance_flag.inherited_from_type`
Inherited From Type records the inherited from type supplied for this Schemas record by Databricks. It is needed to distinguish Schemas rows by the exact Databricks-returned inherited from type value.
* **Enables:** separate Schemas rows by the exact Databricks-returned `inherited_from_type` label when comparing inherited from type.
* **Interpretation:** Databricks reports this value on the Effective Auto Maintenance Flag object returned for Schemas; it is interpreted at one Effective Auto Maintenance Flag record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `schemas.effective_auto_maintenance_flag.value`
Value records the effective auto maintenance flag value supplied for this Schemas record by Databricks. It is needed to interpret the effective Databricks automatic-maintenance setting returned for this schema.
* **Enables:** combine `value` with the sibling inheritance source type and name to explain the effective schema-maintenance setting.
* **Interpretation:** Databricks reports this value on the Effective Auto Maintenance Flag object returned for Schemas; it is interpreted at one Effective Auto Maintenance Flag record per row; the value is a Databricks setting and inheritance result, not proof that maintenance work executed.
Developer identifier: `schemas.effective_predictive_optimization_flag`
Effective Predictive Optimization Flag records effective predictive optimization settings inherited or set on this schema. It is needed to preserve the nested effective predictive optimization flag relationship or details on the parent Databricks Schema record.
* **Enables:** expand `effective_predictive_optimization_flag` to connect the containing Databricks Schema row to its returned effective predictive optimization flag entries.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is one nested object per containing Databricks Schema object when present.
Developer identifier: `schemas.effective_predictive_optimization_flag.inherited_from_name`
Inherited From Name records the name of the object from which this flag was inherited. It is needed to compare the returned inherited from name for individual Schemas rows and select rows with a specific `inherited_from_name` value.
* **Enables:** locate Schemas rows whose returned inherited from name exactly matches `inherited_from_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Effective Predictive Optimization object returned for Schemas; it is interpreted at one Effective Predictive Optimization record per row.
Developer identifier: `schemas.effective_predictive_optimization_flag.inherited_from_type`
Inherited From Type records the type of the object from which this flag was inherited (e.g., CATALOG, SCHEMA). It is needed to distinguish Schemas rows by the exact Databricks-returned inherited from type value.
* **Enables:** separate Schemas rows by the exact Databricks-returned `inherited_from_type` label when comparing inherited from type.
* **Interpretation:** Databricks reports this value on the Effective Predictive Optimization object returned for Schemas; it is interpreted at one Effective Predictive Optimization record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `schemas.effective_predictive_optimization_flag.value`
Value records the effective value of the predictive optimization flag. It is needed to distinguish Schemas rows by the exact Databricks-returned value value.
* **Enables:** separate Schemas rows by the exact Databricks-returned `value` label when comparing value.
* **Interpretation:** Databricks reports this value on the Effective Predictive Optimization object returned for Schemas; it is interpreted at one Effective Predictive Optimization record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `schemas.enable_auto_maintenance`
Enable Auto Maintenance records whether auto-maintenance is enabled, disabled, or inherited. It is needed to distinguish Schemas rows by the exact Databricks-returned enable auto maintenance value.
* **Enables:** select Schemas rows where `enable_auto_maintenance` is true or false when comparing the condition described by Enable Auto Maintenance.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `schemas.enable_predictive_optimization`
Enable Predictive Optimization records whether predictive optimization is enabled, disabled, or inherited for this schema. It is needed to distinguish Schemas rows by the exact Databricks-returned enable predictive optimization value.
* **Enables:** select Schemas rows where `enable_predictive_optimization` is true or false when comparing the condition described by Enable Predictive Optimization.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `schemas.etag`
ETag records entity tag for optimistic concurrency. It is needed to correlate the Databricks object version used for optimistic concurrency.
* **Enables:** compare `etag` across observations of the same Databricks Schema identifier to detect a returned version change before a conditional update.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row; the entity tag is a version token, not a timestamp or proof that every intermediate update was observed.
Developer identifier: `schemas.full_name`
Full Name records full name of the schema in the format `catalog_name`.`schema_name`. It is needed to distinguish repeated deliveries of the same Schemas row using the declared ingestion key.
* **Enables:** use `full_name` as the declared ingestion deduplication key for Schemas and match repeated rows carrying the same Databricks identifier.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row; the connector declares it as an ingestion deduplication key.
Developer identifier: `schemas.metastore_id`
Metastore ID records unique identifier of the metastore that contains this schema. It is needed to refer to the same metastore across records without relying on display text.
* **Enables:** match `metastore_id` to metastore references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is an identifier, not a measured quantity.
Developer identifier: `schemas.metastore_version`
Metastore Version records metastore version associated with this schema record. It is needed to compare the exact metastore version configuration returned for this Databricks Schema record.
* **Enables:** compare the exact `metastore_version` configuration returned for each Databricks Schema record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row.
Developer identifier: `schemas.name`
Name records name of the schema. It is needed to compare the returned name for individual Schemas rows and select rows with a specific `name` value.
* **Enables:** locate Schemas rows whose returned name exactly matches `name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row.
Developer identifier: `schemas.owner`
Owner records owner of the schema (user or group). It is needed to attribute this Schemas row to the returned person, account, or organization reference.
* **Enables:** attribute the Schemas row to the returned person or account and match the exact `owner` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row.
Developer identifier: `schemas.properties`
Properties records key-value properties associated with the schema. Contains arbitrary metadata. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `properties` and associate them with the containing Schemas record.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row; the schema uses the `Generic.JSON` scalar; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `schemas.provisioning_info`
Provisioning Info records provisioning status information for the schema. It is needed to preserve the nested provisioning info relationship or details on the parent Databricks Schema record.
* **Enables:** expand `provisioning_info` to connect the containing Databricks Schema row to its returned provisioning info entries.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is one nested object per containing Databricks Schema object when present.
Developer identifier: `schemas.provisioning_info.state`
State records current provisioning state. It is needed to distinguish Schemas rows by the exact Databricks-returned state value.
* **Enables:** separate Schemas rows by the exact Databricks-returned `state` label when comparing state.
* **Interpretation:** Databricks reports this value on the Provisioning Info object returned for Schemas; it is interpreted at one Provisioning Info record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `schemas.related_entity_hints`
Related Entity Hints records the related entity hints details attached to this Schemas record. It is needed to preserve the nested related entity hints relationship or details on the parent Databricks Schema record.
* **Enables:** expand `related_entity_hints` to connect the containing Databricks Schema row to its returned related entity hints entries.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is one nested object per containing Databricks Schema object when present.
Provider-defined fields may also be returned for this field.
Developer identifier: `schemas.related_entity_hints.related_entity_id`
Related Entity ID records identifier of the related entity. It is needed to refer to the same related entity across records without relying on display text.
* **Enables:** match `related_entity_id` to related entity references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Related Entity Hints object returned for Schemas; it is an identifier, not a measured quantity.
Developer identifier: `schemas.related_entity_hints.related_entity_type`
Related Entity Type records type of the related entity. It is needed to distinguish Schemas rows by the exact Databricks-returned related entity type value.
* **Enables:** separate Schemas rows by the exact Databricks-returned `related_entity_type` label when comparing related entity type.
* **Interpretation:** Databricks reports this value on the Related Entity Hints object returned for Schemas; it is interpreted at one Related Entity Hints record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `schemas.schema_id`
Schema ID records unique identifier of the schema. It is needed to refer to the same schema across records without relying on display text.
* **Enables:** match `schema_id` to schema references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is an identifier, not a measured quantity.
Developer identifier: `schemas.securable_kind`
Securable Kind records the kind of the securable object. It is needed to distinguish Schemas rows by the exact Databricks-returned securable kind value.
* **Enables:** separate Schemas rows by the exact Databricks-returned `securable_kind` label when comparing securable kind.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `schemas.securable_type`
Securable Type records the type of the securable object. It is needed to distinguish Schemas rows by the exact Databricks-returned securable type value.
* **Enables:** separate Schemas rows by the exact Databricks-returned `securable_type` label when comparing securable type.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `schemas.storage_location`
Storage Location records storage location URL for the schema. It is needed to preserve the Databricks-reported resource location link for the same record.
* **Enables:** correlate the Databricks resource link in `storage_location` with its containing Databricks Schema row without treating the resource path as a statement of data residency.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row; the schema uses the `Network.Uri` scalar; the value is resource location link; this Databricks-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `schemas.storage_root`
Storage Root records storage root URL for managed tables within this schema. It is needed to retain the exact Databricks resource or external link reported for this Schemas record.
* **Enables:** open or correlate the resource named by `storage_root` while retaining the containing Databricks Schema row as provenance.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `schemas.updated_at`
Updated At records timestamp in epoch milliseconds when the schema was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Schemas records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; its unit or granularity is epoch milliseconds; the connector also declares it for record ordering; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `schemas.updated_by`
Updated By records username or principal that last updated the schema. It is needed to attribute this Schemas row to the returned person, account, or organization reference.
* **Enables:** attribute the Schemas row to the returned person or account and match the exact `updated_by` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Databricks Schema object returned for Schemas; it is interpreted at one Databricks Schema record per row.
Developer identifier: `service_principals`
Service Principals covers service principals in the Databricks workspace via the SCIM v2 API. Provides service principal identity and entitlement information.
* **Enables:** map the Databricks accounts and memberships represented by Service Principals records and trace a returned access assignment to its account or group.
* **Scope:** Lists all service principals in the Databricks workspace via the SCIM v2 API. Provides service principal identity and entitlement information; the connector reads `/api/{apiVersion}/preview/scim/v2/ServicePrincipals` as a snapshot stream in full mode. The configured credential must grant the declared `all-apis` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the Databricks record was deleted.
Developer identifier: `service_principals.active`
Active records whether the service principal is currently active and allowed to authenticate. It is needed to distinguish Service Principals rows by the exact Databricks-returned active value.
* **Enables:** select Service Principals rows where `active` is true or false when comparing the condition described by Active.
* **Interpretation:** Databricks reports this value on the Service Principal object returned for Service Principals; it is interpreted at one Service Principal record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `service_principals.applicationId`
Application ID records the application (client) ID of the service principal, typically a UUID matching the Azure AD or Databricks application registration. It is needed to refer to the same application across records without relying on display text.
* **Enables:** match `applicationId` to application references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Service Principal object returned for Service Principals; it is an identifier, not a measured quantity.
Developer identifier: `service_principals.displayName`
Display Name records human-readable display name of the service principal. It is needed to attribute this Service Principals row to the returned person, account, or organization reference.
* **Enables:** attribute the Service Principals row to the returned person or account and match the exact `displayName` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Service Principal object returned for Service Principals; it is interpreted at one Service Principal record per row.
Developer identifier: `service_principals.entitlements`
Entitlements records array of entitlements (feature permissions) assigned to the service principal, such as workspace-access or databricks-sql-access. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `entitlements` to examine the returned entitlements details for the containing Service Principal record.
* **Interpretation:** Databricks reports this value on the Service Principal object returned for Service Principals; it is one returned collection per containing Service Principal object; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `service_principals.entitlements.value`
Value records the entitlement identifier string (e.g., workspace-access, databricks-sql-access, allow-cluster-create). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `value` access value with the resource, account, or membership represented by the same Service Principals row.
* **Interpretation:** Databricks reports this value on the Entitlement Value object returned for Service Principals; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `service_principals.externalId`
External ID records external identifier for the service principal, often set by an external identity provider or SCIM provisioning client. It is needed to refer to the same external across records without relying on display text.
* **Enables:** match `externalId` to external references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Service Principal object returned for Service Principals; it is an identifier, not a measured quantity.
Developer identifier: `service_principals.groups`
Groups records array of groups the service principal belongs to. It is needed to preserve the nested groups relationship or details on the parent Service Principal record.
* **Enables:** expand `groups` to connect the containing Service Principal row to its returned groups entries.
* **Interpretation:** Databricks reports this value on the Service Principal object returned for Service Principals; it is one returned collection per containing Service Principal object.
Developer identifier: `service_principals.groups.$ref`
Resource Reference records the URI reference for the group resource. It is needed to retain the exact Databricks resource or external link reported for this Service Principals record.
* **Enables:** open or correlate the resource named by `$ref` while retaining the containing Group Reference row as provenance.
* **Interpretation:** Databricks reports this value on the Group Reference object returned for Service Principals; it is interpreted at one Group Reference record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `service_principals.groups.display`
Display records the display name of the group. It is needed to compare the returned display for individual Service Principals rows and select rows with a specific `display` value.
* **Enables:** locate Service Principals rows whose returned display exactly matches `display` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Group Reference object returned for Service Principals; it is interpreted at one Group Reference record per row.
Developer identifier: `service_principals.groups.type`
Type records the type of group membership (e.g., direct). It is needed to distinguish Service Principals rows by the exact Databricks-returned type value.
* **Enables:** separate Service Principals rows by the exact Databricks-returned `type` label when comparing type.
* **Interpretation:** Databricks reports this value on the Group Reference object returned for Service Principals; it is interpreted at one Group Reference record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `service_principals.groups.value`
Value records the SCIM id of the group. It is needed to link the service-principal relationship to the exact Databricks SCIM group.
* **Enables:** match `value` to the Databricks group record carrying the same SCIM identifier.
* **Interpretation:** Databricks reports this value on the Group Reference object returned for Service Principals; it is interpreted at one Group Reference record per row; the value is a Databricks SCIM group identifier, not a display name or measured quantity.
Developer identifier: `service_principals.id`
ID records unique SCIM identifier for the service principal within the Databricks workspace. It is needed to distinguish repeated deliveries of the same Service Principals row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Service Principals and match repeated rows carrying the same Databricks identifier.
* **Interpretation:** Databricks reports this value on the Service Principal object returned for Service Principals; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `service_principals.roles`
Roles records array of workspace-level roles assigned to the service principal. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `roles` to examine the returned roles details for the containing Service Principal record.
* **Interpretation:** Databricks reports this value on the Service Principal object returned for Service Principals; it is one returned collection per containing Service Principal object; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `service_principals.roles.type`
Type records the type qualifier for the role assignment. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Service Principals rows with the exact `type` access-related value being investigated.
* **Interpretation:** Databricks reports this value on the Role Value object returned for Service Principals; it is interpreted at one Role Value record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `service_principals.roles.value`
Value records the role identifier string. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `value` access value with the resource, account, or membership represented by the same Service Principals row.
* **Interpretation:** Databricks reports this value on the Role Value object returned for Service Principals; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `service_principals.schemas`
Schemas records list of SCIM schema URNs that apply to this resource (e.g., urn:ietf:params:scim:schemas:core:2.0:ServicePrincipal). It is needed to preserve the nested schemas relationship or details on the parent Service Principal record.
* **Enables:** expand `schemas` to connect the containing Service Principal row to its returned schemas entries.
* **Interpretation:** Databricks reports this value on the Service Principal object returned for Service Principals; it is one returned collection per containing Service Principal object.
Developer identifier: `sql_warehouses`
SQL Warehouses covers SQL warehouses in the Databricks workspace. Provides SQL warehouse configuration, state, and sizing details.
* **Enables:** compare returned SQL warehouse configuration, size, state, creator, and operating times.
* **Scope:** Lists all SQL warehouses in the Databricks workspace. Provides SQL warehouse configuration, state, and sizing details; the connector reads `/api/{apiVersion}/sql/warehouses` as a snapshot stream in full mode. The configured credential must grant the declared `all-apis` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the Databricks record was deleted.
Developer identifier: `sql_warehouses.auto_resume`
Auto Resume records whether the warehouse automatically resumes when a SQL statement is submitted. It is needed to distinguish SQL Warehouses rows by the exact Databricks-returned auto resume value.
* **Enables:** select SQL Warehouses rows where `auto_resume` is true or false when comparing the condition described by Auto Resume.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is interpreted at one SQL Warehouse record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `sql_warehouses.auto_stop_mins`
Auto Stop Mins records minutes of inactivity before the warehouse auto-stops. 0 means auto-stop is disabled. It is needed to measure the reported auto stop mins for one sql warehouse record.
* **Enables:** measure and compare `auto_stop_mins` per SQL Warehouse record in minutes.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; its unit or granularity is minutes.
Developer identifier: `sql_warehouses.channel`
Channel records release channel configuration for the warehouse. It is needed to preserve the nested channel relationship or details on the parent SQL Warehouse record.
* **Enables:** expand `channel` to connect the containing SQL Warehouse row to its returned channel entries.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is one nested object per containing SQL Warehouse object when present.
Developer identifier: `sql_warehouses.channel.dbsql_version`
Dbsql Version records the DBSQL version associated with this channel. It is needed to compare the exact dbsql version configuration returned for this Channel record.
* **Enables:** compare the exact `dbsql_version` configuration returned for each Channel record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Channel object returned for SQL Warehouses; it is interpreted at one Channel record per row.
Developer identifier: `sql_warehouses.channel.name`
Name records name of the release channel. It is needed to distinguish SQL Warehouses rows by the exact Databricks-returned name value.
* **Enables:** separate SQL Warehouses rows by the exact Databricks-returned `name` label when comparing name.
* **Interpretation:** Databricks reports this value on the Channel object returned for SQL Warehouses; it is interpreted at one Channel record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `sql_warehouses.cluster_size`
Cluster Size records size of the warehouse cluster (e.g., 2X-Small, X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large, 4X-Large). It is needed to compare the Databricks-reported compute size selected for the warehouse.
* **Enables:** filter SQL Warehouses by the exact `cluster_size` size label when reconciling configured warehouse capacity.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is interpreted at one SQL Warehouse record per row; the value is a Databricks size class rather than a direct core, memory, performance, or cost measurement.
Developer identifier: `sql_warehouses.creator_id`
Creator ID records unique identifier of the user who created the warehouse. It is needed to refer to the same creator across records without relying on display text.
* **Enables:** match `creator_id` to creator references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is an identifier, not a measured quantity.
Developer identifier: `sql_warehouses.creator_name`
Creator Name records username or email of the user who created the warehouse. It is needed to attribute this SQL Warehouses row to the returned person, account, or organization reference.
* **Enables:** attribute the SQL Warehouses row to the returned person or account and match the exact `creator_name` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is interpreted at one SQL Warehouse record per row.
Developer identifier: `sql_warehouses.data_source_id`
Data Source ID records data source ID used for internal references. It is needed to refer to the same data source across records without relying on display text.
* **Enables:** match `data_source_id` to data source references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is an identifier, not a measured quantity; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `sql_warehouses.enable_photon`
Enable Photon records whether the Photon query engine is enabled. It is needed to distinguish SQL Warehouses rows by the exact Databricks-returned enable photon value.
* **Enables:** select SQL Warehouses rows where `enable_photon` is true or false when comparing the condition described by Enable Photon.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is interpreted at one SQL Warehouse record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `sql_warehouses.enable_serverless_compute`
Enable Serverless Compute records whether serverless compute is enabled for this warehouse. It is needed to distinguish SQL Warehouses rows by the exact Databricks-returned enable serverless compute value.
* **Enables:** select SQL Warehouses rows where `enable_serverless_compute` is true or false when comparing the condition described by Enable Serverless Compute.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is interpreted at one SQL Warehouse record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `sql_warehouses.health`
Health records health status information for the warehouse. It is needed to preserve the nested health relationship or details on the parent SQL Warehouse record.
* **Enables:** expand `health` to connect the containing SQL Warehouse row to its returned health entries.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is one nested object per containing SQL Warehouse object when present.
Developer identifier: `sql_warehouses.health.details`
Details records detailed health information. It is needed to inspect the exact health-detail text returned for this Warehouse Health record.
* **Enables:** attribute the health-detail text in `details` to the containing SQL Warehouses identifier, owner or author, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Warehouse Health object returned for SQL Warehouses; it is interpreted at one Warehouse Health record per row; this is only the health-detail text included in the Databricks response for this record.
Developer identifier: `sql_warehouses.health.failure_reason`
Failure Reason records details about a health failure, if applicable. It is needed to preserve the nested failure reason relationship or details on the parent Warehouse Health record.
* **Enables:** expand `failure_reason` to connect the containing Warehouse Health row to its returned failure reason entries.
* **Interpretation:** Databricks reports this value on the Warehouse Health object returned for SQL Warehouses; it is one nested object per containing Warehouse Health object when present.
Developer identifier: `sql_warehouses.health.failure_reason.code`
Code records error code for the failure reason. It is needed to distinguish SQL Warehouses rows by the exact Databricks-returned code value.
* **Enables:** separate SQL Warehouses rows by the exact Databricks-returned `code` label when comparing code.
* **Interpretation:** Databricks reports this value on the Health Failure Reason object returned for SQL Warehouses; it is interpreted at one Health Failure Reason record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `sql_warehouses.health.failure_reason.parameters`
Parameters records additional parameters providing context for the failure. It is needed to preserve the exact Databricks configuration or execution metadata attached to this Health Failure Reason record.
* **Enables:** inspect the keys in `parameters` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Databricks reports this value on the Health Failure Reason object returned for SQL Warehouses; it is interpreted at one Health Failure Reason record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Databricks response and can vary by resource type or configuration.
Developer identifier: `sql_warehouses.health.failure_reason.type`
Type records type classification of the failure. It is needed to distinguish SQL Warehouses rows by the exact Databricks-returned type value.
* **Enables:** separate SQL Warehouses rows by the exact Databricks-returned `type` label when comparing type.
* **Interpretation:** Databricks reports this value on the Health Failure Reason object returned for SQL Warehouses; it is interpreted at one Health Failure Reason record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `sql_warehouses.health.message`
Message records human-readable health status message. It is needed to inspect the exact status message included with this record.
* **Enables:** inspect the status message returned in `message` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Warehouse Health object returned for SQL Warehouses; it is status message at one Warehouse Health record per row; this is only the content included in the Databricks response for this record.
Developer identifier: `sql_warehouses.health.status`
Status records overall health status of the warehouse. It is needed to distinguish SQL Warehouses rows by the exact Databricks-returned status value.
* **Enables:** separate SQL Warehouses rows by the exact Databricks-returned `status` label when comparing status.
* **Interpretation:** Databricks reports this value on the Warehouse Health object returned for SQL Warehouses; it is interpreted at one Warehouse Health record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `sql_warehouses.health.summary`
Summary records summary of the warehouse health. It is needed to inspect the exact summary text included with this record.
* **Enables:** inspect the summary text returned in `summary` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Warehouse Health object returned for SQL Warehouses; it is summary text at one Warehouse Health record per row; this is only the content included in the Databricks response for this record.
Developer identifier: `sql_warehouses.id`
ID records unique identifier for the SQL warehouse. It is needed to distinguish repeated deliveries of the same SQL Warehouses row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for SQL Warehouses and match repeated rows carrying the same Databricks identifier.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `sql_warehouses.instance_profile_arn`
Instance Profile Arn records AWS instance profile ARN associated with the warehouse (if applicable). It is needed to inventory the exact Databricks-reported configuration or classification represented by this field.
* **Enables:** compare `instance_profile_arn` among SQL Warehouses records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is interpreted at one SQL Warehouse record per row; the value is a Databricks-returned or configured label at the SQL Warehouse grain rather than a universal taxonomy.
Developer identifier: `sql_warehouses.jdbc_url`
Jdbc URL records JDBC connection URL for the warehouse. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Databricks resource referenced by `jdbc_url` while retaining the containing SQL Warehouses record as provenance.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is link at one SQL Warehouse record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `sql_warehouses.max_num_clusters`
Max Num Clusters records maximum number of clusters for auto-scaling. It is needed to measure the Databricks-reported number of max num clusters at one SQL Warehouse record per row.
* **Enables:** measure and compare the Databricks-reported number of max num clusters in `max_num_clusters` at one SQL Warehouse record per row.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is a Databricks-reported count at one SQL Warehouse record per row.
Developer identifier: `sql_warehouses.min_num_clusters`
Min Num Clusters records minimum number of clusters for auto-scaling. It is needed to measure the Databricks-reported number of min num clusters at one SQL Warehouse record per row.
* **Enables:** measure and compare the Databricks-reported number of min num clusters in `min_num_clusters` at one SQL Warehouse record per row.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is a Databricks-reported count at one SQL Warehouse record per row.
Developer identifier: `sql_warehouses.name`
Name records name of the SQL warehouse. It is needed to compare the returned name for individual SQL Warehouses rows and select rows with a specific `name` value.
* **Enables:** locate SQL Warehouses rows whose returned name exactly matches `name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is interpreted at one SQL Warehouse record per row.
Developer identifier: `sql_warehouses.num_active_sessions`
Num Active Sessions records number of currently active sessions on the warehouse. It is needed to measure the Databricks-reported number of currently active sessions on the warehouse at one SQL Warehouse record per row.
* **Enables:** measure and compare the Databricks-reported number of currently active sessions on the warehouse in `num_active_sessions` at one SQL Warehouse record per row.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is a Databricks-reported count at one SQL Warehouse record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `sql_warehouses.num_clusters`
Num Clusters records current number of running clusters for this warehouse. It is needed to measure the Databricks-reported number of num clusters at one SQL Warehouse record per row.
* **Enables:** measure and compare the Databricks-reported number of num clusters in `num_clusters` at one SQL Warehouse record per row.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is a Databricks-reported count at one SQL Warehouse record per row.
Developer identifier: `sql_warehouses.odbc_params`
Odbc Params records ODBC connection parameters for the warehouse. It is needed to preserve the nested odbc params relationship or details on the parent SQL Warehouse record.
* **Enables:** expand `odbc_params` to connect the containing SQL Warehouse row to its returned odbc params entries.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is one nested object per containing SQL Warehouse object when present.
Developer identifier: `sql_warehouses.odbc_params.hostname`
Hostname records hostname for the ODBC connection. It is needed to compare the returned hostname for individual SQL Warehouses rows and select rows with a specific `hostname` value.
* **Enables:** locate SQL Warehouses rows whose returned hostname exactly matches `hostname` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Odbc Params object returned for SQL Warehouses; it is interpreted at one Odbc Params record per row.
Developer identifier: `sql_warehouses.odbc_params.path`
Path records HTTP path for the ODBC connection. It is needed to compare the returned path for individual SQL Warehouses rows and select rows with a specific `path` value.
* **Enables:** trace the path relationship returned in `path` from the Odbc Params row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Odbc Params object returned for SQL Warehouses; it is interpreted at one Odbc Params record per row.
Developer identifier: `sql_warehouses.odbc_params.port`
Port records port number for the ODBC connection. It is needed to compare the numeric port reported for one Odbc Params record without assuming an unstated unit.
* **Enables:** compare the numeric `port` value per Odbc Params record without assigning a unit not declared by the schema description.
* **Interpretation:** Databricks reports this value on the Odbc Params object returned for SQL Warehouses; it is interpreted at one Odbc Params record per row.
Developer identifier: `sql_warehouses.odbc_params.protocol`
Protocol records protocol used (e.g., https). It is needed to compare the exact protocol configuration returned for this Odbc Params record.
* **Enables:** compare the exact `protocol` configuration returned for each Odbc Params record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Odbc Params object returned for SQL Warehouses; it is interpreted at one Odbc Params record per row.
Developer identifier: `sql_warehouses.spot_instance_policy`
Spot Instance Policy records policy for using spot instances. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select SQL Warehouses rows with the exact `spot_instance_policy` access-related value being investigated.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is interpreted at one SQL Warehouse record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `sql_warehouses.state`
State records current state of the SQL warehouse. It is needed to distinguish SQL Warehouses rows by the exact Databricks-returned state value.
* **Enables:** separate SQL Warehouses rows by the exact Databricks-returned `state` label when comparing state.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is interpreted at one SQL Warehouse record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `sql_warehouses.tags`
Tags records tags applied to the warehouse. It is needed to preserve the nested tags relationship or details on the parent SQL Warehouse record.
* **Enables:** expand `tags` to connect the containing SQL Warehouse row to its returned tags entries.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is one nested object per containing SQL Warehouse object when present.
Developer identifier: `sql_warehouses.tags.custom_tags`
Custom Tags records list of custom key-value tag pairs. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `custom_tags` and associate them with the containing SQL Warehouses record.
* **Interpretation:** Databricks reports this value on the Tags object returned for SQL Warehouses; it is one returned collection per containing Tags object; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `sql_warehouses.tags.custom_tags.key`
Key records tag key. It is needed to refer to the same tag across records without relying on display text.
* **Enables:** match `key` to tag references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Tag object returned for SQL Warehouses; it is an identifier, not a measured quantity.
Developer identifier: `sql_warehouses.tags.custom_tags.value`
Value records tag value. It is needed to inventory the exact Databricks-reported configuration or classification represented by this field.
* **Enables:** compare `value` among SQL Warehouses records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Databricks reports this value on the Tag object returned for SQL Warehouses; it is interpreted at one Tag record per row; the value is a Databricks-returned or configured label at the Tag grain rather than a universal taxonomy.
Developer identifier: `sql_warehouses.warehouse_type`
Warehouse Type records type of the SQL warehouse. It is needed to distinguish SQL Warehouses rows by the exact Databricks-returned warehouse type value.
* **Enables:** separate SQL Warehouses rows by the exact Databricks-returned `warehouse_type` label when comparing warehouse type.
* **Interpretation:** Databricks reports this value on the SQL Warehouse object returned for SQL Warehouses; it is interpreted at one SQL Warehouse record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `table_summaries`
Table Summaries covers table summaries within a catalog, providing a lightweight view of available tables with optional LIKE pattern filtering.
* **Enables:** connect each returned table to its catalog and schema, then inspect its table kind, columns, owner, and storage metadata where returned.
* **Scope:** Lists table summaries within a catalog, providing a lightweight view of available tables with optional LIKE pattern filtering; the connector reads `/api/2.1/unity-catalog/table-summaries` as a snapshot stream in full mode. The configured credential must grant the declared `all-apis` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the Databricks record was deleted.
Developer identifier: `table_summaries._parent_catalog_name`
Parent Catalog Name records parent key injected by the ingestor from the catalogs to `table_summaries` traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to compare the returned parent catalog name for individual Table Summaries rows and select rows with a specific `_parent_catalog_name` value.
* **Enables:** locate Table Summaries rows whose returned parent catalog name exactly matches `_parent_catalog_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks's child response does not supply this field; the connector injects parent context into each child row; it is interpreted at one Table Summary record per row.
Developer identifier: `table_summaries.catalog_name`
Catalog Name records name of the parent catalog containing this table. It is needed to compare the returned catalog name for individual Table Summaries rows and select rows with a specific `catalog_name` value.
* **Enables:** locate Table Summaries rows whose returned catalog name exactly matches `catalog_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Table Summary object returned for Table Summaries; it is interpreted at one Table Summary record per row.
Developer identifier: `table_summaries.full_name`
Full Name records full three-level name of the table in the format catalog.schema.table. Serves as the unique identifier. It is needed to distinguish repeated deliveries of the same Table Summaries row using the declared ingestion key.
* **Enables:** use `full_name` as the declared ingestion deduplication key for Table Summaries and match repeated rows carrying the same Databricks identifier.
* **Interpretation:** Databricks reports this value on the Table Summary object returned for Table Summaries; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `table_summaries.schema_name`
Schema Name records name of the parent schema (database) containing this table. It is needed to compare the returned schema name for individual Table Summaries rows and select rows with a specific `schema_name` value.
* **Enables:** locate Table Summaries rows whose returned schema name exactly matches `schema_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Table Summary object returned for Table Summaries; it is interpreted at one Table Summary record per row.
Developer identifier: `table_summaries.table_type`
Table Type records the type of the table. It is needed to distinguish Table Summaries rows by the exact Databricks-returned table type value.
* **Enables:** separate Table Summaries rows by the exact Databricks-returned `table_type` label when comparing table type.
* **Interpretation:** Databricks reports this value on the Table Summary object returned for Table Summaries; it is interpreted at one Table Summary record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `tables`
Tables covers tables within a specified Unity Catalog catalog and schema. Requires `catalog_name` and `schema_name` as parent context fields. Provides table metadata including columns, data types, and storage info.
* **Enables:** connect each returned table to its catalog and schema, then inspect its table kind, columns, owner, and storage metadata where returned.
* **Scope:** Lists all tables within a specified Unity Catalog catalog and schema. Requires `catalog_name` and `schema_name` as parent context fields. Provides table metadata including columns, data types, and storage info; the connector reads `/api/2.1/unity-catalog/tables` as a snapshot stream in full mode. The configured credential must grant the declared `all-apis` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the Databricks record was deleted.
Developer identifier: `tables._parent_catalog_name`
Parent Catalog Name records parent catalog name injected by the schemas to tables traversal parentContextFields. Not part of the upstream API response. It is needed to compare the returned parent catalog name for individual Tables rows and select rows with a specific `_parent_catalog_name` value.
* **Enables:** locate Tables rows whose returned parent catalog name exactly matches `_parent_catalog_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks's child response does not supply this field; the connector injects parent context into each child row; it is interpreted at one Databricks Table record per row.
Developer identifier: `tables._parent_schema_name`
Parent Schema Name records parent schema name injected by the schemas to tables traversal parentContextFields. Not part of the upstream API response. It is needed to compare the returned parent schema name for individual Tables rows and select rows with a specific `_parent_schema_name` value.
* **Enables:** locate Tables rows whose returned parent schema name exactly matches `_parent_schema_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks's child response does not supply this field; the connector injects parent context into each child row; it is interpreted at one Databricks Table record per row.
Developer identifier: `tables.access_point`
Access Point records access point for the table, if applicable. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `access_point` access value with the resource, account, or membership represented by the same Tables row.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `tables.browse_only`
Browse Only records whether the user can only browse metadata for this table (no data access). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Tables rows with the exact `browse_only` access-related value being investigated.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `tables.cache_version_info`
Cache Version Info records the cache version info details attached to this Tables record. It is needed to preserve the nested cache version info relationship or details on the parent Databricks Table record.
* **Enables:** expand `cache_version_info` to connect the containing Databricks Table row to its returned cache version info entries.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is one nested object per containing Databricks Table object when present.
Developer identifier: `tables.cache_version_info.metastore_version`
Metastore Version records metastore version cached for this object. It is needed to compare the exact metastore version configuration returned for this Cache Version Info record.
* **Enables:** compare the exact `metastore_version` configuration returned for each Cache Version Info record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Cache Version Info object returned for Tables; it is interpreted at one Cache Version Info record per row.
Developer identifier: `tables.catalog_id`
Catalog ID records Unity Catalog catalog UUID. It is needed to refer to the same catalog across records without relying on display text.
* **Enables:** match `catalog_id` to catalog references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is an identifier, not a measured quantity; the schema uses the `Identity.UUID` scalar.
Developer identifier: `tables.catalog_name`
Catalog Name records name of the parent catalog. It is needed to compare the returned catalog name for individual Tables rows and select rows with a specific `catalog_name` value.
* **Enables:** locate Tables rows whose returned catalog name exactly matches `catalog_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row.
Developer identifier: `tables.columns`
Columns records array of column definitions for the table. It is needed to preserve the nested columns relationship or details on the parent Databricks Table record.
* **Enables:** expand `columns` to connect the containing Databricks Table row to its returned columns entries.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is one returned collection per containing Databricks Table object.
Developer identifier: `tables.columns.comment`
Comment records user-provided comment for the column. It is needed to inspect the exact comment or journal text included with this record.
* **Enables:** inspect the comment or journal text returned in `comment` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Column Info object returned for Tables; it is comment or journal text at one Column Info record per row; this is only the content included in the Databricks response for this record.
Developer identifier: `tables.columns.mask`
Mask records column mask configuration, if any. It is needed to preserve the nested mask relationship or details on the parent Column Info record.
* **Enables:** expand `mask` to connect the containing Column Info row to its returned mask entries.
* **Interpretation:** Databricks reports this value on the Column Info object returned for Tables; it is one nested object per containing Column Info object when present.
Developer identifier: `tables.columns.mask.function_name`
Function Name records full name of the masking function. It is needed to compare the returned function name for individual Tables rows and select rows with a specific `function_name` value.
* **Enables:** locate Tables rows whose returned function name exactly matches `function_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Column Mask object returned for Tables; it is interpreted at one Column Mask record per row.
Developer identifier: `tables.columns.mask.using_column_names`
Using Column Names records column names used as inputs to the masking function. It is needed to preserve the nested using column names relationship or details on the parent Column Mask record.
* **Enables:** expand `using_column_names` to connect the containing Column Mask row to its returned using column names entries.
* **Interpretation:** Databricks reports this value on the Column Mask object returned for Tables; it is one returned collection per containing Column Mask object.
Developer identifier: `tables.columns.name`
Name records name of the column. It is needed to compare the returned name for individual Tables rows and select rows with a specific `name` value.
* **Enables:** locate Tables rows whose returned name exactly matches `name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Column Info object returned for Tables; it is interpreted at one Column Info record per row.
Developer identifier: `tables.columns.nullable`
Nullable records whether the column allows null values. It is needed to distinguish Tables rows by the exact Databricks-returned nullable value.
* **Enables:** select Tables rows where `nullable` is true or false when comparing the condition described by Nullable.
* **Interpretation:** Databricks reports this value on the Column Info object returned for Tables; it is interpreted at one Column Info record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `tables.columns.partition_index`
Partition Index records partition index if this column is a partition column. It is needed to compare the numeric partition index reported for one Column Info record without assuming an unstated unit.
* **Enables:** compare the numeric `partition_index` value per Column Info record without assigning a unit not declared by the schema description.
* **Interpretation:** Databricks reports this value on the Column Info object returned for Tables; it is interpreted at one Column Info record per row.
Developer identifier: `tables.columns.position`
Position records zero-based ordinal position of the column in the table. It is needed to compare the numeric position reported for one Column Info record without assuming an unstated unit.
* **Enables:** compare the numeric `position` value per Column Info record without assigning a unit not declared by the schema description.
* **Interpretation:** Databricks reports this value on the Column Info object returned for Tables; it is interpreted at one Column Info record per row.
Developer identifier: `tables.columns.type_interval_type`
Type Interval Type records interval type string for INTERVAL columns. It is needed to distinguish Tables rows by the exact Databricks-returned type interval type value.
* **Enables:** separate Tables rows by the exact Databricks-returned `type_interval_type` label when comparing type interval type.
* **Interpretation:** Databricks reports this value on the Column Info object returned for Tables; it is interpreted at one Column Info record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `tables.columns.type_json`
Type JSON records JSON representation of the column's type. It is needed to distinguish Tables rows by the exact Databricks-returned type json value.
* **Enables:** separate Tables rows by the exact Databricks-returned `type_json` label when comparing type json.
* **Interpretation:** Databricks reports this value on the Column Info object returned for Tables; it is interpreted at one Column Info record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `tables.columns.type_name`
Type Name records the top-level type name of the column. It is needed to distinguish Tables rows by the exact Databricks-returned type name value.
* **Enables:** separate Tables rows by the exact Databricks-returned `type_name` label when comparing type name.
* **Interpretation:** Databricks reports this value on the Column Info object returned for Tables; it is interpreted at one Column Info record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `tables.columns.type_precision`
Type Precision records precision of the column type (for DECIMAL types). It is needed to distinguish Tables rows by the exact Databricks-returned type precision value.
* **Enables:** separate Tables rows by the exact Databricks-returned `type_precision` label when comparing type precision.
* **Interpretation:** Databricks reports this value on the Column Info object returned for Tables; it is interpreted at one Column Info record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `tables.columns.type_scale`
Type Scale records scale of the column type (for DECIMAL types). It is needed to distinguish Tables rows by the exact Databricks-returned type scale value.
* **Enables:** separate Tables rows by the exact Databricks-returned `type_scale` label when comparing type scale.
* **Interpretation:** Databricks reports this value on the Column Info object returned for Tables; it is interpreted at one Column Info record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `tables.columns.type_text`
Type Text records the full SQL type declaration for the column (for example, `BIGINT` or `STRUCT`). It is needed to distinguish scalar and nested column types using the exact Databricks-returned text.
* **Enables:** compare `type_text` across Tables rows when reviewing or reconciling table schemas.
* **Interpretation:** Databricks reports this value on the Column Info object returned for Tables; it is the SQL type declaration for one column.
Developer identifier: `tables.comment`
Comment records user-provided comment or description for the table. It is needed to inspect the exact comment or journal text included with this record.
* **Enables:** inspect the comment or journal text returned in `comment` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is comment or journal text at one Databricks Table record per row; this is only the content included in the Databricks response for this record.
Developer identifier: `tables.created_at`
Created At records timestamp in epoch milliseconds when the table was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Tables records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; its unit or granularity is epoch milliseconds; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `tables.created_by`
Created By records user or principal who created the table. It is needed to attribute this Tables row to the returned person, account, or organization reference.
* **Enables:** attribute the Tables row to the returned person or account and match the exact `created_by` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row.
Developer identifier: `tables.data_access_configuration_id`
Data Access Configuration ID records data access configuration UUID when present. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `data_access_configuration_id` access value with the resource, account, or membership represented by the same Tables row.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is an identifier, not a measured quantity; the schema uses the `Identity.UUID` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `tables.data_source_format`
Data Source Format records data source format of the table. It is needed to distinguish Tables rows by the exact Databricks-returned data source format value.
* **Enables:** separate Tables rows by the exact Databricks-returned `data_source_format` label when comparing data source format.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `tables.delta_runtime_properties_kvpairs`
Delta Runtime Properties Kvpairs records delta-specific runtime key-value property pairs. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `delta_runtime_properties_kvpairs` and associate them with the containing Tables record.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; the schema uses the `Generic.JSON` scalar; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `tables.effective_predictive_optimization_flag`
Effective Predictive Optimization Flag records effective predictive optimization setting for the table. It is needed to distinguish Tables rows by the exact Databricks-returned effective predictive optimization flag value.
* **Enables:** separate Tables rows by the exact Databricks-returned `effective_predictive_optimization_flag` label when comparing effective predictive optimization flag.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `tables.enable_predictive_optimization`
Enable Predictive Optimization records whether predictive optimization is enabled for the table. It is needed to distinguish Tables rows by the exact Databricks-returned enable predictive optimization value.
* **Enables:** select Tables rows where `enable_predictive_optimization` is true or false when comparing the condition described by Enable Predictive Optimization.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `tables.encryption_details`
Encryption Details records encryption details for the table. It is needed to preserve the nested encryption details relationship or details on the parent Databricks Table record.
* **Enables:** expand `encryption_details` to connect the containing Databricks Table row to its returned encryption details entries.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is one nested object per containing Databricks Table object when present.
Developer identifier: `tables.encryption_details.sse_encryption_details`
Sse Encryption Details records server-side encryption details. It is needed to preserve the nested sse encryption details relationship or details on the parent Encryption Details record.
* **Enables:** expand `sse_encryption_details` to connect the containing Encryption Details row to its returned sse encryption details entries.
* **Interpretation:** Databricks reports this value on the Encryption Details object returned for Tables; it is one nested object per containing Encryption Details object when present.
Developer identifier: `tables.encryption_details.sse_encryption_details.algorithm`
Algorithm records encryption algorithm used (e.g., `AES_256`). It is needed to inventory the Databricks-reported encryption configuration for this resource.
* **Enables:** correlate `algorithm` with the same table or compute resource's encryption mode and key reference during configuration review.
* **Interpretation:** Databricks reports this value on the Sse Encryption Details object returned for Tables; it is interpreted at one Sse Encryption Details record per row; the returned algorithm or key reference is configuration evidence and does not prove encryption enforcement or key availability.
Developer identifier: `tables.encryption_details.sse_encryption_details.aws_kms_key_arn`
AWS Kms Key Arn records AWS KMS key ARN if using AWS KMS encryption. It is needed to inventory the Databricks-reported encryption configuration for this resource.
* **Enables:** correlate `aws_kms_key_arn` with the same table or compute resource's encryption mode and key reference during configuration review.
* **Interpretation:** Databricks reports this value on the Sse Encryption Details object returned for Tables; it is interpreted at one Sse Encryption Details record per row; the returned algorithm or key reference is configuration evidence and does not prove encryption enforcement or key availability.
Developer identifier: `tables.etag`
ETag records entity tag for optimistic concurrency. It is needed to correlate the Databricks object version used for optimistic concurrency.
* **Enables:** compare `etag` across observations of the same Databricks Table identifier to detect a returned version change before a conditional update.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; the entity tag is a version token, not a timestamp or proof that every intermediate update was observed.
Developer identifier: `tables.full_name`
Full Name records full three-level name of the table (catalog.schema.table). It is needed to distinguish repeated deliveries of the same Tables row using the declared ingestion key.
* **Enables:** use `full_name` as the declared ingestion deduplication key for Tables and match repeated rows carrying the same Databricks identifier.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; the connector declares it as an ingestion deduplication key.
Developer identifier: `tables.generation`
Generation records generation number of the table, incremented on each metadata change. It is needed to measure the Databricks-reported number of generation at one Databricks Table record per row.
* **Enables:** measure and compare the Databricks-reported number of generation in `generation` at one Databricks Table record per row.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is a Databricks-reported count at one Databricks Table record per row.
Developer identifier: `tables.metastore_id`
Metastore ID records unique identifier of the metastore that contains this table. It is needed to refer to the same metastore across records without relying on display text.
* **Enables:** match `metastore_id` to metastore references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is an identifier, not a measured quantity.
Developer identifier: `tables.metastore_version`
Metastore Version records metastore version associated with this table record. It is needed to compare the exact metastore version configuration returned for this Databricks Table record.
* **Enables:** compare the exact `metastore_version` configuration returned for each Databricks Table record and select records with the configuration under review.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row.
Developer identifier: `tables.name`
Name records name of the table. It is needed to compare the returned name for individual Tables rows and select rows with a specific `name` value.
* **Enables:** locate Tables rows whose returned name exactly matches `name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row.
Developer identifier: `tables.owner`
Owner records owner of the table. It is needed to attribute this Tables row to the returned person, account, or organization reference.
* **Enables:** attribute the Tables row to the returned person or account and match the exact `owner` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row.
Developer identifier: `tables.pipeline_id`
Pipeline ID records ID of the Delta Live Tables pipeline that manages this table, if any. It is needed to refer to the same pipeline across records without relying on display text.
* **Enables:** match `pipeline_id` to pipeline references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is an identifier, not a measured quantity.
Developer identifier: `tables.properties`
Properties records key-value properties/metadata associated with the table. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `properties` and associate them with the containing Tables record.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; the schema uses the `Generic.JSON` scalar; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `tables.row_filter`
Row Filter records row filter configuration applied to the table, if any. It is needed to preserve the nested row filter relationship or details on the parent Databricks Table record.
* **Enables:** expand `row_filter` to connect the containing Databricks Table row to its returned row filter entries.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is one nested object per containing Databricks Table object when present.
Developer identifier: `tables.row_filter.input_column_names`
Input Column Names records column names passed as inputs to the row filter function. It is needed to preserve the nested input column names relationship or details on the parent Table Row Filter record.
* **Enables:** expand `input_column_names` to connect the containing Table Row Filter row to its returned input column names entries.
* **Interpretation:** Databricks reports this value on the Table Row Filter object returned for Tables; it is one returned collection per containing Table Row Filter object.
Developer identifier: `tables.row_filter.name`
Name records full name of the row filter function. It is needed to compare the returned name for individual Tables rows and select rows with a specific `name` value.
* **Enables:** locate Tables rows whose returned name exactly matches `name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Table Row Filter object returned for Tables; it is interpreted at one Table Row Filter record per row.
Developer identifier: `tables.row_filters`
Row Filters records row filters applied to the table. It is needed to preserve the nested row filters relationship or details on the parent Databricks Table record.
* **Enables:** expand `row_filters` to connect the containing Databricks Table row to its returned row filters entries.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is one returned collection per containing Databricks Table object.
Developer identifier: `tables.schema_id`
Schema ID records Unity Catalog schema UUID. It is needed to refer to the same schema across records without relying on display text.
* **Enables:** match `schema_id` to schema references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is an identifier, not a measured quantity; the schema uses the `Identity.UUID` scalar.
Developer identifier: `tables.schema_name`
Schema Name records name of the parent schema. It is needed to compare the returned schema name for individual Tables rows and select rows with a specific `schema_name` value.
* **Enables:** locate Tables rows whose returned schema name exactly matches `schema_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row.
Developer identifier: `tables.securable_kind`
Securable Kind records the kind of securable object this table represents. It is needed to distinguish Tables rows by the exact Databricks-returned securable kind value.
* **Enables:** separate Tables rows by the exact Databricks-returned `securable_kind` label when comparing securable kind.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `tables.securable_type`
Securable Type records the securable type of this object. It is needed to distinguish Tables rows by the exact Databricks-returned securable type value.
* **Enables:** separate Tables rows by the exact Databricks-returned `securable_type` label when comparing securable type.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `tables.sql_path`
SQL Path records SQL path of the table. It is needed to compare the returned sql path for individual Tables rows and select rows with a specific `sql_path` value.
* **Enables:** trace the sql path relationship returned in `sql_path` from the Databricks Table row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row.
Developer identifier: `tables.storage_credential_name`
Storage Credential Name records name of the storage credential used to access the storage location. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `storage_credential_name` access value with the resource, account, or membership represented by the same Tables row.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `tables.storage_location`
Storage Location records storage location URL for the table data. It is needed to preserve the Databricks-reported resource location link for the same record.
* **Enables:** correlate the Databricks resource link in `storage_location` with its containing Databricks Table row without treating the resource path as a statement of data residency.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; the schema uses the `Network.Uri` scalar; the value is resource location link; this Databricks-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `tables.table_constraints`
Table Constraints records list of table constraints such as primary key, foreign key, etc. It is needed to refer to the same table constraints across records without relying on display text.
* **Enables:** match `table_constraints` to table constraints references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is one returned collection per containing Databricks Table object.
Developer identifier: `tables.table_constraints.foreign_key_constraint`
Foreign Key Constraint records foreign key constraint definition. It is needed to refer to the same foreign constraint across records without relying on display text.
* **Enables:** match `foreign_key_constraint` to foreign constraint references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Table Constraint object returned for Tables; it is one nested object per containing Table Constraint object when present.
Developer identifier: `tables.table_constraints.foreign_key_constraint.child_columns`
Child Columns records column names in the child (referencing) table. It is needed to preserve the nested child columns relationship or details on the parent Foreign Key Constraint record.
* **Enables:** expand `child_columns` to connect the containing Foreign Key Constraint row to its returned child columns entries.
* **Interpretation:** Databricks reports this value on the Foreign Key Constraint object returned for Tables; it is one returned collection per containing Foreign Key Constraint object.
Developer identifier: `tables.table_constraints.foreign_key_constraint.name`
Name records name of the foreign key constraint. It is needed to refer to the same name across records without relying on display text.
* **Enables:** match `name` to name references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Foreign Key Constraint object returned for Tables; it is an identifier, not a measured quantity.
Developer identifier: `tables.table_constraints.foreign_key_constraint.parent_columns`
Parent Columns records column names in the parent (referenced) table. It is needed to preserve the nested parent columns relationship or details on the parent Foreign Key Constraint record.
* **Enables:** expand `parent_columns` to connect the containing Foreign Key Constraint row to its returned parent columns entries.
* **Interpretation:** Databricks reports this value on the Foreign Key Constraint object returned for Tables; it is one returned collection per containing Foreign Key Constraint object.
Developer identifier: `tables.table_constraints.foreign_key_constraint.parent_table`
Parent Table records full name of the parent (referenced) table. It is needed to compare the returned parent table for individual Tables rows and select rows with a specific `parent_table` value.
* **Enables:** trace the parent table relationship returned in `parent_table` from the Foreign Key Constraint row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Foreign Key Constraint object returned for Tables; it is interpreted at one Foreign Key Constraint record per row.
Developer identifier: `tables.table_constraints.named_table_constraint`
Named Table Constraint records named table constraint (e.g., CHECK constraint). It is needed to preserve the nested named table constraint relationship or details on the parent Table Constraint record.
* **Enables:** expand `named_table_constraint` to connect the containing Table Constraint row to its returned named table constraint entries.
* **Interpretation:** Databricks reports this value on the Table Constraint object returned for Tables; it is one nested object per containing Table Constraint object when present.
Developer identifier: `tables.table_constraints.named_table_constraint.name`
Name records name of the constraint. It is needed to compare the returned name for individual Tables rows and select rows with a specific `name` value.
* **Enables:** locate Tables rows whose returned name exactly matches `name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the Named Table Constraint object returned for Tables; it is interpreted at one Named Table Constraint record per row.
Developer identifier: `tables.table_constraints.primary_key_constraint`
Primary Key Constraint records primary key constraint definition. It is needed to refer to the same primary constraint across records without relying on display text.
* **Enables:** match `primary_key_constraint` to primary constraint references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Table Constraint object returned for Tables; it is one nested object per containing Table Constraint object when present.
Developer identifier: `tables.table_constraints.primary_key_constraint.child_columns`
Child Columns records column names that form the primary key. It is needed to refer to the same child columns across records without relying on display text.
* **Enables:** match `child_columns` to child columns references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Primary Key Constraint object returned for Tables; it is one returned collection per containing Primary Key Constraint object.
Developer identifier: `tables.table_constraints.primary_key_constraint.name`
Name records name of the primary key constraint. It is needed to refer to the same name across records without relying on display text.
* **Enables:** match `name` to name references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Primary Key Constraint object returned for Tables; it is an identifier, not a measured quantity.
Developer identifier: `tables.table_id`
Table ID records unique identifier (UUID) for the table. It is needed to refer to the same table across records without relying on display text.
* **Enables:** match `table_id` to table references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is an identifier, not a measured quantity; the schema uses the `Identity.UUID` scalar.
Developer identifier: `tables.table_type`
Table Type records type of the table. It is needed to distinguish Tables rows by the exact Databricks-returned table type value.
* **Enables:** separate Tables rows by the exact Databricks-returned `table_type` label when comparing table type.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `tables.updated_at`
Updated At records timestamp in epoch milliseconds when the table was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Tables records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; its unit or granularity is epoch milliseconds; the connector also declares it for record ordering; the schema declares the `unix_millis` temporal format; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `tables.updated_by`
Updated By records user or principal who last updated the table. It is needed to attribute this Tables row to the returned person, account, or organization reference.
* **Enables:** attribute the Tables row to the returned person or account and match the exact `updated_by` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row.
Developer identifier: `tables.view_definition`
View Definition records SQL text of the view definition, if the `table_type` is VIEW. It is needed to inspect the exact SQL view definition returned for this Databricks Table record.
* **Enables:** attribute the SQL view definition in `view_definition` to the containing Tables identifier, owner or author, status, and update time where returned.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is interpreted at one Databricks Table record per row; this is only the SQL view definition included in the Databricks response for this record.
Developer identifier: `tables.view_dependencies`
View Dependencies records dependencies of the view, if the `table_type` is VIEW. It is needed to preserve the nested view dependencies relationship or details on the parent Databricks Table record.
* **Enables:** expand `view_dependencies` to connect the containing Databricks Table row to its returned view dependencies entries.
* **Interpretation:** Databricks reports this value on the Databricks Table object returned for Tables; it is one nested object per containing Databricks Table object when present.
Developer identifier: `tables.view_dependencies.dependencies`
Dependencies records list of dependency objects for the view. It is needed to preserve the nested dependencies relationship or details on the parent View Dependencies record.
* **Enables:** expand `dependencies` to connect the containing View Dependencies row to its returned dependencies entries.
* **Interpretation:** Databricks reports this value on the View Dependencies object returned for Tables; it is one returned collection per containing View Dependencies object.
Developer identifier: `tables.view_dependencies.dependencies.function`
Function records function dependency reference. It is needed to preserve the nested function relationship or details on the parent View Dependency record.
* **Enables:** expand `function` to connect the containing View Dependency row to its returned function entries.
* **Interpretation:** Databricks reports this value on the View Dependency object returned for Tables; it is one nested object per containing View Dependency object when present.
Developer identifier: `tables.view_dependencies.dependencies.function.function_full_name`
Function Full Name records full name of the dependent function. It is needed to compare the returned function full name for individual Tables rows and select rows with a specific `function_full_name` value.
* **Enables:** locate Tables rows whose returned function full name exactly matches `function_full_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the View Dependency Function object returned for Tables; it is interpreted at one View Dependency Function record per row.
Developer identifier: `tables.view_dependencies.dependencies.table`
Table records table dependency reference. It is needed to preserve the nested table relationship or details on the parent View Dependency record.
* **Enables:** expand `table` to connect the containing View Dependency row to its returned table entries.
* **Interpretation:** Databricks reports this value on the View Dependency object returned for Tables; it is one nested object per containing View Dependency object when present.
Developer identifier: `tables.view_dependencies.dependencies.table.table_full_name`
Table Full Name records full three-level name of the dependent table. It is needed to compare the returned table full name for individual Tables rows and select rows with a specific `table_full_name` value.
* **Enables:** locate Tables rows whose returned table full name exactly matches `table_full_name` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the View Dependency Table object returned for Tables; it is interpreted at one View Dependency Table record per row.
Developer identifier: `users`
Users covers users in the Databricks workspace via the SCIM v2 API. Provides user identity, email, and group membership information.
* **Enables:** map the Databricks accounts and memberships represented by Users records and trace a returned access assignment to its account or group.
* **Scope:** Lists all users in the Databricks workspace via the SCIM v2 API. Provides user identity, email, and group membership information; the connector reads `/api/{apiVersion}/preview/scim/v2/Users` as a snapshot stream in full mode. The configured credential must grant the declared `all-apis` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the Databricks record was deleted.
Developer identifier: `users.active`
Active records whether the user account is currently active in the workspace. It is needed to distinguish Users rows by the exact Databricks-returned active value.
* **Enables:** select Users rows where `active` is true or false when comparing the condition described by Active.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is interpreted at one Databricks User record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `users.addresses`
Addresses records array of addresses associated with the user. It is needed to preserve the nested addresses relationship or details on the parent Databricks User record.
* **Enables:** expand `addresses` to connect the containing Databricks User row to its returned addresses entries.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is one returned collection per containing Databricks User object.
Developer identifier: `users.addresses.country`
Country records country code or name. It is needed to preserve the Databricks-reported configured or derived address and place context for the same record.
* **Enables:** compare the Databricks-reported configured or derived address and place context in `country` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Databricks reports this value on the User Address object returned for Users; it is interpreted at one User Address record per row; the value is configured or derived address and place context; this Databricks-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `users.addresses.formatted`
Formatted records full formatted address string. It is needed to preserve the Databricks-reported configured or derived address and place context for the same record.
* **Enables:** compare the Databricks-reported configured or derived address and place context in `formatted` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Databricks reports this value on the User Address object returned for Users; it is interpreted at one User Address record per row; the value is configured or derived address and place context; this Databricks-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `users.addresses.locality`
Locality records city or locality. It is needed to preserve the Databricks-reported configured or derived address and place context for the same record.
* **Enables:** compare the Databricks-reported configured or derived address and place context in `locality` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Databricks reports this value on the User Address object returned for Users; it is interpreted at one User Address record per row; the value is configured or derived address and place context; this Databricks-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `users.addresses.postalCode`
Postal Code records postal or ZIP code. It is needed to preserve the Databricks-reported configured or derived address and place context for the same record.
* **Enables:** compare the Databricks-reported configured or derived address and place context in `postalCode` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Databricks reports this value on the User Address object returned for Users; it is interpreted at one User Address record per row; the value is configured or derived address and place context; this Databricks-reported or configured context does not establish residency or verified physical presence; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `users.addresses.primary`
Primary records whether this is the primary address. It is needed to preserve the Databricks-reported configured or derived address and place context for the same record.
* **Enables:** compare the Databricks-reported configured or derived address and place context in `primary` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Databricks reports this value on the User Address object returned for Users; it is interpreted at one User Address record per row; the value is configured or derived address and place context; this Databricks-reported or configured context does not establish residency or verified physical presence; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `users.addresses.region`
Region records state or region. It is needed to preserve the Databricks-reported configured or derived address and place context for the same record.
* **Enables:** compare the Databricks-reported configured or derived address and place context in `region` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Databricks reports this value on the User Address object returned for Users; it is interpreted at one User Address record per row; the value is configured or derived address and place context; this Databricks-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `users.addresses.streetAddress`
Street Address records street address component. It is needed to preserve the Databricks-reported configured or derived address and place context for the same record.
* **Enables:** compare the Databricks-reported configured or derived address and place context in `streetAddress` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Databricks reports this value on the User Address object returned for Users; it is interpreted at one User Address record per row; the value is configured or derived address and place context; this Databricks-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `users.addresses.type`
Type records type of address (e.g., work, home). It is needed to preserve the Databricks-reported configured or derived address and place context for the same record.
* **Enables:** compare the Databricks-reported configured or derived address and place context in `type` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Databricks reports this value on the User Address object returned for Users; it is interpreted at one User Address record per row; the value is configured or derived address and place context; this Databricks-reported or configured context does not establish residency or verified physical presence; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `users.displayName`
Display Name records display name of the user. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `displayName` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is interpreted at one Databricks User record per row.
Developer identifier: `users.emails`
Emails records array of email addresses associated with the user. It is needed to preserve the nested emails relationship or details on the parent Databricks User record.
* **Enables:** expand `emails` to connect the containing Databricks User row to its returned emails entries.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is one returned collection per containing Databricks User object.
Developer identifier: `users.emails.$ref`
Resource Reference records SCIM reference URI for the email resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Databricks resource referenced by `$ref` while retaining the containing Users record as provenance.
* **Interpretation:** Databricks reports this value on the User Email object returned for Users; it is link at one User Email record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `users.emails.display`
Display records display label for the email address. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `display` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the User Email object returned for Users; it is interpreted at one User Email record per row.
Developer identifier: `users.emails.primary`
Primary records whether this is the primary email address. It is needed to distinguish Users rows by the exact Databricks-returned primary value.
* **Enables:** select Users rows where `primary` is true or false when comparing the condition described by Primary.
* **Interpretation:** Databricks reports this value on the User Email object returned for Users; it is interpreted at one User Email record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `users.emails.type`
Type records type of email address (e.g., work, home). It is needed to distinguish Users rows by the exact Databricks-returned type value.
* **Enables:** separate Users rows by the exact Databricks-returned `type` label when comparing type.
* **Interpretation:** Databricks reports this value on the User Email object returned for Users; it is interpreted at one User Email record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `users.emails.value`
Value records the email address value. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `value` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the User Email object returned for Users; it is interpreted at one User Email record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `users.entitlements`
Entitlements records array of entitlements granted to the user (e.g., workspace-access, databricks-sql-access). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `entitlements` to examine the returned entitlements details for the containing Databricks User record.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is one returned collection per containing Databricks User object; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `users.entitlements.$ref`
Resource Reference records SCIM reference URI for the entitlement resource. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `$ref` access value with the resource, account, or membership represented by the same Users row.
* **Interpretation:** Databricks reports this value on the User Entitlement object returned for Users; it is link at one User Entitlement record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `users.entitlements.display`
Display records display name of the entitlement. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `display` access value with the resource, account, or membership represented by the same Users row.
* **Interpretation:** Databricks reports this value on the User Entitlement object returned for Users; it is interpreted at one User Entitlement record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `users.entitlements.value`
Value records the entitlement identifier. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `value` access value with the resource, account, or membership represented by the same Users row.
* **Interpretation:** Databricks reports this value on the User Entitlement object returned for Users; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `users.externalId`
External ID records external ID from the identity provider (e.g., Azure AD, Okta). It is needed to refer to the same external across records without relying on display text.
* **Enables:** match `externalId` to external references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is an identifier, not a measured quantity.
Developer identifier: `users.groups`
Groups records array of groups the user belongs to. It is needed to preserve the nested groups relationship or details on the parent Databricks User record.
* **Enables:** expand `groups` to connect the containing Databricks User row to its returned groups entries.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is one returned collection per containing Databricks User object.
Developer identifier: `users.groups.$ref`
Resource Reference records SCIM reference URI for the group resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Databricks resource referenced by `$ref` while retaining the containing Users record as provenance.
* **Interpretation:** Databricks reports this value on the User Group Membership object returned for Users; it is link at one User Group Membership record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `users.groups.display`
Display records display name of the group. It is needed to compare the returned display for individual Users rows and select rows with a specific `display` value.
* **Enables:** locate Users rows whose returned display exactly matches `display` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the User Group Membership object returned for Users; it is interpreted at one User Group Membership record per row.
Developer identifier: `users.groups.type`
Type records type of group (direct or indirect). It is needed to distinguish Users rows by the exact Databricks-returned type value.
* **Enables:** separate Users rows by the exact Databricks-returned `type` label when comparing type.
* **Interpretation:** Databricks reports this value on the User Group Membership object returned for Users; it is interpreted at one User Group Membership record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `users.groups.value`
Value records unique identifier of the group. It is needed to refer to the same value across records without relying on display text.
* **Enables:** match `value` to value references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the User Group Membership object returned for Users; it is an identifier, not a measured quantity.
Developer identifier: `users.id`
ID records unique SCIM identifier for the user within the Databricks workspace. It is needed to distinguish repeated deliveries of the same Users row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Users and match repeated rows carrying the same Databricks identifier.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `users.locale`
Locale records locale of the user. It is needed to preserve the Databricks-reported language or locale preference for this identity.
* **Enables:** select identities by the exact `locale` language or locale tag without inferring physical location.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is interpreted at one Databricks User record per row; this Databricks-reported setting or qualifier does not establish residency or verified physical presence.
Developer identifier: `users.meta`
Meta records SCIM resource metadata including resource type and creation/modification timestamps. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `meta` and associate them with the containing Users record.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is one nested object per containing Databricks User object when present; keys and availability follow this Databricks response and may vary by object type or Databricks configuration.
Developer identifier: `users.meta.created`
Created records ISO 8601 timestamp when the resource was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Users records by `created`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Scim Meta object returned for Users; it is interpreted at one Scim Meta record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `users.meta.lastModified`
Last Modified records ISO 8601 timestamp when the resource was last modified. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Users records by `lastModified`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Databricks reports this value on the Scim Meta object returned for Users; it is interpreted at one Scim Meta record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `users.meta.location`
Location records URI location of the resource. It is needed to preserve the Databricks-reported resource location link for the same record.
* **Enables:** correlate the Databricks resource link in `location` with its containing Scim Meta row without treating the resource path as a statement of data residency.
* **Interpretation:** Databricks reports this value on the Scim Meta object returned for Users; it is interpreted at one Scim Meta record per row; the schema uses the `Network.Url` scalar; the value is resource location link; this Databricks-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `users.meta.resourceType`
Resource Type records the SCIM resource type (e.g., User, Group). It is needed to distinguish Users rows by the exact Databricks-returned resource type value.
* **Enables:** separate Users rows by the exact Databricks-returned `resourceType` label when comparing resource type.
* **Interpretation:** Databricks reports this value on the Scim Meta object returned for Users; it is interpreted at one Scim Meta record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `users.meta.version`
Version records version identifier (ETag) of the resource. It is needed to refer to the same version across records without relying on display text.
* **Enables:** match `version` to version references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Scim Meta object returned for Users; it is an identifier, not a measured quantity.
Developer identifier: `users.name`
Name records structured name object containing given name and family name. It is needed to preserve the nested name relationship or details on the parent Databricks User record.
* **Enables:** expand `name` to connect the containing Databricks User row to its returned name entries.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is one nested object per containing Databricks User object when present.
Developer identifier: `users.name.familyName`
Family Name records family (last) name of the user. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `familyName` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the User Name object returned for Users; it is interpreted at one User Name record per row.
Developer identifier: `users.name.formatted`
Formatted records full formatted name string. It is needed to preserve the exact Databricks-reported business, directory, or identity attribute represented by this field.
* **Enables:** match or segment Users records by `formatted` only within the same Databricks attribute contract.
* **Interpretation:** Databricks reports this value on the User Name object returned for Users; it is interpreted at one User Name record per row; the value is a Databricks-returned or configured label and is not a universal identity or business taxonomy.
Developer identifier: `users.name.givenName`
Given Name records given (first) name of the user. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `givenName` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the User Name object returned for Users; it is interpreted at one User Name record per row.
Developer identifier: `users.name.honorificPrefix`
Honorific Prefix records honorific prefix (e.g., Mr., Dr.). It is needed to preserve the exact Databricks-reported business, directory, or identity attribute represented by this field.
* **Enables:** match or segment Users records by `honorificPrefix` only within the same Databricks attribute contract.
* **Interpretation:** Databricks reports this value on the User Name object returned for Users; it is interpreted at one User Name record per row; the value is a Databricks-returned or configured label and is not a universal identity or business taxonomy.
Developer identifier: `users.name.honorificSuffix`
Honorific Suffix records honorific suffix (e.g., Jr., III). It is needed to preserve the exact Databricks-reported business, directory, or identity attribute represented by this field.
* **Enables:** match or segment Users records by `honorificSuffix` only within the same Databricks attribute contract.
* **Interpretation:** Databricks reports this value on the User Name object returned for Users; it is interpreted at one User Name record per row; the value is a Databricks-returned or configured label and is not a universal identity or business taxonomy.
Developer identifier: `users.name.middleName`
Middle Name records middle name of the user. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `middleName` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the User Name object returned for Users; it is interpreted at one User Name record per row.
Developer identifier: `users.nickName`
Nick Name records nickname or casual name of the user. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `nickName` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is interpreted at one Databricks User record per row.
Developer identifier: `users.phoneNumbers`
Phone Numbers records array of phone numbers associated with the user. It is needed to preserve the nested phone numbers relationship or details on the parent Databricks User record.
* **Enables:** expand `phoneNumbers` to connect the containing Databricks User row to its returned phone numbers entries.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is one returned collection per containing Databricks User object.
Developer identifier: `users.phoneNumbers.display`
Display records display label for the phone number. It is needed to compare the returned display for individual Users rows and select rows with a specific `display` value.
* **Enables:** locate Users rows whose returned display exactly matches `display` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the User Phone Number object returned for Users; it is interpreted at one User Phone Number record per row.
Developer identifier: `users.phoneNumbers.primary`
Primary records whether this is the primary phone number. It is needed to distinguish Users rows by the exact Databricks-returned primary value.
* **Enables:** select Users rows where `primary` is true or false when comparing the condition described by Primary.
* **Interpretation:** Databricks reports this value on the User Phone Number object returned for Users; it is interpreted at one User Phone Number record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `users.phoneNumbers.type`
Type records type of phone number (e.g., work, mobile, home). It is needed to distinguish Users rows by the exact Databricks-returned type value.
* **Enables:** separate Users rows by the exact Databricks-returned `type` label when comparing type.
* **Interpretation:** Databricks reports this value on the User Phone Number object returned for Users; it is interpreted at one User Phone Number record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `users.phoneNumbers.value`
Value records the phone number value. It is needed to preserve the exact contact number or extension reported for the person represented by this row.
* **Enables:** associate `value` with the same User Phone Number identity and match the contact value only where it recurs exactly.
* **Interpretation:** Databricks reports this value on the User Phone Number object returned for Users; it is interpreted at one User Phone Number record per row; the value is Databricks-reported contact data, not an account identifier or proof of current ownership.
Developer identifier: `users.photos`
Photos records array of photo URLs associated with the user. It is needed to preserve the nested photos relationship or details on the parent Databricks User record.
* **Enables:** expand `photos` to connect the containing Databricks User row to its returned photos entries.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is one returned collection per containing Databricks User object.
Developer identifier: `users.photos.display`
Display records display label for the photo. It is needed to compare the returned display for individual Users rows and select rows with a specific `display` value.
* **Enables:** locate Users rows whose returned display exactly matches `display` and retain the Databricks identifier for any cross-record match.
* **Interpretation:** Databricks reports this value on the User Photo object returned for Users; it is interpreted at one User Photo record per row.
Developer identifier: `users.photos.primary`
Primary records whether this is the primary photo. It is needed to distinguish Users rows by the exact Databricks-returned primary value.
* **Enables:** select Users rows where `primary` is true or false when comparing the condition described by Primary.
* **Interpretation:** Databricks reports this value on the User Photo object returned for Users; it is interpreted at one User Photo record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `users.photos.type`
Type records type of photo (e.g., photo, thumbnail). It is needed to distinguish Users rows by the exact Databricks-returned type value.
* **Enables:** separate Users rows by the exact Databricks-returned `type` label when comparing type.
* **Interpretation:** Databricks reports this value on the User Photo object returned for Users; it is interpreted at one User Photo record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `users.photos.value`
Value records URL of the photo. It is needed to retain the exact Databricks resource or external link reported for this Users record.
* **Enables:** open or correlate the resource named by `value` while retaining the containing User Photo row as provenance.
* **Interpretation:** Databricks reports this value on the User Photo object returned for Users; it is interpreted at one User Photo record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `users.preferredLanguage`
Preferred Language records preferred language of the user (BCP 47 language tag). It is needed to preserve the Databricks-reported language or locale preference for this identity.
* **Enables:** select identities by the exact `preferredLanguage` language or locale tag without inferring physical location.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is interpreted at one Databricks User record per row; this Databricks-reported setting or qualifier does not establish residency or verified physical presence.
Developer identifier: `users.roles`
Roles records array of roles assigned to the user. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `roles` to examine the returned roles details for the containing Databricks User record.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is one returned collection per containing Databricks User object; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `users.roles.$ref`
Resource Reference records SCIM reference URI for the role resource. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `$ref` access value with the resource, account, or membership represented by the same Users row.
* **Interpretation:** Databricks reports this value on the User Role object returned for Users; it is link at one User Role record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `users.roles.display`
Display records display name of the role. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `display` access value with the resource, account, or membership represented by the same Users row.
* **Interpretation:** Databricks reports this value on the User Role object returned for Users; it is interpreted at one User Role record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `users.roles.type`
Type records type of the role. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Users rows with the exact `type` access-related value being investigated.
* **Interpretation:** Databricks reports this value on the User Role object returned for Users; it is interpreted at one User Role record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Databricks-returned labels rather than a universal taxonomy.
Developer identifier: `users.roles.value`
Value records the role identifier or name. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `value` access value with the resource, account, or membership represented by the same Users row.
* **Interpretation:** Databricks reports this value on the User Role object returned for Users; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `users.schemas`
Schemas records SCIM schema URNs that apply to this user resource. It is needed to preserve the nested schemas relationship or details on the parent Databricks User record.
* **Enables:** expand `schemas` to connect the containing Databricks User row to its returned schemas entries.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is one returned collection per containing Databricks User object.
Developer identifier: `users.timezone`
Timezone records timezone of the user (IANA timezone identifier). It is needed to preserve the Databricks-reported timezone or locale setting for the same record.
* **Enables:** compare the Databricks-reported timezone or locale setting in `timezone` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is an identifier, not a measured quantity; the value is timezone or locale setting; this Databricks-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `users.title`
Title records title of the user (e.g., job title). It is needed to preserve the business or job title reported for the person represented by this row.
* **Enables:** select Users rows by the exact business or job title in `title` without treating the title as an authorization role.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is interpreted at one Databricks User record per row.
Developer identifier: `users.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User`
Urn Ietf Params SCIM Schemas Extension Enterprise 2 0 User records SCIM enterprise user extension attributes. It is needed to preserve the nested urn ietf params scim schemas extension enterprise 2 0 user relationship or details on the parent Databricks User record.
* **Enables:** expand `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` to connect the containing Databricks User row to its returned urn ietf params scim schemas extension enterprise 2 0 user entries.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is one nested object per containing Databricks User object when present.
Developer identifier: `users.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.costCenter`
Cost Center records cost center the user belongs to. It is needed to preserve the exact Databricks-reported business, directory, or identity attribute represented by this field.
* **Enables:** match or segment Users records by `costCenter` only within the same Databricks attribute contract.
* **Interpretation:** Databricks reports this value on the Scim Enterprise User Extension object returned for Users; it is interpreted at one Scim Enterprise User Extension record per row; the value is a Databricks-returned or configured label and is not a universal identity or business taxonomy.
Developer identifier: `users.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.department`
Department records department the user belongs to. It is needed to compare the returned department for individual Users rows and select rows with a specific `department` value.
* **Enables:** trace the department relationship returned in `department` from the Scim Enterprise User Extension row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Scim Enterprise User Extension object returned for Users; it is interpreted at one Scim Enterprise User Extension record per row.
Developer identifier: `users.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.division`
Division records division the user belongs to. It is needed to preserve the exact Databricks-reported business, directory, or identity attribute represented by this field.
* **Enables:** match or segment Users records by `division` only within the same Databricks attribute contract.
* **Interpretation:** Databricks reports this value on the Scim Enterprise User Extension object returned for Users; it is interpreted at one Scim Enterprise User Extension record per row; the value is a Databricks-returned or configured label and is not a universal identity or business taxonomy.
Developer identifier: `users.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.employeeNumber`
Employee Number records employee number. It is needed to refer to the same employee number across records without relying on display text.
* **Enables:** match `employeeNumber` to employee number references carrying the same Databricks-issued value in related Databricks records.
* **Interpretation:** Databricks reports this value on the Scim Enterprise User Extension object returned for Users; it is an identifier, not a measured quantity.
Developer identifier: `users.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager`
Manager records manager reference for the user. It is needed to preserve the nested manager relationship or details on the parent Scim Enterprise User Extension record.
* **Enables:** expand `manager` to connect the containing Scim Enterprise User Extension row to its returned manager entries.
* **Interpretation:** Databricks reports this value on the Scim Enterprise User Extension object returned for Users; it is one nested object per containing Scim Enterprise User Extension object when present.
Developer identifier: `users.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.$ref`
Resource Reference records SCIM reference URI for the manager resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Databricks resource referenced by `$ref` while retaining the containing Users record as provenance.
* **Interpretation:** Databricks reports this value on the Scim Manager object returned for Users; it is link at one Scim Manager record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `users.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.displayName`
Display Name records display name of the manager. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `displayName` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Scim Manager object returned for Users; it is interpreted at one Scim Manager record per row.
Developer identifier: `users.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.manager.value`
Value records SCIM ID of the manager. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `value` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Scim Manager object returned for Users; it is interpreted at one Scim Manager record per row.
Developer identifier: `users.urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.organization`
Organization records organization the user belongs to. It is needed to compare the returned organization for individual Users rows and select rows with a specific `organization` value.
* **Enables:** trace the organization relationship returned in `organization` from the Scim Enterprise User Extension row to its named Databricks context.
* **Interpretation:** Databricks reports this value on the Scim Enterprise User Extension object returned for Users; it is interpreted at one Scim Enterprise User Extension record per row.
Developer identifier: `users.userName`
User Name records username of the user (often an email, but not guaranteed to be one). It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `userName` value where it recurs in Databricks.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is interpreted at one Databricks User record per row.
Developer identifier: `users.userType`
User Type records type of user (e.g., Employee, Contractor). It is needed to distinguish Users rows by the exact Databricks-returned user type value.
* **Enables:** separate Users rows by the exact Databricks-returned `userType` label when comparing user type.
* **Interpretation:** Databricks reports this value on the Databricks User object returned for Users; it is interpreted at one Databricks User record per row; classification values are Databricks-returned labels rather than a universal taxonomy.
If validation fails, confirm that the credential is active, the configured account can read the required resources, and every connection field matches the Provider environment.
Parable never returns stored secret values; replace a secret in the connection form when it has expired or been revoked.
# Figma REST API
Source: https://docs.parable.work/plugins/provider-plugins/figma
Figma is a collaborative design platform for building user interfaces, prototyping, and design systems. The Figma REST API provides access to files, projects, components, styles, comments, version history, webhooks, and team/organization management. Base URL: https://api.figma.com with v1 and v2 versioned endpoints.
Figma is a collaborative design platform for building user interfaces, prototyping, and design systems. The Figma REST API provides access to files, projects, components, styles, comments, version history, webhooks, and team/organization management. Base URL: [https://api.figma.com](https://api.figma.com) with v1 and v2 versioned endpoints.
Connect Parable to Figma using either a Personal Access Token (PAT) or a Plan Access Token. Enter whichever you have in the same token field. Parable ingests design assets, version history, team structure, and (Enterprise, opt-in) activity logs.
> **Info:** **Which token should I use?** A **Plan Access Token** is preferred for Organization/Enterprise plans: it is not tied to an individual user, supports up to a 1-year expiration, and can be scoped with a resource allowlist. A **Personal Access Token** is tied to the minting user and expires within 90 days. If you use a Plan Access Token, make sure its resource allowlist includes every team you configure in Parable.
#### Design assets
Projects, files, components, variables, and version history
#### Activity & admin
File comments and org-level activity logs (Enterprise, opt-in)
## Data streams
This Provider Plugin defines 12 data streams.
| Stream | Description | Sync |
| - | - | - |
| `team_projects` | Lists all projects within a Figma team. Requires a team\_id parent context. Returns project id and name. | full |
| `project_files` | Lists all files within a Figma project. Requires a project\_id parent context. Returns file key, name, thumbnail URL, and last modified timestamp. | full |
| `file_versions` | Returns paginated version history for a Figma file. Requires a file\_key parent context. Pagination uses next\_page URL from the pagination object in the response. | full |
| `file_comments` | Returns all comments on a Figma file. Requires a file\_key parent context. | full |
| `team_components` | Lists all published components for a Figma team. Cursor-based pagination using after parameter. Requires team\_id parent context. | full |
| `team_component_sets` | Lists all published component sets for a Figma team. Cursor-based pagination using after parameter. Requires team\_id parent context. | full |
| `team_styles` | Lists all published styles for a Figma team. Cursor-based pagination using after parameter. Requires team\_id parent context. | full |
| `file_components` | Lists all components within a specific Figma file. Requires a file\_key parent context. | full |
| `file_styles` | Lists all styles within a specific Figma file. Requires a file\_key parent context. | full |
| `comment_reactions` | Returns reactions on a specific comment in a Figma file. Requires file\_key and comment\_id parent context. Cursor-based pagination. | full |
| `file_dev_resources` | Returns dev resources attached to a Figma file. Requires a file\_key parent context. | full |
| `activity_logs` | Retrieve organization activity log events from Figma. Returns timestamped events covering user and admin activity: file opens, edits, creation/deletion, comments, sharing changes, team membership changes, plugin usage, and administrative actions. Enterprise plan required. Organization admin must authorize. | incremental |
## Request behavior
File version reads request 50 records per page, then follow Figma's returned
continuation URL. Comment reactions are fetched separately unless the comment
response explicitly reports an empty reactions array. Missing or malformed
reaction data does not suppress that request.
Each reaction's record key includes the file, comment, emoji, and person.
This distinguishes two people reacting with the same emoji. Existing sealed
loads retain their original key recipe; a new complete snapshot uses the new
recipe and marks absent old keys through the normal snapshot deletion rules.
When a Workspace saves only selected fields, ingestion still writes the
full reaction key before removing fields. Its seal omits the recovery recipe
so promotion cannot replace that key using incomplete inputs.
### Figma
#### What You'll Need
| Credential | What it is |
| - | - |
| **Personal Access Token** | Long-lived token minted from a user's Figma account settings |
| **Plan Access Token** | Org/Enterprise token created by a plan admin, not tied to a user (recommended for org-wide automation) |
> **Info:** **Service account required.** PATs are tied to the minting user -- if that user is removed from the team the token is revoked immediately and ingestion stops. Always mint from a **dedicated service-account user** on a **paid plan** (Professional, Organization, or Enterprise).
* **`activity_logs`** is **disabled by default**. Enable it only if your organization is on the **Enterprise plan** with the service-account user having org admin access. Non-Enterprise tenants will receive `402 payment_required` on every sync.
> **Info:** **Using a Plan Access Token instead?** Org/Enterprise admins can create one at [figma.com/developers/tokens](https://www.figma.com/developers/tokens) (requires 2FA). Choose the same scopes listed in Step 2, and on the **Choose resources** page either allow all resources or add every team you will sync in Parable. Then skip to Step 3 and paste it into the token field.
#### Step 1: Open Figma Security settings
1. Sign in to Figma as the dedicated service-account user.
2. Click your avatar in the top-right and open **Settings**.
3. Switch to the **Security** tab.
4. Scroll to **Personal access tokens**.
#### Step 2: Generate the token
1. Click **Generate new token**.
2. Set:
* **Token name** -- something traceable, e.g. `parable-platform-prod`.
* **Expiration** -- choose the longest duration your security policy allows (`30 days`, `60 days`, `90 days`, `180 days`, or `No expiration`). Rotate at least every 12 months even if using no expiration.
* **Scopes** -- add the following:
| Scope | Purpose |
| - | - |
| `projects:read` | Team projects and project file listings |
| `file_versions:read` | File version history |
| `file_dev_resources:read` | Dev resources |
| `file_comments:read` | File comments and reactions |
| `team_library_content:read` | Team library components, component sets, and styles |
| `library_content:read` | File-level library components and styles |
| `org:activity_log_read` | Org activity logs (Enterprise only) |
3. Copy the token.
> **Warning:** **Copy your Personal Access Token now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
#### Step 3: Enter values in the form
1. **Personal Access Token**: Paste the token from Figma.
2. **Team IDs** (optional): Add one row per Figma team you want to sync.
Find each team ID in the Figma URL: `figma.com/files/team/{team_id}/...`.
Leave empty to skip team-scoped taps that require `team_id`.
3. Click **Save & test connection**.
Developer identifier: `activity_logs`
Activity Logs contain organization activity log events from Figma. Returns timestamped events covering user and admin activity: file opens, edits, creation/deletion, comments, sharing changes, team membership changes, plugin usage, and administrative actions. Enterprise plan required. Organization admin must authorize.
* **Enables:** trace organization events such as file changes, sharing changes, and membership administration to recorded actors and times.
* **Scope:** Reads provider changes through `GET /{apiVersion}/activity_logs` using the declared incremental request boundary. This Enterprise-only operation requires organization-administrator authorization; events outside the returned organization log are absent.
Developer identifier: `activity_logs.action`
Action captures the action taken, including its type and event-specific details. It preserves the provider's current classification of this record.
* **Enables:** separate activity log records by the exact provider-reported action value when describing their recorded state.
* **Interpretation:** The provider supplies `action` per activity log event record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `activity_logs.action.details`
Details records action-specific details that vary by action type. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret details according to the provider and Workspace configuration that produced each activity log record.
* **Interpretation:** Keys and value shapes within `details` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `activity_logs.action.type`
Type states action type (e.g., `file_view`, `file_edit`, `comment_add`, `team_member_add`, `admin_settings_change`). It preserves the provider's current classification of this record.
* **Enables:** separate activity log records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per activity action record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `activity_logs.actor`
Actor captures the user who performed the action. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the activity log event record to the provider-reported actor represented by actor.
* **Interpretation:** The provider supplies `actor` as identity or attribution context on each activity log event record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `activity_logs.actor.email`
Email records email address of the actor. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the activity actor record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each activity actor record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `activity_logs.actor.id`
ID is the unique identifier of the actor. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match activity log records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ActivityActor`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `activity_logs.actor.name`
Name records display name of the actor. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the activity actor record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each activity actor record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `activity_logs.actor.type`
Type states type of the actor (e.g., user, `service_account`). It preserves the provider's current classification of this record.
* **Enables:** separate activity log records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per activity actor record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `activity_logs.context`
Context records client and network context in which the action occurred. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested context object into its declared child fields for each activity log event record.
* **Interpretation:** The provider returns `context` as a nested object or reference on `ActivityLogEvent`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `activity_logs.context.client_name`
Client Name records name of the client from which the action was performed (e.g., `figma_web`, `figma_desktop`). It preserves the client environment reported with the event.
* **Enables:** count Mixpanel events by the reported client name client environment.
* **Interpretation:** Mixpanel supplies `client_name` per tracked event from client metadata; missing values do not identify an operating system or browser.
Developer identifier: `activity_logs.context.ip_address`
IP Address records IP address from which the action was performed. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** segment activity log records by the recorded IP address without inferring a person's physical presence.
* **Interpretation:** The provider supplies `ip_address` as location or localization context per activity context record; it does not establish a person's real-time physical location.
Developer identifier: `activity_logs.context.is_figma_support_team_action`
Is Figma Support Team Action indicates whether the action was performed by the Figma support team. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select activity log records for which the provider reports is figma support team action as true or false.
* **Interpretation:** The provider supplies `is_figma_support_team_action` as a boolean per activity context record; false and missing are distinct when the field is optional.
Developer identifier: `activity_logs.entity`
Entity captures the primary entity (file, project, team, etc.) that was acted upon. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each activity log event record with the specific provider container named by entity.
* **Interpretation:** The provider returns `entity` as a nested object or reference on `ActivityLogEvent`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `activity_logs.entity.key`
Key is the unique key of the entity. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match activity log records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `ActivityEntity`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `activity_logs.entity.name`
Name records display name of the entity. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma activity log record.
* **Interpretation:** The value covers only the activity logs content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `activity_logs.entity.type`
Type states type of the entity (e.g., file, project, team, org). It preserves the provider's current classification of this record.
* **Enables:** separate activity log records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per activity entity record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `activity_logs.id`
ID is the unique identifier for the activity log event. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same activity log event source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per activity log event record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `activity_logs.timestamp`
Timestamp records unix epoch seconds when the event occurred. It anchors the named event or boundary on the record's timeline.
* **Enables:** place activity log records on a timeline by timestamp and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `timestamp` per activity log event record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `comment_reactions`
Comment Reactions contain reactions on a specific comment in a Figma file. Requires `file_key` and `comment_id` parent context. Cursor-based pagination.
* **Enables:** count and attribute the reactions recorded on a specific file comment.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/files/{file_key}/comments/{id}/reactions` as a full snapshot. Results are limited by the token's granted scopes and team resource allowlist; inaccessible files and teams are absent.
Developer identifier: `comment_reactions.comment_id`
Comment ID identifies parent id injected by the ingestor from the `file_comments` to `comment_reactions` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match comment reaction records to provider records that carry the same comment ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `comment_id` as a record-level identifier on `CommentReaction`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `comment_reactions.created_at`
Created At records ISO 8601 timestamp indicating when the reaction was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place comment reaction records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per comment reaction record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `comment_reactions.emoji`
Emoji captures the emoji shortcode representing the reaction. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied emoji for the represented design or board object.
* **Interpretation:** The provider supplies `emoji` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `comment_reactions.file_key`
File Key identifies parent `file_key` injected by the ingestor from the `file_comments` to `comment_reactions` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match comment reaction records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `file_key` as a record-level identifier on `CommentReaction`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `comment_reactions.id`
Parable hashes `file_key`, `comment_id`, `emoji`, and `user.id` to identify a reaction. Two people using the same emoji on the same comment remain separate rows. Repeated reads of the same person's reaction keep the same key.
Developer identifier: `comment_reactions.user`
User captures the user who posted this reaction on the comment. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the comment reaction record to the provider-reported actor represented by user.
* **Interpretation:** The provider supplies `user` as identity or attribution context on each comment reaction record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `comment_reactions.user.handle`
Handle records display name (handle) of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the reaction user record to the provider-reported person or account represented by handle.
* **Interpretation:** The provider supplies `handle` as identity or attribution context on each reaction user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `comment_reactions.user.id`
ID is the unique identifier for the Figma user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match comment reaction records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ReactionUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `comment_reactions.user.img_url`
Img URL records URL to the user's profile image/avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by img URL on a reaction user record.
* **Interpretation:** The provider supplies `img_url` as a URL or resource locator on each reaction user record. Availability still follows the provider's permissions and retention.
Developer identifier: `file_comments`
File Comments contain all comments on a Figma file. Requires a `file_key` parent context.
* **Enables:** review comment text and authorship attached to each design file.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/files/{key}/comments` as a full snapshot. Results are limited by the token's granted scopes and team resource allowlist; inaccessible files and teams are absent.
Developer identifier: `file_comments.client_meta`
Client Meta records positional metadata indicating where the comment was placed on the canvas or within a frame. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** place the represented design or board object using its provider canvas client meta.
* **Interpretation:** The provider supplies `client_meta` in its canvas coordinate system for this object; it is not a geographic coordinate.
Developer identifier: `file_comments.client_meta.node_id`
Node ID captures the node ID the comment is pinned to, if applicable. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file comment records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `node_id` as a record-level identifier on `ClientMeta`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_comments.client_meta.node_offset`
Node Offset records offset from the node origin where the comment is pinned. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** place the represented design or board object using its provider canvas node offset.
* **Interpretation:** The provider supplies `node_offset` in its canvas coordinate system for this object; it is not a geographic coordinate.
Developer identifier: `file_comments.client_meta.node_offset.x`
X Coordinate records x component. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** place the represented design or board object using its provider canvas x coordinate.
* **Interpretation:** The provider supplies `x` in its canvas coordinate system for this object; it is not a geographic coordinate.
Developer identifier: `file_comments.client_meta.node_offset.y`
Y Coordinate records y component. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** place the represented design or board object using its provider canvas y coordinate.
* **Interpretation:** The provider supplies `y` in its canvas coordinate system for this object; it is not a geographic coordinate.
Developer identifier: `file_comments.client_meta.x`
X Coordinate records x coordinate of the comment pin. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** place the represented design or board object using its provider canvas x coordinate.
* **Interpretation:** The provider supplies `x` in its canvas coordinate system for this object; it is not a geographic coordinate.
Developer identifier: `file_comments.client_meta.y`
Y Coordinate records y coordinate of the comment pin. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** place the represented design or board object using its provider canvas y coordinate.
* **Interpretation:** The provider supplies `y` in its canvas coordinate system for this object; it is not a geographic coordinate.
Developer identifier: `file_comments.created_at`
Created At records ISO 8601 timestamp when the comment was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place file comment records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per file comment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `file_comments.file_key`
File Key captures the key of the Figma file this comment belongs to. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file comment records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `file_key` as a record-level identifier on `FileComment`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_comments.id`
ID is the unique identifier for the comment. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same file comment source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per file comment record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `file_comments.message`
Message captures the comment message text. Returned as markdown when `as_md`=true. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact message returned for each Figma file comment record.
* **Interpretation:** The value covers only the file comments content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `file_comments.order_id`
Order ID contains an ordering identifier used to sort comments chronologically. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file comment records to provider records that carry the same order ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `order_id` as a record-level identifier on `FileComment`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_comments.parent_id`
Parent ID captures the ID of the parent comment if this comment is a reply. Empty string if top-level. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file comment records to provider records that carry the same parent ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `parent_id` as a record-level identifier on `FileComment`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_comments.resolved_at`
Resolved At records ISO 8601 timestamp when the comment was resolved. Null if unresolved. It anchors the named event or boundary on the record's timeline.
* **Enables:** place file comment records on a timeline by resolved at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `resolved_at` per file comment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `file_comments.user`
User captures the user who posted the comment. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the file comment record to the provider-reported actor represented by user.
* **Interpretation:** The provider supplies `user` as identity or attribution context on each file comment record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `file_comments.user.handle`
Handle records display name / handle of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the comment user record to the provider-reported person or account represented by handle.
* **Interpretation:** The provider supplies `handle` as identity or attribution context on each comment user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `file_comments.user.id`
ID is the unique user identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file comment records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `CommentUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_comments.user.img_url`
Img URL records URL of the user's profile image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by img URL on a comment user record.
* **Interpretation:** The provider supplies `img_url` as a URL or resource locator on each comment user record. Availability still follows the provider's permissions and retention.
Developer identifier: `file_components`
File Components contain all components within a specific Figma file. Requires a `file_key` parent context.
* **Enables:** inspect component definitions local to a specific design file.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/files/{key}/components` as a full snapshot. Results are limited by the token's granted scopes and team resource allowlist; inaccessible files and teams are absent.
Developer identifier: `file_components.component_set_id`
Component Set ID identifies if this component is part of a component set (variants), this is the key of the parent component set. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file component records to provider records that carry the same component set ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `component_set_id` as a record-level identifier on `FileComponent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_components.component_set_name`
Component Set Name captures the name of the parent component set, if applicable. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact component set name returned for each Figma file component record.
* **Interpretation:** The value covers only the file components content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `file_components.containing_frame`
Containing Frame records information about the frame that contains this component in the file. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested containing frame object into its declared child fields for each file component record.
* **Interpretation:** The provider returns `containing_frame` as a nested object or reference on `FileComponent`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `file_components.containing_frame.backgroundColor`
Background Color records background color of the containing frame. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied background color for the represented design or board object.
* **Interpretation:** The provider supplies `backgroundColor` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `file_components.containing_frame.containingStateGroup`
Containing State Group states if the component is inside a state group, information about that group. It preserves the provider's current classification of this record.
* **Enables:** separate file component records by the exact provider-reported containing state group value when describing their recorded state.
* **Interpretation:** The provider supplies `containingStateGroup` per containing frame record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `file_components.containing_frame.containingStateGroup.name`
Name captures the name of the state group. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma file component record.
* **Interpretation:** The value covers only the file components content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `file_components.containing_frame.containingStateGroup.nodeId`
Node ID captures the node ID of the state group. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file component records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `nodeId` as a record-level identifier on `ContainingStateGroup`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_components.containing_frame.name`
Name captures the name of the containing frame. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma file component record.
* **Interpretation:** The value covers only the file components content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `file_components.containing_frame.nodeId`
Node ID captures the node ID of the containing frame. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file component records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `nodeId` as a record-level identifier on `ContainingFrame`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_components.containing_frame.pageId`
Page ID captures the node ID of the page that contains this frame. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file component records to provider records that carry the same page ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `pageId` as a record-level identifier on `ContainingFrame`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_components.containing_frame.pageName`
Page Name captures the name of the page that contains this frame. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact page name returned for each Figma file component record.
* **Interpretation:** The value covers only the file components content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `file_components.created_at`
Created At records ISO 8601 timestamp indicating when the component was first created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place file component records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per file component record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `file_components.description`
Description contains a human-readable description of the component. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description returned for each Figma file component record.
* **Interpretation:** The value covers only the file components content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `file_components.file_key`
File Key captures the key of the Figma file containing this component. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file component records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `file_key` as a record-level identifier on `FileComponent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_components.key`
Key is the unique component key that globally identifies this component. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same file component source row before constructing its represented state.
* **Interpretation:** The provider supplies `key` at one value per file component record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `file_components.name`
Name captures the name of the component as displayed in Figma. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma file component record.
* **Interpretation:** The value covers only the file components content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `file_components.node_id`
Node ID captures the node ID of this component within the file's document tree. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file component records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `node_id` as a record-level identifier on `FileComponent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_components.thumbnail_url`
Thumbnail URL records URL to a thumbnail image of the component. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by thumbnail URL on a file component record.
* **Interpretation:** The provider supplies `thumbnail_url` as a URL or resource locator on each file component record. Availability still follows the provider's permissions and retention.
Developer identifier: `file_components.updated_at`
Updated At records ISO 8601 timestamp indicating when the component was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place file component records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated_at` per file component record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `file_components.user`
User captures the user who last modified or published this component. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the file component record to the provider-reported actor represented by user.
* **Interpretation:** The provider supplies `user` as identity or attribution context on each file component record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `file_components.user.handle`
Handle records display name (handle) of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by handle.
* **Interpretation:** The provider supplies `handle` as identity or attribution context on each user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `file_components.user.id`
ID is the unique identifier for the Figma user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file component records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `User`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_components.user.img_url`
Img URL records URL to the user's profile image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by img URL on a user record.
* **Interpretation:** The provider supplies `img_url` as a URL or resource locator on each user record. Availability still follows the provider's permissions and retention.
Developer identifier: `file_dev_resources`
File Dev Resources contain dev resources attached to a Figma file. Requires a `file_key` parent context.
* **Enables:** trace developer-resource links attached to nodes in a specific file.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/files/{key}/dev_resources` as a full snapshot. Results are limited by the token's granted scopes and team resource allowlist; inaccessible files and teams are absent.
Developer identifier: `file_dev_resources.created_at`
Created At records ISO 8601 timestamp of when the dev resource was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place file dev resource records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per dev resource record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `file_dev_resources.created_by`
Created By captures the user who created this dev resource. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the dev resource record to the provider-reported person or account represented by created by.
* **Interpretation:** The provider supplies `created_by` as identity or attribution context on each dev resource record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `file_dev_resources.created_by.handle`
Handle records display name / handle of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by handle.
* **Interpretation:** The provider supplies `handle` as identity or attribution context on each user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `file_dev_resources.created_by.id`
ID is the unique user identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file dev resource records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `User`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_dev_resources.created_by.img_url`
Img URL records URL of the user's profile image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by img URL on a user record.
* **Interpretation:** The provider supplies `img_url` as a URL or resource locator on each user record. Availability still follows the provider's permissions and retention.
Developer identifier: `file_dev_resources.dev_resource_type`
Dev Resource Type captures the type/category of the dev resource. It preserves the provider's current classification of this record.
* **Enables:** separate file dev resource records by the exact provider-reported dev resource type value when describing their recorded state.
* **Interpretation:** The provider supplies `dev_resource_type` per dev resource record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `file_dev_resources.file_key`
File Key captures the key of the Figma file this dev resource belongs to. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file dev resource records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `file_key` as a record-level identifier on `DevResource`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_dev_resources.id`
ID is the unique identifier for the dev resource. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same dev resource source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per dev resource record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `file_dev_resources.inherited_from`
Inherited From identifies the component or instance from which the development resource inherits. It preserves the source relationship needed to explain inherited resource metadata.
* **Enables:** follow the inheritance link back to its source component or instance and distinguish inherited resources from directly defined ones.
* **Interpretation:** The provider returns `inherited_from` as a nested source reference on `DevResource`; absence means no inheritance source was reported on that resource.
Developer identifier: `file_dev_resources.inherited_from.file_key`
File Key captures the file key of the source file from which the dev resource was inherited. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file dev resource records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `file_key` as a record-level identifier on `InheritedFrom`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_dev_resources.inherited_from.node_id`
Node ID captures the node ID in the source file from which the dev resource was inherited. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file dev resource records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `node_id` as a record-level identifier on `InheritedFrom`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_dev_resources.name`
Name records display name of the dev resource. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma file dev resource record.
* **Interpretation:** The value covers only the file dev resources content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `file_dev_resources.node_id`
Node ID captures the ID of the node within the file that this dev resource is attached to. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file dev resource records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `node_id` as a record-level identifier on `DevResource`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_dev_resources.updated_at`
Updated At records ISO 8601 timestamp of when the dev resource was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place file dev resource records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated_at` per dev resource record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `file_dev_resources.url`
URL records URL of the external dev resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a dev resource record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each dev resource record. Availability still follows the provider's permissions and retention.
Developer identifier: `file_styles`
File Styles contain all styles within a specific Figma file. Requires a `file_key` parent context.
* **Enables:** inspect style definitions local to a specific design file.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/files/{key}/styles` as a full snapshot. Results are limited by the token's granted scopes and team resource allowlist; inaccessible files and teams are absent.
Developer identifier: `file_styles.created_at`
Created At records ISO 8601 timestamp indicating when the style was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place file style records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per figma file style record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `file_styles.description`
Description records description of the style provided by the designer. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description returned for each Figma file style record.
* **Interpretation:** The value covers only the file styles content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `file_styles.file_key`
File Key captures the key of the Figma file that contains this style. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file style records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `file_key` as a record-level identifier on `FigmaFileStyle`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_styles.key`
Key is the unique identifier key for the style. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same figma file style source row before constructing its represented state.
* **Interpretation:** The provider supplies `key` at one value per figma file style record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `file_styles.name`
Name records human-readable name of the style. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma file style record.
* **Interpretation:** The value covers only the file styles content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `file_styles.node_id`
Node ID captures the node ID within the file where this style is defined. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file style records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `node_id` as a record-level identifier on `FigmaFileStyle`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_styles.sort_position`
Sort Position contains a string used for sorting the style within its category or file. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify file style records using the provider-defined sort position value.
* **Interpretation:** The provider supplies `sort_position` at figma file style granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `file_styles.style_type`
Style Type captures the type of style (e.g., FILL, TEXT, EFFECT, GRID). It preserves the provider's current classification of this record.
* **Enables:** separate file style records by the exact provider-reported style type value when describing their recorded state.
* **Interpretation:** The provider supplies `style_type` per figma file style record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `file_styles.thumbnail_url`
Thumbnail URL records URL to a thumbnail image representing the style. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by thumbnail URL on a figma file style record.
* **Interpretation:** The provider supplies `thumbnail_url` as a URL or resource locator on each figma file style record. Availability still follows the provider's permissions and retention.
Developer identifier: `file_styles.updated_at`
Updated At records ISO 8601 timestamp indicating when the style was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place file style records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated_at` per figma file style record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `file_styles.user`
User captures the user who last modified or published the style. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the figma file style record to the provider-reported actor represented by user.
* **Interpretation:** The provider supplies `user` as identity or attribution context on each figma file style record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `file_styles.user.handle`
Handle records display name (handle) of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the figma user record to the provider-reported person or account represented by handle.
* **Interpretation:** The provider supplies `handle` as identity or attribution context on each figma user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `file_styles.user.id`
ID is the unique identifier of the Figma user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file style records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `FigmaUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_styles.user.img_url`
Img URL records URL to the user's profile image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by img URL on a figma user record.
* **Interpretation:** The provider supplies `img_url` as a URL or resource locator on each figma user record. Availability still follows the provider's permissions and retention.
Developer identifier: `file_versions`
File Versions contain paginated version history for a Figma file. Requires a `file_key` parent context. Pagination uses `next_page` URL from the pagination object in the response.
* **Enables:** reconstruct the version history returned for each design file.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/files/{key}/versions` as a full snapshot. Results are limited by the token's granted scopes and team resource allowlist; inaccessible files and teams are absent.
Developer identifier: `file_versions.created_at`
Created At records ISO 8601 timestamp indicating when this version was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place file version records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per file version record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `file_versions.description`
Description records user-provided description for this version. May be empty if no description was set. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description returned for each Figma file version record.
* **Interpretation:** The value covers only the file versions content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `file_versions.file_key`
File Key identifies parent key injected by the ingestor from the `project_files` to `file_versions` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file version records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `file_key` as a record-level identifier on `FileVersion`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_versions.id`
ID is the unique identifier for this file version. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same file version source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per file version record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `file_versions.label`
Label records user-assigned label or name for this version. May be empty if no label was set. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact label returned for each Figma file version record.
* **Interpretation:** The value covers only the file versions content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `file_versions.thumbnail_url`
Thumbnail URL records URL to a thumbnail image representing the file at this version. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by thumbnail URL on a file version record.
* **Interpretation:** The provider supplies `thumbnail_url` as a URL or resource locator on each file version record. Availability still follows the provider's permissions and retention.
Developer identifier: `file_versions.user`
User captures the user who created or saved this version. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the file version record to the provider-reported actor represented by user.
* **Interpretation:** The provider supplies `user` as identity or attribution context on each file version record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `file_versions.user.email`
Email records email address of the user. Typically only populated on the /v1/me endpoint; may be absent here. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `file_versions.user.handle`
Handle records display name or handle of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by handle.
* **Interpretation:** The provider supplies `handle` as identity or attribution context on each user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `file_versions.user.id`
ID is the unique identifier for the Figma user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match file version records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `User`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `file_versions.user.img_url`
Img URL records URL to the user's profile avatar image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by img URL on a user record.
* **Interpretation:** The provider supplies `img_url` as a URL or resource locator on each user record. Availability still follows the provider's permissions and retention.
Developer identifier: `project_files`
Project Files contain all files within a Figma project. Requires a `project_id` parent context. Returns file key, name, thumbnail URL, and last modified timestamp.
* **Enables:** catalog design files in each project with their names, thumbnails, and modification times.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/projects/{id}/files` as a full snapshot. Results are limited by the token's granted scopes and team resource allowlist; inaccessible files and teams are absent.
Developer identifier: `project_files.branches`
Branches records list of branches for this file. Only present when `branch_data` query parameter is set to true. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested branches object into its declared child fields for each project file record.
* **Interpretation:** The provider returns `branches` as a list on `ProjectFile`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `project_files.branches.key`
Key is the unique key identifier for the branch file. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same branch source row before constructing its represented state.
* **Interpretation:** The provider supplies `key` at one value per branch record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `project_files.branches.last_modified`
Last Modified records ISO 8601 timestamp indicating when the branch was last modified. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project file records on a timeline by last modified and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `last_modified` per branch record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `project_files.branches.name`
Name captures the human-readable name of the branch. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma project file record.
* **Interpretation:** The value covers only the project files content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `project_files.branches.thumbnail_url`
Thumbnail URL records URL of the branch's thumbnail image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by thumbnail URL on a branch record.
* **Interpretation:** The provider supplies `thumbnail_url` as a URL or resource locator on each branch record. Availability still follows the provider's permissions and retention.
Developer identifier: `project_files.key`
Key is the unique file key identifier used to reference this file across the Figma API. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same project file source row before constructing its represented state.
* **Interpretation:** The provider supplies `key` at one value per project file record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `project_files.last_modified`
Last Modified records ISO 8601 timestamp indicating when the file was last modified. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project file records on a timeline by last modified and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `last_modified` per project file record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `project_files.name`
Name captures the human-readable name of the file. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma project file record.
* **Interpretation:** The value covers only the project files content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `project_files.team_id`
Team ID identifies parent id injected by the ingestor from the `team_projects` to `project_files` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project file records to provider records that carry the same team ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `team_id` as a record-level identifier on `ProjectFile`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `project_files.thumbnail_url`
Thumbnail URL records URL of the file's thumbnail image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by thumbnail URL on a project file record.
* **Interpretation:** The provider supplies `thumbnail_url` as a URL or resource locator on each project file record. Availability still follows the provider's permissions and retention.
Developer identifier: `team_component_sets`
Team Component Sets contain all published component sets for a Figma team. Cursor-based pagination using after parameter. Requires `team_id` parent context.
* **Enables:** catalog published component families available from each team.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/teams/{team_id}/component_sets` as a full snapshot. Results are limited by the token's granted scopes and team resource allowlist; inaccessible files and teams are absent.
Developer identifier: `team_component_sets.containing_frame`
Containing Frame records information about the frame that contains this component set in the file. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested containing frame object into its declared child fields for each team component set record.
* **Interpretation:** The provider returns `containing_frame` as a nested object or reference on `TeamComponentSet`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `team_component_sets.containing_frame.backgroundColor`
Background Color records background color of the containing frame. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied background color for the represented design or board object.
* **Interpretation:** The provider supplies `backgroundColor` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `team_component_sets.containing_frame.containingStateGroup`
Containing State Group states if the component set is inside a state group, this describes that group. It preserves the provider's current classification of this record.
* **Enables:** separate team component set records by the exact provider-reported containing state group value when describing their recorded state.
* **Interpretation:** The provider supplies `containingStateGroup` per containing frame record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `team_component_sets.containing_frame.containingStateGroup.name`
Name captures the name of the containing state group. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma team component set record.
* **Interpretation:** The value covers only the team component sets content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `team_component_sets.containing_frame.containingStateGroup.nodeId`
Node ID captures the node ID of the containing state group. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component set records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `nodeId` as a record-level identifier on `ContainingStateGroup`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_component_sets.containing_frame.name`
Name captures the name of the containing frame. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma team component set record.
* **Interpretation:** The value covers only the team component sets content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `team_component_sets.containing_frame.nodeId`
Node ID captures the node ID of the containing frame. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component set records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `nodeId` as a record-level identifier on `ContainingFrame`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_component_sets.containing_frame.pageId`
Page ID captures the node ID of the page that contains this frame. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component set records to provider records that carry the same page ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `pageId` as a record-level identifier on `ContainingFrame`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_component_sets.containing_frame.pageName`
Page Name captures the name of the page that contains this frame. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact page name returned for each Figma team component set record.
* **Interpretation:** The value covers only the team component sets content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `team_component_sets.created_at`
Created At records ISO 8601 timestamp indicating when this component set was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place team component set records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per team component set record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `team_component_sets.description`
Description contains a text description of the component set. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description returned for each Figma team component set record.
* **Interpretation:** The value covers only the team component sets content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `team_component_sets.file_key`
File Key captures the key of the file that contains this component set. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component set records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `file_key` as a record-level identifier on `TeamComponentSet`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_component_sets.key`
Key is the unique identifier key for this component set. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same team component set source row before constructing its represented state.
* **Interpretation:** The provider supplies `key` at one value per team component set record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `team_component_sets.name`
Name captures the name of the component set. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma team component set record.
* **Interpretation:** The value covers only the team component sets content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `team_component_sets.node_id`
Node ID captures the node ID of this component set within its file. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component set records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `node_id` as a record-level identifier on `TeamComponentSet`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_component_sets.team_id`
Team ID identifies team id injected by the ingestor from config fan-out `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component set records to provider records that carry the same team ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `team_id` as a record-level identifier on `TeamComponentSet`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_component_sets.thumbnail_url`
Thumbnail URL records URL of the thumbnail image for this component set. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by thumbnail URL on a team component set record.
* **Interpretation:** The provider supplies `thumbnail_url` as a URL or resource locator on each team component set record. Availability still follows the provider's permissions and retention.
Developer identifier: `team_component_sets.updated_at`
Updated At records ISO 8601 timestamp indicating when this component set was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place team component set records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated_at` per team component set record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `team_component_sets.user`
User captures the user who last published this component set. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the team component set record to the provider-reported actor represented by user.
* **Interpretation:** The provider supplies `user` as identity or attribution context on each team component set record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `team_component_sets.user.handle`
Handle records display name (handle) of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the figma user record to the provider-reported person or account represented by handle.
* **Interpretation:** The provider supplies `handle` as identity or attribution context on each figma user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `team_component_sets.user.id`
ID is the unique identifier of the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component set records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `FigmaUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_component_sets.user.img_url`
Img URL records URL of the user's profile image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by img URL on a figma user record.
* **Interpretation:** The provider supplies `img_url` as a URL or resource locator on each figma user record. Availability still follows the provider's permissions and retention.
Developer identifier: `team_components`
Team Components contain all published components for a Figma team. Cursor-based pagination using after parameter. Requires `team_id` parent context.
* **Enables:** catalog published components available from each team.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/teams/{team_id}/components` as a full snapshot. Results are limited by the token's granted scopes and team resource allowlist; inaccessible files and teams are absent.
Developer identifier: `team_components.component_set_id`
Component Set ID identifies if this component is part of a component set (variants), the ID of the parent component set. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component records to provider records that carry the same component set ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `component_set_id` as a record-level identifier on `TeamComponent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_components.component_set_name`
Component Set Name records if this component is part of a component set, the name of the parent component set. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact component set name returned for each Figma team component record.
* **Interpretation:** The value covers only the team components content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `team_components.containing_frame`
Containing Frame records information about the frame that contains this component in the file. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested containing frame object into its declared child fields for each team component record.
* **Interpretation:** The provider returns `containing_frame` as a nested object or reference on `TeamComponent`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `team_components.containing_frame.backgroundColor`
Background Color captures the background color of the containing frame. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied background color for the represented design or board object.
* **Interpretation:** The provider supplies `backgroundColor` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `team_components.containing_frame.containingStateGroup`
Containing State Group states if the component is inside a state group, information about that group. It preserves the provider's current classification of this record.
* **Enables:** separate team component records by the exact provider-reported containing state group value when describing their recorded state.
* **Interpretation:** The provider supplies `containingStateGroup` per containing frame record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `team_components.containing_frame.containingStateGroup.name`
Name captures the name of the state group. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma team component record.
* **Interpretation:** The value covers only the team components content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `team_components.containing_frame.containingStateGroup.nodeId`
Node ID captures the node ID of the state group. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `nodeId` as a record-level identifier on `ContainingStateGroup`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_components.containing_frame.name`
Name captures the name of the containing frame. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma team component record.
* **Interpretation:** The value covers only the team components content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `team_components.containing_frame.nodeId`
Node ID captures the node ID of the containing frame. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `nodeId` as a record-level identifier on `ContainingFrame`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_components.containing_frame.pageId`
Page ID captures the node ID of the page that contains this frame. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component records to provider records that carry the same page ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `pageId` as a record-level identifier on `ContainingFrame`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_components.containing_frame.pageName`
Page Name captures the name of the page that contains this frame. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact page name returned for each Figma team component record.
* **Interpretation:** The value covers only the team components content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `team_components.created_at`
Created At records ISO 8601 timestamp indicating when the component was first created/published. It anchors the named event or boundary on the record's timeline.
* **Enables:** place team component records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per team component record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `team_components.description`
Description contains a text description of the component, typically set by the designer. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description returned for each Figma team component record.
* **Interpretation:** The value covers only the team components content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `team_components.file_key`
File Key captures the key of the Figma file that contains this component. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `file_key` as a record-level identifier on `TeamComponent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_components.key`
Key is the unique identifier key for the component. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same team component source row before constructing its represented state.
* **Interpretation:** The provider supplies `key` at one value per team component record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `team_components.name`
Name captures the display name of the component. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma team component record.
* **Interpretation:** The value covers only the team components content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `team_components.node_id`
Node ID captures the node ID of this component within its containing file. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `node_id` as a record-level identifier on `TeamComponent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_components.team_id`
Team ID identifies team id injected by the ingestor from config fan-out `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component records to provider records that carry the same team ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `team_id` as a record-level identifier on `TeamComponent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_components.thumbnail_url`
Thumbnail URL records URL of the component's thumbnail image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by thumbnail URL on a team component record.
* **Interpretation:** The provider supplies `thumbnail_url` as a URL or resource locator on each team component record. Availability still follows the provider's permissions and retention.
Developer identifier: `team_components.updated_at`
Updated At records ISO 8601 timestamp indicating when the component was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place team component records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated_at` per team component record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `team_components.user`
User captures the user who last published or updated the component. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the team component record to the provider-reported actor represented by user.
* **Interpretation:** The provider supplies `user` as identity or attribution context on each team component record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `team_components.user.handle`
Handle captures the user's display name / handle. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the figma user record to the provider-reported person or account represented by handle.
* **Interpretation:** The provider supplies `handle` as identity or attribution context on each figma user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `team_components.user.id`
ID is the unique numeric identifier for the user, represented as a string. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team component records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `FigmaUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_components.user.img_url`
Img URL records URL of the user's profile image / avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by img URL on a figma user record.
* **Interpretation:** The provider supplies `img_url` as a URL or resource locator on each figma user record. Availability still follows the provider's permissions and retention.
Developer identifier: `team_projects`
Team Projects contain all projects within a Figma team. Requires a `team_id` parent context. Returns project id and name.
* **Enables:** enumerate projects inside each configured Figma team.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/teams/{team_id}/projects` as a full snapshot. Results are limited by the token's granted scopes and team resource allowlist; inaccessible files and teams are absent.
Developer identifier: `team_projects.id`
ID is the unique identifier for the project within Figma. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same team project source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per team project record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `team_projects.name`
Name records human-readable name of the project. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma team project record.
* **Interpretation:** The value covers only the team projects content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `team_projects.team_id`
Team ID identifies team id injected by the ingestor from config fan-out `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team project records to provider records that carry the same team ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `team_id` as a record-level identifier on `TeamProject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_styles`
Team Styles contain all published styles for a Figma team. Cursor-based pagination using after parameter. Requires `team_id` parent context.
* **Enables:** catalog published styles available from each team.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/teams/{team_id}/styles` as a full snapshot. Results are limited by the token's granted scopes and team resource allowlist; inaccessible files and teams are absent.
Developer identifier: `team_styles.created_at`
Created At records ISO 8601 timestamp indicating when the style was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place team style records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per team style record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `team_styles.description`
Description records description of the style provided by the creator. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description returned for each Figma team style record.
* **Interpretation:** The value covers only the team styles content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `team_styles.file_key`
File Key captures the key of the file that contains this style. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team style records to provider records that carry the same file key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `file_key` as a record-level identifier on `TeamStyle`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_styles.key`
Key is the unique style key that identifies this style across Figma. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same team style source row before constructing its represented state.
* **Interpretation:** The provider supplies `key` at one value per team style record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `team_styles.name`
Name records human-readable name of the style. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name returned for each Figma team style record.
* **Interpretation:** The value covers only the team styles content returned by this Figma operation; unrequested canvas content is not inferred.
Developer identifier: `team_styles.node_id`
Node ID captures the node ID within the file where this style is defined. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team style records to provider records that carry the same node ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `node_id` as a record-level identifier on `TeamStyle`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_styles.sort_position`
Sort Position reports sort position of the style. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify team style records using the provider-defined sort position value.
* **Interpretation:** The provider supplies `sort_position` at team style granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `team_styles.style_type`
Style Type captures the type of the style (e.g., FILL, TEXT, EFFECT, GRID). It preserves the provider's current classification of this record.
* **Enables:** separate team style records by the exact provider-reported style type value when describing their recorded state.
* **Interpretation:** The provider supplies `style_type` per team style record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `team_styles.team_id`
Team ID identifies team id injected by the ingestor from config fan-out `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team style records to provider records that carry the same team ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `team_id` as a record-level identifier on `TeamStyle`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_styles.thumbnail_url`
Thumbnail URL records URL to a thumbnail image representing this style. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by thumbnail URL on a team style record.
* **Interpretation:** The provider supplies `thumbnail_url` as a URL or resource locator on each team style record. Availability still follows the provider's permissions and retention.
Developer identifier: `team_styles.updated_at`
Updated At records ISO 8601 timestamp indicating when the style was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place team style records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated_at` per team style record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `team_styles.user`
User captures the user who published or last updated this style. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the team style record to the provider-reported actor represented by user.
* **Interpretation:** The provider supplies `user` as identity or attribution context on each team style record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `team_styles.user.handle`
Handle records display name (handle) of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the style user record to the provider-reported person or account represented by handle.
* **Interpretation:** The provider supplies `handle` as identity or attribution context on each style user record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `team_styles.user.id`
ID is the unique identifier of the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team style records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `StyleUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_styles.user.img_url`
Img URL records URL to the user's avatar image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by img URL on a style user record.
* **Interpretation:** The provider supplies `img_url` as a URL or resource locator on each style user record. Availability still follows the provider's permissions and retention.
| Error | Meaning | Solution |
| - | - | - |
| `403 Invalid token` | Bad PAT, or PAT was revoked | Re-mint from Figma Settings → Security; confirm minting user is still active |
| `403 Invalid scope` | PAT missing a required scope | Re-mint with the full scope list above |
| `404 Not found` on a file or team | Minting user lacks access | Add service-account user to the team, or remove the missing resource |
| `403` on a Plan Access Token | Team is outside the token's resource allowlist | Edit the token at figma.com/developers/tokens and add the team, or allow all resources |
| `429 Too many requests` | Rate limit exceeded | Parable respects `Retry-After` and backs off automatically |
| `Activity logs return empty` | Tap is disabled by default | Enable the `activity_logs` tap in Provider settings; requires Enterprise plan and org admin access |
#### Common Issues
#### The connection reports an invalid token
Confirm you copied the full token string -- Figma PATs are 40+ characters and may contain hyphens. Trailing whitespace from a paste also fails; re-paste into the Provider form.
#### `activity_logs` returns 402 / `payment_required`
Activity logs are an Enterprise-only feature and are disabled by default. Enable the `activity_logs` tap only on Enterprise plans with org admin access.
**[Figma REST API](https://www.figma.com/developers/api)** — Full endpoint reference
**[Personal access tokens](https://www.figma.com/developers/api#access-tokens)** — Official PAT setup guide including scope semantics
# GitHub
Source: https://docs.parable.work/plugins/provider-plugins/github
Sync repositories, issues, pull requests, and commits from GitHub
Sync repositories, issues, pull requests, and commits from GitHub.
Connect Parable to GitHub using fine-grained personal access tokens for granular, organization-scoped access to repositories and organization data.
#### Repositories
Commits, branches, pull requests, issues
#### Organization
Members, teams, projects, events
## Data streams
This Provider Plugin defines 12 data streams.
| Stream | Description | Sync |
| - | - | - |
| `repositories` | Organization repositories | incremental |
| `members` | Organization members | full |
| `issues` | Repository issues (includes pull requests) | incremental |
| `pull_requests` | Repository pull requests | incremental |
| `commits` | Repository commits | incremental |
| `teams` | Organization teams | full |
| `team_members` | Team members | full |
| `branches` | Repository branches | full |
| `commits_by_branch` | Repository commits for a specific branch | incremental |
| `commit_diffs` | Commit diff details including files changed | full |
| `pull_request_comments` | Comments on pull requests (review comments) | incremental |
| `releases` | Repository releases | incremental |
### GitHub
#### What You'll Need
| Credential | What it is |
| - | - |
| **Token** | Fine-grained personal access token |
| **Org ID** | Your GitHub organization name |
* **Admin access** to the GitHub organization
* A GitHub account that is a **member of the organization** with admin privileges
#### Step 1: Access Developer Settings
1. Log in to GitHub
2. Click your profile picture → **Settings**
3. Scroll to the bottom → **Developer settings**
#### Step 2: Create Fine-Grained Token
1. Select **Personal access tokens** → **Fine-grained tokens**
2. Click **Generate new token**
3. If you have 2FA enabled, enter your code
#### Step 3: Configure Token Settings
| Setting | Value |
| - | - |
| **Token name** | `Parable GitHub Integration` |
| **Description** | Integration for Parable analytics |
| **Resource owner** | Select your organization |
| **Expiration** | 360 days (recommended) |
| **Repository access** | All repositories (or select specific) |
#### Step 4: Set Organization Permissions
Under **Organization permissions**, set these to **Read**:
* ✅ Members
* ✅ Organization administration
* ✅ Organization events
* ✅ Organization projects
* ✅ Team discussions
#### Step 5: Set Repository Permissions
Under **Repository permissions**, set these to **Read**:
* ✅ Pull requests
* ✅ Issues
* ✅ Discussions
* ✅ Commit statuses
* ✅ Contents
* ✅ Code (if available)
* ✅ Metadata
#### Step 6: Generate and Save
1. Click **Generate token**
2. Copy the token immediately
> **Warning:** **Copy your personal access token now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
#### Step 7: Enter values in the form
1. **Token** and **Org ID**: Paste your fine-grained token and GitHub organization name.
2. Click **Save & test connection**.
Developer identifier: `branches`
Branches covers repository branches.
* **Enables:** inventory returned branches and connect each branch name to its head revision and protection details.
* **Scope:** Repository branches; the connector reads `/repos/{full_name}/branches` as a snapshot stream in full mode. The configured credential must grant the declared `repo` access scope; records outside that access are not returned. A successful full collection can reveal a previously returned row as absent, but a credential or permission change can produce the same observation.
Developer identifier: `branches.commit`
Commit records the latest commit object on this branch. It is needed to preserve the nested commit relationship or details on the parent GitHub Branch record.
* **Enables:** expand `commit` to connect the containing GitHub Branch row to its returned commit entries.
* **Interpretation:** GitHub reports this value on the GitHub Branch object returned for Branches; it is one nested object per containing GitHub Branch object when present.
Developer identifier: `branches.commit.sha`
Sha records the SHA1 hash of the commit. It is needed to refer to the same branch commit across records without relying on display text.
* **Enables:** match `sha` to branch commit references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Branch Commit object returned for Branches; it is an identifier, not a measured quantity.
Developer identifier: `branches.commit.url`
URL records API URL for the commit resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Branch Commit object returned for Branches; it is link at one Branch Commit record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.full_name`
Full Name records owner-qualified repository identifier (e.g. 'owner/repo'). Injected from the parent repository context via parentContextFields; not present in the raw GitHub Branches API response. It is needed to refer to the same full name across records without relying on display text.
* **Enables:** match `full_name` to full name references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub's child response does not supply this field; the connector injects parent context into each child row; it is an identifier, not a measured quantity.
Developer identifier: `branches.name`
Name records the branch name. It is needed to distinguish repeated deliveries of the same Branches row using the declared ingestion key.
* **Enables:** use `name` as the declared ingestion deduplication key for Branches and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub Branch object returned for Branches; it is interpreted at one GitHub Branch record per row; the connector declares it as an ingestion deduplication key.
Developer identifier: `branches.protected`
Protected records whether the branch has protection rules enabled. It is needed to distinguish Branches rows by the exact GitHub-returned protected value.
* **Enables:** select Branches rows where `protected` is true or false when comparing the condition described by Protected.
* **Interpretation:** GitHub reports this value on the GitHub Branch object returned for Branches; it is interpreted at one GitHub Branch record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `branches.protection`
Protection records branch protection settings summary. It is needed to preserve the nested protection relationship or details on the parent GitHub Branch record.
* **Enables:** expand `protection` to connect the containing GitHub Branch row to its returned protection entries.
* **Interpretation:** GitHub reports this value on the GitHub Branch object returned for Branches; it is one nested object per containing GitHub Branch object when present.
Developer identifier: `branches.protection.allow_deletions`
Allow Deletions records whether the branch can be deleted. It is needed to measure the GitHub-reported number of allow deletions at one Branch Protection record per row.
* **Enables:** measure and compare the GitHub-reported number of allow deletions in `allow_deletions` at one Branch Protection record per row.
* **Interpretation:** GitHub reports this value on the Branch Protection object returned for Branches; it is a GitHub-reported count at one Branch Protection record per row.
Developer identifier: `branches.protection.allow_deletions.enabled`
Enabled records whether this protection setting is enabled. It is needed to distinguish Branches rows by the exact GitHub-returned enabled value.
* **Enables:** select Branches rows where `enabled` is true or false when comparing the condition described by Enabled.
* **Interpretation:** GitHub reports this value on the Protection Toggle object returned for Branches; it is interpreted at one Protection Toggle record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `branches.protection.allow_force_pushes`
Allow Force Pushes records whether force pushes are allowed. It is needed to preserve the nested allow force pushes relationship or details on the parent Branch Protection record.
* **Enables:** expand `allow_force_pushes` to connect the containing Branch Protection row to its returned allow force pushes entries.
* **Interpretation:** GitHub reports this value on the Branch Protection object returned for Branches; it is one nested object per containing Branch Protection object when present.
Developer identifier: `branches.protection.allow_fork_syncing`
Allow Fork Syncing records whether fork syncing is allowed. It is needed to preserve the nested allow fork syncing relationship or details on the parent Branch Protection record.
* **Enables:** expand `allow_fork_syncing` to connect the containing Branch Protection row to its returned allow fork syncing entries.
* **Interpretation:** GitHub reports this value on the Branch Protection object returned for Branches; it is one nested object per containing Branch Protection object when present.
Developer identifier: `branches.protection.block_creations`
Block Creations records whether creation of matching branches is blocked. It is needed to preserve the nested block creations relationship or details on the parent Branch Protection record.
* **Enables:** expand `block_creations` to connect the containing Branch Protection row to its returned block creations entries.
* **Interpretation:** GitHub reports this value on the Branch Protection object returned for Branches; it is one nested object per containing Branch Protection object when present.
Developer identifier: `branches.protection.enabled`
Enabled records whether branch protection is enabled. It is needed to distinguish Branches rows by the exact GitHub-returned enabled value.
* **Enables:** select Branches rows where `enabled` is true or false when comparing the condition described by Enabled.
* **Interpretation:** GitHub reports this value on the Branch Protection object returned for Branches; it is interpreted at one Branch Protection record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `branches.protection.enforce_admins`
Enforce Admins records whether protection rules are enforced for admins. It is needed to preserve the nested enforce admins relationship or details on the parent Branch Protection record.
* **Enables:** expand `enforce_admins` to connect the containing Branch Protection row to its returned enforce admins entries.
* **Interpretation:** GitHub reports this value on the Branch Protection object returned for Branches; it is one nested object per containing Branch Protection object when present.
Developer identifier: `branches.protection.enforce_admins.enabled`
Enabled records whether enforcement for admins is enabled. It is needed to distinguish Branches rows by the exact GitHub-returned enabled value.
* **Enables:** select Branches rows where `enabled` is true or false when comparing the condition described by Enabled.
* **Interpretation:** GitHub reports this value on the Enforce Admins object returned for Branches; it is interpreted at one Enforce Admins record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `branches.protection.enforce_admins.url`
URL records API URL for the enforce admins setting. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Enforce Admins object returned for Branches; it is link at one Enforce Admins record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.lock_branch`
Lock Branch records whether the branch is locked (read-only). It is needed to preserve the nested lock branch relationship or details on the parent Branch Protection record.
* **Enables:** expand `lock_branch` to connect the containing Branch Protection row to its returned lock branch entries.
* **Interpretation:** GitHub reports this value on the Branch Protection object returned for Branches; it is one nested object per containing Branch Protection object when present.
Developer identifier: `branches.protection.required_conversation_resolution`
Required Conversation Resolution records whether conversation resolution is required before merging. It is needed to preserve the nested required conversation resolution relationship or details on the parent Branch Protection record.
* **Enables:** expand `required_conversation_resolution` to connect the containing Branch Protection row to its returned required conversation resolution entries.
* **Interpretation:** GitHub reports this value on the Branch Protection object returned for Branches; it is one nested object per containing Branch Protection object when present.
Developer identifier: `branches.protection.required_linear_history`
Required Linear History records whether a linear commit history is required. It is needed to preserve the nested required linear history relationship or details on the parent Branch Protection record.
* **Enables:** expand `required_linear_history` to connect the containing Branch Protection row to its returned required linear history entries.
* **Interpretation:** GitHub reports this value on the Branch Protection object returned for Branches; it is one nested object per containing Branch Protection object when present.
Developer identifier: `branches.protection.required_pull_request_reviews`
Required Pull Request Reviews records required pull request review configuration. It is needed to preserve the nested required pull request reviews relationship or details on the parent Branch Protection record.
* **Enables:** expand `required_pull_request_reviews` to connect the containing Branch Protection row to its returned required pull request reviews entries.
* **Interpretation:** GitHub reports this value on the Branch Protection object returned for Branches; it is one nested object per containing Branch Protection object when present.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances`
Bypass Pull Request Allowances records actors who can bypass required pull request reviews. It is needed to preserve the nested bypass pull request allowances relationship or details on the parent Required Pull Request Reviews record.
* **Enables:** expand `bypass_pull_request_allowances` to connect the containing Required Pull Request Reviews row to its returned bypass pull request allowances entries.
* **Interpretation:** GitHub reports this value on the Required Pull Request Reviews object returned for Branches; it is one nested object per containing Required Pull Request Reviews object when present.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps`
Apps records GitHub Apps that can bypass. It is needed to preserve the nested apps relationship or details on the parent Bypass Allowances record.
* **Enables:** expand `apps` to connect the containing Bypass Allowances row to its returned apps entries.
* **Interpretation:** GitHub reports this value on the Bypass Allowances object returned for Branches; it is one returned collection per containing Bypass Allowances object.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.created_at`
Created At records when the app was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Branches records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the Simple App object returned for Branches; it is interpreted at one Simple App record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.description`
Description records description of the GitHub App. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, branch name, revision, and update time where returned.
* **Interpretation:** GitHub reports this value on the Simple App object returned for Branches; it is description text at one Simple App record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.events`
Events records the events the app subscribes to. It is needed to preserve the nested events relationship or details on the parent Simple App record.
* **Enables:** expand `events` to connect the containing Simple App row to its returned events entries.
* **Interpretation:** GitHub reports this value on the Simple App object returned for Branches; it is one returned collection per containing Simple App object.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.external_url`
External URL records the external URL of the GitHub App. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `external_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple App object returned for Branches; it is link at one Simple App record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.html_url`
HTML URL records web URL for the GitHub App. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple App object returned for Branches; it is link at one Simple App record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.id`
ID records the unique numeric ID of the GitHub App. It is needed to refer to the same simple app across records without relying on display text.
* **Enables:** match `id` to simple app references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Simple App object returned for Branches; it is an identifier, not a measured quantity.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.name`
Name records the name of the GitHub App. It is needed to compare the returned name for individual Branches rows and select rows with a specific `name` value.
* **Enables:** locate Branches rows whose returned name exactly matches `name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the Simple App object returned for Branches; it is interpreted at one Simple App record per row.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.node_id`
Node ID records the GraphQL node ID of the app. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Simple App object returned for Branches; it is an identifier, not a measured quantity.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner`
Owner records the owner of the GitHub App. It is needed to preserve the nested owner relationship or details on the parent Simple App record.
* **Enables:** expand `owner` to connect the containing Simple App row to its returned owner entries.
* **Interpretation:** GitHub reports this value on the Simple App object returned for Branches; it is one nested object per containing Simple App object when present.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.avatar_url`
Avatar URL records URL of the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `avatar_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is link at one Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.events_url`
Events URL records API URL template for the user's events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is link at one Simple User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.followers_url`
Followers URL records API URL for the user's followers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `followers_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is link at one Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.following_url`
Following URL records API URL template for users this user follows. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `following_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is link at one Simple User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.gists_url`
Gists URL records API URL template for the user's gists. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `gists_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is link at one Simple User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.gravatar_id`
Gravatar ID records the user's Gravatar ID. It is needed to refer to the same gravatar across records without relying on display text.
* **Enables:** match `gravatar_id` to gravatar references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is an identifier, not a measured quantity.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.html_url`
HTML URL records web URL for the user's GitHub profile. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is link at one Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.id`
ID records the unique numeric ID of the user. It is needed to refer to the same simple user across records without relying on display text.
* **Enables:** match `id` to simple user references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is an identifier, not a measured quantity.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.login`
Login records the user's login username. It is needed to attribute this Branches row to the returned person, account, or organization reference.
* **Enables:** attribute the Branches row to the returned person or account and match the exact `login` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is interpreted at one Simple User record per row.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.node_id`
Node ID records the GraphQL node ID of the user. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is an identifier, not a measured quantity.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.organizations_url`
Organizations URL records API URL for the user's organizations. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `organizations_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is link at one Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.received_events_url`
Received Events URL records API URL for events received by the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `received_events_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is link at one Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.repos_url`
Repos URL records API URL for the user's repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repos_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is link at one Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.site_admin`
Site Admin records whether the user is a GitHub site administrator. It is needed to distinguish Branches rows by the exact GitHub-returned site admin value.
* **Enables:** select Branches rows where `site_admin` is true or false when comparing the condition described by Site Admin.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is interpreted at one Simple User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.starred_url`
Starred URL records API URL template for the user's starred repos. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `starred_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is link at one Simple User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.subscriptions_url`
Subscriptions URL records API URL for the user's subscriptions. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscriptions_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is link at one Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.type`
Type records the type of the user account (e.g., User, Organization, Bot). It is needed to distinguish Branches rows by the exact GitHub-returned type value.
* **Enables:** separate Branches rows by the exact GitHub-returned `type` label when comparing type.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is interpreted at one Simple User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.owner.url`
URL records API URL for the user resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple User object returned for Branches; it is link at one Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.permissions`
Permissions records the permissions granted to the app. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `permissions` access value with the resource, account, or membership represented by the same Branches row.
* **Interpretation:** GitHub reports this value on the Simple App object returned for Branches; it is interpreted at one Simple App record per row; the schema uses the `Generic.JSON` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.slug`
Slug records the URL-friendly slug of the app. It is needed to compare the returned slug for individual Branches rows and select rows with a specific `slug` value.
* **Enables:** locate Branches rows whose returned slug exactly matches `slug` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the Simple App object returned for Branches; it is interpreted at one Simple App record per row; the schema uses the `Identity.Slug` scalar.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.apps.updated_at`
Updated At records when the app was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Branches records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the Simple App object returned for Branches; it is interpreted at one Simple App record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.teams`
Teams records teams that can bypass. It is needed to preserve the nested teams relationship or details on the parent Bypass Allowances record.
* **Enables:** expand `teams` to connect the containing Bypass Allowances row to its returned teams entries.
* **Interpretation:** GitHub reports this value on the Bypass Allowances object returned for Branches; it is one returned collection per containing Bypass Allowances object.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.teams.description`
Description records description of the team. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, branch name, revision, and update time where returned.
* **Interpretation:** GitHub reports this value on the Simple Team object returned for Branches; it is description text at one Simple Team record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.teams.html_url`
HTML URL records web URL for the team page. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple Team object returned for Branches; it is link at one Simple Team record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.teams.id`
ID records the unique numeric ID of the team. It is needed to refer to the same simple team across records without relying on display text.
* **Enables:** match `id` to simple team references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Simple Team object returned for Branches; it is an identifier, not a measured quantity.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.teams.members_url`
Members URL records API URL template for the team's members. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `members_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple Team object returned for Branches; it is link at one Simple Team record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.teams.name`
Name records the name of the team. It is needed to compare the returned name for individual Branches rows and select rows with a specific `name` value.
* **Enables:** locate Branches rows whose returned name exactly matches `name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the Simple Team object returned for Branches; it is interpreted at one Simple Team record per row.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.teams.node_id`
Node ID records the GraphQL node ID of the team. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Simple Team object returned for Branches; it is an identifier, not a measured quantity.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.teams.notification_setting`
Notification Setting records the notification setting for the team. It is needed to compare the exact notification setting configuration returned for this Simple Team record.
* **Enables:** compare the exact `notification_setting` configuration returned for each Simple Team record and select records with the configuration under review.
* **Interpretation:** GitHub reports this value on the Simple Team object returned for Branches; it is interpreted at one Simple Team record per row.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.teams.parent`
Parent records the parent team, if this is a child team. It is needed to preserve the nested parent relationship or details on the parent Simple Team record.
* **Enables:** expand `parent` to connect the containing Simple Team row to its returned parent entries.
* **Interpretation:** GitHub reports this value on the Simple Team object returned for Branches; it is one nested object per containing Simple Team object when present.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.teams.permission`
Permission records the default permission level for the team. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `permission` access value with the resource, account, or membership represented by the same Branches row.
* **Interpretation:** GitHub reports this value on the Simple Team object returned for Branches; it is interpreted at one Simple Team record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.teams.privacy`
Privacy records the privacy level of the team (e.g., closed, secret). It is needed to inventory the exact GitHub-reported configuration or classification represented by this field.
* **Enables:** compare `privacy` among Branches records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitHub reports this value on the Simple Team object returned for Branches; it is interpreted at one Simple Team record per row; the value is a GitHub-returned or configured label at the Simple Team grain rather than a universal taxonomy.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.teams.repositories_url`
Repositories URL records API URL for the team's repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repositories_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple Team object returned for Branches; it is link at one Simple Team record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.teams.slug`
Slug records the URL-friendly slug of the team. It is needed to compare the returned slug for individual Branches rows and select rows with a specific `slug` value.
* **Enables:** locate Branches rows whose returned slug exactly matches `slug` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the Simple Team object returned for Branches; it is interpreted at one Simple Team record per row; the schema uses the `Identity.Slug` scalar.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.teams.url`
URL records API URL for the team resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Simple Team object returned for Branches; it is link at one Simple Team record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.bypass_pull_request_allowances.users`
Users records users who can bypass. It is needed to preserve the nested users relationship or details on the parent Bypass Allowances record.
* **Enables:** expand `users` to connect the containing Bypass Allowances row to its returned users entries.
* **Interpretation:** GitHub reports this value on the Bypass Allowances object returned for Branches; it is one returned collection per containing Bypass Allowances object.
Developer identifier: `branches.protection.required_pull_request_reviews.dismiss_stale_reviews`
Dismiss Stale Reviews records whether stale reviews are automatically dismissed when new commits are pushed. It is needed to distinguish Branches rows by the exact GitHub-returned dismiss stale reviews value.
* **Enables:** select Branches rows where `dismiss_stale_reviews` is true or false when comparing the condition described by Dismiss Stale Reviews.
* **Interpretation:** GitHub reports this value on the Required Pull Request Reviews object returned for Branches; it is interpreted at one Required Pull Request Reviews record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `branches.protection.required_pull_request_reviews.dismissal_restrictions`
Dismissal Restrictions records restrictions on who can dismiss pull request reviews. It is needed to preserve the nested dismissal restrictions relationship or details on the parent Required Pull Request Reviews record.
* **Enables:** expand `dismissal_restrictions` to connect the containing Required Pull Request Reviews row to its returned dismissal restrictions entries.
* **Interpretation:** GitHub reports this value on the Required Pull Request Reviews object returned for Branches; it is one nested object per containing Required Pull Request Reviews object when present.
Developer identifier: `branches.protection.required_pull_request_reviews.dismissal_restrictions.apps`
Apps records GitHub Apps that can dismiss reviews. It is needed to preserve the nested apps relationship or details on the parent Dismissal Restrictions record.
* **Enables:** expand `apps` to connect the containing Dismissal Restrictions row to its returned apps entries.
* **Interpretation:** GitHub reports this value on the Dismissal Restrictions object returned for Branches; it is one returned collection per containing Dismissal Restrictions object.
Developer identifier: `branches.protection.required_pull_request_reviews.dismissal_restrictions.teams`
Teams records teams that can dismiss reviews. It is needed to preserve the nested teams relationship or details on the parent Dismissal Restrictions record.
* **Enables:** expand `teams` to connect the containing Dismissal Restrictions row to its returned teams entries.
* **Interpretation:** GitHub reports this value on the Dismissal Restrictions object returned for Branches; it is one returned collection per containing Dismissal Restrictions object.
Developer identifier: `branches.protection.required_pull_request_reviews.dismissal_restrictions.teams_url`
Teams URL records API URL for the teams that can dismiss reviews. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `teams_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Dismissal Restrictions object returned for Branches; it is link at one Dismissal Restrictions record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.dismissal_restrictions.url`
URL records API URL for the dismissal restrictions. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Dismissal Restrictions object returned for Branches; it is link at one Dismissal Restrictions record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.dismissal_restrictions.users`
Users records users who can dismiss reviews. It is needed to preserve the nested users relationship or details on the parent Dismissal Restrictions record.
* **Enables:** expand `users` to connect the containing Dismissal Restrictions row to its returned users entries.
* **Interpretation:** GitHub reports this value on the Dismissal Restrictions object returned for Branches; it is one returned collection per containing Dismissal Restrictions object.
Developer identifier: `branches.protection.required_pull_request_reviews.dismissal_restrictions.users_url`
Users URL records API URL for the users who can dismiss reviews. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `users_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Dismissal Restrictions object returned for Branches; it is link at one Dismissal Restrictions record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_pull_request_reviews.require_code_owner_reviews`
Require Code Owner Reviews records whether reviews from code owners are required. It is needed to distinguish Branches rows by the exact GitHub-returned require code owner reviews value.
* **Enables:** select Branches rows where `require_code_owner_reviews` is true or false when comparing the condition described by Require Code Owner Reviews.
* **Interpretation:** GitHub reports this value on the Required Pull Request Reviews object returned for Branches; it is interpreted at one Required Pull Request Reviews record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `branches.protection.required_pull_request_reviews.require_last_push_approval`
Require Last Push Approval records whether the most recent push must be approved by someone other than the pusher. It is needed to distinguish Branches rows by the exact GitHub-returned require last push approval value.
* **Enables:** select Branches rows where `require_last_push_approval` is true or false when comparing the condition described by Require Last Push Approval.
* **Interpretation:** GitHub reports this value on the Required Pull Request Reviews object returned for Branches; it is interpreted at one Required Pull Request Reviews record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `branches.protection.required_pull_request_reviews.required_approving_review_count`
Required Approving Review Count records the number of approving reviews required. It is needed to measure the GitHub-reported number of required approving review at one Required Pull Request Reviews record per row.
* **Enables:** measure and compare the GitHub-reported number of required approving review in `required_approving_review_count` at one Required Pull Request Reviews record per row.
* **Interpretation:** GitHub reports this value on the Required Pull Request Reviews object returned for Branches; it is a GitHub-reported count at one Required Pull Request Reviews record per row.
Developer identifier: `branches.protection.required_pull_request_reviews.url`
URL records API URL for the required reviews resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Required Pull Request Reviews object returned for Branches; it is link at one Required Pull Request Reviews record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_signatures`
Required Signatures records whether commit signatures are required. It is needed to preserve the nested required signatures relationship or details on the parent Branch Protection record.
* **Enables:** expand `required_signatures` to connect the containing Branch Protection row to its returned required signatures entries.
* **Interpretation:** GitHub reports this value on the Branch Protection object returned for Branches; it is one nested object per containing Branch Protection object when present.
Developer identifier: `branches.protection.required_status_checks`
Required Status Checks records required status checks configuration. It is needed to preserve the nested required status checks relationship or details on the parent Branch Protection record.
* **Enables:** expand `required_status_checks` to connect the containing Branch Protection row to its returned required status checks entries.
* **Interpretation:** GitHub reports this value on the Branch Protection object returned for Branches; it is one nested object per containing Branch Protection object when present.
Developer identifier: `branches.protection.required_status_checks.checks`
Checks records list of required status check objects. It is needed to preserve the nested checks relationship or details on the parent Required Status Checks record.
* **Enables:** expand `checks` to connect the containing Required Status Checks row to its returned checks entries.
* **Interpretation:** GitHub reports this value on the Required Status Checks object returned for Branches; it is one returned collection per containing Required Status Checks object.
Developer identifier: `branches.protection.required_status_checks.checks.app_id`
App ID records the ID of the GitHub App that provides this check. It is needed to refer to the same app across records without relying on display text.
* **Enables:** match `app_id` to app references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Status Check object returned for Branches; it is an identifier, not a measured quantity.
Developer identifier: `branches.protection.required_status_checks.checks.context`
Context records the name of the required status check. It is needed to inventory the exact GitHub-reported configuration or classification represented by this field.
* **Enables:** compare `context` among Branches records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitHub reports this value on the Status Check object returned for Branches; it is interpreted at one Status Check record per row; the value is a GitHub-returned or configured label at the Status Check grain rather than a universal taxonomy.
Developer identifier: `branches.protection.required_status_checks.contexts`
Contexts records list of required status check context names. It is needed to preserve the nested contexts relationship or details on the parent Required Status Checks record.
* **Enables:** expand `contexts` to connect the containing Required Status Checks row to its returned contexts entries.
* **Interpretation:** GitHub reports this value on the Required Status Checks object returned for Branches; it is one returned collection per containing Required Status Checks object.
Developer identifier: `branches.protection.required_status_checks.contexts_url`
Contexts URL records API URL for the status check contexts. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `contexts_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Required Status Checks object returned for Branches; it is link at one Required Status Checks record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.required_status_checks.enforcement_level`
Enforcement Level records the enforcement level of the status checks (e.g., off, `non_admins`, everyone). It is needed to inventory the exact GitHub-reported configuration or classification represented by this field.
* **Enables:** compare `enforcement_level` among Branches records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitHub reports this value on the Required Status Checks object returned for Branches; it is interpreted at one Required Status Checks record per row; the value is a GitHub-returned or configured label at the Required Status Checks grain rather than a universal taxonomy.
Developer identifier: `branches.protection.required_status_checks.strict`
Strict records whether the branch must be up to date before merging. It is needed to distinguish Branches rows by the exact GitHub-returned strict value.
* **Enables:** select Branches rows where `strict` is true or false when comparing the condition described by Strict.
* **Interpretation:** GitHub reports this value on the Required Status Checks object returned for Branches; it is interpreted at one Required Status Checks record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `branches.protection.required_status_checks.url`
URL records API URL for the required status checks resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Required Status Checks object returned for Branches; it is link at one Required Status Checks record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.restrictions`
Restrictions records restrictions on who can push to the branch. It is needed to preserve the nested restrictions relationship or details on the parent Branch Protection record.
* **Enables:** expand `restrictions` to connect the containing Branch Protection row to its returned restrictions entries.
* **Interpretation:** GitHub reports this value on the Branch Protection object returned for Branches; it is one nested object per containing Branch Protection object when present.
Developer identifier: `branches.protection.restrictions.apps`
Apps records GitHub Apps that can push to the branch. It is needed to preserve the nested apps relationship or details on the parent Branch Restrictions record.
* **Enables:** expand `apps` to connect the containing Branch Restrictions row to its returned apps entries.
* **Interpretation:** GitHub reports this value on the Branch Restrictions object returned for Branches; it is one returned collection per containing Branch Restrictions object.
Developer identifier: `branches.protection.restrictions.apps_url`
Apps URL records API URL for the restricted apps. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `apps_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Branch Restrictions object returned for Branches; it is link at one Branch Restrictions record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.restrictions.teams`
Teams records teams that can push to the branch. It is needed to preserve the nested teams relationship or details on the parent Branch Restrictions record.
* **Enables:** expand `teams` to connect the containing Branch Restrictions row to its returned teams entries.
* **Interpretation:** GitHub reports this value on the Branch Restrictions object returned for Branches; it is one returned collection per containing Branch Restrictions object.
Developer identifier: `branches.protection.restrictions.teams_url`
Teams URL records API URL for the restricted teams. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `teams_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Branch Restrictions object returned for Branches; it is link at one Branch Restrictions record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.restrictions.url`
URL records API URL for the restrictions resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Branch Restrictions object returned for Branches; it is link at one Branch Restrictions record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.restrictions.users`
Users records users who can push to the branch. It is needed to preserve the nested users relationship or details on the parent Branch Restrictions record.
* **Enables:** expand `users` to connect the containing Branch Restrictions row to its returned users entries.
* **Interpretation:** GitHub reports this value on the Branch Restrictions object returned for Branches; it is one returned collection per containing Branch Restrictions object.
Developer identifier: `branches.protection.restrictions.users_url`
Users URL records API URL for the restricted users. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `users_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Branch Restrictions object returned for Branches; it is link at one Branch Restrictions record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection.url`
URL records API URL for the branch protection resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the Branch Protection object returned for Branches; it is link at one Branch Protection record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.protection_url`
Protection URL records API URL for the branch protection resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `protection_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Branch object returned for Branches; it is link at one GitHub Branch record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs`
Commit Diffs covers commit diff details including files changed.
* **Enables:** inspect each returned file diff in the context of its repository or project and parent commit.
* **Scope:** Commit diff details including files changed; the connector reads `/repos/{full_name}/commits/{sha}` as an event stream in full mode. The configured credential must grant the declared `repo` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitHub record was deleted.
Developer identifier: `commit_diffs.author`
Author records GitHub user who authored the commit (may be null if no linked account). It is needed to preserve the nested author relationship or details on the parent GitHub Commit Diff record.
* **Enables:** expand `author` to connect the containing GitHub Commit Diff row to its returned author entries.
* **Interpretation:** GitHub reports this value on the GitHub Commit Diff object returned for Commit Diffs; it is one nested object per containing GitHub Commit Diff object when present.
Developer identifier: `commit_diffs.author.avatar_url`
Avatar URL records URL of the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `avatar_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.author.events_url`
Events URL records REST API URL template for the user's events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.author.followers_url`
Followers URL records REST API URL for the user's followers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `followers_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.author.following_url`
Following URL records REST API URL template for users this user follows. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `following_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.author.gists_url`
Gists URL records REST API URL template for the user's gists. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `gists_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.author.gravatar_id`
Gravatar ID records gravatar ID for the user (may be empty string). It is needed to refer to the same gravatar across records without relying on display text.
* **Enables:** match `gravatar_id` to gravatar references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is an identifier, not a measured quantity.
Developer identifier: `commit_diffs.author.html_url`
HTML URL records web URL for the user's GitHub profile. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.author.id`
ID records numeric GitHub user ID. It is needed to refer to the same user across records without relying on display text.
* **Enables:** match `id` to user references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is an identifier, not a measured quantity.
Developer identifier: `commit_diffs.author.login`
Login records the GitHub username/login handle. It is needed to attribute this Commit Diffs row to the returned person, account, or organization reference.
* **Enables:** attribute the Commit Diffs row to the returned person or account and match the exact `login` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is interpreted at one GitHub User record per row.
Developer identifier: `commit_diffs.author.node_id`
Node ID records graphQL global node ID for the user. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is an identifier, not a measured quantity.
Developer identifier: `commit_diffs.author.organizations_url`
Organizations URL records REST API URL for the user's organizations. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `organizations_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.author.received_events_url`
Received Events URL records REST API URL for events received by the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `received_events_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.author.repos_url`
Repos URL records REST API URL for the user's repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repos_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.author.site_admin`
Site Admin records whether the user is a GitHub site administrator. It is needed to distinguish Commit Diffs rows by the exact GitHub-returned site admin value.
* **Enables:** select Commit Diffs rows where `site_admin` is true or false when comparing the condition described by Site Admin.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commit_diffs.author.starred_url`
Starred URL records REST API URL template for the user's starred repos. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `starred_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.author.subscriptions_url`
Subscriptions URL records REST API URL for the user's subscriptions. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscriptions_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.author.type`
Type records the type of account (e.g., User, Bot, Organization). It is needed to distinguish Commit Diffs rows by the exact GitHub-returned type value.
* **Enables:** separate Commit Diffs rows by the exact GitHub-returned `type` label when comparing type.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commit_diffs.author.url`
URL records REST API URL for the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.author.user_view_type`
User View Type records the view type for the user (e.g., public). It is needed to distinguish Commit Diffs rows by the exact GitHub-returned user view type value.
* **Enables:** separate Commit Diffs rows by the exact GitHub-returned `user_view_type` label when comparing user view type.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commit Diffs; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commit_diffs.branch_name`
Branch Name records parent name injected by the ingestor from the branches to `commits_by_branch` traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to compare the returned branch name for individual Commit Diffs rows and select rows with a specific `branch_name` value.
* **Enables:** locate Commit Diffs rows whose returned branch name exactly matches `branch_name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub's child response does not supply this field; the connector injects parent context into each child row; it is interpreted at one GitHub Commit Diff record per row.
Developer identifier: `commit_diffs.comments_url`
Comments URL records REST API URL for comments on this commit. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `comments_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Commit Diff object returned for Commit Diffs; it is link at one GitHub Commit Diff record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.commit`
Commit records the core Git commit data including message, author, committer, and tree info. It is needed to preserve the nested commit relationship or details on the parent GitHub Commit Diff record.
* **Enables:** expand `commit` to connect the containing GitHub Commit Diff row to its returned commit entries.
* **Interpretation:** GitHub reports this value on the GitHub Commit Diff object returned for Commit Diffs; it is one nested object per containing GitHub Commit Diff object when present.
Developer identifier: `commit_diffs.commit.author`
Author records the Git author of the commit (name, email, date from git log). It is needed to preserve the nested author relationship or details on the parent Commit Detail record.
* **Enables:** expand `author` to connect the containing Commit Detail row to its returned author entries.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commit Diffs; it is one nested object per containing Commit Detail object when present.
Developer identifier: `commit_diffs.commit.author.date`
Date records ISO 8601 timestamp of when the action (authoring or committing) occurred. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Commit Diffs records by `date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the Git Person object returned for Commit Diffs; it is interpreted at one Git Person record per row; the schema assigns the `event_time` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `commit_diffs.commit.author.email`
Email records the email address of the Git author or committer. It is needed to attribute this Commit Diffs row to the returned person, account, or organization reference.
* **Enables:** attribute the Commit Diffs row to the returned person or account and match the exact `email` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the Git Person object returned for Commit Diffs; it is interpreted at one Git Person record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `commit_diffs.commit.author.name`
Name records the name of the Git author or committer. It is needed to attribute this Commit Diffs row to the returned person, account, or organization reference.
* **Enables:** attribute the Commit Diffs row to the returned person or account and match the exact `name` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the Git Person object returned for Commit Diffs; it is interpreted at one Git Person record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `commit_diffs.commit.comment_count`
Comment Count records number of comments on this commit. It is needed to measure the GitHub-reported number of comments at commit granularity.
* **Enables:** measure and compare the GitHub-reported number of comments in `comment_count` at one commit per row.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commit Diffs; it is the GitHub-reported number of comments at commit granularity.
Developer identifier: `commit_diffs.commit.committer`
Committer records the Git committer of the commit (name, email, date from git log). It is needed to preserve the nested committer relationship or details on the parent Commit Detail record.
* **Enables:** expand `committer` to connect the containing Commit Detail row to its returned committer entries.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commit Diffs; it is one nested object per containing Commit Detail object when present.
Developer identifier: `commit_diffs.commit.message`
Message records the full commit message text. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `message` and attribute it to the same record's repository or project, revision, file path, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commit Diffs; it is commit message at one Commit Detail record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `commit_diffs.commit.tree`
Tree records reference to the tree object for this commit. It is needed to refer to the same `the` across records without relying on display text.
* **Enables:** match `tree` to `the` references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commit Diffs; it is one nested object per containing Commit Detail object when present.
Developer identifier: `commit_diffs.commit.tree.sha`
Sha records SHA hash of the tree object. It is needed to refer to the same commit tree across records without relying on display text.
* **Enables:** match `sha` to commit tree references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Commit Tree object returned for Commit Diffs; it is an identifier, not a measured quantity.
Developer identifier: `commit_diffs.commit.tree.url`
URL records REST API URL for the tree object. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the Commit Tree object returned for Commit Diffs; it is link at one Commit Tree record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.commit.url`
URL records REST API URL for the Git commit object. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commit Diffs; it is link at one Commit Detail record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.commit.verification`
Verification records GPG/S-MIME signature verification details for the commit. It is needed to preserve the nested verification relationship or details on the parent Commit Detail record.
* **Enables:** expand `verification` to connect the containing Commit Detail row to its returned verification entries.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commit Diffs; it is one nested object per containing Commit Detail object when present.
Developer identifier: `commit_diffs.commit.verification.payload`
Payload records the payload that was signed, or null if unsigned. It is needed to preserve the exact payload GitHub reports as the material covered by the commit signature.
* **Enables:** correlate `payload` with the sibling signature, verification result, reason, and commit SHA during a signed-revision investigation.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for the commit; it is signed payload content at commit grain and does not independently prove that the signature is valid.
Developer identifier: `commit_diffs.commit.verification.reason`
Reason records the reason for the verification status (e.g., valid, unsigned, `unknown_key`). It is needed to distinguish Commit Diffs rows by the exact GitHub-returned reason value.
* **Enables:** separate Commit Diffs rows by the exact GitHub-returned `reason` label when comparing reason.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for Commit Diffs; it is interpreted at one Commit Verification record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commit_diffs.commit.verification.signature`
Signature records the raw signature data, or null if unsigned. It is needed to preserve the raw signature returned with GitHub commit-verification metadata.
* **Enables:** correlate `signature` with the sibling signed payload, verification result, reason, and commit SHA during a signed-revision investigation.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for the commit; it is raw signature content at commit grain and does not independently prove that the signature is valid.
Developer identifier: `commit_diffs.commit.verification.verified`
Verified records whether the signature was verified as valid. It is needed to distinguish Commit Diffs rows by the exact GitHub-returned verified value.
* **Enables:** select Commit Diffs rows where `verified` is true or false when comparing the condition described by Verified.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for Commit Diffs; it is interpreted at one Commit Verification record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commit_diffs.commit.verification.verified_at`
Verified At records timestamp when the signature was verified, if applicable. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Commit Diffs records by `verified_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for Commit Diffs; it is interpreted at one Commit Verification record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `commit_diffs.committer`
Committer records GitHub user who committed the commit (may be null if no linked account). It is needed to preserve the nested committer relationship or details on the parent GitHub Commit Diff record.
* **Enables:** expand `committer` to connect the containing GitHub Commit Diff row to its returned committer entries.
* **Interpretation:** GitHub reports this value on the GitHub Commit Diff object returned for Commit Diffs; it is one nested object per containing GitHub Commit Diff object when present.
Developer identifier: `commit_diffs.files`
Files records files changed in this commit with per-file diff metadata. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `files` and associate them with the containing Commit Diffs record.
* **Interpretation:** GitHub reports this value on the GitHub Commit Diff object returned for Commit Diffs; it is one returned collection per containing GitHub Commit Diff object; keys and availability follow this GitHub response and may vary by object type or GitHub configuration.
Developer identifier: `commit_diffs.files.additions`
Additions records lines added in this file. It is needed to measure the GitHub-reported number of additions at one Commit File record per row.
* **Enables:** measure and compare the GitHub-reported number of additions in `additions` at one Commit File record per row.
* **Interpretation:** GitHub reports this value on the Commit File object returned for Commit Diffs; it is a GitHub-reported count at one Commit File record per row.
Developer identifier: `commit_diffs.files.blob_url`
Blob URL records REST API URL for the file blob. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `blob_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the Commit File object returned for Commit Diffs; it is link at one Commit File record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.files.changes`
Changes records total line changes in this file. It is needed to compare the numeric changes reported for one Commit File record without assuming an unstated unit.
* **Enables:** compare the numeric `changes` value per Commit File record without assigning a unit not declared by the schema description.
* **Interpretation:** GitHub reports this value on the Commit File object returned for Commit Diffs; it is interpreted at one Commit File record per row.
Developer identifier: `commit_diffs.files.contents_url`
Contents URL records REST API URL for file contents. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `contents_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the Commit File object returned for Commit Diffs; it is link at one Commit File record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.files.deletions`
Deletions records lines deleted from this file. It is needed to measure the GitHub-reported number of deletions at one Commit File record per row.
* **Enables:** measure and compare the GitHub-reported number of deletions in `deletions` at one Commit File record per row.
* **Interpretation:** GitHub reports this value on the Commit File object returned for Commit Diffs; it is a GitHub-reported count at one Commit File record per row.
Developer identifier: `commit_diffs.files.filename`
Filename records path of the changed file. It is needed to compare the returned filename for individual Commit Diffs rows and select rows with a specific `filename` value.
* **Enables:** locate Commit Diffs rows whose returned filename exactly matches `filename` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the Commit File object returned for Commit Diffs; it is interpreted at one Commit File record per row; the schema uses the `Asset.FilePath` scalar.
Developer identifier: `commit_diffs.files.patch`
Patch records unified diff patch for the file, if included. It is needed to inspect the exact patch included with this record.
* **Enables:** inspect the patch returned in `patch` and attribute it to the same record's repository or project, revision, file path, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the Commit File object returned for Commit Diffs; it is patch at one Commit File record per row; GitHub may omit, collapse, summarize, or truncate this code-change content as noted by the field description.
Developer identifier: `commit_diffs.files.previous_filename`
Previous Filename records previous path when status is renamed. It is needed to compare the returned previous filename for individual Commit Diffs rows and select rows with a specific `previous_filename` value.
* **Enables:** locate Commit Diffs rows whose returned previous filename exactly matches `previous_filename` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the Commit File object returned for Commit Diffs; it is interpreted at one Commit File record per row; the schema uses the `Asset.FilePath` scalar.
Developer identifier: `commit_diffs.files.raw_url`
Raw URL records URL to fetch raw file contents. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `raw_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the Commit File object returned for Commit Diffs; it is link at one Commit File record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.files.sha`
Sha records blob SHA for the file at this commit.
* **Enables:** Match Commit Diffs elements carrying the same GitHub `sha`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** GitHub reports this value on the Commit File object returned for Commit Diffs; it is an identifier, not a measured quantity.
Developer identifier: `commit_diffs.files.status`
Status records change type: added, removed, modified, renamed, copied, changed, unchanged. It is needed to distinguish Commit Diffs rows by the exact GitHub-returned status value.
* **Enables:** separate Commit Diffs rows by the exact GitHub-returned `status` label when comparing status.
* **Interpretation:** GitHub reports this value on the Commit File object returned for Commit Diffs; it is interpreted at one Commit File record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commit_diffs.full_name`
Full Name records parent `full_name` injected by the ingestor from the branches to `commits_by_branch` traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to compare the returned full name for individual Commit Diffs rows and select rows with a specific `full_name` value.
* **Enables:** locate Commit Diffs rows whose returned full name exactly matches `full_name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub's child response does not supply this field; the connector injects parent context into each child row; it is interpreted at one GitHub Commit Diff record per row.
Developer identifier: `commit_diffs.html_url`
HTML URL records web URL for viewing this commit on GitHub. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Commit Diff object returned for Commit Diffs; it is link at one GitHub Commit Diff record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.node_id`
Node ID records the GraphQL global node ID for the commit. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Commit Diff object returned for Commit Diffs; it is an identifier, not a measured quantity.
Developer identifier: `commit_diffs.parents`
Parents records list of parent commits (merge commits have multiple parents). It is needed to preserve the nested parents relationship or details on the parent GitHub Commit Diff record.
* **Enables:** expand `parents` to connect the containing GitHub Commit Diff row to its returned parents entries.
* **Interpretation:** GitHub reports this value on the GitHub Commit Diff object returned for Commit Diffs; it is one returned collection per containing GitHub Commit Diff object.
Developer identifier: `commit_diffs.parents.html_url`
HTML URL records web URL for viewing the parent commit on GitHub. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the Commit Parent object returned for Commit Diffs; it is link at one Commit Parent record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.parents.sha`
Sha records SHA hash of the parent commit. It is needed to distinguish repeated deliveries of the same Commit Diffs row using the declared ingestion key.
* **Enables:** use `sha` as the declared ingestion deduplication key for Commit Diffs and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the Commit Parent object returned for Commit Diffs; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `commit_diffs.parents.url`
URL records REST API URL for the parent commit. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the Commit Parent object returned for Commit Diffs; it is link at one Commit Parent record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs.sha`
Sha records the SHA hash uniquely identifying the commit. It is needed to distinguish repeated deliveries of the same Commit Diffs row using the declared ingestion key.
* **Enables:** use `sha` as the declared ingestion deduplication key for Commit Diffs and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub Commit Diff object returned for Commit Diffs; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `commit_diffs.stats`
Stats records aggregate line change counts for the commit. It is needed to preserve the nested stats relationship or details on the parent GitHub Commit Diff record.
* **Enables:** expand `stats` to connect the containing GitHub Commit Diff row to its returned stats entries.
* **Interpretation:** GitHub reports this value on the GitHub Commit Diff object returned for Commit Diffs; it is one nested object per containing GitHub Commit Diff object when present.
Developer identifier: `commit_diffs.stats.additions`
Additions records total lines added across all files. It is needed to measure the GitHub-reported number of additions at one Commit Stats record per row.
* **Enables:** measure and compare the GitHub-reported number of additions in `additions` at one Commit Stats record per row.
* **Interpretation:** GitHub reports this value on the Commit Stats object returned for Commit Diffs; it is a GitHub-reported count at one Commit Stats record per row.
Developer identifier: `commit_diffs.stats.deletions`
Deletions records total lines deleted across all files. It is needed to measure the GitHub-reported number of deletions at one Commit Stats record per row.
* **Enables:** measure and compare the GitHub-reported number of deletions in `deletions` at one Commit Stats record per row.
* **Interpretation:** GitHub reports this value on the Commit Stats object returned for Commit Diffs; it is a GitHub-reported count at one Commit Stats record per row.
Developer identifier: `commit_diffs.stats.total`
Total records total lines changed across all files. It is needed to measure the GitHub-reported number of total at one Commit Stats record per row.
* **Enables:** measure and compare the GitHub-reported number of total in `total` at one Commit Stats record per row.
* **Interpretation:** GitHub reports this value on the Commit Stats object returned for Commit Diffs; it is a GitHub-reported count at one Commit Stats record per row.
Developer identifier: `commit_diffs.url`
URL records REST API URL for this commit. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commit Diffs record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Commit Diff object returned for Commit Diffs; it is link at one GitHub Commit Diff record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits`
Commits covers repository commits.
* **Enables:** trace each returned revision to its repository or project, author and committer identities, message, and provider-reported commit times.
* **Scope:** Repository commits; the connector reads `/repos/{full_name}/commits` as an event stream in incremental mode, and a commit that overlapping loads deliver again is stored once per repository. The configured credential must grant the declared `repo` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitHub record was deleted.
Developer identifier: `commits.author`
Author records the GitHub user who authored the commit (may be null if no linked account). It is needed to preserve the nested author relationship or details on the parent GitHub Commit record.
* **Enables:** expand `author` to connect the containing GitHub Commit row to its returned author entries.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits; it is one nested object per containing GitHub Commit object when present.
Developer identifier: `commits.author.avatar_url`
Avatar URL records URL of the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `avatar_url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.author.events_url`
Events URL records REST API URL template for the user's events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.author.followers_url`
Followers URL records REST API URL for the user's followers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `followers_url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.author.following_url`
Following URL records REST API URL template for users this user follows. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `following_url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.author.gists_url`
Gists URL records REST API URL template for the user's gists. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `gists_url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.author.gravatar_id`
Gravatar ID records gravatar ID for the user (may be empty string). It is needed to refer to the same gravatar across records without relying on display text.
* **Enables:** match `gravatar_id` to gravatar references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is an identifier, not a measured quantity.
Developer identifier: `commits.author.html_url`
HTML URL records web URL for the user's GitHub profile. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.author.id`
ID records numeric GitHub user ID. It is needed to refer to the same user across records without relying on display text.
* **Enables:** match `id` to user references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is an identifier, not a measured quantity.
Developer identifier: `commits.author.login`
Login records GitHub username/login. It is needed to attribute this Commits row to the returned person, account, or organization reference.
* **Enables:** attribute the Commits row to the returned person or account and match the exact `login` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is interpreted at one GitHub User record per row.
Developer identifier: `commits.author.node_id`
Node ID records global GraphQL node ID for the user. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is an identifier, not a measured quantity.
Developer identifier: `commits.author.organizations_url`
Organizations URL records REST API URL for the user's organizations. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `organizations_url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.author.received_events_url`
Received Events URL records REST API URL for events received by the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `received_events_url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.author.repos_url`
Repos URL records REST API URL for the user's repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repos_url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.author.site_admin`
Site Admin records whether the user is a GitHub site administrator. It is needed to distinguish Commits rows by the exact GitHub-returned site admin value.
* **Enables:** select Commits rows where `site_admin` is true or false when comparing the condition described by Site Admin.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commits.author.starred_url`
Starred URL records REST API URL template for the user's starred repos. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `starred_url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.author.subscriptions_url`
Subscriptions URL records REST API URL for the user's subscriptions. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscriptions_url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.author.type`
Type records the type of GitHub account (User, Organization, Bot, etc.). It is needed to distinguish Commits rows by the exact GitHub-returned type value.
* **Enables:** separate Commits rows by the exact GitHub-returned `type` label when comparing type.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commits.author.url`
URL records REST API URL for the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.author.user_view_type`
User View Type records the view type of the user (e.g., public). It is needed to distinguish Commits rows by the exact GitHub-returned user view type value.
* **Enables:** separate Commits rows by the exact GitHub-returned `user_view_type` label when comparing user view type.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commits.comments_url`
Comments URL records REST API URL for comments on this commit. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `comments_url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits; it is link at one GitHub Commit record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.commit`
Commit records the core commit metadata including message, author, committer, and tree info. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `commit` and associate them with the containing Commits record.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits; it is one nested object per containing GitHub Commit object when present; keys and availability follow this GitHub response and may vary by object type or GitHub configuration.
Developer identifier: `commits.commit.author`
Author records the git author of the commit (name, email, date). It is needed to preserve the nested author relationship or details on the parent Commit Detail record.
* **Enables:** expand `author` to connect the containing Commit Detail row to its returned author entries.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commits; it is one nested object per containing Commit Detail object when present.
Developer identifier: `commits.commit.author.date`
Date records ISO 8601 timestamp of when the action occurred. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Commits records by `date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the Git Person object returned for Commits; it is interpreted at one Git Person record per row; the schema assigns the `event_time` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `commits.commit.author.email`
Email records the email address of the person. It is needed to attribute this Commits row to the returned person, account, or organization reference.
* **Enables:** attribute the Commits row to the returned person or account and match the exact `email` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the Git Person object returned for Commits; it is interpreted at one Git Person record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `commits.commit.author.name`
Name records the name of the person. It is needed to attribute this Commits row to the returned person, account, or organization reference.
* **Enables:** attribute the Commits row to the returned person or account and match the exact `name` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the Git Person object returned for Commits; it is interpreted at one Git Person record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `commits.commit.comment_count`
Comment Count records number of comments on this commit. It is needed to measure the GitHub-reported number of comments at commit granularity.
* **Enables:** measure and compare the GitHub-reported number of comments in `comment_count` at one commit per row.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commits; it is the GitHub-reported number of comments at commit granularity.
Developer identifier: `commits.commit.committer`
Committer records the git committer of the commit (name, email, date). It is needed to preserve the nested committer relationship or details on the parent Commit Detail record.
* **Enables:** expand `committer` to connect the containing Commit Detail row to its returned committer entries.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commits; it is one nested object per containing Commit Detail object when present.
Developer identifier: `commits.commit.message`
Message records the commit message. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `message` and attribute it to the same record's repository or project, revision, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commits; it is commit message at one Commit Detail record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `commits.commit.tree`
Tree records the tree object this commit points to. It is needed to preserve the nested tree relationship or details on the parent Commit Detail record.
* **Enables:** expand `tree` to connect the containing Commit Detail row to its returned tree entries.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commits; it is one nested object per containing Commit Detail object when present.
Developer identifier: `commits.commit.tree.sha`
Sha records SHA hash of the tree object. It is needed to refer to the same commit tree across records without relying on display text.
* **Enables:** match `sha` to commit tree references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Commit Tree object returned for Commits; it is an identifier, not a measured quantity.
Developer identifier: `commits.commit.tree.url`
URL records REST API URL for the tree object. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the Commit Tree object returned for Commits; it is link at one Commit Tree record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.commit.url`
URL records REST API URL for the git commit object. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commits; it is link at one Commit Detail record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.commit.verification`
Verification records GPG/S-MIME signature verification details. It is needed to preserve the nested verification relationship or details on the parent Commit Detail record.
* **Enables:** expand `verification` to connect the containing Commit Detail row to its returned verification entries.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commits; it is one nested object per containing Commit Detail object when present.
Developer identifier: `commits.commit.verification.payload`
Payload records the payload that was signed. It is needed to preserve the exact payload GitHub reports as the material covered by the commit signature.
* **Enables:** correlate `payload` with the sibling signature, verification result, reason, and commit SHA during a signed-revision investigation.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for the commit; it is signed payload content at commit grain and does not independently prove that the signature is valid.
Developer identifier: `commits.commit.verification.reason`
Reason records the reason for the verification status (e.g., valid, unsigned, `unknown_key`). It is needed to distinguish Commits rows by the exact GitHub-returned reason value.
* **Enables:** separate Commits rows by the exact GitHub-returned `reason` label when comparing reason.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for Commits; it is interpreted at one Commit Verification record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commits.commit.verification.signature`
Signature records the raw signature data. It is needed to preserve the raw signature returned with GitHub commit-verification metadata.
* **Enables:** correlate `signature` with the sibling signed payload, verification result, reason, and commit SHA during a signed-revision investigation.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for the commit; it is raw signature content at commit grain and does not independently prove that the signature is valid.
Developer identifier: `commits.commit.verification.verified`
Verified records whether the signature was verified. It is needed to distinguish Commits rows by the exact GitHub-returned verified value.
* **Enables:** select Commits rows where `verified` is true or false when comparing the condition described by Verified.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for Commits; it is interpreted at one Commit Verification record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commits.commit.verification.verified_at`
Verified At records timestamp when the signature was verified. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Commits records by `verified_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for Commits; it is interpreted at one Commit Verification record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `commits.committer`
Committer records the GitHub user who committed the commit (may be null if no linked account). It is needed to preserve the nested committer relationship or details on the parent GitHub Commit record.
* **Enables:** expand `committer` to connect the containing GitHub Commit row to its returned committer entries.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits; it is one nested object per containing GitHub Commit object when present.
Developer identifier: `commits.full_name`
Full Name records parent `full_name` injected by the ingestor from the repositories to commits traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to compare the returned full name for individual Commits rows and select rows with a specific `full_name` value.
* **Enables:** locate Commits rows whose returned full name exactly matches `full_name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub's child response does not supply this field; the connector injects parent context into each child row; it is interpreted at one GitHub Commit record per row.
Developer identifier: `commits.html_url`
HTML URL records web URL for viewing this commit on GitHub. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits; it is link at one GitHub Commit record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.node_id`
Node ID records GitHub's global node ID for the commit in the repository that returned it. It is needed to keep one Commits row per commit per repository when overlapping loads deliver the same commit again.
* **Enables:** use `node_id` as the declared ingestion deduplication key for Commits: a replay of a commit through the same repository matches the stored row, while one `sha` read through a fork and through its source stays two rows.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits; it is an identifier in GitHub's node namespace, not a measured quantity. GitHub scopes it to the repository, so the same `sha` read through two repositories carries two node IDs. GitHub treats node IDs as opaque and returns a legacy or a newer encoding depending on the commit; a re-encoded ID would not match a stored row. The connector declares it as an ingestion deduplication key.
Developer identifier: `commits.parents`
Parents records list of parent commits. It is needed to preserve the nested parents relationship or details on the parent GitHub Commit record.
* **Enables:** expand `parents` to connect the containing GitHub Commit row to its returned parents entries.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits; it is one returned collection per containing GitHub Commit object.
Developer identifier: `commits.parents.html_url`
HTML URL records web URL for viewing the parent commit on GitHub. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the Commit Parent object returned for Commits; it is link at one Commit Parent record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.parents.sha`
Sha records SHA hash of the parent commit. It is needed to distinguish repeated deliveries of the same Commits row using the declared ingestion key.
* **Enables:** use `sha` as the declared ingestion deduplication key for Commits and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the Commit Parent object returned for Commits; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `commits.parents.url`
URL records REST API URL for the parent commit. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the Commit Parent object returned for Commits; it is link at one Commit Parent record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits.sha`
Sha records the commit SHA hash. It is needed to refer to the same Git revision across repositories and related GitHub records.
* **Enables:** match `sha` to commit references carrying the same Git revision, such as `commit_diffs.sha` and `commits_by_branch.sha`.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits; it is an identifier, not a measured quantity. It names a Git revision rather than a commit in one repository: a fork and its source report the same `sha`, so Commits deduplicates on `node_id` instead.
Developer identifier: `commits.url`
URL records REST API URL for this commit. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commits record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits; it is link at one GitHub Commit record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch`
Commits By Branch covers repository commits for a specific branch.
* **Enables:** trace each returned revision to its repository or project, author and committer identities, message, and provider-reported commit times.
* **Scope:** Repository commits for a specific branch; the connector reads `/repos/{full_name}/commits` as an event stream in incremental mode. The configured credential must grant the declared `repo` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitHub record was deleted.
Developer identifier: `commits_by_branch.author`
Author records GitHub user who authored the commit (may be null if no linked account). It is needed to preserve the nested author relationship or details on the parent GitHub Commit record.
* **Enables:** expand `author` to connect the containing GitHub Commit row to its returned author entries.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits By Branch; it is one nested object per containing GitHub Commit object when present.
Developer identifier: `commits_by_branch.author.avatar_url`
Avatar URL records URL of the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `avatar_url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.author.events_url`
Events URL records REST API URL template for the user's events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.author.followers_url`
Followers URL records REST API URL for the user's followers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `followers_url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.author.following_url`
Following URL records REST API URL template for users this user follows. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `following_url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.author.gists_url`
Gists URL records REST API URL template for the user's gists. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `gists_url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.author.gravatar_id`
Gravatar ID records gravatar ID for the user (may be empty string). It is needed to refer to the same gravatar across records without relying on display text.
* **Enables:** match `gravatar_id` to gravatar references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is an identifier, not a measured quantity.
Developer identifier: `commits_by_branch.author.html_url`
HTML URL records web URL for the user's GitHub profile. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.author.id`
ID records numeric GitHub user ID. It is needed to refer to the same user across records without relying on display text.
* **Enables:** match `id` to user references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is an identifier, not a measured quantity.
Developer identifier: `commits_by_branch.author.login`
Login records the GitHub username/login handle. It is needed to attribute this Commits By Branch row to the returned person, account, or organization reference.
* **Enables:** attribute the Commits By Branch row to the returned person or account and match the exact `login` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is interpreted at one GitHub User record per row.
Developer identifier: `commits_by_branch.author.node_id`
Node ID records graphQL global node ID for the user. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is an identifier, not a measured quantity.
Developer identifier: `commits_by_branch.author.organizations_url`
Organizations URL records REST API URL for the user's organizations. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `organizations_url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.author.received_events_url`
Received Events URL records REST API URL for events received by the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `received_events_url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.author.repos_url`
Repos URL records REST API URL for the user's repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repos_url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.author.site_admin`
Site Admin records whether the user is a GitHub site administrator. It is needed to distinguish Commits By Branch rows by the exact GitHub-returned site admin value.
* **Enables:** select Commits By Branch rows where `site_admin` is true or false when comparing the condition described by Site Admin.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commits_by_branch.author.starred_url`
Starred URL records REST API URL template for the user's starred repos. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `starred_url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.author.subscriptions_url`
Subscriptions URL records REST API URL for the user's subscriptions. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscriptions_url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.author.type`
Type records the type of account (e.g., User, Bot, Organization). It is needed to distinguish Commits By Branch rows by the exact GitHub-returned type value.
* **Enables:** separate Commits By Branch rows by the exact GitHub-returned `type` label when comparing type.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commits_by_branch.author.url`
URL records REST API URL for the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.author.user_view_type`
User View Type records the view type for the user (e.g., public). It is needed to distinguish Commits By Branch rows by the exact GitHub-returned user view type value.
* **Enables:** separate Commits By Branch rows by the exact GitHub-returned `user_view_type` label when comparing user view type.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Commits By Branch; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commits_by_branch.branch_name`
Branch Name records parent name injected by the ingestor from the branches to `commits_by_branch` traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to compare the returned branch name for individual Commits By Branch rows and select rows with a specific `branch_name` value.
* **Enables:** locate Commits By Branch rows whose returned branch name exactly matches `branch_name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub's child response does not supply this field; the connector injects parent context into each child row; it is interpreted at one GitHub Commit record per row.
Developer identifier: `commits_by_branch.comments_url`
Comments URL records REST API URL for comments on this commit. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `comments_url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits By Branch; it is link at one GitHub Commit record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.commit`
Commit records the core Git commit data including message, author, committer, and tree info. It is needed to preserve the nested commit relationship or details on the parent GitHub Commit record.
* **Enables:** expand `commit` to connect the containing GitHub Commit row to its returned commit entries.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits By Branch; it is one nested object per containing GitHub Commit object when present.
Developer identifier: `commits_by_branch.commit.author`
Author records the Git author of the commit (name, email, date from git log). It is needed to preserve the nested author relationship or details on the parent Commit Detail record.
* **Enables:** expand `author` to connect the containing Commit Detail row to its returned author entries.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commits By Branch; it is one nested object per containing Commit Detail object when present.
Developer identifier: `commits_by_branch.commit.author.date`
Date records ISO 8601 timestamp of when the action (authoring or committing) occurred. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Commits By Branch records by `date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the Git Person object returned for Commits By Branch; it is interpreted at one Git Person record per row; the schema assigns the `event_time` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `commits_by_branch.commit.author.email`
Email records the email address of the Git author or committer. It is needed to attribute this Commits By Branch row to the returned person, account, or organization reference.
* **Enables:** attribute the Commits By Branch row to the returned person or account and match the exact `email` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the Git Person object returned for Commits By Branch; it is interpreted at one Git Person record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `commits_by_branch.commit.author.name`
Name records the name of the Git author or committer. It is needed to attribute this Commits By Branch row to the returned person, account, or organization reference.
* **Enables:** attribute the Commits By Branch row to the returned person or account and match the exact `name` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the Git Person object returned for Commits By Branch; it is interpreted at one Git Person record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `commits_by_branch.commit.comment_count`
Comment Count records number of comments on this commit. It is needed to measure the GitHub-reported number of comments at commit granularity.
* **Enables:** measure and compare the GitHub-reported number of comments in `comment_count` at one commit per row.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commits By Branch; it is the GitHub-reported number of comments at commit granularity.
Developer identifier: `commits_by_branch.commit.committer`
Committer records the Git committer of the commit (name, email, date from git log). It is needed to preserve the nested committer relationship or details on the parent Commit Detail record.
* **Enables:** expand `committer` to connect the containing Commit Detail row to its returned committer entries.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commits By Branch; it is one nested object per containing Commit Detail object when present.
Developer identifier: `commits_by_branch.commit.message`
Message records the full commit message text. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `message` and attribute it to the same record's repository or project, revision, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commits By Branch; it is commit message at one Commit Detail record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `commits_by_branch.commit.tree`
Tree records reference to the tree object for this commit. It is needed to refer to the same `the` across records without relying on display text.
* **Enables:** match `tree` to `the` references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commits By Branch; it is one nested object per containing Commit Detail object when present.
Developer identifier: `commits_by_branch.commit.tree.sha`
Sha records SHA hash of the tree object. It is needed to refer to the same commit tree across records without relying on display text.
* **Enables:** match `sha` to commit tree references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Commit Tree object returned for Commits By Branch; it is an identifier, not a measured quantity.
Developer identifier: `commits_by_branch.commit.tree.url`
URL records REST API URL for the tree object. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the Commit Tree object returned for Commits By Branch; it is link at one Commit Tree record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.commit.url`
URL records REST API URL for the Git commit object. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commits By Branch; it is link at one Commit Detail record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.commit.verification`
Verification records GPG/S-MIME signature verification details for the commit. It is needed to preserve the nested verification relationship or details on the parent Commit Detail record.
* **Enables:** expand `verification` to connect the containing Commit Detail row to its returned verification entries.
* **Interpretation:** GitHub reports this value on the Commit Detail object returned for Commits By Branch; it is one nested object per containing Commit Detail object when present.
Developer identifier: `commits_by_branch.commit.verification.payload`
Payload records the payload that was signed, or null if unsigned. It is needed to preserve the exact payload GitHub reports as the material covered by the commit signature.
* **Enables:** correlate `payload` with the sibling signature, verification result, reason, and commit SHA during a signed-revision investigation.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for the commit; it is signed payload content at commit grain and does not independently prove that the signature is valid.
Developer identifier: `commits_by_branch.commit.verification.reason`
Reason records the reason for the verification status (e.g., valid, unsigned, `unknown_key`). It is needed to distinguish Commits By Branch rows by the exact GitHub-returned reason value.
* **Enables:** separate Commits By Branch rows by the exact GitHub-returned `reason` label when comparing reason.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for Commits By Branch; it is interpreted at one Commit Verification record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commits_by_branch.commit.verification.signature`
Signature records the raw signature data, or null if unsigned. It is needed to preserve the raw signature returned with GitHub commit-verification metadata.
* **Enables:** correlate `signature` with the sibling signed payload, verification result, reason, and commit SHA during a signed-revision investigation.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for the commit; it is raw signature content at commit grain and does not independently prove that the signature is valid.
Developer identifier: `commits_by_branch.commit.verification.verified`
Verified records whether the signature was verified as valid. It is needed to distinguish Commits By Branch rows by the exact GitHub-returned verified value.
* **Enables:** select Commits By Branch rows where `verified` is true or false when comparing the condition described by Verified.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for Commits By Branch; it is interpreted at one Commit Verification record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `commits_by_branch.commit.verification.verified_at`
Verified At records timestamp when the signature was verified, if applicable. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Commits By Branch records by `verified_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the Commit Verification object returned for Commits By Branch; it is interpreted at one Commit Verification record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `commits_by_branch.committer`
Committer records GitHub user who committed the commit (may be null if no linked account). It is needed to preserve the nested committer relationship or details on the parent GitHub Commit record.
* **Enables:** expand `committer` to connect the containing GitHub Commit row to its returned committer entries.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits By Branch; it is one nested object per containing GitHub Commit object when present.
Developer identifier: `commits_by_branch.full_name`
Full Name records parent `full_name` injected by the ingestor from the branches to `commits_by_branch` traversal parentContextFields. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to compare the returned full name for individual Commits By Branch rows and select rows with a specific `full_name` value.
* **Enables:** locate Commits By Branch rows whose returned full name exactly matches `full_name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub's child response does not supply this field; the connector injects parent context into each child row; it is interpreted at one GitHub Commit record per row.
Developer identifier: `commits_by_branch.html_url`
HTML URL records web URL for viewing this commit on GitHub. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits By Branch; it is link at one GitHub Commit record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.node_id`
Node ID records the GraphQL global node ID for the commit. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits By Branch; it is an identifier, not a measured quantity.
Developer identifier: `commits_by_branch.parents`
Parents records list of parent commits (merge commits have multiple parents). It is needed to preserve the nested parents relationship or details on the parent GitHub Commit record.
* **Enables:** expand `parents` to connect the containing GitHub Commit row to its returned parents entries.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits By Branch; it is one returned collection per containing GitHub Commit object.
Developer identifier: `commits_by_branch.parents.html_url`
HTML URL records web URL for viewing the parent commit on GitHub. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the Commit Parent object returned for Commits By Branch; it is link at one Commit Parent record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.parents.sha`
Sha records SHA hash of the parent commit. It is needed to distinguish repeated deliveries of the same Commits By Branch row using the declared ingestion key.
* **Enables:** use `sha` as the declared ingestion deduplication key for Commits By Branch and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the Commit Parent object returned for Commits By Branch; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `commits_by_branch.parents.url`
URL records REST API URL for the parent commit. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the Commit Parent object returned for Commits By Branch; it is link at one Commit Parent record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commits_by_branch.sha`
Sha records the SHA hash uniquely identifying the commit. It is needed to distinguish repeated deliveries of the same Commits By Branch row using the declared ingestion key.
* **Enables:** use `sha` as the declared ingestion deduplication key for Commits By Branch and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits By Branch; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `commits_by_branch.url`
URL records REST API URL for this commit. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Commits By Branch record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Commit object returned for Commits By Branch; it is link at one GitHub Commit record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues`
Issues covers repository issues (includes pull requests).
* **Enables:** follow each returned issue from its repository or project and issue number through author, assignee, state, and update time.
* **Scope:** Repository issues (includes pull requests); the connector reads `/repos/{full_name}/issues` as a changelog stream in incremental mode. The configured credential must grant the declared `repo` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitHub record was deleted.
Developer identifier: `issues.active_lock_reason`
Active Lock Reason records the reason the issue was locked. It is needed to distinguish Issues rows by the exact GitHub-returned active lock reason value.
* **Enables:** separate Issues rows by the exact GitHub-returned `active_lock_reason` label when comparing active lock reason.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is interpreted at one GitHub Issue record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `issues.assignee`
Assignee records the primary assigned user. It is needed to preserve the nested assignee relationship or details on the parent GitHub Issue record.
* **Enables:** expand `assignee` to connect the containing GitHub Issue row to its returned assignee entries.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is one nested object per containing GitHub Issue object when present.
Developer identifier: `issues.assignee.avatar_url`
Avatar URL records URL of the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `avatar_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.assignee.events_url`
Events URL records URL template for the user's events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.assignee.followers_url`
Followers URL records REST API URL for the user's followers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `followers_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.assignee.following_url`
Following URL records URL template for users this user follows. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `following_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.assignee.gists_url`
Gists URL records URL template for the user's gists. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `gists_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.assignee.gravatar_id`
Gravatar ID records gravatar ID for the user. It is needed to refer to the same gravatar across records without relying on display text.
* **Enables:** match `gravatar_id` to gravatar references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.assignee.html_url`
HTML URL records web URL for the user's profile. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.assignee.id`
ID records unique numeric identifier for the user. It is needed to distinguish repeated deliveries of the same Issues row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Issues and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `issues.assignee.login`
Login records the user's login username. It is needed to attribute this Issues row to the returned person, account, or organization reference.
* **Enables:** attribute the Issues row to the returned person or account and match the exact `login` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is interpreted at one GitHub User record per row.
Developer identifier: `issues.assignee.node_id`
Node ID records global node ID for the user. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.assignee.organizations_url`
Organizations URL records REST API URL for the user's organizations. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `organizations_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.assignee.received_events_url`
Received Events URL records REST API URL for events received by the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `received_events_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.assignee.repos_url`
Repos URL records REST API URL for the user's repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repos_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.assignee.site_admin`
Site Admin records whether the user is a GitHub site administrator. It is needed to distinguish Issues rows by the exact GitHub-returned site admin value.
* **Enables:** select Issues rows where `site_admin` is true or false when comparing the condition described by Site Admin.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `issues.assignee.starred_url`
Starred URL records URL template for the user's starred repos. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `starred_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.assignee.subscriptions_url`
Subscriptions URL records REST API URL for the user's subscriptions. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscriptions_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.assignee.type`
Type records type of the account (e.g., User, Organization, Bot). It is needed to distinguish Issues rows by the exact GitHub-returned type value.
* **Enables:** separate Issues rows by the exact GitHub-returned `type` label when comparing type.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `issues.assignee.url`
URL records REST API URL for the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.assignee.user_view_type`
User View Type records the view type of the user (e.g., public, private). It is needed to distinguish Issues rows by the exact GitHub-returned user view type value.
* **Enables:** separate Issues rows by the exact GitHub-returned `user_view_type` label when comparing user view type.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Issues; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `issues.assignees`
Assignees records array of all assigned users. It is needed to preserve the nested assignees relationship or details on the parent GitHub Issue record.
* **Enables:** expand `assignees` to connect the containing GitHub Issue row to its returned assignees entries.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is one returned collection per containing GitHub Issue object.
Developer identifier: `issues.author_association`
Author Association records how the issue author is associated with the repository. It is needed to distinguish Issues rows by the exact GitHub-returned author association value.
* **Enables:** separate Issues rows by the exact GitHub-returned `author_association` label when comparing author association.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is interpreted at one GitHub Issue record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `issues.body`
Body records issue body text in Markdown. It is needed to inspect the exact Markdown body included with this record.
* **Enables:** inspect the Markdown body returned in `body` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is Markdown body at one GitHub Issue record per row; the schema uses the `Text.Markdown` scalar; this is only the content included in the GitHub response for this record.
Developer identifier: `issues.closed_at`
Closed At records when the issue was closed, if applicable. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `closed_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is interpreted at one GitHub Issue record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.closed_by`
Closed By records the user who closed the issue. It is needed to preserve the nested closed by relationship or details on the parent GitHub Issue record.
* **Enables:** expand `closed_by` to connect the containing GitHub Issue row to its returned closed by entries.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is one nested object per containing GitHub Issue object when present.
Developer identifier: `issues.comments`
Comments records number of comments on the issue. It is needed to measure the GitHub-reported number of comments on the issue at one GitHub Issue record per row.
* **Enables:** measure and compare the GitHub-reported number of comments on the issue in `comments` at one GitHub Issue record per row.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is a GitHub-reported count at one GitHub Issue record per row.
Developer identifier: `issues.comments_url`
Comments URL records REST API URL for comments on this issue. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `comments_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is link at one GitHub Issue record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.created_at`
Created At records when the issue was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is interpreted at one GitHub Issue record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.draft`
Draft records whether the issue is a draft (applicable to pull requests surfaced via issues endpoint). It is needed to distinguish Issues rows by the exact GitHub-returned draft value.
* **Enables:** select Issues rows where `draft` is true or false when comparing the condition described by Draft.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is interpreted at one GitHub Issue record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `issues.events_url`
Events URL records REST API URL for events on this issue. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is link at one GitHub Issue record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.html_url`
HTML URL records web URL for viewing this issue in a browser. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is link at one GitHub Issue record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.id`
ID records unique numeric identifier for the issue. It is needed to distinguish repeated deliveries of the same Issues row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Issues and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `issues.labels`
Labels records array of label objects applied to the issue. It is needed to preserve the nested labels relationship or details on the parent GitHub Issue record.
* **Enables:** expand `labels` to connect the containing GitHub Issue row to its returned labels entries.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is one returned collection per containing GitHub Issue object.
Developer identifier: `issues.labels.color`
Color records hex color code for the label (without # prefix). It is needed to inventory the exact GitHub-reported configuration or classification represented by this field.
* **Enables:** compare `color` among Issues records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitHub reports this value on the GitHub Label object returned for Issues; it is interpreted at one GitHub Label record per row; the value is a GitHub-returned or configured label at the GitHub Label grain rather than a universal taxonomy.
Developer identifier: `issues.labels.default`
Default records whether this is a default label. It is needed to distinguish Issues rows by the exact GitHub-returned default value.
* **Enables:** select Issues rows where `default` is true or false when comparing the condition described by Default.
* **Interpretation:** GitHub reports this value on the GitHub Label object returned for Issues; it is interpreted at one GitHub Label record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `issues.labels.description`
Description records short description of the label. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Label object returned for Issues; it is description text at one GitHub Label record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `issues.labels.id`
ID records unique numeric identifier for the label. It is needed to distinguish repeated deliveries of the same Issues row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Issues and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub Label object returned for Issues; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `issues.labels.name`
Name records display name of the label. It is needed to compare the returned name for individual Issues rows and select rows with a specific `name` value.
* **Enables:** locate Issues rows whose returned name exactly matches `name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Label object returned for Issues; it is interpreted at one GitHub Label record per row.
Developer identifier: `issues.labels.node_id`
Node ID records global node ID for the label. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Label object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.labels.url`
URL records REST API URL for the label. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Label object returned for Issues; it is link at one GitHub Label record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.labels_url`
Labels URL records URL template for labels on this issue. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `labels_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is link at one GitHub Issue record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.locked`
Locked records whether the issue conversation is locked. It is needed to distinguish Issues rows by the exact GitHub-returned locked value.
* **Enables:** select Issues rows where `locked` is true or false when comparing the condition described by Locked.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is interpreted at one GitHub Issue record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `issues.milestone`
Milestone records the milestone this issue belongs to. It is needed to preserve the nested milestone relationship or details on the parent GitHub Issue record.
* **Enables:** expand `milestone` to connect the containing GitHub Issue row to its returned milestone entries.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is one nested object per containing GitHub Issue object when present.
Developer identifier: `issues.milestone.closed_at`
Closed At records when the milestone was closed. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `closed_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is interpreted at one GitHub Milestone record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.milestone.closed_issues`
Closed Issues records number of closed issues in this milestone. It is needed to measure the GitHub-reported number of closed issues in this milestone at one GitHub Milestone record per row.
* **Enables:** measure and compare the GitHub-reported number of closed issues in this milestone in `closed_issues` at one GitHub Milestone record per row.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is a GitHub-reported count at one GitHub Milestone record per row.
Developer identifier: `issues.milestone.created_at`
Created At records when the milestone was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is interpreted at one GitHub Milestone record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.milestone.creator`
Creator records the user who created the milestone. It is needed to preserve the nested creator relationship or details on the parent GitHub Milestone record.
* **Enables:** expand `creator` to connect the containing GitHub Milestone row to its returned creator entries.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is one nested object per containing GitHub Milestone object when present.
Developer identifier: `issues.milestone.description`
Description records description of the milestone. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is description text at one GitHub Milestone record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `issues.milestone.due_on`
Due On records due date for the milestone. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `due_on`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is interpreted at one GitHub Milestone record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.milestone.html_url`
HTML URL records web URL for the milestone. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is link at one GitHub Milestone record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.milestone.id`
ID records unique numeric identifier for the milestone. It is needed to refer to the same milestone across records without relying on display text.
* **Enables:** match `id` to milestone references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.milestone.labels_url`
Labels URL records REST API URL for labels on this milestone. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `labels_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is link at one GitHub Milestone record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.milestone.node_id`
Node ID records global node ID for the milestone. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.milestone.number`
Number records milestone number within the repository. It is needed to refer to the same issues across records without relying on display text.
* **Enables:** match `number` to issues references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.milestone.open_issues`
Open Issues records number of open issues in this milestone. It is needed to measure the GitHub-reported number of open issues in this milestone at one GitHub Milestone record per row.
* **Enables:** measure and compare the GitHub-reported number of open issues in this milestone in `open_issues` at one GitHub Milestone record per row.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is a GitHub-reported count at one GitHub Milestone record per row.
Developer identifier: `issues.milestone.state`
State records current state of the milestone. It is needed to distinguish Issues rows by the exact GitHub-returned state value.
* **Enables:** separate Issues rows by the exact GitHub-returned `state` label when comparing state.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is interpreted at one GitHub Milestone record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `issues.milestone.title`
Title records title of the milestone. It is needed to inspect the exact title text included with this record.
* **Enables:** inspect the title text returned in `title` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is title text at one GitHub Milestone record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `issues.milestone.updated_at`
Updated At records when the milestone was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is interpreted at one GitHub Milestone record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.milestone.url`
URL records REST API URL for the milestone. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Issues; it is link at one GitHub Milestone record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.node_id`
Node ID records global node ID for use with the GraphQL API. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.number`
Number records issue number within the repository. It is needed to refer to the same issues across records without relying on display text.
* **Enables:** match `number` to issues references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.performed_via_github_app`
Performed Via Github App records the GitHub App that created the issue, if applicable. It is needed to preserve the nested performed via github app relationship or details on the parent GitHub Issue record.
* **Enables:** expand `performed_via_github_app` to connect the containing GitHub Issue row to its returned performed via github app entries.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is one nested object per containing GitHub Issue object when present.
Developer identifier: `issues.performed_via_github_app.created_at`
Created At records when the app was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub App object returned for Issues; it is interpreted at one GitHub App record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.performed_via_github_app.description`
Description records description of the app. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub App object returned for Issues; it is description text at one GitHub App record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `issues.performed_via_github_app.events`
Events records events the app subscribes to. It is needed to preserve the nested events relationship or details on the parent GitHub App record.
* **Enables:** expand `events` to connect the containing GitHub App row to its returned events entries.
* **Interpretation:** GitHub reports this value on the GitHub App object returned for Issues; it is one returned collection per containing GitHub App object.
Developer identifier: `issues.performed_via_github_app.external_url`
External URL records external URL for the app. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `external_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub App object returned for Issues; it is link at one GitHub App record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.performed_via_github_app.html_url`
HTML URL records web URL for the app on GitHub. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub App object returned for Issues; it is link at one GitHub App record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.performed_via_github_app.id`
ID records unique numeric identifier for the app. It is needed to refer to the same app across records without relying on display text.
* **Enables:** match `id` to app references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub App object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.performed_via_github_app.name`
Name records display name of the app. It is needed to compare the returned name for individual Issues rows and select rows with a specific `name` value.
* **Enables:** locate Issues rows whose returned name exactly matches `name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub App object returned for Issues; it is interpreted at one GitHub App record per row.
Developer identifier: `issues.performed_via_github_app.node_id`
Node ID records global node ID for the app. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub App object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.performed_via_github_app.owner`
Owner records the user or organization that owns the app. It is needed to preserve the nested owner relationship or details on the parent GitHub App record.
* **Enables:** expand `owner` to connect the containing GitHub App row to its returned owner entries.
* **Interpretation:** GitHub reports this value on the GitHub App object returned for Issues; it is one nested object per containing GitHub App object when present.
Developer identifier: `issues.performed_via_github_app.permissions`
Permissions records permissions granted to the app. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `permissions` access value with the resource, account, or membership represented by the same Issues row.
* **Interpretation:** GitHub reports this value on the GitHub App object returned for Issues; it is interpreted at one GitHub App record per row; the schema uses the `Generic.JSON` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `issues.performed_via_github_app.slug`
Slug records URL-friendly slug of the app. It is needed to compare the returned slug for individual Issues rows and select rows with a specific `slug` value.
* **Enables:** locate Issues rows whose returned slug exactly matches `slug` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub App object returned for Issues; it is interpreted at one GitHub App record per row; the schema uses the `Identity.Slug` scalar.
Developer identifier: `issues.performed_via_github_app.updated_at`
Updated At records when the app was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub App object returned for Issues; it is interpreted at one GitHub App record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.pull_request`
Pull Request records present if the issue is actually a pull request. Used to distinguish PRs from issues. It is needed to preserve the nested pull request relationship or details on the parent GitHub Issue record.
* **Enables:** expand `pull_request` to connect the containing GitHub Issue row to its returned pull request entries.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is one nested object per containing GitHub Issue object when present.
Developer identifier: `issues.pull_request.diff_url`
Diff URL records URL for the pull request diff. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `diff_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Issue Pull Request object returned for Issues; it is link at one GitHub Issue Pull Request record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.pull_request.html_url`
HTML URL records web URL for the pull request. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Issue Pull Request object returned for Issues; it is link at one GitHub Issue Pull Request record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.pull_request.merged_at`
Merged At records when the pull request was merged. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `merged_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Issue Pull Request object returned for Issues; it is interpreted at one GitHub Issue Pull Request record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.pull_request.patch_url`
Patch URL records URL for the pull request patch. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `patch_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Issue Pull Request object returned for Issues; it is link at one GitHub Issue Pull Request record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.pull_request.url`
URL records REST API URL for the pull request. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Issue Pull Request object returned for Issues; it is link at one GitHub Issue Pull Request record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.reactions`
Reactions records reaction rollup counts for the issue. It is needed to preserve the nested reactions relationship or details on the parent GitHub Issue record.
* **Enables:** expand `reactions` to connect the containing GitHub Issue row to its returned reactions entries.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is one nested object per containing GitHub Issue object when present.
Developer identifier: `issues.reactions.+1`
+1 records number of +1 (thumbs up) reactions. It is needed to measure the GitHub-reported number of +1 (thumbs up) reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of +1 (thumbs up) reactions in `+1` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Issues; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `issues.reactions.-1`
Minus One records number of -1 (thumbs down) reactions. It is needed to measure the GitHub-reported number of -1 (thumbs down) reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of -1 (thumbs down) reactions in `-1` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Issues; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `issues.reactions.confused`
Confused records number of confused reactions. It is needed to measure the GitHub-reported number of confused reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of confused reactions in `confused` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Issues; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `issues.reactions.eyes`
Eyes records number of eyes reactions. It is needed to measure the GitHub-reported number of eyes reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of eyes reactions in `eyes` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Issues; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `issues.reactions.heart`
Heart records number of heart reactions. It is needed to measure the GitHub-reported number of heart reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of heart reactions in `heart` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Issues; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `issues.reactions.hooray`
Hooray records number of hooray reactions. It is needed to measure the GitHub-reported number of hooray reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of hooray reactions in `hooray` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Issues; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `issues.reactions.laugh`
Laugh records number of laugh reactions. It is needed to measure the GitHub-reported number of laugh reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of laugh reactions in `laugh` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Issues; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `issues.reactions.rocket`
Rocket records number of rocket reactions. It is needed to measure the GitHub-reported number of rocket reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of rocket reactions in `rocket` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Issues; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `issues.reactions.total_count`
Total Count records total number of reactions. It is needed to measure the GitHub-reported number of reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of reactions in `total_count` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Issues; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `issues.reactions.url`
URL records REST API URL for reactions. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Issues; it is link at one GitHub Reactions record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.repository_url`
Repository URL records REST API URL for the parent repository. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repository_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is link at one GitHub Issue record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.state`
State records current state of the issue. It is needed to distinguish Issues rows by the exact GitHub-returned state value.
* **Enables:** separate Issues rows by the exact GitHub-returned `state` label when comparing state.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is interpreted at one GitHub Issue record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `issues.state_reason`
State Reason records the reason the issue state was changed. It is needed to distinguish Issues rows by the exact GitHub-returned state reason value.
* **Enables:** separate Issues rows by the exact GitHub-returned `state_reason` label when comparing state reason.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is interpreted at one GitHub Issue record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `issues.sub_issues_summary`
Sub Issues Summary records summary of sub-issues counts. It is needed to preserve the nested sub issues summary relationship or details on the parent GitHub Issue record.
* **Enables:** expand `sub_issues_summary` to connect the containing GitHub Issue row to its returned sub issues summary entries.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is one nested object per containing GitHub Issue object when present.
Developer identifier: `issues.sub_issues_summary.completed`
Completed records number of completed sub-issues. It is needed to measure the GitHub-reported number of completed sub-issues at one GitHub Sub Issues Summary record per row.
* **Enables:** measure and compare the GitHub-reported number of completed sub-issues in `completed` at one GitHub Sub Issues Summary record per row.
* **Interpretation:** GitHub reports this value on the GitHub Sub Issues Summary object returned for Issues; it is a GitHub-reported count at one GitHub Sub Issues Summary record per row.
Developer identifier: `issues.sub_issues_summary.percent_completed`
Percent Completed records percentage of sub-issues completed. It is needed to measure the reported percent completed for one git hub sub issues summary record.
* **Enables:** measure and compare `percent_completed` per GitHub Sub Issues Summary record in percent.
* **Interpretation:** GitHub reports this value on the GitHub Sub Issues Summary object returned for Issues; its unit or granularity is percent.
Developer identifier: `issues.sub_issues_summary.total`
Total records total number of sub-issues. It is needed to measure the GitHub-reported number of sub-issues at one GitHub Sub Issues Summary record per row.
* **Enables:** measure and compare the GitHub-reported number of sub-issues in `total` at one GitHub Sub Issues Summary record per row.
* **Interpretation:** GitHub reports this value on the GitHub Sub Issues Summary object returned for Issues; it is a GitHub-reported count at one GitHub Sub Issues Summary record per row.
Developer identifier: `issues.timeline_url`
Timeline URL records REST API URL for the issue timeline. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `timeline_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is link at one GitHub Issue record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.title`
Title records issue title. It is needed to inspect the exact title text included with this record.
* **Enables:** inspect the title text returned in `title` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is title text at one GitHub Issue record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `issues.type`
Type records issue type assigned to the issue (GitHub issue types). It is needed to preserve the nested type relationship or details on the parent GitHub Issue record.
* **Enables:** expand `type` to connect the containing GitHub Issue row to its returned type entries.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is one nested object per containing GitHub Issue object when present.
Developer identifier: `issues.type.color`
Color records issue type display color. It is needed to inventory the exact GitHub-reported configuration or classification represented by this field.
* **Enables:** compare `color` among Issues records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is interpreted at one GitHub Issue record per row; the value is a GitHub-returned or configured label at the GitHub Issue grain rather than a universal taxonomy.
Developer identifier: `issues.type.description`
Description records issue type description. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is description text at one GitHub Issue record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `issues.type.id`
ID records issue type identifier. It is needed to refer to the same issue across records without relying on display text.
* **Enables:** match `id` to issue references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.type.name`
Name records issue type name. It is needed to compare the returned name for individual Issues rows and select rows with a specific `name` value.
* **Enables:** locate Issues rows whose returned name exactly matches `name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is interpreted at one GitHub Issue record per row.
Developer identifier: `issues.type.node_id`
Node ID records graphQL node identifier for the issue type. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.updated_at`
Updated At records when the issue was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is interpreted at one GitHub Issue record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.url`
URL records REST API URL for this issue. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is link at one GitHub Issue record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.user`
User records the user who created the issue. It is needed to preserve the nested user relationship or details on the parent GitHub Issue record.
* **Enables:** expand `user` to connect the containing GitHub Issue row to its returned user entries.
* **Interpretation:** GitHub reports this value on the GitHub Issue object returned for Issues; it is one nested object per containing GitHub Issue object when present.
Developer identifier: `members`
Members covers organization members.
* **Enables:** map the GitHub accounts and memberships represented by Members records and trace a returned access assignment to its account or group.
* **Scope:** Organization members; the connector reads `/orgs/{orgId}/members` as a snapshot stream in full mode. The configured credential must grant the declared `read:org` access scope; records outside that access are not returned. A successful full collection can reveal a previously returned row as absent, but a credential or permission change can produce the same observation.
Developer identifier: `members.avatar_url`
Avatar URL records URL to the member's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `avatar_url` while retaining the containing Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is link at one GitHub Org Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target. A connector directive maps this field to the person's identity photo.
Developer identifier: `members.events_url`
Events URL records API URL template for the member's events. Contains (/privacy) placeholder. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is link at one GitHub Org Member record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `members.followers_url`
Followers URL records API URL for the member's followers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `followers_url` while retaining the containing Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is link at one GitHub Org Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `members.following_url`
Following URL records API URL template for users this member is following. Contains (/`other_user`) placeholder. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `following_url` while retaining the containing Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is link at one GitHub Org Member record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `members.gists_url`
Gists URL records API URL template for the member's gists. Contains (/`gist_id`) placeholder. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `gists_url` while retaining the containing Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is link at one GitHub Org Member record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `members.gravatar_id`
Gravatar ID records the Gravatar ID associated with the member, if any. It is needed to refer to the same gravatar across records without relying on display text.
* **Enables:** match `gravatar_id` to gravatar references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is an identifier, not a measured quantity.
Developer identifier: `members.html_url`
HTML URL records URL to the member's GitHub profile page. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is link at one GitHub Org Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `members.id`
ID records the unique GitHub user ID of the member. It is needed to distinguish repeated deliveries of the same Members row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Members and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `members.login`
Login records the GitHub username of the member. It is needed to attribute this Members row to the returned person, account, or organization reference.
* **Enables:** attribute the Members row to the returned person or account and match the exact `login` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is interpreted at one GitHub Org Member record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `members.node_id`
Node ID records the global relay ID (GraphQL node ID) for the member. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is an identifier, not a measured quantity.
Developer identifier: `members.organizations_url`
Organizations URL records API URL for the member's organizations. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `organizations_url` while retaining the containing Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is link at one GitHub Org Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `members.received_events_url`
Received Events URL records API URL for events received by the member. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `received_events_url` while retaining the containing Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is link at one GitHub Org Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `members.repos_url`
Repos URL records API URL for the member's repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repos_url` while retaining the containing Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is link at one GitHub Org Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `members.site_admin`
Site Admin records whether the member is a GitHub site administrator. It is needed to distinguish Members rows by the exact GitHub-returned site admin value.
* **Enables:** select Members rows where `site_admin` is true or false when comparing the condition described by Site Admin.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is interpreted at one GitHub Org Member record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `members.starred_url`
Starred URL records API URL template for the member's starred repositories. Contains (/owner)(/repo) placeholder. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `starred_url` while retaining the containing Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is link at one GitHub Org Member record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `members.subscriptions_url`
Subscriptions URL records API URL for the member's subscriptions. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscriptions_url` while retaining the containing Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is link at one GitHub Org Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `members.type`
Type records the type of GitHub account: User or Bot. It is needed to distinguish Members rows by the exact GitHub-returned type value.
* **Enables:** separate Members rows by the exact GitHub-returned `type` label when comparing type.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is interpreted at one GitHub Org Member record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `members.url`
URL records API URL for the member's user resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is link at one GitHub Org Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `members.user_view_type`
User View Type records the view type of the user, e.g. public or private. It is needed to distinguish Members rows by the exact GitHub-returned user view type value.
* **Enables:** separate Members rows by the exact GitHub-returned `user_view_type` label when comparing user view type.
* **Interpretation:** GitHub reports this value on the GitHub Org Member object returned for Members; it is interpreted at one GitHub Org Member record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_request_comments`
Pull Request Comments covers comments on pull requests (review comments).
* **Enables:** attribute each returned review comment or note to its work item, author, file or diff position, and time where those fields are present.
* **Scope:** Comments on pull requests (review comments); the connector reads `/repos/{full_name}/pulls/comments` as an event stream in incremental mode. The configured credential must grant the declared `repo` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitHub record was deleted.
Developer identifier: `pull_request_comments._links`
Links records hypermedia links for related resources. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `_links` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is link at one GitHub Pull Request Comment record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments._links.html`
HTML records link to the HTML view of this comment. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the Pull Request Comment Links object returned for Pull Request Comments; it is link at one Pull Request Comment Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments._links.html.href`
Href records the URL of the linked resource. It is needed to retain the exact GitHub resource or external link reported for this Pull Request Comments record.
* **Enables:** open or correlate the resource named by `href` while retaining the containing Hypermedia Link row as provenance.
* **Interpretation:** GitHub reports this value on the Hypermedia Link object returned for Pull Request Comments; it is interpreted at one Hypermedia Link record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments._links.pull_request`
Pull Request records link to the parent pull request. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `pull_request` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the Pull Request Comment Links object returned for Pull Request Comments; it is link at one Pull Request Comment Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments._links.self`
Self records link to this comment. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `self` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the Pull Request Comment Links object returned for Pull Request Comments; it is link at one Pull Request Comment Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.author_association`
Author Association records how the author is associated with the repository. It is needed to distinguish Pull Request Comments rows by the exact GitHub-returned author association value.
* **Enables:** separate Pull Request Comments rows by the exact GitHub-returned `author_association` label when comparing author association.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is interpreted at one GitHub Pull Request Comment record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_request_comments.body`
Body records markdown body of the review comment. It is needed to inspect the exact Markdown body included with this record.
* **Enables:** inspect the Markdown body returned in `body` and attribute it to the same record's repository or project, revision, file path, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is Markdown body at one GitHub Pull Request Comment record per row; the schema uses the `Text.Markdown` scalar; this is only the content included in the GitHub response for this record.
Developer identifier: `pull_request_comments.body_html`
Body HTML records HTML rendered version of the comment body. It is needed to inspect the exact HTML body included with this record.
* **Enables:** inspect the HTML body returned in `body_html` and attribute it to the same record's repository or project, revision, file path, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is HTML body at one GitHub Pull Request Comment record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `pull_request_comments.body_text`
Body Text records plain text version of the comment body. It is needed to inspect the exact plain-text body included with this record.
* **Enables:** inspect the plain-text body returned in `body_text` and attribute it to the same record's repository or project, revision, file path, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is plain-text body at one GitHub Pull Request Comment record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `pull_request_comments.commit_id`
Commit ID records SHA of the commit the comment was made on. It is needed to refer to the same commit across records without relying on display text.
* **Enables:** match `commit_id` to commit references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is an identifier, not a measured quantity.
Developer identifier: `pull_request_comments.created_at`
Created At records ISO 8601 timestamp when the comment was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pull Request Comments records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is interpreted at one GitHub Pull Request Comment record per row; the schema assigns the `event_time` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pull_request_comments.diff_hunk`
Diff Hunk records the diff hunk that the comment applies to. It is needed to inspect the exact diff hunk included with this record.
* **Enables:** inspect the diff hunk returned in `diff_hunk` and attribute it to the same record's repository or project, revision, file path, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is diff hunk at one GitHub Pull Request Comment record per row; this is the code-change content included in the response, not a separate full-file fetch.
Developer identifier: `pull_request_comments.full_name`
Full Name records owner-qualified repository identifier (e.g. 'owner/repo'). Injected from the parent repository context via parentContextFields; not present in the raw GitHub review comments API response. It is needed to refer to the same full name across records without relying on display text.
* **Enables:** match `full_name` to full name references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub's child response does not supply this field; the connector injects parent context into each child row; it is an identifier, not a measured quantity.
Developer identifier: `pull_request_comments.html_url`
HTML URL records URL to view this comment on github.com. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is link at one GitHub Pull Request Comment record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.id`
ID records unique numeric identifier for the review comment. It is needed to distinguish repeated deliveries of the same Pull Request Comments row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Pull Request Comments and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `pull_request_comments.in_reply_to_id`
In Reply To ID records the ID of the comment this comment replies to, if it is a reply. It is needed to refer to the same in reply to across records without relying on display text.
* **Enables:** match `in_reply_to_id` to in reply to references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is an identifier, not a measured quantity.
Developer identifier: `pull_request_comments.line`
Line records the line of the blob to which the comment applies. The last line of the range for a multi-line comment. It is needed to compare the numeric line reported for one GitHub Pull Request Comment record without assuming an unstated unit.
* **Enables:** compare the numeric `line` value per GitHub Pull Request Comment record without assigning a unit not declared by the schema description.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is interpreted at one GitHub Pull Request Comment record per row.
Developer identifier: `pull_request_comments.node_id`
Node ID records global relay ID for the GraphQL API. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is an identifier, not a measured quantity.
Developer identifier: `pull_request_comments.original_commit_id`
Original Commit ID records SHA of the original commit the comment was made on. It is needed to refer to the same original commit across records without relying on display text.
* **Enables:** match `original_commit_id` to original commit references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is an identifier, not a measured quantity.
Developer identifier: `pull_request_comments.original_line`
Original Line records the original line of the blob to which the comment applies. It is needed to compare the numeric original line reported for one GitHub Pull Request Comment record without assuming an unstated unit.
* **Enables:** compare the numeric `original_line` value per GitHub Pull Request Comment record without assigning a unit not declared by the schema description.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is interpreted at one GitHub Pull Request Comment record per row.
Developer identifier: `pull_request_comments.original_position`
Original Position records the original line index in the diff to which the comment was made. It is needed to compare the numeric original position reported for one GitHub Pull Request Comment record without assuming an unstated unit.
* **Enables:** compare the numeric `original_position` value per GitHub Pull Request Comment record without assigning a unit not declared by the schema description.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is interpreted at one GitHub Pull Request Comment record per row.
Developer identifier: `pull_request_comments.original_start_line`
Original Start Line records the original first line of the range for a multi-line comment. It is needed to compare the numeric original start line reported for one GitHub Pull Request Comment record without assuming an unstated unit.
* **Enables:** compare the numeric `original_start_line` value per GitHub Pull Request Comment record without assigning a unit not declared by the schema description.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is interpreted at one GitHub Pull Request Comment record per row.
Developer identifier: `pull_request_comments.path`
Path records the relative file path the comment applies to. It is needed to compare the returned path for individual Pull Request Comments rows and select rows with a specific `path` value.
* **Enables:** trace the path relationship returned in `path` from the GitHub Pull Request Comment row to its named GitHub context.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is interpreted at one GitHub Pull Request Comment record per row; the schema uses the `Asset.FilePath` scalar.
Developer identifier: `pull_request_comments.position`
Position records the line index in the diff to which the comment applies (deprecated in favor of line). It is needed to compare the numeric position reported for one GitHub Pull Request Comment record without assuming an unstated unit.
* **Enables:** compare the numeric `position` value per GitHub Pull Request Comment record without assigning a unit not declared by the schema description.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is interpreted at one GitHub Pull Request Comment record per row.
Developer identifier: `pull_request_comments.pull_request_review_id`
Pull Request Review ID records ID of the parent pull request review this comment belongs to. It is needed to refer to the same pull request review across records without relying on display text.
* **Enables:** match `pull_request_review_id` to pull request review references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is an identifier, not a measured quantity.
Developer identifier: `pull_request_comments.pull_request_url`
Pull Request URL records REST API URL for the parent pull request. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `pull_request_url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is link at one GitHub Pull Request Comment record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.reactions`
Reactions records reaction rollup counts for the comment. It is needed to preserve the nested reactions relationship or details on the parent GitHub Pull Request Comment record.
* **Enables:** expand `reactions` to connect the containing GitHub Pull Request Comment row to its returned reactions entries.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is one nested object per containing GitHub Pull Request Comment object when present.
Developer identifier: `pull_request_comments.reactions.+1`
+1 records number of +1 reactions. It is needed to measure the GitHub-reported number of +1 reactions at one Reaction Rollup record per row.
* **Enables:** measure and compare the GitHub-reported number of +1 reactions in `+1` at one Reaction Rollup record per row.
* **Interpretation:** GitHub reports this value on the Reaction Rollup object returned for Pull Request Comments; it is a GitHub-reported count at one Reaction Rollup record per row.
Developer identifier: `pull_request_comments.reactions.-1`
Minus One records number of -1 reactions. It is needed to measure the GitHub-reported number of -1 reactions at one Reaction Rollup record per row.
* **Enables:** measure and compare the GitHub-reported number of -1 reactions in `-1` at one Reaction Rollup record per row.
* **Interpretation:** GitHub reports this value on the Reaction Rollup object returned for Pull Request Comments; it is a GitHub-reported count at one Reaction Rollup record per row.
Developer identifier: `pull_request_comments.reactions.confused`
Confused records number of confused reactions. It is needed to measure the GitHub-reported number of confused reactions at one Reaction Rollup record per row.
* **Enables:** measure and compare the GitHub-reported number of confused reactions in `confused` at one Reaction Rollup record per row.
* **Interpretation:** GitHub reports this value on the Reaction Rollup object returned for Pull Request Comments; it is a GitHub-reported count at one Reaction Rollup record per row.
Developer identifier: `pull_request_comments.reactions.eyes`
Eyes records number of eyes reactions. It is needed to measure the GitHub-reported number of eyes reactions at one Reaction Rollup record per row.
* **Enables:** measure and compare the GitHub-reported number of eyes reactions in `eyes` at one Reaction Rollup record per row.
* **Interpretation:** GitHub reports this value on the Reaction Rollup object returned for Pull Request Comments; it is a GitHub-reported count at one Reaction Rollup record per row.
Developer identifier: `pull_request_comments.reactions.heart`
Heart records number of heart reactions. It is needed to measure the GitHub-reported number of heart reactions at one Reaction Rollup record per row.
* **Enables:** measure and compare the GitHub-reported number of heart reactions in `heart` at one Reaction Rollup record per row.
* **Interpretation:** GitHub reports this value on the Reaction Rollup object returned for Pull Request Comments; it is a GitHub-reported count at one Reaction Rollup record per row.
Developer identifier: `pull_request_comments.reactions.hooray`
Hooray records number of hooray reactions. It is needed to measure the GitHub-reported number of hooray reactions at one Reaction Rollup record per row.
* **Enables:** measure and compare the GitHub-reported number of hooray reactions in `hooray` at one Reaction Rollup record per row.
* **Interpretation:** GitHub reports this value on the Reaction Rollup object returned for Pull Request Comments; it is a GitHub-reported count at one Reaction Rollup record per row.
Developer identifier: `pull_request_comments.reactions.laugh`
Laugh records number of laugh reactions. It is needed to measure the GitHub-reported number of laugh reactions at one Reaction Rollup record per row.
* **Enables:** measure and compare the GitHub-reported number of laugh reactions in `laugh` at one Reaction Rollup record per row.
* **Interpretation:** GitHub reports this value on the Reaction Rollup object returned for Pull Request Comments; it is a GitHub-reported count at one Reaction Rollup record per row.
Developer identifier: `pull_request_comments.reactions.rocket`
Rocket records number of rocket reactions. It is needed to measure the GitHub-reported number of rocket reactions at one Reaction Rollup record per row.
* **Enables:** measure and compare the GitHub-reported number of rocket reactions in `rocket` at one Reaction Rollup record per row.
* **Interpretation:** GitHub reports this value on the Reaction Rollup object returned for Pull Request Comments; it is a GitHub-reported count at one Reaction Rollup record per row.
Developer identifier: `pull_request_comments.reactions.total_count`
Total Count records total number of reactions. It is needed to measure the GitHub-reported number of reactions at one Reaction Rollup record per row.
* **Enables:** measure and compare the GitHub-reported number of reactions in `total_count` at one Reaction Rollup record per row.
* **Interpretation:** GitHub reports this value on the Reaction Rollup object returned for Pull Request Comments; it is a GitHub-reported count at one Reaction Rollup record per row.
Developer identifier: `pull_request_comments.reactions.url`
URL records REST API URL for reactions on this comment. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the Reaction Rollup object returned for Pull Request Comments; it is link at one Reaction Rollup record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.side`
Side records the side of the diff to which the comment applies. It is needed to distinguish Pull Request Comments rows by the exact GitHub-returned side value.
* **Enables:** separate Pull Request Comments rows by the exact GitHub-returned `side` label when comparing side.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is interpreted at one GitHub Pull Request Comment record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_request_comments.start_line`
Start Line records the first line of the range for a multi-line comment. It is needed to compare the numeric start line reported for one GitHub Pull Request Comment record without assuming an unstated unit.
* **Enables:** compare the numeric `start_line` value per GitHub Pull Request Comment record without assigning a unit not declared by the schema description.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is interpreted at one GitHub Pull Request Comment record per row.
Developer identifier: `pull_request_comments.start_side`
Start Side records the side of the first line of the range for a multi-line comment. It is needed to distinguish Pull Request Comments rows by the exact GitHub-returned start side value.
* **Enables:** separate Pull Request Comments rows by the exact GitHub-returned `start_side` label when comparing start side.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is interpreted at one GitHub Pull Request Comment record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_request_comments.subject_type`
Subject Type records the level at which the comment is targeted. It is needed to distinguish Pull Request Comments rows by the exact GitHub-returned subject type value.
* **Enables:** separate Pull Request Comments rows by the exact GitHub-returned `subject_type` label when comparing subject type.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is interpreted at one GitHub Pull Request Comment record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_request_comments.updated_at`
Updated At records ISO 8601 timestamp when the comment was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pull Request Comments records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is interpreted at one GitHub Pull Request Comment record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pull_request_comments.url`
URL records REST API URL for this review comment. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is link at one GitHub Pull Request Comment record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.user`
User records the user who authored the review comment. It is needed to preserve the nested user relationship or details on the parent GitHub Pull Request Comment record.
* **Enables:** expand `user` to connect the containing GitHub Pull Request Comment row to its returned user entries.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Comment object returned for Pull Request Comments; it is one nested object per containing GitHub Pull Request Comment object when present.
Developer identifier: `pull_request_comments.user.avatar_url`
Avatar URL records URL to the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `avatar_url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is link at one GitHub Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.user.events_url`
Events URL records REST API URL template for the user's events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is link at one GitHub Simple User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.user.followers_url`
Followers URL records REST API URL for the user's followers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `followers_url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is link at one GitHub Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.user.following_url`
Following URL records REST API URL template for users this user follows. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `following_url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is link at one GitHub Simple User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.user.gists_url`
Gists URL records REST API URL template for the user's gists. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `gists_url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is link at one GitHub Simple User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.user.gravatar_id`
Gravatar ID records gravatar ID for the user. It is needed to refer to the same gravatar across records without relying on display text.
* **Enables:** match `gravatar_id` to gravatar references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is an identifier, not a measured quantity.
Developer identifier: `pull_request_comments.user.html_url`
HTML URL records URL to the user's GitHub profile page. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is link at one GitHub Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.user.id`
ID records unique numeric identifier for the user. It is needed to refer to the same simple user across records without relying on display text.
* **Enables:** match `id` to simple user references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is an identifier, not a measured quantity.
Developer identifier: `pull_request_comments.user.login`
Login records the username of the user. It is needed to attribute this Pull Request Comments row to the returned person, account, or organization reference.
* **Enables:** attribute the Pull Request Comments row to the returned person or account and match the exact `login` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is interpreted at one GitHub Simple User record per row.
Developer identifier: `pull_request_comments.user.node_id`
Node ID records global relay ID for the GraphQL API. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is an identifier, not a measured quantity.
Developer identifier: `pull_request_comments.user.organizations_url`
Organizations URL records REST API URL for the user's organizations. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `organizations_url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is link at one GitHub Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.user.received_events_url`
Received Events URL records REST API URL for events received by the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `received_events_url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is link at one GitHub Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.user.repos_url`
Repos URL records REST API URL for the user's repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repos_url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is link at one GitHub Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.user.site_admin`
Site Admin records whether the user is a GitHub site administrator. It is needed to distinguish Pull Request Comments rows by the exact GitHub-returned site admin value.
* **Enables:** select Pull Request Comments rows where `site_admin` is true or false when comparing the condition described by Site Admin.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is interpreted at one GitHub Simple User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_request_comments.user.starred_url`
Starred URL records REST API URL template for the user's starred repos. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `starred_url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is link at one GitHub Simple User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.user.subscriptions_url`
Subscriptions URL records REST API URL for the user's subscriptions. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscriptions_url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is link at one GitHub Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.user.type`
Type records type of GitHub account (e.g., User, Organization, Bot). It is needed to distinguish Pull Request Comments rows by the exact GitHub-returned type value.
* **Enables:** separate Pull Request Comments rows by the exact GitHub-returned `type` label when comparing type.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is interpreted at one GitHub Simple User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_request_comments.user.url`
URL records REST API URL for this user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Pull Request Comments record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is link at one GitHub Simple User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_request_comments.user.user_view_type`
User View Type records view type of the user. It is needed to distinguish Pull Request Comments rows by the exact GitHub-returned user view type value.
* **Enables:** separate Pull Request Comments rows by the exact GitHub-returned `user_view_type` label when comparing user view type.
* **Interpretation:** GitHub reports this value on the GitHub Simple User object returned for Pull Request Comments; it is interpreted at one GitHub Simple User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests`
Pull Requests covers repository pull requests.
* **Enables:** follow each returned code-review request from its repository or project and source revision through reviewer, state, and merge outcome.
* **Scope:** Repository pull requests; the connector reads `/repos/{full_name}/pulls` as a changelog stream in incremental mode. The configured credential must grant the declared `repo` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitHub record was deleted.
Developer identifier: `pull_requests._links`
Links records hypermedia link relations for the pull request. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `_links` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is link at one GitHub Pull Request record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests._links.comments`
Comments records link to the comments. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `comments` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Links object returned for Pull Requests; it is link at one GitHub Pull Request Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests._links.comments.href`
Href records the URL of the link. It is needed to retain the exact GitHub resource or external link reported for this Pull Requests record.
* **Enables:** open or correlate the resource named by `href` while retaining the containing Github Link row as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Link object returned for Pull Requests; it is interpreted at one GitHub Link record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests._links.commits`
Commits records link to the commits. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `commits` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Links object returned for Pull Requests; it is link at one GitHub Pull Request Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests._links.html`
HTML records link to the HTML view. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Links object returned for Pull Requests; it is link at one GitHub Pull Request Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests._links.issue`
Issue records link to the associated issue. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `issue` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Links object returned for Pull Requests; it is link at one GitHub Pull Request Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests._links.review_comment`
Review Comment records link template for a review comment. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `review_comment` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Links object returned for Pull Requests; it is link at one GitHub Pull Request Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests._links.review_comments`
Review Comments records link to the review comments. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `review_comments` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Links object returned for Pull Requests; it is link at one GitHub Pull Request Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests._links.self`
Self records link to this pull request. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `self` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Links object returned for Pull Requests; it is link at one GitHub Pull Request Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests._links.statuses`
Statuses records link to the commit statuses. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `statuses` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request Links object returned for Pull Requests; it is link at one GitHub Pull Request Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.active_lock_reason`
Active Lock Reason records the reason the pull request conversation was locked. It is needed to distinguish Pull Requests rows by the exact GitHub-returned active lock reason value.
* **Enables:** separate Pull Requests rows by the exact GitHub-returned `active_lock_reason` label when comparing active lock reason.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is interpreted at one GitHub Pull Request record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.assignee`
Assignee records the primary user assigned to the pull request. It is needed to preserve the nested assignee relationship or details on the parent GitHub Pull Request record.
* **Enables:** expand `assignee` to connect the containing GitHub Pull Request row to its returned assignee entries.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is one nested object per containing GitHub Pull Request object when present.
Developer identifier: `pull_requests.assignee.avatar_url`
Avatar URL records URL of the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `avatar_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is link at one GitHub User Ref record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignee.events_url`
Events URL records URL template for the user's events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is link at one GitHub User Ref record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignee.followers_url`
Followers URL records REST API URL for the user's followers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `followers_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is link at one GitHub User Ref record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignee.following_url`
Following URL records URL template for users this user follows. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `following_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is link at one GitHub User Ref record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignee.gists_url`
Gists URL records URL template for the user's gists. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `gists_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is link at one GitHub User Ref record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignee.gravatar_id`
Gravatar ID records gravatar ID of the user. It is needed to refer to the same gravatar across records without relying on display text.
* **Enables:** match `gravatar_id` to gravatar references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.assignee.html_url`
HTML URL records web URL for the user's profile. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is link at one GitHub User Ref record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignee.id`
ID records unique numeric identifier for the user. It is needed to refer to the same user ref across records without relying on display text.
* **Enables:** match `id` to user ref references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.assignee.login`
Login records the username/login handle of the user. It is needed to attribute this Pull Requests row to the returned person, account, or organization reference.
* **Enables:** attribute the Pull Requests row to the returned person or account and match the exact `login` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is interpreted at one GitHub User Ref record per row.
Developer identifier: `pull_requests.assignee.node_id`
Node ID records global node ID for the GraphQL API. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.assignee.organizations_url`
Organizations URL records REST API URL for the user's organizations. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `organizations_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is link at one GitHub User Ref record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignee.received_events_url`
Received Events URL records REST API URL for events received by the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `received_events_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is link at one GitHub User Ref record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignee.repos_url`
Repos URL records REST API URL for the user's repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repos_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is link at one GitHub User Ref record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignee.site_admin`
Site Admin records whether the user is a GitHub site administrator. It is needed to distinguish Pull Requests rows by the exact GitHub-returned site admin value.
* **Enables:** select Pull Requests rows where `site_admin` is true or false when comparing the condition described by Site Admin.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is interpreted at one GitHub User Ref record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.assignee.starred_url`
Starred URL records URL template for the user's starred repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `starred_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is link at one GitHub User Ref record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignee.subscriptions_url`
Subscriptions URL records REST API URL for the user's subscriptions. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscriptions_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is link at one GitHub User Ref record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignee.type`
Type records the type of account (User, Organization, Bot, etc.). It is needed to distinguish Pull Requests rows by the exact GitHub-returned type value.
* **Enables:** separate Pull Requests rows by the exact GitHub-returned `type` label when comparing type.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is interpreted at one GitHub User Ref record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.assignee.url`
URL records REST API URL for this user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is link at one GitHub User Ref record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignee.user_view_type`
User View Type records view type for the user (e.g. public). It is needed to distinguish Pull Requests rows by the exact GitHub-returned user view type value.
* **Enables:** separate Pull Requests rows by the exact GitHub-returned `user_view_type` label when comparing user view type.
* **Interpretation:** GitHub reports this value on the GitHub User Ref object returned for Pull Requests; it is interpreted at one GitHub User Ref record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.assignees`
Assignees records all users assigned to the pull request. It is needed to preserve the nested assignees relationship or details on the parent GitHub Pull Request record.
* **Enables:** expand `assignees` to connect the containing GitHub Pull Request row to its returned assignees entries.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is one returned collection per containing GitHub Pull Request object.
Developer identifier: `pull_requests.assignees.avatar_url`
Avatar URL records URL of the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `avatar_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignees.events_url`
Events URL records URL template for the user's events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignees.followers_url`
Followers URL records REST API URL for the user's followers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `followers_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignees.following_url`
Following URL records URL template for users this user follows. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `following_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignees.gists_url`
Gists URL records URL template for the user's gists. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `gists_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignees.gravatar_id`
Gravatar ID records gravatar ID of the user. It is needed to refer to the same gravatar across records without relying on display text.
* **Enables:** match `gravatar_id` to gravatar references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.assignees.html_url`
HTML URL records web URL for the user's profile. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignees.id`
ID records unique numeric identifier for the user. It is needed to distinguish repeated deliveries of the same Pull Requests row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Pull Requests and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `pull_requests.assignees.login`
Login records the username/login handle of the user. It is needed to attribute this Pull Requests row to the returned person, account, or organization reference.
* **Enables:** attribute the Pull Requests row to the returned person or account and match the exact `login` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is interpreted at one GitHub User record per row.
Developer identifier: `pull_requests.assignees.node_id`
Node ID records global node ID for the GraphQL API. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.assignees.organizations_url`
Organizations URL records REST API URL for the user's organizations. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `organizations_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignees.received_events_url`
Received Events URL records REST API URL for events received by the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `received_events_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignees.repos_url`
Repos URL records REST API URL for the user's repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repos_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignees.site_admin`
Site Admin records whether the user is a GitHub site administrator. It is needed to distinguish Pull Requests rows by the exact GitHub-returned site admin value.
* **Enables:** select Pull Requests rows where `site_admin` is true or false when comparing the condition described by Site Admin.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.assignees.starred_url`
Starred URL records URL template for the user's starred repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `starred_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignees.subscriptions_url`
Subscriptions URL records REST API URL for the user's subscriptions. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscriptions_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignees.type`
Type records the type of account (User, Organization, Bot, etc.). It is needed to distinguish Pull Requests rows by the exact GitHub-returned type value.
* **Enables:** separate Pull Requests rows by the exact GitHub-returned `type` label when comparing type.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.assignees.url`
URL records REST API URL for this user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.assignees.user_view_type`
User View Type records view type for the user (e.g. public). It is needed to distinguish Pull Requests rows by the exact GitHub-returned user view type value.
* **Enables:** separate Pull Requests rows by the exact GitHub-returned `user_view_type` label when comparing user view type.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Pull Requests; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.author_association`
Author Association records the association of the author with the repository. It is needed to distinguish Pull Requests rows by the exact GitHub-returned author association value.
* **Enables:** separate Pull Requests rows by the exact GitHub-returned `author_association` label when comparing author association.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is interpreted at one GitHub Pull Request record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.auto_merge`
Auto Merge records auto-merge configuration if enabled. It is needed to preserve the nested auto merge relationship or details on the parent GitHub Pull Request record.
* **Enables:** expand `auto_merge` to connect the containing GitHub Pull Request row to its returned auto merge entries.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is one nested object per containing GitHub Pull Request object when present.
Developer identifier: `pull_requests.auto_merge.commit_message`
Commit Message records message for the merge commit. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `commit_message` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Auto Merge object returned for Pull Requests; it is commit message at one GitHub Auto Merge record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `pull_requests.auto_merge.commit_title`
Commit Title records title for the merge commit. It is needed to inspect the exact merge-commit title returned for this Github Auto Merge record.
* **Enables:** attribute the merge-commit title in `commit_title` to the containing Pull Requests identifier, owner or author, status, and update time where returned.
* **Interpretation:** GitHub reports this value on the GitHub Auto Merge object returned for Pull Requests; it is interpreted at one GitHub Auto Merge record per row; this is only the merge-commit title included in the GitHub response for this record.
Developer identifier: `pull_requests.auto_merge.enabled_by`
Enabled By records the user who enabled auto-merge. It is needed to preserve the nested enabled by relationship or details on the parent GitHub Auto Merge record.
* **Enables:** expand `enabled_by` to connect the containing GitHub Auto Merge row to its returned enabled by entries.
* **Interpretation:** GitHub reports this value on the GitHub Auto Merge object returned for Pull Requests; it is one nested object per containing GitHub Auto Merge object when present.
Developer identifier: `pull_requests.auto_merge.merge_method`
Merge Method records the merge method to use (merge, squash, rebase). It is needed to distinguish Pull Requests rows by the exact GitHub-returned merge method value.
* **Enables:** separate Pull Requests rows by the exact GitHub-returned `merge_method` label when comparing merge method.
* **Interpretation:** GitHub reports this value on the GitHub Auto Merge object returned for Pull Requests; it is interpreted at one GitHub Auto Merge record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base`
Base records the target (base) branch reference for the pull request. It is needed to preserve the nested base relationship or details on the parent GitHub Pull Request record.
* **Enables:** expand `base` to connect the containing GitHub Pull Request row to its returned base entries.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is one nested object per containing GitHub Pull Request object when present.
Developer identifier: `pull_requests.base.label`
Label records label in the format owner:branch. It is needed to compare the returned label for individual Pull Requests rows and select rows with a specific `label` value.
* **Enables:** locate Pull Requests rows whose returned label exactly matches `label` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Branch Ref object returned for Pull Requests; it is interpreted at one GitHub Branch Ref record per row.
Developer identifier: `pull_requests.base.ref`
Ref records branch name. It is needed to link the row to the exact GitHub branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `ref` to the returned branch, tag, commit SHA, or work-item reference on related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Branch Ref object returned for Pull Requests; it is interpreted at one GitHub Branch Ref record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `pull_requests.base.repo`
Repo records the repository containing this branch. May be null if the fork was deleted. It is needed to preserve the nested repo relationship or details on the parent GitHub Branch Ref record.
* **Enables:** expand `repo` to connect the containing GitHub Branch Ref row to its returned repo entries.
* **Interpretation:** GitHub reports this value on the GitHub Branch Ref object returned for Pull Requests; it is one nested object per containing GitHub Branch Ref object when present.
Developer identifier: `pull_requests.base.repo.allow_auto_merge`
Allow Auto Merge records whether auto-merge is allowed. It is needed to distinguish Pull Requests rows by the exact GitHub-returned allow auto merge value.
* **Enables:** select Pull Requests rows where `allow_auto_merge` is true or false when comparing the condition described by Allow Auto Merge.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.allow_forking`
Allow Forking records whether forking is allowed. It is needed to distinguish Pull Requests rows by the exact GitHub-returned allow forking value.
* **Enables:** select Pull Requests rows where `allow_forking` is true or false when comparing the condition described by Allow Forking.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.allow_merge_commit`
Allow Merge Commit records whether merge commits are allowed. It is needed to distinguish Pull Requests rows by the exact GitHub-returned allow merge commit value.
* **Enables:** select Pull Requests rows where `allow_merge_commit` is true or false when comparing the condition described by Allow Merge Commit.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.allow_rebase_merge`
Allow Rebase Merge records whether rebase merging is allowed. It is needed to distinguish Pull Requests rows by the exact GitHub-returned allow rebase merge value.
* **Enables:** select Pull Requests rows where `allow_rebase_merge` is true or false when comparing the condition described by Allow Rebase Merge.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.allow_squash_merge`
Allow Squash Merge records whether squash merging is allowed. It is needed to distinguish Pull Requests rows by the exact GitHub-returned allow squash merge value.
* **Enables:** select Pull Requests rows where `allow_squash_merge` is true or false when comparing the condition described by Allow Squash Merge.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.archive_url`
Archive URL records URL template for downloading repository archives. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `archive_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.archived`
Archived records whether the repository is archived. It is needed to distinguish Pull Requests rows by the exact GitHub-returned archived value.
* **Enables:** select Pull Requests rows where `archived` is true or false when comparing the condition described by Archived.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.assignees_url`
Assignees URL records URL template for repository assignees. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `assignees_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.blobs_url`
Blobs URL records URL template for repository blobs. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `blobs_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.branches_url`
Branches URL records URL template for repository branches. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `branches_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.clone_url`
Clone URL records HTTPS clone URL for the repository. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `clone_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.collaborators_url`
Collaborators URL records URL template for repository collaborators. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `collaborators_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.comments_url`
Comments URL records URL template for repository comments. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `comments_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.commits_url`
Commits URL records URL template for repository commits. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `commits_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.compare_url`
Compare URL records URL template for comparing commits. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `compare_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.contents_url`
Contents URL records URL template for repository contents. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `contents_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.contributors_url`
Contributors URL records REST API URL for repository contributors. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `contributors_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.created_at`
Created At records timestamp when the repository was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pull Requests records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pull_requests.base.repo.default_branch`
Default Branch records name of the default branch. It is needed to distinguish Pull Requests rows by the exact GitHub-returned default branch value.
* **Enables:** separate Pull Requests rows by the exact GitHub-returned `default_branch` label when comparing default branch.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.delete_branch_on_merge`
Delete Branch On Merge records whether branches are deleted on merge. It is needed to distinguish Pull Requests rows by the exact GitHub-returned delete branch on merge value.
* **Enables:** select Pull Requests rows where `delete_branch_on_merge` is true or false when comparing the condition described by Delete Branch On Merge.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.deployments_url`
Deployments URL records REST API URL for repository deployments. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `deployments_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.description`
Description records description of the repository. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is description text at one GitHub Repository record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `pull_requests.base.repo.disabled`
Disabled records whether the repository is disabled. It is needed to distinguish Pull Requests rows by the exact GitHub-returned disabled value.
* **Enables:** select Pull Requests rows where `disabled` is true or false when comparing the condition described by Disabled.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.downloads_url`
Downloads URL records REST API URL for repository downloads. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `downloads_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.events_url`
Events URL records REST API URL for repository events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.fork`
Fork records whether the repository is a fork. It is needed to distinguish Pull Requests rows by the exact GitHub-returned fork value.
* **Enables:** select Pull Requests rows where `fork` is true or false when comparing the condition described by Fork.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.forks_count`
Forks Count records number of forks. It is needed to measure the GitHub-reported number of forks at one GitHub Repository record per row.
* **Enables:** measure and compare the GitHub-reported number of forks in `forks_count` at one GitHub Repository record per row.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is a GitHub-reported count at one GitHub Repository record per row.
Developer identifier: `pull_requests.base.repo.forks_url`
Forks URL records REST API URL for repository forks. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `forks_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.full_name`
Full Name records full name of the repository in owner/repo format. It is needed to compare the returned full name for individual Pull Requests rows and select rows with a specific `full_name` value.
* **Enables:** locate Pull Requests rows whose returned full name exactly matches `full_name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row.
Developer identifier: `pull_requests.base.repo.git_commits_url`
Git Commits URL records URL template for git commits. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `git_commits_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.git_refs_url`
Git Refs URL records URL template for git references. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `git_refs_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.git_tags_url`
Git Tags URL records URL template for git tags. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `git_tags_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.git_url`
Git URL records git protocol URL for the repository. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `git_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.has_discussions`
Has Discussions records whether discussions are enabled. It is needed to distinguish Pull Requests rows by the exact GitHub-returned has discussions value.
* **Enables:** select Pull Requests rows where `has_discussions` is true or false when comparing the condition described by Has Discussions.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.has_downloads`
Has Downloads records whether downloads are enabled. It is needed to distinguish Pull Requests rows by the exact GitHub-returned has downloads value.
* **Enables:** select Pull Requests rows where `has_downloads` is true or false when comparing the condition described by Has Downloads.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.has_issues`
Has Issues records whether issues are enabled. It is needed to distinguish Pull Requests rows by the exact GitHub-returned has issues value.
* **Enables:** select Pull Requests rows where `has_issues` is true or false when comparing the condition described by Has Issues.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.has_pages`
Has Pages records whether GitHub Pages is enabled. It is needed to distinguish Pull Requests rows by the exact GitHub-returned has pages value.
* **Enables:** select Pull Requests rows where `has_pages` is true or false when comparing the condition described by Has Pages.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.has_projects`
Has Projects records whether projects are enabled. It is needed to distinguish Pull Requests rows by the exact GitHub-returned has projects value.
* **Enables:** select Pull Requests rows where `has_projects` is true or false when comparing the condition described by Has Projects.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.has_wiki`
Has Wiki records whether the wiki is enabled. It is needed to distinguish Pull Requests rows by the exact GitHub-returned has wiki value.
* **Enables:** select Pull Requests rows where `has_wiki` is true or false when comparing the condition described by Has Wiki.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.homepage`
Homepage records homepage URL for the repository. It is needed to retain the exact GitHub resource or external link reported for this Pull Requests record.
* **Enables:** open or correlate the resource named by `homepage` while retaining the containing Github Repository row as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.hooks_url`
Hooks URL records REST API URL for repository webhooks. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `hooks_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.html_url`
HTML URL records web URL for viewing this repository. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.id`
ID records unique numeric identifier for the repository. It is needed to refer to the same repository across records without relying on display text.
* **Enables:** match `id` to repository references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.base.repo.is_template`
Is Template records whether the repository is a template. It is needed to distinguish Pull Requests rows by the exact GitHub-returned is template value.
* **Enables:** select Pull Requests rows where `is_template` is true or false when comparing the condition described by Is Template.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.issue_comment_url`
Issue Comment URL records URL template for issue comments. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `issue_comment_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.issue_events_url`
Issue Events URL records URL template for issue events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `issue_events_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.issues_url`
Issues URL records URL template for repository issues. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `issues_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.keys_url`
Keys URL records URL template for repository deploy keys. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `keys_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.labels_url`
Labels URL records URL template for repository labels. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `labels_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.language`
Language records primary programming language of the repository. It is needed to inventory the exact GitHub-reported configuration or classification represented by this field.
* **Enables:** compare `language` among Pull Requests records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; the value is a GitHub-returned or configured label at the Github Repository grain rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.languages_url`
Languages URL records REST API URL for repository languages. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `languages_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.license`
License records license information for the repository. It is needed to preserve the nested license relationship or details on the parent GitHub Repository record.
* **Enables:** expand `license` to connect the containing GitHub Repository row to its returned license entries.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is one nested object per containing GitHub Repository object when present.
Developer identifier: `pull_requests.base.repo.license.key`
Key records SPDX short identifier for the license. It is needed to refer to the same license across records without relying on display text.
* **Enables:** match `key` to license references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub License object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.base.repo.license.name`
Name records full name of the license. It is needed to compare the exact name configuration returned for this GitHub License record.
* **Enables:** compare the exact `name` configuration returned for each GitHub License record and select records with the configuration under review.
* **Interpretation:** GitHub reports this value on the GitHub License object returned for Pull Requests; it is interpreted at one GitHub License record per row.
Developer identifier: `pull_requests.base.repo.license.node_id`
Node ID records global node ID for the GraphQL API. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub License object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.base.repo.license.spdx_id`
Spdx ID records SPDX identifier. It is needed to refer to the same spdx across records without relying on display text.
* **Enables:** match `spdx_id` to spdx references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub License object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.base.repo.license.url`
URL records URL to the license definition. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub License object returned for Pull Requests; it is link at one GitHub License record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.merges_url`
Merges URL records REST API URL for repository merges. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `merges_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.milestones_url`
Milestones URL records URL template for repository milestones. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `milestones_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.mirror_url`
Mirror URL records mirror URL if the repository is a mirror. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `mirror_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.name`
Name records short name of the repository. It is needed to compare the returned name for individual Pull Requests rows and select rows with a specific `name` value.
* **Enables:** locate Pull Requests rows whose returned name exactly matches `name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row.
Developer identifier: `pull_requests.base.repo.node_id`
Node ID records global node ID for the GraphQL API. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.base.repo.notifications_url`
Notifications URL records URL template for repository notifications. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `notifications_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.open_issues_count`
Open Issues Count records number of open issues. It is needed to measure the GitHub-reported number of open issues at one GitHub Repository record per row.
* **Enables:** measure and compare the GitHub-reported number of open issues in `open_issues_count` at one GitHub Repository record per row.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is a GitHub-reported count at one GitHub Repository record per row.
Developer identifier: `pull_requests.base.repo.owner`
Owner records owner of the repository. It is needed to preserve the nested owner relationship or details on the parent GitHub Repository record.
* **Enables:** expand `owner` to connect the containing GitHub Repository row to its returned owner entries.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is one nested object per containing GitHub Repository object when present.
Developer identifier: `pull_requests.base.repo.private`
Private records whether the repository is private. It is needed to distinguish Pull Requests rows by the exact GitHub-returned private value.
* **Enables:** select Pull Requests rows where `private` is true or false when comparing the condition described by Private.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.pulls_url`
Pulls URL records URL template for repository pull requests. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `pulls_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.pushed_at`
Pushed At records timestamp of the last push. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pull Requests records by `pushed_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pull_requests.base.repo.releases_url`
Releases URL records URL template for repository releases. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `releases_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.size`
Size records size of the repository in kilobytes. It is needed to compare the numeric size reported for one GitHub Repository record without assuming an unstated unit.
* **Enables:** compare the numeric `size` value per GitHub Repository record without assigning a unit not declared by the schema description.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row.
Developer identifier: `pull_requests.base.repo.ssh_url`
SSH URL records SSH URL for the repository. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `ssh_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.stargazers_count`
Stargazers Count records number of stargazers. It is needed to measure the GitHub-reported number of stargazers at one GitHub Repository record per row.
* **Enables:** measure and compare the GitHub-reported number of stargazers in `stargazers_count` at one GitHub Repository record per row.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is a GitHub-reported count at one GitHub Repository record per row.
Developer identifier: `pull_requests.base.repo.stargazers_url`
Stargazers URL records REST API URL for repository stargazers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `stargazers_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.statuses_url`
Statuses URL records URL template for commit statuses. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `statuses_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.subscribers_url`
Subscribers URL records REST API URL for repository subscribers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscribers_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.subscription_url`
Subscription URL records REST API URL for the authenticated user's subscription. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscription_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.svn_url`
Svn URL records SVN URL for the repository. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `svn_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.tags_url`
Tags URL records REST API URL for repository tags. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `tags_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.teams_url`
Teams URL records REST API URL for repository teams. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `teams_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.topics`
Topics records topics associated with the repository. It is needed to preserve the nested topics relationship or details on the parent GitHub Repository record.
* **Enables:** expand `topics` to connect the containing GitHub Repository row to its returned topics entries.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is one returned collection per containing GitHub Repository object.
Developer identifier: `pull_requests.base.repo.trees_url`
Trees URL records URL template for repository trees. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `trees_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.updated_at`
Updated At records timestamp when the repository was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pull Requests records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pull_requests.base.repo.url`
URL records REST API URL for this repository. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.base.repo.visibility`
Visibility records visibility of the repository (public, private, internal). It is needed to inventory the exact GitHub-reported configuration or classification represented by this field.
* **Enables:** compare `visibility` among Pull Requests records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; the value is a GitHub-returned or configured label at the Github Repository grain rather than a universal taxonomy.
Developer identifier: `pull_requests.base.repo.watchers_count`
Watchers Count records number of watchers. It is needed to measure the GitHub-reported number of watchers at one GitHub Repository record per row.
* **Enables:** measure and compare the GitHub-reported number of watchers in `watchers_count` at one GitHub Repository record per row.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is a GitHub-reported count at one GitHub Repository record per row.
Developer identifier: `pull_requests.base.repo.web_commit_signoff_required`
Web Commit Signoff Required records whether web commit sign-off is required. It is needed to distinguish Pull Requests rows by the exact GitHub-returned web commit signoff required value.
* **Enables:** select Pull Requests rows where `web_commit_signoff_required` is true or false when comparing the condition described by Web Commit Signoff Required.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Pull Requests; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.base.sha`
Sha records SHA of the commit at the tip of the branch. It is needed to refer to the same branch ref across records without relying on display text.
* **Enables:** match `sha` to branch ref references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Branch Ref object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.base.user`
User records owner of the repository containing this branch. It is needed to preserve the nested user relationship or details on the parent GitHub Branch Ref record.
* **Enables:** expand `user` to connect the containing GitHub Branch Ref row to its returned user entries.
* **Interpretation:** GitHub reports this value on the GitHub Branch Ref object returned for Pull Requests; it is one nested object per containing GitHub Branch Ref object when present.
Developer identifier: `pull_requests.body`
Body records body text of the pull request in Markdown. It is needed to inspect the exact Markdown body included with this record.
* **Enables:** inspect the Markdown body returned in `body` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is Markdown body at one GitHub Pull Request record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `pull_requests.closed_at`
Closed At records timestamp when the pull request was closed. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pull Requests records by `closed_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is interpreted at one GitHub Pull Request record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pull_requests.comments_url`
Comments URL records REST API URL for issue-style comments on this pull request. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `comments_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is link at one GitHub Pull Request record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.commits_url`
Commits URL records REST API URL for the commits in this pull request. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `commits_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is link at one GitHub Pull Request record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.created_at`
Created At records timestamp when the pull request was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pull Requests records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is interpreted at one GitHub Pull Request record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pull_requests.diff_url`
Diff URL records URL to the diff of this pull request. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `diff_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is link at one GitHub Pull Request record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.draft`
Draft records whether the pull request is a draft. It is needed to distinguish Pull Requests rows by the exact GitHub-returned draft value.
* **Enables:** select Pull Requests rows where `draft` is true or false when comparing the condition described by Draft.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is interpreted at one GitHub Pull Request record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.full_name`
Full Name records owner-qualified repository identifier (e.g. 'owner/repo'). Injected from the parent repository context via parentContextFields; not present in the raw GitHub Pull Requests API response. It is needed to refer to the same full name across records without relying on display text.
* **Enables:** match `full_name` to full name references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub's child response does not supply this field; the connector injects parent context into each child row; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.head`
Head records the source (head) branch reference for the pull request. It is needed to preserve the nested head relationship or details on the parent GitHub Pull Request record.
* **Enables:** expand `head` to connect the containing GitHub Pull Request row to its returned head entries.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is one nested object per containing GitHub Pull Request object when present.
Developer identifier: `pull_requests.html_url`
HTML URL records web URL for viewing this pull request in a browser. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is link at one GitHub Pull Request record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.id`
ID records unique numeric identifier for the pull request. It is needed to distinguish repeated deliveries of the same Pull Requests row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Pull Requests and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `pull_requests.issue_url`
Issue URL records REST API URL for the associated issue. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `issue_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is link at one GitHub Pull Request record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.labels`
Labels records labels applied to the pull request. It is needed to preserve the nested labels relationship or details on the parent GitHub Pull Request record.
* **Enables:** expand `labels` to connect the containing GitHub Pull Request row to its returned labels entries.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is one returned collection per containing GitHub Pull Request object.
Developer identifier: `pull_requests.labels.color`
Color records hex color code for the label (without #). It is needed to inventory the exact GitHub-reported configuration or classification represented by this field.
* **Enables:** compare `color` among Pull Requests records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitHub reports this value on the GitHub Label object returned for Pull Requests; it is interpreted at one GitHub Label record per row; the value is a GitHub-returned or configured label at the Github Label grain rather than a universal taxonomy.
Developer identifier: `pull_requests.labels.default`
Default records whether this is a default label. It is needed to distinguish Pull Requests rows by the exact GitHub-returned default value.
* **Enables:** select Pull Requests rows where `default` is true or false when comparing the condition described by Default.
* **Interpretation:** GitHub reports this value on the GitHub Label object returned for Pull Requests; it is interpreted at one GitHub Label record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.labels.description`
Description records description of the label. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Label object returned for Pull Requests; it is description text at one GitHub Label record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `pull_requests.labels.id`
ID records unique numeric identifier for the label. It is needed to distinguish repeated deliveries of the same Pull Requests row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Pull Requests and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub Label object returned for Pull Requests; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `pull_requests.labels.name`
Name records display name of the label. It is needed to compare the returned name for individual Pull Requests rows and select rows with a specific `name` value.
* **Enables:** locate Pull Requests rows whose returned name exactly matches `name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Label object returned for Pull Requests; it is interpreted at one GitHub Label record per row.
Developer identifier: `pull_requests.labels.node_id`
Node ID records global node ID for the GraphQL API. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Label object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.labels.url`
URL records REST API URL for this label. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Label object returned for Pull Requests; it is link at one GitHub Label record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.locked`
Locked records whether the pull request conversation is locked. It is needed to distinguish Pull Requests rows by the exact GitHub-returned locked value.
* **Enables:** select Pull Requests rows where `locked` is true or false when comparing the condition described by Locked.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is interpreted at one GitHub Pull Request record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.merge_commit_sha`
Merge Commit Sha records SHA of the merge commit if the PR was merged. It is needed to refer to the same merge commit across records without relying on display text.
* **Enables:** match `merge_commit_sha` to merge commit references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.merged_at`
Merged At records timestamp when the pull request was merged. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pull Requests records by `merged_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is interpreted at one GitHub Pull Request record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pull_requests.milestone`
Milestone records the milestone associated with the pull request. It is needed to preserve the nested milestone relationship or details on the parent GitHub Pull Request record.
* **Enables:** expand `milestone` to connect the containing GitHub Pull Request row to its returned milestone entries.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is one nested object per containing GitHub Pull Request object when present.
Developer identifier: `pull_requests.milestone.closed_at`
Closed At records timestamp when the milestone was closed. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pull Requests records by `closed_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is interpreted at one GitHub Milestone record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pull_requests.milestone.closed_issues`
Closed Issues records number of closed issues in this milestone. It is needed to measure the GitHub-reported number of closed issues in this milestone at one GitHub Milestone record per row.
* **Enables:** measure and compare the GitHub-reported number of closed issues in this milestone in `closed_issues` at one GitHub Milestone record per row.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is a GitHub-reported count at one GitHub Milestone record per row.
Developer identifier: `pull_requests.milestone.created_at`
Created At records timestamp when the milestone was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pull Requests records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is interpreted at one GitHub Milestone record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pull_requests.milestone.creator`
Creator records the user who created the milestone. It is needed to preserve the nested creator relationship or details on the parent GitHub Milestone record.
* **Enables:** expand `creator` to connect the containing GitHub Milestone row to its returned creator entries.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is one nested object per containing GitHub Milestone object when present.
Developer identifier: `pull_requests.milestone.description`
Description records description of the milestone. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is description text at one GitHub Milestone record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `pull_requests.milestone.due_on`
Due On records due date for the milestone. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pull Requests records by `due_on`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is interpreted at one GitHub Milestone record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pull_requests.milestone.html_url`
HTML URL records web URL for viewing this milestone. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is link at one GitHub Milestone record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.milestone.id`
ID records unique numeric identifier for the milestone. It is needed to refer to the same milestone across records without relying on display text.
* **Enables:** match `id` to milestone references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.milestone.labels_url`
Labels URL records REST API URL for labels in this milestone. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `labels_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is link at one GitHub Milestone record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.milestone.node_id`
Node ID records global node ID for the GraphQL API. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.milestone.number`
Number records milestone number within the repository. It is needed to refer to the same pull requests across records without relying on display text.
* **Enables:** match `number` to pull requests references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.milestone.open_issues`
Open Issues records number of open issues in this milestone. It is needed to measure the GitHub-reported number of open issues in this milestone at one GitHub Milestone record per row.
* **Enables:** measure and compare the GitHub-reported number of open issues in this milestone in `open_issues` at one GitHub Milestone record per row.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is a GitHub-reported count at one GitHub Milestone record per row.
Developer identifier: `pull_requests.milestone.state`
State records state of the milestone (open or closed). It is needed to distinguish Pull Requests rows by the exact GitHub-returned state value.
* **Enables:** separate Pull Requests rows by the exact GitHub-returned `state` label when comparing state.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is interpreted at one GitHub Milestone record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.milestone.title`
Title records title of the milestone. It is needed to inspect the exact title text included with this record.
* **Enables:** inspect the title text returned in `title` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is title text at one GitHub Milestone record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `pull_requests.milestone.updated_at`
Updated At records timestamp when the milestone was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pull Requests records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is interpreted at one GitHub Milestone record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pull_requests.milestone.url`
URL records REST API URL for this milestone. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Milestone object returned for Pull Requests; it is link at one GitHub Milestone record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.node_id`
Node ID records global node ID for the GraphQL API. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.number`
Number records pull request number within the repository. It is needed to refer to the same pull requests across records without relying on display text.
* **Enables:** match `number` to pull requests references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.patch_url`
Patch URL records URL to the patch of this pull request. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `patch_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is link at one GitHub Pull Request record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.requested_reviewers`
Requested Reviewers records users requested to review the pull request. It is needed to preserve the nested requested reviewers relationship or details on the parent GitHub Pull Request record.
* **Enables:** expand `requested_reviewers` to connect the containing GitHub Pull Request row to its returned requested reviewers entries.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is one returned collection per containing GitHub Pull Request object.
Developer identifier: `pull_requests.requested_teams`
Requested Teams records teams requested to review the pull request. It is needed to preserve the nested requested teams relationship or details on the parent GitHub Pull Request record.
* **Enables:** expand `requested_teams` to connect the containing GitHub Pull Request row to its returned requested teams entries.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is one returned collection per containing GitHub Pull Request object.
Developer identifier: `pull_requests.requested_teams.description`
Description records description of the team. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Pull Requests; it is description text at one GitHub Team record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `pull_requests.requested_teams.html_url`
HTML URL records web URL for viewing this team. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Pull Requests; it is link at one GitHub Team record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.requested_teams.id`
ID records unique numeric identifier for the team. It is needed to distinguish repeated deliveries of the same Pull Requests row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Pull Requests and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Pull Requests; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `pull_requests.requested_teams.members_url`
Members URL records URL template for team members. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `members_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Pull Requests; it is link at one GitHub Team record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.requested_teams.name`
Name records display name of the team. It is needed to compare the returned name for individual Pull Requests rows and select rows with a specific `name` value.
* **Enables:** locate Pull Requests rows whose returned name exactly matches `name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Pull Requests; it is interpreted at one GitHub Team record per row.
Developer identifier: `pull_requests.requested_teams.node_id`
Node ID records global node ID for the GraphQL API. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Pull Requests; it is an identifier, not a measured quantity.
Developer identifier: `pull_requests.requested_teams.notification_setting`
Notification Setting records notification setting for the team. It is needed to compare the exact notification setting configuration returned for this GitHub Team record.
* **Enables:** compare the exact `notification_setting` configuration returned for each GitHub Team record and select records with the configuration under review.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Pull Requests; it is interpreted at one GitHub Team record per row.
Developer identifier: `pull_requests.requested_teams.permission`
Permission records default permission level for the team. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `permission` access value with the resource, account, or membership represented by the same Pull Requests row.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Pull Requests; it is interpreted at one GitHub Team record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `pull_requests.requested_teams.privacy`
Privacy records privacy level of the team (secret or closed). It is needed to inventory the exact GitHub-reported configuration or classification represented by this field.
* **Enables:** compare `privacy` among Pull Requests records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Pull Requests; it is interpreted at one GitHub Team record per row; the value is a GitHub-returned or configured label at the Github Team grain rather than a universal taxonomy.
Developer identifier: `pull_requests.requested_teams.repositories_url`
Repositories URL records REST API URL for the team's repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repositories_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Pull Requests; it is link at one GitHub Team record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.requested_teams.slug`
Slug records URL-friendly slug of the team. It is needed to compare the returned slug for individual Pull Requests rows and select rows with a specific `slug` value.
* **Enables:** locate Pull Requests rows whose returned slug exactly matches `slug` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Pull Requests; it is interpreted at one GitHub Team record per row; the schema uses the `Identity.Slug` scalar.
Developer identifier: `pull_requests.requested_teams.url`
URL records REST API URL for this team. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Pull Requests; it is link at one GitHub Team record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.review_comment_url`
Review Comment URL records URL template for individual review comments. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `review_comment_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is link at one GitHub Pull Request record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.review_comments_url`
Review Comments URL records REST API URL for review comments on this pull request. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `review_comments_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is link at one GitHub Pull Request record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.state`
State records current state of the pull request (open or closed). It is needed to distinguish Pull Requests rows by the exact GitHub-returned state value.
* **Enables:** separate Pull Requests rows by the exact GitHub-returned `state` label when comparing state.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is interpreted at one GitHub Pull Request record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `pull_requests.statuses_url`
Statuses URL records REST API URL for commit statuses of the head SHA. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `statuses_url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is link at one GitHub Pull Request record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.title`
Title records title of the pull request. It is needed to inspect the exact title text included with this record.
* **Enables:** inspect the title text returned in `title` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is title text at one GitHub Pull Request record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `pull_requests.updated_at`
Updated At records timestamp when the pull request was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pull Requests records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is interpreted at one GitHub Pull Request record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pull_requests.url`
URL records REST API URL for this pull request. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Pull Requests record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is link at one GitHub Pull Request record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pull_requests.user`
User records the user who opened the pull request. It is needed to preserve the nested user relationship or details on the parent GitHub Pull Request record.
* **Enables:** expand `user` to connect the containing GitHub Pull Request row to its returned user entries.
* **Interpretation:** GitHub reports this value on the GitHub Pull Request object returned for Pull Requests; it is one nested object per containing GitHub Pull Request object when present.
Developer identifier: `releases`
Releases covers repository releases.
* **Enables:** inventory returned releases and connect each tag to its target revision, author, publication time, notes, and assets.
* **Scope:** Repository releases; the connector reads `/repos/{full_name}/releases` as a snapshot stream in incremental mode. The configured credential must grant the declared `repo` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitHub record was deleted.
Developer identifier: `releases.assets`
Assets records list of assets attached to this release. It is needed to preserve the nested assets relationship or details on the parent GitHub Release record.
* **Enables:** expand `assets` to connect the containing GitHub Release row to its returned assets entries.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is one returned collection per containing GitHub Release object.
Developer identifier: `releases.assets.browser_download_url`
Browser Download URL records URL to download the asset via a browser. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `browser_download_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Release Asset object returned for Releases; it is link at one GitHub Release Asset record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.assets.content_type`
Content Type records MIME content type of the asset. It is needed to distinguish Releases rows by the exact GitHub-returned content type value.
* **Enables:** separate Releases rows by the exact GitHub-returned `content_type` label when comparing content type.
* **Interpretation:** GitHub reports this value on the GitHub Release Asset object returned for Releases; it is interpreted at one GitHub Release Asset record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `releases.assets.created_at`
Created At records ISO 8601 timestamp when the asset was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Releases records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Release Asset object returned for Releases; it is interpreted at one GitHub Release Asset record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `releases.assets.download_count`
Download Count records number of times the asset has been downloaded. It is needed to measure the GitHub-reported number of times the asset has been downloaded at one GitHub Release Asset record per row.
* **Enables:** measure and compare the GitHub-reported number of times the asset has been downloaded in `download_count` at one GitHub Release Asset record per row.
* **Interpretation:** GitHub reports this value on the GitHub Release Asset object returned for Releases; it is a GitHub-reported count at one GitHub Release Asset record per row.
Developer identifier: `releases.assets.id`
ID records unique numeric identifier for the asset. It is needed to distinguish repeated deliveries of the same Releases row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Releases and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub Release Asset object returned for Releases; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `releases.assets.label`
Label records short description or label for the asset. It is needed to compare the returned label for individual Releases rows and select rows with a specific `label` value.
* **Enables:** locate Releases rows whose returned label exactly matches `label` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Release Asset object returned for Releases; it is interpreted at one GitHub Release Asset record per row.
Developer identifier: `releases.assets.name`
Name records the file name of the asset. It is needed to compare the returned name for individual Releases rows and select rows with a specific `name` value.
* **Enables:** locate Releases rows whose returned name exactly matches `name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Release Asset object returned for Releases; it is interpreted at one GitHub Release Asset record per row.
Developer identifier: `releases.assets.node_id`
Node ID records global relay ID for the asset. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Release Asset object returned for Releases; it is an identifier, not a measured quantity.
Developer identifier: `releases.assets.size`
Size records size of the asset in bytes. It is needed to measure the reported size for one github release asset record.
* **Enables:** measure and compare `size` per GitHub Release Asset record in bytes.
* **Interpretation:** GitHub reports this value on the GitHub Release Asset object returned for Releases; its unit or granularity is bytes.
Developer identifier: `releases.assets.state`
State records state of the asset (e.g., uploaded, open). It is needed to distinguish Releases rows by the exact GitHub-returned state value.
* **Enables:** separate Releases rows by the exact GitHub-returned `state` label when comparing state.
* **Interpretation:** GitHub reports this value on the GitHub Release Asset object returned for Releases; it is interpreted at one GitHub Release Asset record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `releases.assets.updated_at`
Updated At records ISO 8601 timestamp when the asset was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Releases records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Release Asset object returned for Releases; it is interpreted at one GitHub Release Asset record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `releases.assets.uploader`
Uploader records the user who uploaded the asset. It is needed to preserve the nested uploader relationship or details on the parent GitHub Release Asset record.
* **Enables:** expand `uploader` to connect the containing GitHub Release Asset row to its returned uploader entries.
* **Interpretation:** GitHub reports this value on the GitHub Release Asset object returned for Releases; it is one nested object per containing GitHub Release Asset object when present.
Developer identifier: `releases.assets.uploader.avatar_url`
Avatar URL records URL of the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `avatar_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.assets.uploader.events_url`
Events URL records API URL template for the user's events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.assets.uploader.followers_url`
Followers URL records API URL for the user's followers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `followers_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.assets.uploader.following_url`
Following URL records API URL template for users this user follows. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `following_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.assets.uploader.gists_url`
Gists URL records API URL template for the user's gists. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `gists_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.assets.uploader.gravatar_id`
Gravatar ID records gravatar ID of the user, if applicable. It is needed to refer to the same gravatar across records without relying on display text.
* **Enables:** match `gravatar_id` to gravatar references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is an identifier, not a measured quantity.
Developer identifier: `releases.assets.uploader.html_url`
HTML URL records HTML URL for the user's GitHub profile. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.assets.uploader.id`
ID records unique numeric identifier for the user. It is needed to refer to the same user across records without relying on display text.
* **Enables:** match `id` to user references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is an identifier, not a measured quantity.
Developer identifier: `releases.assets.uploader.login`
Login records the username of the user. It is needed to attribute this Releases row to the returned person, account, or organization reference.
* **Enables:** attribute the Releases row to the returned person or account and match the exact `login` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is interpreted at one GitHub User record per row.
Developer identifier: `releases.assets.uploader.node_id`
Node ID records global relay ID for the user. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is an identifier, not a measured quantity.
Developer identifier: `releases.assets.uploader.organizations_url`
Organizations URL records API URL for the user's organizations. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `organizations_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.assets.uploader.received_events_url`
Received Events URL records API URL for events received by the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `received_events_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.assets.uploader.repos_url`
Repos URL records API URL for the user's repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repos_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.assets.uploader.site_admin`
Site Admin records whether the user is a GitHub site administrator. It is needed to distinguish Releases rows by the exact GitHub-returned site admin value.
* **Enables:** select Releases rows where `site_admin` is true or false when comparing the condition described by Site Admin.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `releases.assets.uploader.starred_url`
Starred URL records API URL template for the user's starred repos. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `starred_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is link at one GitHub User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.assets.uploader.subscriptions_url`
Subscriptions URL records API URL for the user's subscriptions. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscriptions_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.assets.uploader.type`
Type records type of the account (e.g., User, Organization, Bot). It is needed to distinguish Releases rows by the exact GitHub-returned type value.
* **Enables:** separate Releases rows by the exact GitHub-returned `type` label when comparing type.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `releases.assets.uploader.url`
URL records API URL for this user resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is link at one GitHub User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.assets.uploader.user_view_type`
User View Type records the view type of the user. It is needed to distinguish Releases rows by the exact GitHub-returned user view type value.
* **Enables:** separate Releases rows by the exact GitHub-returned `user_view_type` label when comparing user view type.
* **Interpretation:** GitHub reports this value on the GitHub User object returned for Releases; it is interpreted at one GitHub User record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `releases.assets.url`
URL records API URL for this asset resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Release Asset object returned for Releases; it is link at one GitHub Release Asset record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.assets_url`
Assets URL records API URL for listing the release assets. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `assets_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is link at one GitHub Release record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.author`
Author records the user who created the release. It is needed to preserve the nested author relationship or details on the parent GitHub Release record.
* **Enables:** expand `author` to connect the containing GitHub Release row to its returned author entries.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is one nested object per containing GitHub Release object when present.
Developer identifier: `releases.body`
Body records release notes in Markdown. It is needed to inspect the exact Markdown body included with this record.
* **Enables:** inspect the Markdown body returned in `body` and attribute it to the same record's repository, tag, author, and publication time where returned.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is Markdown body at one GitHub Release record per row; the schema uses the `Text.Markdown` scalar; this is only the content included in the GitHub response for this record.
Developer identifier: `releases.body_html`
Body HTML records HTML rendered version of the release body, if requested via Accept header. It is needed to inspect the exact HTML body included with this record.
* **Enables:** inspect the HTML body returned in `body_html` and attribute it to the same record's repository, tag, author, and publication time where returned.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is HTML body at one GitHub Release record per row; availability and any truncation follow the limitation stated in the field description.
Developer identifier: `releases.body_text`
Body Text records plain text version of the release body, if requested via Accept header. It is needed to inspect the exact plain-text body included with this record.
* **Enables:** inspect the plain-text body returned in `body_text` and attribute it to the same record's repository, tag, author, and publication time where returned.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is plain-text body at one GitHub Release record per row; availability and any truncation follow the limitation stated in the field description.
Developer identifier: `releases.created_at`
Created At records ISO 8601 timestamp when the release was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Releases records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is interpreted at one GitHub Release record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `releases.discussion_url`
Discussion URL records URL of the linked discussion for this release, if a discussion was created. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `discussion_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is link at one GitHub Release record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.draft`
Draft records whether this is a draft (unpublished) release. It is needed to distinguish Releases rows by the exact GitHub-returned draft value.
* **Enables:** select Releases rows where `draft` is true or false when comparing the condition described by Draft.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is interpreted at one GitHub Release record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `releases.html_url`
HTML URL records HTML URL for viewing the release on GitHub. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is link at one GitHub Release record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.id`
ID records unique numeric identifier for the release. It is needed to distinguish repeated deliveries of the same Releases row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Releases and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `releases.make_latest`
Make Latest specifies whether this release was marked as the latest. It is needed to inventory the exact GitHub-reported configuration or classification represented by this field.
* **Enables:** compare `make_latest` among Releases records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is interpreted at one GitHub Release record per row; the value is a GitHub-returned or configured label at the Github Release grain rather than a universal taxonomy.
Developer identifier: `releases.mentions_count`
Mentions Count records number of @mentions in the release body. It is needed to measure the GitHub-reported number of @mentions in the release body at one GitHub Release record per row.
* **Enables:** measure and compare the GitHub-reported number of @mentions in the release body in `mentions_count` at one GitHub Release record per row.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is a GitHub-reported count at one GitHub Release record per row.
Developer identifier: `releases.name`
Name records release title. It is needed to compare the returned name for individual Releases rows and select rows with a specific `name` value.
* **Enables:** locate Releases rows whose returned name exactly matches `name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is interpreted at one GitHub Release record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `releases.node_id`
Node ID records global relay ID for the release (GraphQL node ID). It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is an identifier, not a measured quantity.
Developer identifier: `releases.prerelease`
Prerelease records whether this is identified as a pre-release. It is needed to distinguish Releases rows by the exact GitHub-returned prerelease value.
* **Enables:** select Releases rows where `prerelease` is true or false when comparing the condition described by Prerelease.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is interpreted at one GitHub Release record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `releases.published_at`
Published At records ISO 8601 timestamp when the release was published. Null for draft releases. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Releases records by `published_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is interpreted at one GitHub Release record per row; the connector also declares it for record ordering; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `releases.reactions`
Reactions records reaction rollup counts for the release. It is needed to preserve the nested reactions relationship or details on the parent GitHub Release record.
* **Enables:** expand `reactions` to connect the containing GitHub Release row to its returned reactions entries.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is one nested object per containing GitHub Release object when present.
Developer identifier: `releases.reactions.+1`
+1 records number of +1 reactions. It is needed to measure the GitHub-reported number of +1 reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of +1 reactions in `+1` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Releases; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `releases.reactions.-1`
Minus One records number of -1 reactions. It is needed to measure the GitHub-reported number of -1 reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of -1 reactions in `-1` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Releases; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `releases.reactions.confused`
Confused records number of confused reactions. It is needed to measure the GitHub-reported number of confused reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of confused reactions in `confused` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Releases; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `releases.reactions.eyes`
Eyes records number of eyes reactions. It is needed to measure the GitHub-reported number of eyes reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of eyes reactions in `eyes` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Releases; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `releases.reactions.heart`
Heart records number of heart reactions. It is needed to measure the GitHub-reported number of heart reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of heart reactions in `heart` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Releases; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `releases.reactions.hooray`
Hooray records number of hooray reactions. It is needed to measure the GitHub-reported number of hooray reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of hooray reactions in `hooray` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Releases; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `releases.reactions.laugh`
Laugh records number of laugh reactions. It is needed to measure the GitHub-reported number of laugh reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of laugh reactions in `laugh` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Releases; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `releases.reactions.rocket`
Rocket records number of rocket reactions. It is needed to measure the GitHub-reported number of rocket reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of rocket reactions in `rocket` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Releases; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `releases.reactions.total_count`
Total Count records total number of reactions. It is needed to measure the GitHub-reported number of reactions at one GitHub Reactions record per row.
* **Enables:** measure and compare the GitHub-reported number of reactions in `total_count` at one GitHub Reactions record per row.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Releases; it is a GitHub-reported count at one GitHub Reactions record per row.
Developer identifier: `releases.reactions.url`
URL records API URL for the reactions resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Reactions object returned for Releases; it is link at one GitHub Reactions record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.tag_name`
Tag Name records git tag associated with the release. It is needed to compare the returned tag name for individual Releases rows and select rows with a specific `tag_name` value.
* **Enables:** locate Releases rows whose returned tag name exactly matches `tag_name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is interpreted at one GitHub Release record per row.
Developer identifier: `releases.tarball_url`
Tarball URL records URL to download the release source as a tarball. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `tarball_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is link at one GitHub Release record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.target_commitish`
Target Commitish records the commitish value (branch or SHA) that determines where the Git tag is created from. It is needed to link the row to the exact GitHub branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `target_commitish` to the returned branch, tag, commit SHA, or work-item reference on related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is interpreted at one GitHub Release record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `releases.updated_at`
Updated At records ISO 8601 timestamp when the release was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Releases records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is interpreted at one GitHub Release record per row; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `releases.upload_url`
Upload URL records hypermedia upload URL template for uploading assets to this release. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `upload_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is link at one GitHub Release record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.url`
URL records API URL for this release resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is link at one GitHub Release record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `releases.zipball_url`
Zipball URL records URL to download the release source as a zipball. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `zipball_url` while retaining the containing Releases record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Release object returned for Releases; it is link at one GitHub Release record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories`
Repositories covers organization repositories.
* **Enables:** inventory returned repositories or project files and correlate each record with its owner, namespace, visibility, default branch, and update time where present.
* **Scope:** Organization repositories; the connector reads `/orgs/{orgId}/repos` as a snapshot stream in incremental mode. The configured credential must grant the declared `repo` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitHub record was deleted.
Developer identifier: `repositories.allow_forking`
Allow Forking records whether forking is allowed. It is needed to distinguish Repositories rows by the exact GitHub-returned allow forking value.
* **Enables:** select Repositories rows where `allow_forking` is true or false when comparing the condition described by Allow Forking.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.archive_url`
Archive URL records URL template for downloading repository archives. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `archive_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.archived`
Archived records whether the repository is archived. It is needed to distinguish Repositories rows by the exact GitHub-returned archived value.
* **Enables:** select Repositories rows where `archived` is true or false when comparing the condition described by Archived.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.assignees_url`
Assignees URL records URL template for listing assignees. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `assignees_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.blobs_url`
Blobs URL records URL template for accessing blobs. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `blobs_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.branches_url`
Branches URL records URL template for listing branches. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `branches_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.clone_url`
Clone URL records HTTPS URL for cloning. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `clone_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.collaborators_url`
Collaborators URL records URL template for listing collaborators. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `collaborators_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.comments_url`
Comments URL records URL template for listing comments. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `comments_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.commits_url`
Commits URL records URL template for listing commits. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `commits_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.compare_url`
Compare URL records URL template for comparing commits. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `compare_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.contents_url`
Contents URL records URL template for accessing contents. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `contents_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.contributors_url`
Contributors URL records REST API URL for listing contributors. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `contributors_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.created_at`
Created At records timestamp when the repository was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Repositories records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `repositories.default_branch`
Default Branch records name of the default branch (e.g. main). It is needed to distinguish Repositories rows by the exact GitHub-returned default branch value.
* **Enables:** separate Repositories rows by the exact GitHub-returned `default_branch` label when comparing default branch.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.deployments_url`
Deployments URL records REST API URL for listing deployments. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `deployments_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.description`
Description records short description of the repository. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, owner, and update time where returned.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is description text at one GitHub Repository record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `repositories.disabled`
Disabled records whether the repository is disabled. It is needed to distinguish Repositories rows by the exact GitHub-returned disabled value.
* **Enables:** select Repositories rows where `disabled` is true or false when comparing the condition described by Disabled.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.downloads_url`
Downloads URL records REST API URL for listing downloads. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `downloads_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.events_url`
Events URL records REST API URL for listing events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.fork`
Fork records whether the repository is a fork. It is needed to distinguish Repositories rows by the exact GitHub-returned fork value.
* **Enables:** select Repositories rows where `fork` is true or false when comparing the condition described by Fork.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.forks`
Forks records number of forks (alias). It is needed to measure the GitHub-reported number of forks (alias) at one GitHub Repository record per row.
* **Enables:** measure and compare the GitHub-reported number of forks (alias) in `forks` at one GitHub Repository record per row.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is a GitHub-reported count at one GitHub Repository record per row.
Developer identifier: `repositories.forks_count`
Forks Count records number of forks. It is needed to measure the GitHub-reported number of forks at one GitHub Repository record per row.
* **Enables:** measure and compare the GitHub-reported number of forks in `forks_count` at one GitHub Repository record per row.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is a GitHub-reported count at one GitHub Repository record per row.
Developer identifier: `repositories.forks_url`
Forks URL records REST API URL for listing forks. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `forks_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.full_name`
Full Name records owner/repo slug (e.g. octocat/Hello-World). It is needed to compare the returned full name for individual Repositories rows and select rows with a specific `full_name` value.
* **Enables:** locate Repositories rows whose returned full name exactly matches `full_name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row.
Developer identifier: `repositories.git_commits_url`
Git Commits URL records URL template for accessing git commits. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `git_commits_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.git_refs_url`
Git Refs URL records URL template for accessing git refs. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `git_refs_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.git_tags_url`
Git Tags URL records URL template for accessing git tags. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `git_tags_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.git_url`
Git URL records git protocol URL for cloning. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `git_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.has_discussions`
Has Discussions records whether discussions are enabled. It is needed to distinguish Repositories rows by the exact GitHub-returned has discussions value.
* **Enables:** select Repositories rows where `has_discussions` is true or false when comparing the condition described by Has Discussions.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.has_downloads`
Has Downloads records whether downloads are enabled. It is needed to distinguish Repositories rows by the exact GitHub-returned has downloads value.
* **Enables:** select Repositories rows where `has_downloads` is true or false when comparing the condition described by Has Downloads.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.has_issues`
Has Issues records whether the issues feature is enabled. It is needed to distinguish Repositories rows by the exact GitHub-returned has issues value.
* **Enables:** select Repositories rows where `has_issues` is true or false when comparing the condition described by Has Issues.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.has_pages`
Has Pages records whether GitHub Pages is enabled. It is needed to distinguish Repositories rows by the exact GitHub-returned has pages value.
* **Enables:** select Repositories rows where `has_pages` is true or false when comparing the condition described by Has Pages.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.has_projects`
Has Projects records whether the projects feature is enabled. It is needed to distinguish Repositories rows by the exact GitHub-returned has projects value.
* **Enables:** select Repositories rows where `has_projects` is true or false when comparing the condition described by Has Projects.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.has_wiki`
Has Wiki records whether the wiki feature is enabled. It is needed to distinguish Repositories rows by the exact GitHub-returned has wiki value.
* **Enables:** select Repositories rows where `has_wiki` is true or false when comparing the condition described by Has Wiki.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.homepage`
Homepage records homepage URL or text set by the repository owner. It is needed to retain the exact GitHub resource or external link reported for this Repositories record.
* **Enables:** open or correlate the resource named by `homepage` while retaining the containing GitHub Repository row as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.hooks_url`
Hooks URL records REST API URL for listing webhooks. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `hooks_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.html_url`
HTML URL records URL of the repository on GitHub. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.id`
ID records unique numeric identifier for the repository. It is needed to distinguish repeated deliveries of the same Repositories row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Repositories and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `repositories.is_template`
Is Template records whether this repository is a template repository. It is needed to distinguish Repositories rows by the exact GitHub-returned is template value.
* **Enables:** select Repositories rows where `is_template` is true or false when comparing the condition described by Is Template.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.issue_comment_url`
Issue Comment URL records URL template for accessing issue comments. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `issue_comment_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.issue_events_url`
Issue Events URL records URL template for accessing issue events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `issue_events_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.issues_url`
Issues URL records URL template for accessing issues. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `issues_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.keys_url`
Keys URL records URL template for accessing deploy keys. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `keys_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.labels_url`
Labels URL records URL template for accessing labels. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `labels_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.language`
Language records primary programming language detected in the repository. It is needed to inventory the exact GitHub-reported configuration or classification represented by this field.
* **Enables:** compare `language` among Repositories records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; the value is a GitHub-returned or configured label at the GitHub Repository grain rather than a universal taxonomy.
Developer identifier: `repositories.languages_url`
Languages URL records REST API URL for listing languages. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `languages_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.license`
License records license information for the repository. It is needed to preserve the nested license relationship or details on the parent GitHub Repository record.
* **Enables:** expand `license` to connect the containing GitHub Repository row to its returned license entries.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is one nested object per containing GitHub Repository object when present.
Developer identifier: `repositories.license.html_url`
HTML URL records URL of the license page on GitHub. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the License Simple object returned for Repositories; it is link at one License Simple record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.license.key`
Key records SPDX license key (e.g. mit, apache-2.0). It is needed to refer to the same license simple across records without relying on display text.
* **Enables:** match `key` to license simple references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the License Simple object returned for Repositories; it is an identifier, not a measured quantity.
Developer identifier: `repositories.license.name`
Name records full name of the license. It is needed to compare the exact name configuration returned for this License Simple record.
* **Enables:** compare the exact `name` configuration returned for each License Simple record and select records with the configuration under review.
* **Interpretation:** GitHub reports this value on the License Simple object returned for Repositories; it is interpreted at one License Simple record per row.
Developer identifier: `repositories.license.node_id`
Node ID records global GraphQL node ID for the license. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the License Simple object returned for Repositories; it is an identifier, not a measured quantity.
Developer identifier: `repositories.license.spdx_id`
Spdx ID records SPDX identifier for the license. It is needed to refer to the same spdx across records without relying on display text.
* **Enables:** match `spdx_id` to spdx references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the License Simple object returned for Repositories; it is an identifier, not a measured quantity.
Developer identifier: `repositories.license.url`
URL records REST API URL for the license details. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the License Simple object returned for Repositories; it is link at one License Simple record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.merges_url`
Merges URL records REST API URL for merges. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `merges_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.milestones_url`
Milestones URL records URL template for accessing milestones. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `milestones_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.mirror_url`
Mirror URL records URL of the upstream mirror, if this repo is a mirror. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `mirror_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.name`
Name records repository name. It is needed to compare the returned name for individual Repositories rows and select rows with a specific `name` value.
* **Enables:** locate Repositories rows whose returned name exactly matches `name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `repositories.network_count`
Network Count records number of repositories in the fork network. It is needed to measure the GitHub-reported number of repositories in the fork network at one GitHub Repository record per row.
* **Enables:** measure and compare the GitHub-reported number of repositories in the fork network in `network_count` at one GitHub Repository record per row.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is a GitHub-reported count at one GitHub Repository record per row.
Developer identifier: `repositories.node_id`
Node ID records global GraphQL node ID. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is an identifier, not a measured quantity.
Developer identifier: `repositories.notifications_url`
Notifications URL records URL template for accessing notifications. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `notifications_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.open_issues`
Open Issues records number of open issues and pull requests (alias). It is needed to measure the GitHub-reported number of open issues and pull requests (alias) at one GitHub Repository record per row.
* **Enables:** measure and compare the GitHub-reported number of open issues and pull requests (alias) in `open_issues` at one GitHub Repository record per row.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is a GitHub-reported count at one GitHub Repository record per row.
Developer identifier: `repositories.open_issues_count`
Open Issues Count records number of open issues and pull requests. It is needed to measure the GitHub-reported number of open issues and pull requests at one GitHub Repository record per row.
* **Enables:** measure and compare the GitHub-reported number of open issues and pull requests in `open_issues_count` at one GitHub Repository record per row.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is a GitHub-reported count at one GitHub Repository record per row.
Developer identifier: `repositories.owner`
Owner records the user or organization that owns the repository. It is needed to preserve the nested owner relationship or details on the parent GitHub Repository record.
* **Enables:** expand `owner` to connect the containing GitHub Repository row to its returned owner entries.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is one nested object per containing GitHub Repository object when present.
Developer identifier: `repositories.owner.avatar_url`
Avatar URL records URL of the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `avatar_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is link at one Repository Owner record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.owner.events_url`
Events URL records URL template for listing events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is link at one Repository Owner record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.owner.followers_url`
Followers URL records REST API URL for listing followers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `followers_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is link at one Repository Owner record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.owner.following_url`
Following URL records URL template for listing users this user follows. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `following_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is link at one Repository Owner record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.owner.gists_url`
Gists URL records URL template for listing gists. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `gists_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is link at one Repository Owner record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.owner.gravatar_id`
Gravatar ID records gravatar ID of the user (may be empty string). It is needed to refer to the same gravatar across records without relying on display text.
* **Enables:** match `gravatar_id` to gravatar references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is an identifier, not a measured quantity.
Developer identifier: `repositories.owner.html_url`
HTML URL records profile URL on GitHub. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is link at one Repository Owner record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.owner.id`
ID records unique numeric identifier for the user. It is needed to refer to the same repository owner across records without relying on display text.
* **Enables:** match `id` to repository owner references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is an identifier, not a measured quantity.
Developer identifier: `repositories.owner.login`
Login records username of the owner. It is needed to attribute this Repositories row to the returned person, account, or organization reference.
* **Enables:** attribute the Repositories row to the returned person or account and match the exact `login` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is interpreted at one Repository Owner record per row.
Developer identifier: `repositories.owner.node_id`
Node ID records global GraphQL node ID for the user. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is an identifier, not a measured quantity.
Developer identifier: `repositories.owner.organizations_url`
Organizations URL records REST API URL for listing organizations. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `organizations_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is link at one Repository Owner record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.owner.received_events_url`
Received Events URL records REST API URL for listing received events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `received_events_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is link at one Repository Owner record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.owner.repos_url`
Repos URL records REST API URL for listing repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repos_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is link at one Repository Owner record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.owner.site_admin`
Site Admin records whether the user is a GitHub site administrator. It is needed to distinguish Repositories rows by the exact GitHub-returned site admin value.
* **Enables:** select Repositories rows where `site_admin` is true or false when comparing the condition described by Site Admin.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is interpreted at one Repository Owner record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.owner.starred_url`
Starred URL records URL template for listing starred repos. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `starred_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is link at one Repository Owner record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.owner.subscriptions_url`
Subscriptions URL records REST API URL for listing subscriptions. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscriptions_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is link at one Repository Owner record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.owner.type`
Type records type of the account (User or Organization). It is needed to distinguish Repositories rows by the exact GitHub-returned type value.
* **Enables:** separate Repositories rows by the exact GitHub-returned `type` label when comparing type.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is interpreted at one Repository Owner record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.owner.url`
URL records REST API URL for the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is link at one Repository Owner record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.owner.user_view_type`
User View Type records view type for the user (e.g. public). It is needed to distinguish Repositories rows by the exact GitHub-returned user view type value.
* **Enables:** separate Repositories rows by the exact GitHub-returned `user_view_type` label when comparing user view type.
* **Interpretation:** GitHub reports this value on the Repository Owner object returned for Repositories; it is interpreted at one Repository Owner record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.permissions`
Permissions records permissions the authenticated user has on this repository. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `permissions` to examine the returned permissions details for the containing GitHub Repository record.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is one nested object per containing GitHub Repository object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `repositories.permissions.admin`
Admin records whether the user has admin access. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Repositories rows with the exact `admin` access-related value being investigated.
* **Interpretation:** GitHub reports this value on the Repository Permissions object returned for Repositories; it is interpreted at one Repository Permissions record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.permissions.maintain`
Maintain records whether the user has maintain access. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Repositories rows with the exact `maintain` access-related value being investigated.
* **Interpretation:** GitHub reports this value on the Repository Permissions object returned for Repositories; it is interpreted at one Repository Permissions record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.permissions.pull`
Pull records whether the user has pull (read) access. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Repositories rows with the exact `pull` access-related value being investigated.
* **Interpretation:** GitHub reports this value on the Repository Permissions object returned for Repositories; it is interpreted at one Repository Permissions record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.permissions.push`
Push records whether the user has push (write) access. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Repositories rows with the exact `push` access-related value being investigated.
* **Interpretation:** GitHub reports this value on the Repository Permissions object returned for Repositories; it is interpreted at one Repository Permissions record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.permissions.triage`
Triage records whether the user has triage access. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Repositories rows with the exact `triage` access-related value being investigated.
* **Interpretation:** GitHub reports this value on the Repository Permissions object returned for Repositories; it is interpreted at one Repository Permissions record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.private`
Private records whether the repository is private. It is needed to distinguish Repositories rows by the exact GitHub-returned private value.
* **Enables:** select Repositories rows where `private` is true or false when comparing the condition described by Private.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.pulls_url`
Pulls URL records URL template for accessing pull requests. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `pulls_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.pushed_at`
Pushed At records timestamp of the last push to any branch. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Repositories records by `pushed_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `repositories.releases_url`
Releases URL records URL template for accessing releases. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `releases_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.security_and_analysis`
Security And Analysis records security and analysis feature settings. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `security_and_analysis` to examine the returned security and analysis details for the containing GitHub Repository record.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is one nested object per containing GitHub Repository object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `repositories.security_and_analysis.advanced_security`
Advanced Security records GitHub Advanced Security status. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `advanced_security` to examine the returned advanced security details for the containing Security And Analysis record.
* **Interpretation:** GitHub reports this value on the Security And Analysis object returned for Repositories; it is one nested object per containing Security And Analysis object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `repositories.security_and_analysis.advanced_security.status`
Status records whether the feature is enabled or disabled. It is needed to distinguish Repositories rows by the exact GitHub-returned status value.
* **Enables:** select Repositories rows where `status` is true or false when comparing the condition described by Status.
* **Interpretation:** GitHub reports this value on the Security Feature Status object returned for Repositories; it is interpreted at one Security Feature Status record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.security_and_analysis.dependabot_security_updates`
Dependabot Security Updates records dependabot security updates status. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `dependabot_security_updates` to examine the returned dependabot security updates details for the containing Security And Analysis record.
* **Interpretation:** GitHub reports this value on the Security And Analysis object returned for Repositories; it is one nested object per containing Security And Analysis object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `repositories.security_and_analysis.secret_scanning`
Secret Scanning records secret scanning status. It is needed to preserve the nested secret scanning relationship or details on the parent Security And Analysis record.
* **Enables:** expand `secret_scanning` to connect the containing Security And Analysis row to its returned secret scanning entries.
* **Interpretation:** GitHub reports this value on the Security And Analysis object returned for Repositories; it is one nested object per containing Security And Analysis object when present.
Developer identifier: `repositories.security_and_analysis.secret_scanning_non_provider_patterns`
Secret Scanning Non Provider Patterns records secret scanning non-provider patterns status. It is needed to preserve the nested secret scanning non provider patterns relationship or details on the parent Security And Analysis record.
* **Enables:** expand `secret_scanning_non_provider_patterns` to connect the containing Security And Analysis row to its returned secret scanning non provider patterns entries.
* **Interpretation:** GitHub reports this value on the Security And Analysis object returned for Repositories; it is one nested object per containing Security And Analysis object when present.
Developer identifier: `repositories.security_and_analysis.secret_scanning_push_protection`
Secret Scanning Push Protection records secret scanning push protection status. It is needed to preserve the nested secret scanning push protection relationship or details on the parent Security And Analysis record.
* **Enables:** expand `secret_scanning_push_protection` to connect the containing Security And Analysis row to its returned secret scanning push protection entries.
* **Interpretation:** GitHub reports this value on the Security And Analysis object returned for Repositories; it is one nested object per containing Security And Analysis object when present.
Developer identifier: `repositories.security_and_analysis.secret_scanning_validity_checks`
Secret Scanning Validity Checks records secret scanning validity checks status. It is needed to preserve the nested secret scanning validity checks relationship or details on the parent Security And Analysis record.
* **Enables:** expand `secret_scanning_validity_checks` to connect the containing Security And Analysis row to its returned secret scanning validity checks entries.
* **Interpretation:** GitHub reports this value on the Security And Analysis object returned for Repositories; it is one nested object per containing Security And Analysis object when present.
Developer identifier: `repositories.size`
Size records repository size in kilobytes. It is needed to compare the numeric size reported for one GitHub Repository record without assuming an unstated unit.
* **Enables:** compare the numeric `size` value per GitHub Repository record without assigning a unit not declared by the schema description.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row.
Developer identifier: `repositories.ssh_url`
SSH URL records SSH URL for cloning. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `ssh_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.stargazers_count`
Stargazers Count records number of stars. It is needed to measure the GitHub-reported number of stars at one GitHub Repository record per row.
* **Enables:** measure and compare the GitHub-reported number of stars in `stargazers_count` at one GitHub Repository record per row.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is a GitHub-reported count at one GitHub Repository record per row.
Developer identifier: `repositories.stargazers_url`
Stargazers URL records REST API URL for listing stargazers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `stargazers_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.statuses_url`
Statuses URL records URL template for accessing commit statuses. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `statuses_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.subscribers_count`
Subscribers Count records number of subscribers (watchers). It is needed to measure the GitHub-reported number of subscribers (watchers) at one GitHub Repository record per row.
* **Enables:** measure and compare the GitHub-reported number of subscribers (watchers) in `subscribers_count` at one GitHub Repository record per row.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is a GitHub-reported count at one GitHub Repository record per row.
Developer identifier: `repositories.subscribers_url`
Subscribers URL records REST API URL for listing subscribers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscribers_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.subscription_url`
Subscription URL records REST API URL for the authenticated user's subscription. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscription_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.svn_url`
Svn URL records subversion URL for checkout. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `svn_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.tags_url`
Tags URL records REST API URL for listing tags. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `tags_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.teams_url`
Teams URL records REST API URL for listing teams. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `teams_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.topics`
Topics records list of topic tags applied to the repository. It is needed to preserve the nested topics relationship or details on the parent GitHub Repository record.
* **Enables:** expand `topics` to connect the containing GitHub Repository row to its returned topics entries.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is one returned collection per containing GitHub Repository object.
Developer identifier: `repositories.trees_url`
Trees URL records URL template for accessing git trees. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `trees_url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.updated_at`
Updated At records timestamp when the repository metadata was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Repositories records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `repositories.url`
URL records REST API URL for this repository. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Repositories record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is link at one GitHub Repository record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `repositories.visibility`
Visibility records visibility level of the repository. It is needed to distinguish Repositories rows by the exact GitHub-returned visibility value.
* **Enables:** separate Repositories rows by the exact GitHub-returned `visibility` label when comparing visibility.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `repositories.watchers`
Watchers records number of watchers (alias). It is needed to measure the GitHub-reported number of watchers (alias) at one GitHub Repository record per row.
* **Enables:** measure and compare the GitHub-reported number of watchers (alias) in `watchers` at one GitHub Repository record per row.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is a GitHub-reported count at one GitHub Repository record per row.
Developer identifier: `repositories.watchers_count`
Watchers Count records number of watchers (legacy, equals `stargazers_count`). It is needed to measure the GitHub-reported number of watchers (legacy, equals 'stargazers\_count') at one GitHub Repository record per row.
* **Enables:** measure and compare the GitHub-reported number of watchers (legacy, equals stargazers\_count) in `watchers_count` at one GitHub Repository record per row.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is a GitHub-reported count at one GitHub Repository record per row.
Developer identifier: `repositories.web_commit_signoff_required`
Web Commit Signoff Required records whether web-based commits require sign-off. It is needed to distinguish Repositories rows by the exact GitHub-returned web commit signoff required value.
* **Enables:** select Repositories rows where `web_commit_signoff_required` is true or false when comparing the condition described by Web Commit Signoff Required.
* **Interpretation:** GitHub reports this value on the GitHub Repository object returned for Repositories; it is interpreted at one GitHub Repository record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `team_members`
Team Members covers team members.
* **Enables:** map the GitHub accounts and memberships represented by Team Members records and trace a returned access assignment to its account or group.
* **Scope:** Team members; the connector reads `/orgs/{orgId}/teams/{slug}/members` as a snapshot stream in full mode. The configured credential must grant the declared `read:org` access scope; records outside that access are not returned. A successful full collection can reveal a previously returned row as absent, but a credential or permission change can produce the same observation.
Developer identifier: `team_members.avatar_url`
Avatar URL records URL to the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `avatar_url` while retaining the containing Team Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is link at one GitHub Team Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target. A connector directive maps this field to the person's identity photo.
Developer identifier: `team_members.events_url`
Events URL records API URL template to list events for the user. Contains (/privacy) template variable. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Team Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is link at one GitHub Team Member record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `team_members.followers_url`
Followers URL records API URL to list the user's followers. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `followers_url` while retaining the containing Team Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is link at one GitHub Team Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `team_members.following_url`
Following URL records API URL template to list users this user is following. Contains (/`other_user`) template variable. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `following_url` while retaining the containing Team Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is link at one GitHub Team Member record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `team_members.gists_url`
Gists URL records API URL template to list the user's gists. Contains (/`gist_id`) template variable. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `gists_url` while retaining the containing Team Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is link at one GitHub Team Member record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `team_members.gravatar_id`
Gravatar ID records gravatar ID associated with the user's email, if any. It is needed to refer to the same gravatar across records without relying on display text.
* **Enables:** match `gravatar_id` to gravatar references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is an identifier, not a measured quantity.
Developer identifier: `team_members.html_url`
HTML URL records URL to the user's GitHub profile page. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Team Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is link at one GitHub Team Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `team_members.id`
**ID.** GitHub's numeric identifier for the user who is a member of the team.
* **Enables:** Connect each team membership to the member's GitHub account through `team_members.id`.
* **Interpretation:** GitHub reports this value in its user namespace. The same value repeats once for every team the member belongs to, so it does not identify a row on its own. A connector directive maps this field to account identity.
Developer identifier: `team_members.login`
Login records GitHub username of the team member. It is needed to attribute this Team Members row to the returned person, account, or organization reference.
* **Enables:** attribute the Team Members row to the returned person or account and match the exact `login` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is interpreted at one GitHub Team Member record per row.
Developer identifier: `team_members.membership_key`
**Membership Key.** Parable-generated SHA-1 digest of `team_id` and `id`, joined with `|`.
* **Enables:** Deduplicate each team membership on its own, so a member who belongs to several GitHub teams keeps one row per team.
* **Interpretation:** Parable calculates `membership_key` at ingestion. It identifies one team-to-member relationship, not the member or the team by itself, and is not a GitHub identifier. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `team_members.node_id`
Node ID records global node ID used in the GitHub GraphQL API. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is an identifier, not a measured quantity.
Developer identifier: `team_members.organizations_url`
Organizations URL records API URL to list the user's organizations. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `organizations_url` while retaining the containing Team Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is link at one GitHub Team Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `team_members.received_events_url`
Received Events URL records API URL to list events received by the user. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `received_events_url` while retaining the containing Team Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is link at one GitHub Team Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `team_members.repos_url`
Repos URL records API URL to list the user's repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repos_url` while retaining the containing Team Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is link at one GitHub Team Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `team_members.site_admin`
Site Admin records whether the user is a GitHub site administrator. It is needed to distinguish Team Members rows by the exact GitHub-returned site admin value.
* **Enables:** select Team Members rows where `site_admin` is true or false when comparing the condition described by Site Admin.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is interpreted at one GitHub Team Member record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `team_members.starred_url`
Starred URL records API URL template to list repositories the user has starred. Contains (/owner)(/repo) template variable. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `starred_url` while retaining the containing Team Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is link at one GitHub Team Member record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `team_members.subscriptions_url`
Subscriptions URL records API URL to list repositories the user is watching. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `subscriptions_url` while retaining the containing Team Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is link at one GitHub Team Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `team_members.team_id`
**Team ID.** The GitHub team this membership belongs to, copied from the parent team because the team members operation does not return it.
* **Enables:** Join each membership to `teams.id` and list the teams a member belongs to.
* **Interpretation:** Parable copies the team ID from the parent traversal record into each member row; the value is in GitHub's team namespace. Rows ingested before the connector injected it have no value.
Developer identifier: `team_members.type`
Type records account type indicating whether this is a regular user or bot. It is needed to distinguish Team Members rows by the exact GitHub-returned type value.
* **Enables:** separate Team Members rows by the exact GitHub-returned `type` label when comparing type.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is interpreted at one GitHub Team Member record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `team_members.url`
URL records API URL for the user resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Team Members record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is link at one GitHub Team Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `team_members.user_view_type`
User View Type records the view type of the user, e.g. public or private. It is needed to distinguish Team Members rows by the exact GitHub-returned user view type value.
* **Enables:** separate Team Members rows by the exact GitHub-returned `user_view_type` label when comparing user view type.
* **Interpretation:** GitHub reports this value on the GitHub Team Member object returned for Team Members; it is interpreted at one GitHub Team Member record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams`
Teams covers organization teams.
* **Enables:** map the GitHub accounts and memberships represented by Teams records and trace a returned access assignment to its account or group.
* **Scope:** Organization teams; the connector reads `/orgs/{orgId}/teams` as a snapshot stream in full mode. The configured credential must grant the declared `read:org` access scope; records outside that access are not returned. A successful full collection can reveal a previously returned row as absent, but a credential or permission change can produce the same observation.
Developer identifier: `teams.created_at`
Created At records ISO 8601 timestamp when the team was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Teams records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is interpreted at one GitHub Team record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `teams.description`
Description records team description text. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is description text at one GitHub Team record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `teams.html_url`
HTML URL records HTML URL for the team page on GitHub. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is link at one GitHub Team record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `teams.id`
ID records unique numeric identifier for the team. It is needed to distinguish repeated deliveries of the same Teams row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Teams and match repeated rows carrying the same GitHub identifier.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `teams.members_count`
Members Count records number of members in the team. It is needed to measure the GitHub-reported number of members in the team at one GitHub Team record per row.
* **Enables:** measure and compare the GitHub-reported number of members in the team in `members_count` at one GitHub Team record per row.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is a GitHub-reported count at one GitHub Team record per row.
Developer identifier: `teams.members_url`
Members URL records URL template for listing team members (contains (/member) placeholder). It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `members_url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is link at one GitHub Team record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `teams.name`
Name records team display name. It is needed to compare the returned name for individual Teams rows and select rows with a specific `name` value.
* **Enables:** locate Teams rows whose returned name exactly matches `name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is interpreted at one GitHub Team record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `teams.node_id`
Node ID records global GraphQL node ID for the team. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is an identifier, not a measured quantity.
Developer identifier: `teams.notification_setting`
Notification Setting records team notification setting. It is needed to distinguish Teams rows by the exact GitHub-returned notification setting value.
* **Enables:** separate Teams rows by the exact GitHub-returned `notification_setting` label when comparing notification setting.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is interpreted at one GitHub Team record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams.organization`
Organization records the organization that owns this team (included in detailed responses). It is needed to preserve the nested organization relationship or details on the parent GitHub Team record.
* **Enables:** expand `organization` to connect the containing GitHub Team row to its returned organization entries.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is one nested object per containing GitHub Team object when present.
Developer identifier: `teams.organization.avatar_url`
Avatar URL records URL of the organization avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `avatar_url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is link at one Team Organization record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `teams.organization.blog`
Blog records blog URL for the organization. It is needed to compare the returned blog for individual Teams rows and select rows with a specific `blog` value.
* **Enables:** trace the blog relationship returned in `blog` from the Team Organization row to its named GitHub context.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is interpreted at one Team Organization record per row.
Developer identifier: `teams.organization.company`
Company records company name associated with the organization. It is needed to compare the returned company for individual Teams rows and select rows with a specific `company` value.
* **Enables:** trace the company relationship returned in `company` from the Team Organization row to its named GitHub context.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is interpreted at one Team Organization record per row.
Developer identifier: `teams.organization.created_at`
Created At records ISO 8601 timestamp when the organization was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Teams records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is interpreted at one Team Organization record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `teams.organization.description`
Description records organization description. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is description text at one Team Organization record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `teams.organization.email`
Email records public email address for the organization. It is needed to attribute this Teams row to the returned person, account, or organization reference.
* **Enables:** attribute the Teams row to the returned person or account and match the exact `email` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is interpreted at one Team Organization record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `teams.organization.events_url`
Events URL records API URL for organization events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `events_url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is link at one Team Organization record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `teams.organization.followers`
Followers records number of followers. It is needed to measure the GitHub-reported number of followers at one Team Organization record per row.
* **Enables:** measure and compare the GitHub-reported number of followers in `followers` at one Team Organization record per row.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is a GitHub-reported count at one Team Organization record per row.
Developer identifier: `teams.organization.following`
Following records number of accounts the organization follows. It is needed to measure the GitHub-reported number of accounts the organization follows at one Team Organization record per row.
* **Enables:** measure and compare the GitHub-reported number of accounts the organization follows in `following` at one Team Organization record per row.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is a GitHub-reported count at one Team Organization record per row.
Developer identifier: `teams.organization.has_organization_projects`
Has Organization Projects records whether organization projects are enabled. It is needed to distinguish Teams rows by the exact GitHub-returned has organization projects value.
* **Enables:** select Teams rows where `has_organization_projects` is true or false when comparing the condition described by Has Organization Projects.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is interpreted at one Team Organization record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams.organization.has_repository_projects`
Has Repository Projects records whether repository projects are enabled. It is needed to distinguish Teams rows by the exact GitHub-returned has repository projects value.
* **Enables:** select Teams rows where `has_repository_projects` is true or false when comparing the condition described by Has Repository Projects.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is interpreted at one Team Organization record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams.organization.hooks_url`
Hooks URL records API URL for organization webhooks. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `hooks_url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is link at one Team Organization record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `teams.organization.html_url`
HTML URL records HTML URL for the organization page. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is link at one Team Organization record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `teams.organization.id`
ID records unique numeric identifier for the organization. It is needed to refer to the same team organization across records without relying on display text.
* **Enables:** match `id` to team organization references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is an identifier, not a measured quantity.
Developer identifier: `teams.organization.is_verified`
Is Verified records whether the organization's domain is verified. It is needed to distinguish Teams rows by the exact GitHub-returned is verified value.
* **Enables:** select Teams rows where `is_verified` is true or false when comparing the condition described by Is Verified.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is interpreted at one Team Organization record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams.organization.issues_url`
Issues URL records API URL for organization issues. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `issues_url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is link at one Team Organization record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams.organization.location`
Location records geographic location of the organization. It is needed to preserve the GitHub-reported configured or derived address and place context for the same record.
* **Enables:** compare the GitHub-reported configured or derived address and place context in `location` for individual Teams rows without treating it as a verified physical location.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is interpreted at one Team Organization record per row; the value is configured or derived address and place context; this GitHub-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `teams.organization.login`
Login records organization login/username. It is needed to attribute this Teams row to the returned person, account, or organization reference.
* **Enables:** attribute the Teams row to the returned person or account and match the exact `login` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is interpreted at one Team Organization record per row.
Developer identifier: `teams.organization.members_url`
Members URL records URL template for listing organization members. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `members_url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is link at one Team Organization record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `teams.organization.name`
Name records organization display name. It is needed to compare the returned name for individual Teams rows and select rows with a specific `name` value.
* **Enables:** locate Teams rows whose returned name exactly matches `name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is interpreted at one Team Organization record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `teams.organization.node_id`
Node ID records global GraphQL node ID for the organization. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is an identifier, not a measured quantity.
Developer identifier: `teams.organization.public_gists`
Public Gists records number of public gists. It is needed to measure the GitHub-reported number of public gists at one Team Organization record per row.
* **Enables:** measure and compare the GitHub-reported number of public gists in `public_gists` at one Team Organization record per row.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is a GitHub-reported count at one Team Organization record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams.organization.public_members_url`
Public Members URL records URL template for listing public organization members. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `public_members_url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is link at one Team Organization record per row; the returned link or template does not establish that the current credential can retrieve its target; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams.organization.public_repos`
Public Repos records number of public repositories. It is needed to measure the GitHub-reported number of public repositories at one Team Organization record per row.
* **Enables:** measure and compare the GitHub-reported number of public repositories in `public_repos` at one Team Organization record per row.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is a GitHub-reported count at one Team Organization record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams.organization.repos_url`
Repos URL records API URL for listing organization repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repos_url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is link at one Team Organization record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `teams.organization.twitter_username`
Twitter Username records twitter username for the organization. It is needed to attribute this Teams row to the returned person, account, or organization reference.
* **Enables:** attribute the Teams row to the returned person or account and match the exact `twitter_username` value where it recurs in GitHub.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is interpreted at one Team Organization record per row.
Developer identifier: `teams.organization.type`
Type records account type (e.g., Organization). It is needed to distinguish Teams rows by the exact GitHub-returned type value.
* **Enables:** separate Teams rows by the exact GitHub-returned `type` label when comparing type.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is interpreted at one Team Organization record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams.organization.updated_at`
Updated At records ISO 8601 timestamp when the organization was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Teams records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is interpreted at one Team Organization record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `teams.organization.url`
URL records API URL for the organization. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the Team Organization object returned for Teams; it is link at one Team Organization record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `teams.parent`
Parent records parent team object for nested team hierarchies. Null if no parent. It is needed to preserve the nested parent relationship or details on the parent GitHub Team record.
* **Enables:** expand `parent` to connect the containing GitHub Team row to its returned parent entries.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is one nested object per containing GitHub Team object when present.
Developer identifier: `teams.parent.description`
Description records parent team description. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** GitHub reports this value on the Parent Team object returned for Teams; it is description text at one Parent Team record per row; this is only the content included in the GitHub response for this record.
Developer identifier: `teams.parent.html_url`
HTML URL records HTML URL for the parent team page on GitHub. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `html_url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the Parent Team object returned for Teams; it is link at one Parent Team record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `teams.parent.id`
ID records unique numeric identifier for the parent team. It is needed to refer to the same parent team across records without relying on display text.
* **Enables:** match `id` to parent team references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Parent Team object returned for Teams; it is an identifier, not a measured quantity.
Developer identifier: `teams.parent.members_url`
Members URL records URL template for listing parent team members. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `members_url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the Parent Team object returned for Teams; it is link at one Parent Team record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `teams.parent.name`
Name records parent team display name. It is needed to compare the returned name for individual Teams rows and select rows with a specific `name` value.
* **Enables:** locate Teams rows whose returned name exactly matches `name` and retain the GitHub identifier for any cross-record match.
* **Interpretation:** GitHub reports this value on the Parent Team object returned for Teams; it is interpreted at one Parent Team record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `teams.parent.node_id`
Node ID records global GraphQL node ID for the parent team. It is needed to refer to the same node across records without relying on display text.
* **Enables:** match `node_id` to node references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Parent Team object returned for Teams; it is an identifier, not a measured quantity.
Developer identifier: `teams.parent.notification_setting`
Notification Setting records parent team notification setting. It is needed to distinguish Teams rows by the exact GitHub-returned notification setting value.
* **Enables:** separate Teams rows by the exact GitHub-returned `notification_setting` label when comparing notification setting.
* **Interpretation:** GitHub reports this value on the Parent Team object returned for Teams; it is interpreted at one Parent Team record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams.parent.permission`
Permission records default repository permission for the parent team. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Teams rows with the exact `permission` access-related value being investigated.
* **Interpretation:** GitHub reports this value on the Parent Team object returned for Teams; it is interpreted at one Parent Team record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams.parent.privacy`
Privacy records parent team visibility level. It is needed to distinguish Teams rows by the exact GitHub-returned privacy value.
* **Enables:** separate Teams rows by the exact GitHub-returned `privacy` label when comparing privacy.
* **Interpretation:** GitHub reports this value on the Parent Team object returned for Teams; it is interpreted at one Parent Team record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams.parent.repositories_url`
Repositories URL records API URL for listing parent team repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repositories_url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the Parent Team object returned for Teams; it is link at one Parent Team record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `teams.parent.slug`
Slug records URL-friendly identifier for the parent team. It is needed to refer to the same slug across records without relying on display text.
* **Enables:** match `slug` to slug references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the Parent Team object returned for Teams; it is an identifier, not a measured quantity; the schema uses the `Identity.Slug` scalar.
Developer identifier: `teams.parent.url`
URL records API URL for the parent team. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the Parent Team object returned for Teams; it is link at one Parent Team record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `teams.permission`
Permission records default repository permission granted to the team. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Teams rows with the exact `permission` access-related value being investigated.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is interpreted at one GitHub Team record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams.privacy`
Privacy records team visibility level. It is needed to distinguish Teams rows by the exact GitHub-returned privacy value.
* **Enables:** separate Teams rows by the exact GitHub-returned `privacy` label when comparing privacy.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is interpreted at one GitHub Team record per row; classification values are GitHub-returned labels rather than a universal taxonomy.
Developer identifier: `teams.repos_count`
Repos Count records number of repositories accessible to the team. It is needed to measure the GitHub-reported number of repositories accessible to the team at one GitHub Team record per row.
* **Enables:** measure and compare the GitHub-reported number of repositories accessible to the team in `repos_count` at one GitHub Team record per row.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is a GitHub-reported count at one GitHub Team record per row.
Developer identifier: `teams.repositories_url`
Repositories URL records API URL for listing team repositories. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `repositories_url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is link at one GitHub Team record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `teams.slug`
Slug records URL-friendly team identifier used as path variable for child tap traversal. It is needed to refer to the same slug across records without relying on display text.
* **Enables:** match `slug` to slug references carrying the same GitHub-issued value in related GitHub records.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is an identifier, not a measured quantity; the schema uses the `Identity.Slug` scalar.
Developer identifier: `teams.updated_at`
Updated At records ISO 8601 timestamp when the team was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Teams records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is interpreted at one GitHub Team record per row; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `teams.url`
URL records API URL for this team resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitHub resource referenced by `url` while retaining the containing Teams record as provenance.
* **Interpretation:** GitHub reports this value on the GitHub Team object returned for Teams; it is link at one GitHub Team record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
| Error | Meaning | Solution |
| - | - | - |
| **401 Unauthorized** | Invalid or expired token | Regenerate token |
| **403 Forbidden** | Missing permissions | Check token has required permissions |
| **404 Not Found** | Resource doesn't exist or no access | Verify organization name and permissions |
| **429 Rate Limited** | Rate limit exceeded | If this occurs during setup, wait until GitHub's indicated rate-limit reset or retry time before clicking **Save & test connection** again. For secondary limits with no indicated retry time, wait at least one minute and increase the wait if the error persists; avoid repeated immediate retries. See [GitHub's rate-limit guidance](https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api#exceeding-the-rate-limit). If this occurs during syncing, Parable retries automatically for a limited time. If the sync still fails, review the connection error before retrying. |
#### Common Issues
#### Token not working for organization
Ensure you selected the correct **Resource owner** (organization) when creating the token, not your personal account.
#### Can't see private repositories
For private repos, ensure **Repository access** is set to "All repositories" or the specific repos are selected.
**[GitHub REST API](https://docs.github.com/en/rest)** — Official API documentation
**[Personal Access Tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)** — Token creation guide
# GitLab
Source: https://docs.parable.work/plugins/provider-plugins/gitlab
Sync projects, issues, merge requests, and commits from GitLab
Sync projects, issues, merge requests, and commits from GitLab.
Connect Parable to GitLab for comprehensive DevOps and repository data.
#### Code & MRs
Projects, merge requests, commits
#### Issues & Planning
Issues, milestones, labels
## Data streams
This Provider Plugin defines 13 data streams.
| Stream | Description | Sync |
| - | - | - |
| `projects` | GitLab projects the authenticated user is a member of | incremental |
| `groups` | GitLab groups | full |
| `group_members` | Members of a group (including inherited members) | full |
| `issues` | Project issues | incremental |
| `merge_requests` | Project merge requests | incremental |
| `merge_request_notes` | Notes (comments) on merge requests | incremental |
| `project_commits` | Project repository commits | incremental |
| `branches` | Project repository branches | full |
| `project_members` | Members of a project (including inherited members) | full |
| `pipelines` | Project CI/CD pipelines | incremental |
| `repos` | Project repository file tree | full |
| `branch_commits` | Repository commits for a specific branch | incremental |
| `commit_diffs` | Diff details for a specific commit | full |
### GitLab
#### What You'll Need
| Credential | What it is |
| - | - |
| **Token** | Personal access token with API scope |
| **Base URL** | `https://gitlab.com` or your self-hosted GitLab URL |
> **Info:** **Setup access in GitLab.** These steps require **Administrator**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your GitLab administrator.
* **Owner** or **Maintainer** role in the group/project
* For group-level access, group owner permissions
#### Step 1: Access User Settings
1. Log in to GitLab (gitlab.com or your instance)
2. Click your avatar → **Preferences**
3. Navigate to **Access Tokens** in the sidebar
#### Step 2: Create Personal Access Token
1. Click **Add new token**
2. Fill in:
| Field | Value |
| - | - |
| Token name | `Parable Integration` |
| Expiration date | 1 year (or per policy) |
#### Step 3: Select Scopes
Enable these scopes:
| Scope | Purpose |
| - | - |
| `api` | Full API access |
| `read_api` | Read-only API (alternative) |
| `read_user` | Read user information |
| `read_repository` | Read repository contents |
> **Tip:** For read-only integration, use `read_api` instead of `api`.
#### Step 4: Create and Copy Token
1. Click **Create personal access token**
2. Copy the token immediately
> **Warning:** **Copy your personal access token now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
#### Step 5: Enter values in the form
1. **Token** and **GitLab URL**: Paste your personal access token and your GitLab instance base URL.
2. Click **Save & test connection**.
Developer identifier: `branch_commits`
Branch Commits covers repository commits for a specific branch.
* **Enables:** trace each returned revision to its repository or project, author and committer identities, message, and provider-reported commit times.
* **Scope:** Repository commits for a specific branch; the connector reads `/api/v4/projects/{project_id}/repository/commits` as an event stream in incremental mode. The configured credential must grant the declared `read_api` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitLab record was deleted.
Developer identifier: `branch_commits.author_email`
Author Email records email address of the commit author as recorded in Git. It is needed to attribute this Branch Commits row to the returned person, account, or organization reference.
* **Enables:** attribute the Branch Commits row to the returned person or account and match the exact `author_email` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is interpreted at one GitLab Project Commit record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `branch_commits.author_name`
Author Name records display name of the commit author as recorded in Git. It is needed to attribute this Branch Commits row to the returned person, account, or organization reference.
* **Enables:** attribute the Branch Commits row to the returned person or account and match the exact `author_name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is interpreted at one GitLab Project Commit record per row.
Developer identifier: `branch_commits.authored_date`
Authored Date records timestamp when the commit was originally authored (may differ from committed date for rebased/cherry-picked commits). It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Branch Commits records by `authored_date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is interpreted at one GitLab Project Commit record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `branch_commits.committed_date`
Committed Date records timestamp when the commit was applied to the repository. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Branch Commits records by `committed_date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is interpreted at one GitLab Project Commit record per row; the connector also declares it for record ordering; the schema assigns the `event_time` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `branch_commits.committer_email`
Committer Email records email address of the committer as recorded in Git. It is needed to attribute this Branch Commits row to the returned person, account, or organization reference.
* **Enables:** attribute the Branch Commits row to the returned person or account and match the exact `committer_email` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is interpreted at one GitLab Project Commit record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `branch_commits.committer_name`
Committer Name records display name of the person who committed the change (may differ from author for applied patches). It is needed to attribute this Branch Commits row to the returned person, account, or organization reference.
* **Enables:** attribute the Branch Commits row to the returned person or account and match the exact `committer_name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is interpreted at one GitLab Project Commit record per row.
Developer identifier: `branch_commits.created_at`
Created At records timestamp when the commit was created in the repository. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Branch Commits records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is interpreted at one GitLab Project Commit record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `branch_commits.extended_trailers`
Extended Trailers records extended Git trailers supporting multiple values per key. It is needed to preserve the exact GitLab configuration or execution metadata attached to this GitLab Project Commit record.
* **Enables:** inspect the keys in `extended_trailers` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is interpreted at one GitLab Project Commit record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the GitLab response and can vary by resource type or configuration.
Developer identifier: `branch_commits.id`
ID records full SHA-1 hash of the commit, serving as the primary key. It is needed to distinguish repeated deliveries of the same Branch Commits row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Branch Commits and match repeated rows carrying the same GitLab identifier.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `branch_commits.last_pipeline`
Last Pipeline records summary of the last pipeline run for this commit, if any. It is needed to preserve the nested last pipeline relationship or details on the parent GitLab Project Commit record.
* **Enables:** expand `last_pipeline` to connect the containing GitLab Project Commit row to its returned last pipeline entries.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is one nested object per containing GitLab Project Commit object when present.
Developer identifier: `branch_commits.last_pipeline.created_at`
Created At records timestamp when the pipeline was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Branch Commits records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Commit Last Pipeline object returned for Branch Commits; it is interpreted at one GitLab Commit Last Pipeline record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `branch_commits.last_pipeline.id`
ID records unique numeric ID of the pipeline. It is needed to refer to the same commit last pipeline across records without relying on display text.
* **Enables:** match `id` to commit last pipeline references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Commit Last Pipeline object returned for Branch Commits; it is an identifier, not a measured quantity.
Developer identifier: `branch_commits.last_pipeline.iid`
Iid records project-scoped internal ID of the pipeline. It is needed to refer to the same iid across records without relying on display text.
* **Enables:** match `iid` to iid references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Commit Last Pipeline object returned for Branch Commits; it is an identifier, not a measured quantity.
Developer identifier: `branch_commits.last_pipeline.ref`
Ref records branch or tag name the pipeline ran against. It is needed to link the row to the exact GitLab branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `ref` to the returned branch, tag, commit SHA, or work-item reference on related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Commit Last Pipeline object returned for Branch Commits; it is interpreted at one GitLab Commit Last Pipeline record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `branch_commits.last_pipeline.sha`
Sha records full SHA of the commit the pipeline ran on. It is needed to refer to the same commit last pipeline across records without relying on display text.
* **Enables:** match `sha` to commit last pipeline references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Commit Last Pipeline object returned for Branch Commits; it is an identifier, not a measured quantity.
Developer identifier: `branch_commits.last_pipeline.source`
Source records what triggered the pipeline (e.g., push, web, `merge_request_event`, api, schedule). It is needed to distinguish Branch Commits rows by the exact GitLab-returned source value.
* **Enables:** separate Branch Commits rows by the exact GitLab-returned `source` label when comparing source.
* **Interpretation:** GitLab reports this value on the GitLab Commit Last Pipeline object returned for Branch Commits; it is interpreted at one GitLab Commit Last Pipeline record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `branch_commits.last_pipeline.status`
Status records current status of the pipeline (e.g., success, failed, pending, running, canceled). It is needed to distinguish Branch Commits rows by the exact GitLab-returned status value.
* **Enables:** separate Branch Commits rows by the exact GitLab-returned `status` label when comparing status.
* **Interpretation:** GitLab reports this value on the GitLab Commit Last Pipeline object returned for Branch Commits; it is interpreted at one GitLab Commit Last Pipeline record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `branch_commits.last_pipeline.updated_at`
Updated At records timestamp when the pipeline was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Branch Commits records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Commit Last Pipeline object returned for Branch Commits; it is interpreted at one GitLab Commit Last Pipeline record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `branch_commits.last_pipeline.web_url`
Web URL records URL to view the pipeline in the GitLab web interface. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Branch Commits record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Commit Last Pipeline object returned for Branch Commits; it is link at one GitLab Commit Last Pipeline record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branch_commits.message`
Message records full commit message including title and body. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `message` and attribute it to the same record's repository or project, revision, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is commit message at one GitLab Project Commit record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `branch_commits.parent_ids`
Parent IDs records SHA hashes of parent commits. Multiple entries indicate a merge commit. It is needed to preserve the nested parent i ds relationship or details on the parent GitLab Project Commit record.
* **Enables:** expand `parent_ids` to connect the containing GitLab Project Commit row to its returned parent i ds entries.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is one returned collection per containing GitLab Project Commit object.
Developer identifier: `branch_commits.project_id`
Project ID records parent project's numeric id, injected by the ingestion service from the branches tap's parentContextFields. Absent from the GitLab commits API response body itself. It is needed to refer to the same project across records without relying on display text.
* **Enables:** match `project_id` to project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab's child response does not supply this field; the connector injects parent context into each child row; it is an identifier, not a measured quantity.
Developer identifier: `branch_commits.short_id`
Short ID records abbreviated SHA hash of the commit for human-readable display. It is needed to refer to the same short across records without relying on display text.
* **Enables:** match `short_id` to short references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is an identifier, not a measured quantity.
Developer identifier: `branch_commits.stats`
Stats records line-level change statistics for the commit (present when `with_stats`=true). It is needed to preserve the nested stats relationship or details on the parent GitLab Project Commit record.
* **Enables:** expand `stats` to connect the containing GitLab Project Commit row to its returned stats entries.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is one nested object per containing GitLab Project Commit object when present.
Developer identifier: `branch_commits.stats.additions`
Additions records number of lines added in this commit. It is needed to measure the GitLab-reported number of lines added in this commit at one GitLab Commit Stats record per row.
* **Enables:** measure and compare the GitLab-reported number of lines added in this commit in `additions` at one GitLab Commit Stats record per row.
* **Interpretation:** GitLab reports this value on the GitLab Commit Stats object returned for Branch Commits; it is a GitLab-reported count at one GitLab Commit Stats record per row.
Developer identifier: `branch_commits.stats.deletions`
Deletions records number of lines deleted in this commit. It is needed to measure the GitLab-reported number of lines deleted in this commit at one GitLab Commit Stats record per row.
* **Enables:** measure and compare the GitLab-reported number of lines deleted in this commit in `deletions` at one GitLab Commit Stats record per row.
* **Interpretation:** GitLab reports this value on the GitLab Commit Stats object returned for Branch Commits; it is a GitLab-reported count at one GitLab Commit Stats record per row.
Developer identifier: `branch_commits.stats.total`
Total records total number of lines changed (additions + deletions). It is needed to measure the GitLab-reported number of lines changed (additions + deletions) at one GitLab Commit Stats record per row.
* **Enables:** measure and compare the GitLab-reported number of lines changed (additions + deletions) in `total` at one GitLab Commit Stats record per row.
* **Interpretation:** GitLab reports this value on the GitLab Commit Stats object returned for Branch Commits; it is a GitLab-reported count at one GitLab Commit Stats record per row.
Developer identifier: `branch_commits.status`
Status records status of the latest pipeline associated with this commit, if any. It is needed to distinguish Branch Commits rows by the exact GitLab-returned status value.
* **Enables:** separate Branch Commits rows by the exact GitLab-returned `status` label when comparing status.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is interpreted at one GitLab Project Commit record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `branch_commits.title`
Title records first line of the commit message, typically a summary of the change. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `title` and attribute it to the same record's repository or project, revision, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is commit message at one GitLab Project Commit record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `branch_commits.trailers`
Trailers records key-value pairs parsed from Git trailers in the commit message (e.g., Signed-off-by, Co-authored-by). It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `trailers` and attribute it to the same record's repository or project, revision, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is commit message at one GitLab Project Commit record per row; the schema uses the `Generic.JSON` scalar; this is only the content included in the GitLab response for this record.
Developer identifier: `branch_commits.web_url`
Web URL records URL to view the commit in the GitLab web interface. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Branch Commits record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Branch Commits; it is link at one GitLab Project Commit record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches`
Branches covers project repository branches.
* **Enables:** inventory returned branches and connect each branch name to its head revision and protection details.
* **Scope:** Project repository branches; the connector reads `/api/v4/projects/{id}/repository/branches` as a snapshot stream in full mode. The configured credential must grant the declared `read_api` access scope; records outside that access are not returned. A successful full collection can reveal a previously returned row as absent, but a credential or permission change can produce the same observation.
Developer identifier: `branches._composite_id`
Composite ID records synthetic primary key formed by joining `project_id` and branch name with ':' for global uniqueness. Injected by the ingestion service. It is needed to refer to the same composite across records without relying on display text.
* **Enables:** match `_composite_id` to composite references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab's child response does not supply this field; the connector injects parent context into each child row; it is an identifier, not a measured quantity.
Developer identifier: `branches.can_push`
Can Push records whether the current authenticated user can push to this branch. It is needed to distinguish Branches rows by the exact GitLab-returned can push value.
* **Enables:** select Branches rows where `can_push` is true or false when comparing the condition described by Can Push.
* **Interpretation:** GitLab reports this value on the GitLab Branch object returned for Branches; it is interpreted at one GitLab Branch record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `branches.commit`
Commit records the latest commit on this branch. It is needed to preserve the nested commit relationship or details on the parent GitLab Branch record.
* **Enables:** expand `commit` to connect the containing GitLab Branch row to its returned commit entries.
* **Interpretation:** GitLab reports this value on the GitLab Branch object returned for Branches; it is one nested object per containing GitLab Branch object when present.
Developer identifier: `branches.commit.author_email`
Author Email records email address of the commit author. It is needed to attribute this Branches row to the returned person, account, or organization reference.
* **Enables:** attribute the Branches row to the returned person or account and match the exact `author_email` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is interpreted at one GitLab Branch Commit record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `branches.commit.author_name`
Author Name records name of the commit author. It is needed to attribute this Branches row to the returned person, account, or organization reference.
* **Enables:** attribute the Branches row to the returned person or account and match the exact `author_name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is interpreted at one GitLab Branch Commit record per row.
Developer identifier: `branches.commit.authored_date`
Authored Date records timestamp when the commit was authored. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Branches records by `authored_date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is interpreted at one GitLab Branch Commit record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `branches.commit.committed_date`
Committed Date records timestamp when the commit was committed. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Branches records by `committed_date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is interpreted at one GitLab Branch Commit record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `branches.commit.committer_email`
Committer Email records email address of the committer. It is needed to attribute this Branches row to the returned person, account, or organization reference.
* **Enables:** attribute the Branches row to the returned person or account and match the exact `committer_email` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is interpreted at one GitLab Branch Commit record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `branches.commit.committer_name`
Committer Name records name of the committer. It is needed to compare the returned committer name for individual Branches rows and select rows with a specific `committer_name` value.
* **Enables:** locate Branches rows whose returned committer name exactly matches `committer_name` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is interpreted at one GitLab Branch Commit record per row.
Developer identifier: `branches.commit.created_at`
Created At records timestamp when the commit was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Branches records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is interpreted at one GitLab Branch Commit record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `branches.commit.extended_trailers`
Extended Trailers records extended git trailer key-value pairs parsed from the commit message, supporting multiple values per key. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `extended_trailers` and attribute it to the same record's repository or project, branch name, revision, and update time where returned.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is commit message at one GitLab Branch Commit record per row; the schema uses the `Generic.JSON` scalar; this is only the content included in the GitLab response for this record.
Developer identifier: `branches.commit.id`
ID records full SHA hash of the commit. It is needed to refer to the same branch commit across records without relying on display text.
* **Enables:** match `id` to branch commit references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is an identifier, not a measured quantity.
Developer identifier: `branches.commit.message`
Message records full commit message including body. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `message` and attribute it to the same record's repository or project, branch name, revision, and update time where returned.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is commit message at one GitLab Branch Commit record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `branches.commit.parent_ids`
Parent IDs records list of parent commit SHA hashes. It is needed to preserve the nested parent i ds relationship or details on the parent GitLab Branch Commit record.
* **Enables:** expand `parent_ids` to connect the containing GitLab Branch Commit row to its returned parent i ds entries.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is one returned collection per containing GitLab Branch Commit object.
Developer identifier: `branches.commit.short_id`
Short ID records abbreviated SHA hash of the commit. It is needed to refer to the same short across records without relying on display text.
* **Enables:** match `short_id` to short references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is an identifier, not a measured quantity.
Developer identifier: `branches.commit.title`
Title records first line of the commit message (subject). It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `title` and attribute it to the same record's repository or project, branch name, revision, and update time where returned.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is commit message at one GitLab Branch Commit record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `branches.commit.trailers`
Trailers records git trailer key-value pairs parsed from the commit message. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `trailers` and attribute it to the same record's repository or project, branch name, revision, and update time where returned.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is commit message at one GitLab Branch Commit record per row; the schema uses the `Generic.JSON` scalar; this is only the content included in the GitLab response for this record.
Developer identifier: `branches.commit.web_url`
Web URL records URL to view the commit in the GitLab web interface. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Branch Commit object returned for Branches; it is link at one GitLab Branch Commit record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `branches.default`
Default records whether this is the default branch of the repository. It is needed to distinguish Branches rows by the exact GitLab-returned default value.
* **Enables:** select Branches rows where `default` is true or false when comparing the condition described by Default.
* **Interpretation:** GitLab reports this value on the GitLab Branch object returned for Branches; it is interpreted at one GitLab Branch record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `branches.developers_can_merge`
Developers Can Merge records whether developers are allowed to merge into this branch. It is needed to distinguish Branches rows by the exact GitLab-returned developers can merge value.
* **Enables:** select Branches rows where `developers_can_merge` is true or false when comparing the condition described by Developers Can Merge.
* **Interpretation:** GitLab reports this value on the GitLab Branch object returned for Branches; it is interpreted at one GitLab Branch record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `branches.developers_can_push`
Developers Can Push records whether developers are allowed to push to this branch. It is needed to distinguish Branches rows by the exact GitLab-returned developers can push value.
* **Enables:** select Branches rows where `developers_can_push` is true or false when comparing the condition described by Developers Can Push.
* **Interpretation:** GitLab reports this value on the GitLab Branch object returned for Branches; it is interpreted at one GitLab Branch record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `branches.merged`
Merged records whether the branch has been merged into the default branch. It is needed to distinguish Branches rows by the exact GitLab-returned merged value.
* **Enables:** select Branches rows where `merged` is true or false when comparing the condition described by Merged.
* **Interpretation:** GitLab reports this value on the GitLab Branch object returned for Branches; it is interpreted at one GitLab Branch record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `branches.name`
Name records branch name. It is needed to distinguish repeated deliveries of the same Branches row using the declared ingestion key.
* **Enables:** use `name` as the declared ingestion deduplication key for Branches and match repeated rows carrying the same GitLab identifier.
* **Interpretation:** GitLab reports this value on the GitLab Branch object returned for Branches; it is interpreted at one GitLab Branch record per row; the connector declares it as an ingestion deduplication key.
Developer identifier: `branches.project_id`
Project ID records parent project's numeric id, injected by the ingestion service from the projects tap's parentContextFields. Absent from the GitLab branches API response body itself. It is needed to refer to the same project across records without relying on display text.
* **Enables:** match `project_id` to project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab's child response does not supply this field; the connector injects parent context into each child row; it is an identifier, not a measured quantity.
Developer identifier: `branches.protected`
Protected records whether the branch is protected. It is needed to distinguish Branches rows by the exact GitLab-returned protected value.
* **Enables:** select Branches rows where `protected` is true or false when comparing the condition described by Protected.
* **Interpretation:** GitLab reports this value on the GitLab Branch object returned for Branches; it is interpreted at one GitLab Branch record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `branches.web_url`
Web URL records URL to view the branch in the GitLab web interface. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Branches record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Branch object returned for Branches; it is link at one GitLab Branch record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `commit_diffs`
Commit Diffs covers diff details for a specific commit.
* **Enables:** inspect each returned file diff in the context of its repository or project and parent commit.
* **Scope:** Diff details for a specific commit; the connector reads `/api/v4/projects/{project_id}/repository/commits/{id}/diff` as an event stream in full mode. The configured credential must grant the declared `read_api` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitLab record was deleted.
Developer identifier: `commit_diffs.a_mode`
A Mode records unix file mode of the file before the change (e.g., '100644' for regular file, '100755' for executable, '000000' for non-existent). It is needed to distinguish Commit Diffs rows by the exact GitLab-returned a mode value.
* **Enables:** separate Commit Diffs rows by the exact GitLab-returned `a_mode` label when comparing a mode.
* **Interpretation:** GitLab reports this value on the GitLab Commit Diff object returned for Commit Diffs; it is interpreted at one GitLab Commit Diff record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `commit_diffs.b_mode`
B Mode records unix file mode of the file after the change (e.g., '100644' for regular file, '100755' for executable, '000000' for deleted file). It is needed to distinguish Commit Diffs rows by the exact GitLab-returned b mode value.
* **Enables:** separate Commit Diffs rows by the exact GitLab-returned `b_mode` label when comparing b mode.
* **Interpretation:** GitLab reports this value on the GitLab Commit Diff object returned for Commit Diffs; it is interpreted at one GitLab Commit Diff record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `commit_diffs.collapsed`
Collapsed records whether the diff was returned in collapsed form (large diffs may be summarized rather than fully expanded). It is needed to distinguish Commit Diffs rows by the exact GitLab-returned collapsed value.
* **Enables:** select Commit Diffs rows where `collapsed` is true or false when comparing the condition described by Collapsed.
* **Interpretation:** GitLab reports this value on the GitLab Commit Diff object returned for Commit Diffs; it is interpreted at one GitLab Commit Diff record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `commit_diffs.committed_date`
Committed Date records timestamp when the parent commit was applied to the repository, injected by the ingestion service from the `branch_commits` tap's parentContextFields. Absent from the GitLab commit diff API response body itself. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Commit Diffs records by `committed_date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab's child response does not supply this field; the connector injects parent context into each child row; it is interpreted at one GitLab Commit Diff record per row; the connector also declares it for record ordering; the schema assigns the `event_time` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `commit_diffs.deleted_file`
Deleted File records whether the file was deleted in this commit. It is needed to distinguish Commit Diffs rows by the exact GitLab-returned deleted file value.
* **Enables:** select Commit Diffs rows where `deleted_file` is true or false when comparing the condition described by Deleted File.
* **Interpretation:** GitLab reports this value on the GitLab Commit Diff object returned for Commit Diffs; it is interpreted at one GitLab Commit Diff record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `commit_diffs.diff`
Diff records the actual unified diff content showing line-by-line additions and removals. May be truncated for very large diffs. It is needed to measure the GitLab-reported number of diff at one GitLab Commit Diff record per row.
* **Enables:** measure and compare the GitLab-reported number of diff in `diff` at one GitLab Commit Diff record per row.
* **Interpretation:** GitLab reports this value on the GitLab Commit Diff object returned for Commit Diffs; it is diff at one GitLab Commit Diff record per row; GitLab may omit, collapse, summarize, or truncate this code-change content as noted by the field description.
Developer identifier: `commit_diffs.generated_file`
Generated File records whether GitLab considers this file to be a generated file (e.g., compiled assets, lock files). It is needed to distinguish Commit Diffs rows by the exact GitLab-returned generated file value.
* **Enables:** select Commit Diffs rows where `generated_file` is true or false when comparing the condition described by Generated File.
* **Interpretation:** GitLab reports this value on the GitLab Commit Diff object returned for Commit Diffs; it is interpreted at one GitLab Commit Diff record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `commit_diffs.id`
ID records synthetic primary key computed by the ingestor from `old_path`, `new_path`, diff (sha1). Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to distinguish repeated deliveries of the same Commit Diffs row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Commit Diffs and match repeated rows carrying the same GitLab identifier.
* **Interpretation:** GitLab's child response does not supply this field; the connector injects parent context into each child row; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `commit_diffs.new_file`
New File records whether this diff entry represents a newly created file. It is needed to distinguish Commit Diffs rows by the exact GitLab-returned new file value.
* **Enables:** select Commit Diffs rows where `new_file` is true or false when comparing the condition described by New File.
* **Interpretation:** GitLab reports this value on the GitLab Commit Diff object returned for Commit Diffs; it is interpreted at one GitLab Commit Diff record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `commit_diffs.new_path`
New Path records new file path after the change. Identifies which files were modified in each commit. Serves as the primary key for this diff entry. It is needed to refer to the same new path across records without relying on display text.
* **Enables:** match `new_path` to new path references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Commit Diff object returned for Commit Diffs; it is an identifier, not a measured quantity; the schema uses the `Asset.FilePath` scalar.
Developer identifier: `commit_diffs.old_path`
Old Path records original file path before the change. Used to track file renames and moves across commits. It is needed to compare the returned old path for individual Commit Diffs rows and select rows with a specific `old_path` value.
* **Enables:** trace the old path relationship returned in `old_path` from the GitLab Commit Diff row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the GitLab Commit Diff object returned for Commit Diffs; it is interpreted at one GitLab Commit Diff record per row; the schema uses the `Asset.FilePath` scalar.
Developer identifier: `commit_diffs.project_id`
Project ID records parent project's numeric id, injected by the ingestion service from the `branch_commits` tap's parentContextFields. Absent from the GitLab commit diff API response body itself. It is needed to refer to the same project across records without relying on display text.
* **Enables:** match `project_id` to project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab's child response does not supply this field; the connector injects parent context into each child row; it is an identifier, not a measured quantity.
Developer identifier: `commit_diffs.renamed_file`
Renamed File records whether the file was renamed in this commit. It is needed to distinguish Commit Diffs rows by the exact GitLab-returned renamed file value.
* **Enables:** select Commit Diffs rows where `renamed_file` is true or false when comparing the condition described by Renamed File.
* **Interpretation:** GitLab reports this value on the GitLab Commit Diff object returned for Commit Diffs; it is interpreted at one GitLab Commit Diff record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `commit_diffs.too_large`
Too Large records whether the diff exceeded the API's size limit and was truncated. When true, only a summary is returned. It is needed to distinguish Commit Diffs rows by the exact GitLab-returned too large value.
* **Enables:** select Commit Diffs rows where `too_large` is true or false when comparing the condition described by Too Large.
* **Interpretation:** GitLab reports this value on the GitLab Commit Diff object returned for Commit Diffs; it is interpreted at one GitLab Commit Diff record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `group_members`
Group Members covers members of a group (including inherited members).
* **Enables:** map the GitLab accounts and memberships represented by Group Members records and trace a returned access assignment to its account or group.
* **Scope:** Members of a group (including inherited members); the connector reads `/api/v4/groups/{id}/members/all` as a snapshot stream in full mode. The configured credential must grant the declared `read_api` access scope; records outside that access are not returned. A successful full collection can reveal a previously returned row as absent, but a credential or permission change can produce the same observation.
Developer identifier: `group_members.access_level`
Access Level records numeric permission level granted to the member within the group (0=No access, 5=Minimal, 10=Guest, 20=Reporter, 30=Developer, 40=Maintainer, 50=Owner). GitLab returns this as an integer, not a string. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `access_level` access value with the resource, account, or membership represented by the same Group Members row.
* **Interpretation:** GitLab reports this value on the GitLab Group Member object returned for Group Members; it is interpreted at one GitLab Group Member record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `group_members.avatar_url`
Avatar URL records URL to the member's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Group Members record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Group Member object returned for Group Members; it is link at one GitLab Group Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target. A connector directive maps this field to the person's identity photo.
Developer identifier: `group_members.created_at`
Created At records timestamp when the user account was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Group Members records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Group Member object returned for Group Members; it is interpreted at one GitLab Group Member record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `group_members.created_by`
Created By records user who added this member to the group. It is needed to preserve the nested created by relationship or details on the parent GitLab Group Member record.
* **Enables:** expand `created_by` to connect the containing GitLab Group Member row to its returned created by entries.
* **Interpretation:** GitLab reports this value on the GitLab Group Member object returned for Group Members; it is one nested object per containing GitLab Group Member object when present.
Developer identifier: `group_members.created_by.avatar_url`
Avatar URL records URL to the creator's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Group Members record as provenance.
* **Interpretation:** GitLab reports this value on the Member Created By object returned for Group Members; it is link at one Member Created By record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `group_members.created_by.id`
ID records user ID of the creator. It is needed to refer to the same member created by across records without relying on display text.
* **Enables:** match `id` to member created by references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Member Created By object returned for Group Members; it is an identifier, not a measured quantity.
Developer identifier: `group_members.created_by.name`
Name records display name of the creator. It is needed to attribute this Group Members row to the returned person, account, or organization reference.
* **Enables:** attribute the Group Members row to the returned person or account and match the exact `name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the Member Created By object returned for Group Members; it is interpreted at one Member Created By record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `group_members.created_by.state`
State records account state of the creator. It is needed to distinguish Group Members rows by the exact GitLab-returned state value.
* **Enables:** separate Group Members rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the Member Created By object returned for Group Members; it is interpreted at one Member Created By record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `group_members.created_by.username`
User Name records GitLab username of the creator. It is needed to attribute this Group Members row to the returned person, account, or organization reference.
* **Enables:** attribute the Group Members row to the returned person or account and match the exact `username` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the Member Created By object returned for Group Members; it is interpreted at one Member Created By record per row.
Developer identifier: `group_members.created_by.web_url`
Web URL records URL to the creator's GitLab profile page. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Group Members record as provenance.
* **Interpretation:** GitLab reports this value on the Member Created By object returned for Group Members; it is link at one Member Created By record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `group_members.email`
Email records email address of the member, if visible. It is needed to attribute this Group Members row to the returned person, account, or organization reference.
* **Enables:** attribute the Group Members row to the returned person or account and match the exact `email` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Group Member object returned for Group Members; it is interpreted at one GitLab Group Member record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `group_members.expires_at`
Expires At records membership expiration date if set (YYYY-MM-DD format). It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Group Members records by `expires_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Group Member object returned for Group Members; it is interpreted at one GitLab Group Member record per row; the schema uses the `Temporal.Date` scalar.
Developer identifier: `group_members.group_id`
**Group ID.** The GitLab group this membership belongs to, copied from the parent group because the group members operation does not return it.
* **Enables:** Join each membership to `groups.id` and list the groups a member belongs to.
* **Interpretation:** Parable copies the group ID from the parent traversal record into each member row; the value is in GitLab's group namespace. Rows ingested before the connector injected it have no value.
Developer identifier: `group_members.group_saml_identity`
Group SAML Identity records SAML identity information for the member if group SAML SSO is configured. It is needed to preserve the nested group saml identity relationship or details on the parent GitLab Group Member record.
* **Enables:** expand `group_saml_identity` to connect the containing GitLab Group Member row to its returned group saml identity entries.
* **Interpretation:** GitLab reports this value on the GitLab Group Member object returned for Group Members; it is one nested object per containing GitLab Group Member object when present.
Developer identifier: `group_members.group_saml_identity.extern_uid`
Extern Uid records external UID from the SAML identity provider. It is needed to refer to the same extern uid across records without relying on display text.
* **Enables:** match `extern_uid` to extern uid references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Group Saml Identity object returned for Group Members; it is an identifier, not a measured quantity.
Developer identifier: `group_members.group_saml_identity.provider`
Provider records name of the SAML identity provider. It is needed to inventory the exact GitLab-reported configuration or classification represented by this field.
* **Enables:** compare `provider` among Group Members records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitLab reports this value on the Group Saml Identity object returned for Group Members; it is interpreted at one Group Saml Identity record per row; the value is a GitLab-returned or configured label at the Group Saml Identity grain rather than a universal taxonomy.
Developer identifier: `group_members.group_saml_identity.saml_provider_id`
SAML Provider ID records ID of the SAML provider configuration in GitLab. It is needed to refer to the same saml provider across records without relying on display text.
* **Enables:** match `saml_provider_id` to saml provider references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Group Saml Identity object returned for Group Members; it is an identifier, not a measured quantity.
Developer identifier: `group_members.id`
**ID.** GitLab's numeric user ID of the member.
* **Enables:** Connect each group membership to the member's GitLab account through `group_members.id`.
* **Interpretation:** GitLab reports this value in its user namespace. The same value repeats once for every group the member belongs to, including inherited memberships, so it does not identify a row on its own. A connector directive maps this field to account identity.
Developer identifier: `group_members.is_using_seat`
Is Using Seat records whether the member is consuming a license seat. It is needed to distinguish Group Members rows by the exact GitLab-returned is using seat value.
* **Enables:** select Group Members rows where `is_using_seat` is true or false when comparing the condition described by Is Using Seat.
* **Interpretation:** GitLab reports this value on the GitLab Group Member object returned for Group Members; it is interpreted at one GitLab Group Member record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `group_members.membership_key`
**Membership Key.** Parable-generated SHA-1 digest of `group_id` and `id`, joined with `|`.
* **Enables:** Deduplicate each group membership on its own, so a member who belongs to several GitLab groups keeps one row per group.
* **Interpretation:** Parable calculates `membership_key` at ingestion. It identifies one group-to-member relationship, not the member or the group by itself, and is not a GitLab identifier. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `group_members.membership_state`
Membership State records state of the membership itself (active, awaiting, etc.). It is needed to distinguish Group Members rows by the exact GitLab-returned membership state value.
* **Enables:** separate Group Members rows by the exact GitLab-returned `membership_state` label when comparing membership state.
* **Interpretation:** GitLab reports this value on the GitLab Group Member object returned for Group Members; it is interpreted at one GitLab Group Member record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `group_members.name`
Name records display name of the member. It is needed to attribute this Group Members row to the returned person, account, or organization reference.
* **Enables:** attribute the Group Members row to the returned person or account and match the exact `name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Group Member object returned for Group Members; it is interpreted at one GitLab Group Member record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `group_members.override`
Override records whether the member's access level has been overridden from the inherited value. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Group Members rows with the exact `override` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Group Member object returned for Group Members; it is interpreted at one GitLab Group Member record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `group_members.state`
State records account state of the member (active, blocked, etc.). It is needed to distinguish Group Members rows by the exact GitLab-returned state value.
* **Enables:** separate Group Members rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the GitLab Group Member object returned for Group Members; it is interpreted at one GitLab Group Member record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `group_members.username`
User Name records GitLab username of the member. It is needed to attribute this Group Members row to the returned person, account, or organization reference.
* **Enables:** attribute the Group Members row to the returned person or account and match the exact `username` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Group Member object returned for Group Members; it is interpreted at one GitLab Group Member record per row.
Developer identifier: `group_members.web_url`
Web URL records URL to the member's GitLab profile page. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Group Members record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Group Member object returned for Group Members; it is link at one GitLab Group Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `groups`
Groups covers GitLab groups.
* **Enables:** map the GitLab accounts and memberships represented by Groups records and trace a returned access assignment to its account or group.
* **Scope:** GitLab groups; the connector reads `/api/v4/groups` as a snapshot stream in full mode. The configured credential must grant the declared `read_api` access scope; records outside that access are not returned. A successful full collection can reveal a previously returned row as absent, but a credential or permission change can produce the same observation.
Developer identifier: `groups.auto_devops_enabled`
Auto Devops Enabled records whether Auto DevOps is enabled by default for projects in this group. It is needed to distinguish Groups rows by the exact GitLab-returned auto devops enabled value.
* **Enables:** select Groups rows where `auto_devops_enabled` is true or false when comparing the condition described by Auto Devops Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.avatar_url`
Avatar URL records URL of the group avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Groups record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is link at one GitLab Group record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `groups.created_at`
Created At records timestamp when the group was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Groups records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `groups.default_branch`
Default Branch records default branch name for projects in this group. It is needed to distinguish Groups rows by the exact GitLab-returned default branch value.
* **Enables:** separate Groups rows by the exact GitLab-returned `default_branch` label when comparing default branch.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.default_branch_protection`
Default Branch Protection records default branch protection level for projects in this group. It is needed to distinguish Groups rows by the exact GitLab-returned default branch protection value.
* **Enables:** separate Groups rows by the exact GitLab-returned `default_branch_protection` label when comparing default branch protection.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.default_branch_protection_defaults`
Default Branch Protection Defaults records default branch protection settings. It is needed to preserve the nested default branch protection defaults relationship or details on the parent GitLab Group record.
* **Enables:** expand `default_branch_protection_defaults` to connect the containing GitLab Group row to its returned default branch protection defaults entries.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is one nested object per containing GitLab Group object when present.
Developer identifier: `groups.default_branch_protection_defaults.allow_force_push`
Allow Force Push records whether force push is allowed on the default branch. It is needed to distinguish Groups rows by the exact GitLab-returned allow force push value.
* **Enables:** select Groups rows where `allow_force_push` is true or false when comparing the condition described by Allow Force Push.
* **Interpretation:** GitLab reports this value on the Default Branch Protection Defaults object returned for Groups; it is interpreted at one Default Branch Protection Defaults record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.default_branch_protection_defaults.allowed_to_merge`
Allowed To Merge records roles allowed to merge into the default branch. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `allowed_to_merge` to examine the returned allowed to merge details for the containing Default Branch Protection Defaults record.
* **Interpretation:** GitLab reports this value on the Default Branch Protection Defaults object returned for Groups; it is one returned collection per containing Default Branch Protection Defaults object; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `groups.default_branch_protection_defaults.allowed_to_merge.access_level`
Access Level records numeric access level (e.g., 30 for developer, 40 for maintainer). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `access_level` access value with the resource, account, or membership represented by the same Groups row.
* **Interpretation:** GitLab reports this value on the Access Level Entry object returned for Groups; it is interpreted at one Access Level Entry record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `groups.default_branch_protection_defaults.allowed_to_push`
Allowed To Push records roles allowed to push to the default branch. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `allowed_to_push` to examine the returned allowed to push details for the containing Default Branch Protection Defaults record.
* **Interpretation:** GitLab reports this value on the Default Branch Protection Defaults object returned for Groups; it is one returned collection per containing Default Branch Protection Defaults object; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `groups.default_branch_protection_defaults.developer_can_initial_push`
Developer Can Initial Push records whether developers can perform the initial push. It is needed to distinguish Groups rows by the exact GitLab-returned developer can initial push value.
* **Enables:** select Groups rows where `developer_can_initial_push` is true or false when comparing the condition described by Developer Can Initial Push.
* **Interpretation:** GitLab reports this value on the Default Branch Protection Defaults object returned for Groups; it is interpreted at one Default Branch Protection Defaults record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.description`
Description records group description text. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is description text at one GitLab Group record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `groups.duo_features_enabled`
Duo Features Enabled records whether GitLab Duo features are enabled. It is needed to distinguish Groups rows by the exact GitLab-returned duo features enabled value.
* **Enables:** select Groups rows where `duo_features_enabled` is true or false when comparing the condition described by Duo Features Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.emails_disabled`
Emails Disabled records whether email notifications are disabled for the group. It is needed to distinguish Groups rows by the exact GitLab-returned emails disabled value.
* **Enables:** select Groups rows where `emails_disabled` is true or false when comparing the condition described by Emails Disabled.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.emails_enabled`
Emails Enabled records whether email notifications are enabled for the group. It is needed to distinguish Groups rows by the exact GitLab-returned emails enabled value.
* **Enables:** select Groups rows where `emails_enabled` is true or false when comparing the condition described by Emails Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.enabled_git_access_protocol`
Enabled Git Access Protocol records allowed Git access protocol (ssh, http, or all). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Groups rows with the exact `enabled_git_access_protocol` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.extra_shared_runners_minutes_limit`
Extra Shared Runners Minutes Limit records extra CI/CD minutes limit purchased for the group. It is needed to measure the reported extra shared runners minutes limit for one gitlab group record.
* **Enables:** measure and compare `extra_shared_runners_minutes_limit` per GitLab Group record in minutes.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; its unit or granularity is minutes.
Developer identifier: `groups.file_template_project_id`
File Template Project ID records project ID used for file templates. It is needed to refer to the same file template project across records without relying on display text.
* **Enables:** match `file_template_project_id` to file template project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is an identifier, not a measured quantity.
Developer identifier: `groups.full_name`
Full Name records full human-readable name including parent group names separated by slashes. It is needed to compare the returned full name for individual Groups rows and select rows with a specific `full_name` value.
* **Enables:** locate Groups rows whose returned full name exactly matches `full_name` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row.
Developer identifier: `groups.full_path`
Full Path records full path including parent groups, used for namespace resolution. It is needed to compare the returned full path for individual Groups rows and select rows with a specific `full_path` value.
* **Enables:** trace the full path relationship returned in `full_path` from the GitLab Group row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row.
Developer identifier: `groups.full_path_with_namespace`
Full Path With Namespace records alias for `full_path` including namespace. It is needed to compare the returned full path with namespace for individual Groups rows and select rows with a specific `full_path_with_namespace` value.
* **Enables:** locate Groups rows whose returned full path with namespace exactly matches `full_path_with_namespace` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row.
Developer identifier: `groups.id`
ID records unique numeric identifier for the group. It is needed to distinguish repeated deliveries of the same Groups row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Groups and match repeated rows carrying the same GitLab identifier.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `groups.ip_restriction_ranges`
IP Restriction Ranges records comma-separated list of IP address ranges allowed to access the group. It is needed to preserve the GitLab-reported network address context for the same record.
* **Enables:** correlate `ip_restriction_ranges` with the actor, request, or session on the same GitLab event without treating it as proof of physical presence.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; the value is network address context; this GitLab-reported or configured context does not establish residency or verified physical presence; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `groups.ldap_access`
LDAP Access records minimum LDAP access level for group members. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `ldap_access` access value with the resource, account, or membership represented by the same Groups row.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `groups.ldap_cn`
LDAP Cn records LDAP Common Name linked to this group. It is needed to preserve the exact GitLab-reported business, directory, or identity attribute represented by this field.
* **Enables:** match or segment Groups records by `ldap_cn` only within the same GitLab attribute contract.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; the value is a GitLab-returned or configured label and is not a universal identity or business taxonomy.
Developer identifier: `groups.lfs_enabled`
Lfs Enabled records whether Git Large File Storage is enabled. It is needed to distinguish Groups rows by the exact GitLab-returned lfs enabled value.
* **Enables:** select Groups rows where `lfs_enabled` is true or false when comparing the condition described by Lfs Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.lock_duo_features_enabled`
Lock Duo Features Enabled records whether the Duo features setting is locked. It is needed to distinguish Groups rows by the exact GitLab-returned lock duo features enabled value.
* **Enables:** select Groups rows where `lock_duo_features_enabled` is true or false when comparing the condition described by Lock Duo Features Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.lock_math_rendering_limits_enabled`
Lock Math Rendering Limits Enabled records whether the math rendering limits setting is locked. It is needed to distinguish Groups rows by the exact GitLab-returned lock math rendering limits enabled value.
* **Enables:** select Groups rows where `lock_math_rendering_limits_enabled` is true or false when comparing the condition described by Lock Math Rendering Limits Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.marked_for_deletion_on`
Marked For Deletion On records date when the group was marked for deletion. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Groups records by `marked_for_deletion_on`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; the schema uses the `Temporal.Date` scalar.
Developer identifier: `groups.math_rendering_limits_enabled`
Math Rendering Limits Enabled records whether math rendering limits are enabled. It is needed to distinguish Groups rows by the exact GitLab-returned math rendering limits enabled value.
* **Enables:** select Groups rows where `math_rendering_limits_enabled` is true or false when comparing the condition described by Math Rendering Limits Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.membership_lock`
Membership Lock records whether membership is locked and cannot be changed by non-owners. It is needed to distinguish Groups rows by the exact GitLab-returned membership lock value.
* **Enables:** select Groups rows where `membership_lock` is true or false when comparing the condition described by Membership Lock.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.mentions_disabled`
Mentions Disabled records whether mentions are disabled for the group. It is needed to distinguish Groups rows by the exact GitLab-returned mentions disabled value.
* **Enables:** select Groups rows where `mentions_disabled` is true or false when comparing the condition described by Mentions Disabled.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.name`
Name records human-readable group name. It is needed to compare the returned name for individual Groups rows and select rows with a specific `name` value.
* **Enables:** locate Groups rows whose returned name exactly matches `name` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `groups.parent_id`
Parent ID records ID of the parent group, null if top-level. It is needed to refer to the same parent across records without relying on display text.
* **Enables:** match `parent_id` to parent references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is an identifier, not a measured quantity.
Developer identifier: `groups.path`
Path records URL-friendly path slug for the group. It is needed to compare the returned path for individual Groups rows and select rows with a specific `path` value.
* **Enables:** trace the path relationship returned in `path` from the GitLab Group row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; the schema uses the `Identity.Slug` scalar.
Developer identifier: `groups.prevent_forking_outside_group`
Prevent Forking Outside Group records whether forking projects outside the group is prevented. It is needed to distinguish Groups rows by the exact GitLab-returned prevent forking outside group value.
* **Enables:** select Groups rows where `prevent_forking_outside_group` is true or false when comparing the condition described by Prevent Forking Outside Group.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.prevent_sharing_groups_outside_hierarchy`
Prevent Sharing Groups Outside Hierarchy records whether sharing groups outside the hierarchy is prevented. It is needed to distinguish Groups rows by the exact GitLab-returned prevent sharing groups outside hierarchy value.
* **Enables:** select Groups rows where `prevent_sharing_groups_outside_hierarchy` is true or false when comparing the condition described by Prevent Sharing Groups Outside Hierarchy.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.project_creation_level`
Project Creation Level records who can create projects in this group. It is needed to distinguish Groups rows by the exact GitLab-returned project creation level value.
* **Enables:** separate Groups rows by the exact GitLab-returned `project_creation_level` label when comparing project creation level.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.projects`
Projects records list of projects within the group (when requested). It is needed to preserve the nested projects relationship or details on the parent GitLab Group record.
* **Enables:** expand `projects` to connect the containing GitLab Group row to its returned projects entries.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is one returned collection per containing GitLab Group object.
Developer identifier: `groups.projects.avatar_url`
Avatar URL records URL of the project avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Groups record as provenance.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is link at one Group Project record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `groups.projects.created_at`
Created At records timestamp when the project was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Groups records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is interpreted at one Group Project record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `groups.projects.default_branch`
Default Branch records default branch name. It is needed to distinguish Groups rows by the exact GitLab-returned default branch value.
* **Enables:** separate Groups rows by the exact GitLab-returned `default_branch` label when comparing default branch.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is interpreted at one Group Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.projects.description`
Description records project description. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is description text at one Group Project record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `groups.projects.forks_count`
Forks Count records number of forks. It is needed to measure the GitLab-reported number of forks at one Group Project record per row.
* **Enables:** measure and compare the GitLab-reported number of forks in `forks_count` at one Group Project record per row.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is a GitLab-reported count at one Group Project record per row.
Developer identifier: `groups.projects.http_url_to_repo`
HTTP URL To Repo records HTTP URL for cloning the repository. It is needed to reproduce the returned code or dependency configuration for this Groups record.
* **Enables:** use `http_url_to_repo` to locate the configured source, package, or repository when reproducing the same job or repository setup.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is interpreted at one Group Project record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `groups.projects.id`
ID records unique numeric identifier for the project.
* **Enables:** Match Groups elements carrying the same GitLab `id`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is an identifier, not a measured quantity.
Developer identifier: `groups.projects.last_activity_at`
Last Activity At records timestamp of the last activity on the project. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Groups records by `last_activity_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is interpreted at one Group Project record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `groups.projects.name`
Name records human-readable project name. It is needed to compare the returned name for individual Groups rows and select rows with a specific `name` value.
* **Enables:** locate Groups rows whose returned name exactly matches `name` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is interpreted at one Group Project record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `groups.projects.name_with_namespace`
Name With Namespace records full project name including namespace. It is needed to compare the returned name with namespace for individual Groups rows and select rows with a specific `name_with_namespace` value.
* **Enables:** locate Groups rows whose returned name with namespace exactly matches `name_with_namespace` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is interpreted at one Group Project record per row.
Developer identifier: `groups.projects.namespace`
Namespace records namespace the project belongs to. It is needed to preserve the nested namespace relationship or details on the parent Group Project record.
* **Enables:** expand `namespace` to connect the containing Group Project row to its returned namespace entries.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is one nested object per containing Group Project object when present.
Developer identifier: `groups.projects.namespace.avatar_url`
Avatar URL records URL of the namespace avatar. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Groups record as provenance.
* **Interpretation:** GitLab reports this value on the Project Namespace object returned for Groups; it is link at one Project Namespace record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `groups.projects.namespace.full_path`
Full Path records full namespace path. It is needed to compare the returned full path for individual Groups rows and select rows with a specific `full_path` value.
* **Enables:** trace the full path relationship returned in `full_path` from the Project Namespace row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the Project Namespace object returned for Groups; it is interpreted at one Project Namespace record per row.
Developer identifier: `groups.projects.namespace.id`
ID records namespace ID. It is needed to refer to the same project namespace across records without relying on display text.
* **Enables:** match `id` to project namespace references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Project Namespace object returned for Groups; it is an identifier, not a measured quantity.
Developer identifier: `groups.projects.namespace.kind`
Kind records namespace kind (group or user). It is needed to distinguish Groups rows by the exact GitLab-returned kind value.
* **Enables:** separate Groups rows by the exact GitLab-returned `kind` label when comparing kind.
* **Interpretation:** GitLab reports this value on the Project Namespace object returned for Groups; it is interpreted at one Project Namespace record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.projects.namespace.name`
Name records namespace name. It is needed to compare the returned name for individual Groups rows and select rows with a specific `name` value.
* **Enables:** locate Groups rows whose returned name exactly matches `name` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the Project Namespace object returned for Groups; it is interpreted at one Project Namespace record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `groups.projects.namespace.parent_id`
Parent ID records parent namespace ID. It is needed to refer to the same parent across records without relying on display text.
* **Enables:** match `parent_id` to parent references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Project Namespace object returned for Groups; it is an identifier, not a measured quantity.
Developer identifier: `groups.projects.namespace.path`
Path records namespace path. It is needed to compare the returned path for individual Groups rows and select rows with a specific `path` value.
* **Enables:** trace the path relationship returned in `path` from the Project Namespace row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the Project Namespace object returned for Groups; it is interpreted at one Project Namespace record per row; the schema uses the `Identity.Slug` scalar.
Developer identifier: `groups.projects.namespace.web_url`
Web URL records URL to the namespace page. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Groups record as provenance.
* **Interpretation:** GitLab reports this value on the Project Namespace object returned for Groups; it is link at one Project Namespace record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `groups.projects.path`
Path records URL-friendly path slug for the project. It is needed to compare the returned path for individual Groups rows and select rows with a specific `path` value.
* **Enables:** trace the path relationship returned in `path` from the Group Project row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is interpreted at one Group Project record per row; the schema uses the `Identity.Slug` scalar.
Developer identifier: `groups.projects.path_with_namespace`
Path With Namespace records full path including namespace. It is needed to compare the returned path with namespace for individual Groups rows and select rows with a specific `path_with_namespace` value.
* **Enables:** locate Groups rows whose returned path with namespace exactly matches `path_with_namespace` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is interpreted at one Group Project record per row.
Developer identifier: `groups.projects.readme_url`
Readme URL records URL to the project README file. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `readme_url` while retaining the containing Groups record as provenance.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is link at one Group Project record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `groups.projects.ssh_url_to_repo`
SSH URL To Repo records SSH URL for cloning the repository. It is needed to reproduce the returned code or dependency configuration for this Groups record.
* **Enables:** use `ssh_url_to_repo` to locate the configured source, package, or repository when reproducing the same job or repository setup.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is interpreted at one Group Project record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `groups.projects.star_count`
Star Count records number of stars. It is needed to measure the GitLab-reported number of stars at one Group Project record per row.
* **Enables:** measure and compare the GitLab-reported number of stars in `star_count` at one Group Project record per row.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is a GitLab-reported count at one Group Project record per row.
Developer identifier: `groups.projects.tag_list`
Tag List records deprecated: List of tags. Use topics instead. It is needed to preserve the nested tag list relationship or details on the parent Group Project record.
* **Enables:** expand `tag_list` to connect the containing Group Project row to its returned tag list entries.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is one returned collection per containing Group Project object.
Developer identifier: `groups.projects.topics`
Topics records list of topic tags associated with the project. It is needed to preserve the nested topics relationship or details on the parent Group Project record.
* **Enables:** expand `topics` to connect the containing Group Project row to its returned topics entries.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is one returned collection per containing Group Project object.
Developer identifier: `groups.projects.web_url`
Web URL records URL to the project page in the GitLab web interface. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Groups record as provenance.
* **Interpretation:** GitLab reports this value on the Group Project object returned for Groups; it is link at one Group Project record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `groups.repository_storage`
Repository Storage records name of the repository storage shard. It is needed to inventory the exact GitLab-reported configuration or classification represented by this field.
* **Enables:** compare `repository_storage` among Groups records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; the value is a GitLab-returned or configured label at the GitLab Group grain rather than a universal taxonomy.
Developer identifier: `groups.request_access_enabled`
Request Access Enabled records whether users can request access to the group. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Groups rows with the exact `request_access_enabled` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.require_two_factor_authentication`
Require Two Factor Authentication records whether two-factor authentication is required for group members. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Groups rows with the exact `require_two_factor_authentication` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.runners_token`
Runners Token records token used to register runners for this group. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `runners_token` access value with the resource, account, or membership represented by the same Groups row.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `groups.share_with_group_lock`
Share With Group Lock records whether sharing projects with other groups is locked. It is needed to distinguish Groups rows by the exact GitLab-returned share with group lock value.
* **Enables:** select Groups rows where `share_with_group_lock` is true or false when comparing the condition described by Share With Group Lock.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.shared_projects`
Shared Projects records list of projects shared with this group. It is needed to preserve the nested shared projects relationship or details on the parent GitLab Group record.
* **Enables:** expand `shared_projects` to connect the containing GitLab Group row to its returned shared projects entries.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is one returned collection per containing GitLab Group object.
Developer identifier: `groups.shared_runners_minutes_limit`
Shared Runners Minutes Limit records CI/CD minutes limit for shared runners. It is needed to measure the reported shared runners minutes limit for one gitlab group record.
* **Enables:** measure and compare `shared_runners_minutes_limit` per GitLab Group record in minutes.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; its unit or granularity is minutes.
Developer identifier: `groups.shared_runners_setting`
Shared Runners Setting records shared runners availability setting. It is needed to distinguish Groups rows by the exact GitLab-returned shared runners setting value.
* **Enables:** separate Groups rows by the exact GitLab-returned `shared_runners_setting` label when comparing shared runners setting.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.shared_with_groups`
Shared With Groups records list of groups this group is shared with. It is needed to preserve the explicit GitLab group references attached to this row.
* **Enables:** split the references in `shared_with_groups` and match each returned group identifier to the corresponding GitLab group record when available.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is one returned collection per containing GitLab Group object.
Developer identifier: `groups.shared_with_groups.expires_at`
Expires At records date when the sharing expires. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Groups records by `expires_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Shared Group object returned for Groups; it is interpreted at one Shared Group record per row; the schema uses the `Temporal.Date` scalar.
Developer identifier: `groups.shared_with_groups.group_access_level`
Group Access Level records access level granted to the shared group (e.g., 10=Guest, 20=Reporter, 30=Developer, 40=Maintainer, 50=Owner). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `group_access_level` access value with the resource, account, or membership represented by the same Groups row.
* **Interpretation:** GitLab reports this value on the Shared Group object returned for Groups; it is interpreted at one Shared Group record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `groups.shared_with_groups.group_full_path`
Group Full Path records full path of the shared group. It is needed to compare the returned group full path for individual Groups rows and select rows with a specific `group_full_path` value.
* **Enables:** trace the group full path relationship returned in `group_full_path` from the Shared Group row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the Shared Group object returned for Groups; it is interpreted at one Shared Group record per row.
Developer identifier: `groups.shared_with_groups.group_id`
Group ID records ID of the shared group.
* **Enables:** Match Groups elements carrying the same GitLab `group_id`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** GitLab reports this value on the Shared Group object returned for Groups; it is an identifier, not a measured quantity.
Developer identifier: `groups.shared_with_groups.group_name`
Group Name records name of the shared group. It is needed to compare the returned group name for individual Groups rows and select rows with a specific `group_name` value.
* **Enables:** locate Groups rows whose returned group name exactly matches `group_name` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the Shared Group object returned for Groups; it is interpreted at one Shared Group record per row.
Developer identifier: `groups.statistics`
Statistics records storage and usage statistics for the group. It is needed to preserve the nested statistics relationship or details on the parent GitLab Group record.
* **Enables:** expand `statistics` to connect the containing GitLab Group row to its returned statistics entries.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is one nested object per containing GitLab Group object when present.
Developer identifier: `groups.statistics.job_artifacts_size`
Job Artifacts Size records total job artifacts size in bytes. It is needed to measure the reported job artifacts size for one group statistics record.
* **Enables:** measure and compare `job_artifacts_size` per Group Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the Group Statistics object returned for Groups; its unit or granularity is bytes.
Developer identifier: `groups.statistics.lfs_objects_size`
Lfs Objects Size records total LFS objects size in bytes. It is needed to measure the reported lfs objects size for one group statistics record.
* **Enables:** measure and compare `lfs_objects_size` per Group Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the Group Statistics object returned for Groups; its unit or granularity is bytes.
Developer identifier: `groups.statistics.packages_size`
Packages Size records total packages size in bytes. It is needed to measure the reported packages size for one group statistics record.
* **Enables:** measure and compare `packages_size` per Group Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the Group Statistics object returned for Groups; its unit or granularity is bytes.
Developer identifier: `groups.statistics.pipeline_artifacts_size`
Pipeline Artifacts Size records total pipeline artifacts size in bytes. It is needed to measure the reported pipeline artifacts size for one group statistics record.
* **Enables:** measure and compare `pipeline_artifacts_size` per Group Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the Group Statistics object returned for Groups; its unit or granularity is bytes.
Developer identifier: `groups.statistics.repository_size`
Repository Size records total repository size in bytes. It is needed to measure the reported repository size for one group statistics record.
* **Enables:** measure and compare `repository_size` per Group Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the Group Statistics object returned for Groups; its unit or granularity is bytes.
Developer identifier: `groups.statistics.snippets_size`
Snippets Size records total snippets size in bytes. It is needed to measure the reported snippets size for one group statistics record.
* **Enables:** measure and compare `snippets_size` per Group Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the Group Statistics object returned for Groups; its unit or granularity is bytes.
Developer identifier: `groups.statistics.storage_size`
Storage Size records total storage size in bytes. It is needed to measure the reported storage size for one group statistics record.
* **Enables:** measure and compare `storage_size` per Group Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the Group Statistics object returned for Groups; its unit or granularity is bytes.
Developer identifier: `groups.statistics.uploads_size`
Uploads Size records total uploads size in bytes. It is needed to measure the reported uploads size for one group statistics record.
* **Enables:** measure and compare `uploads_size` per Group Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the Group Statistics object returned for Groups; its unit or granularity is bytes.
Developer identifier: `groups.statistics.wiki_size`
Wiki Size records total wiki size in bytes. It is needed to measure the reported wiki size for one group statistics record.
* **Enables:** measure and compare `wiki_size` per Group Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the Group Statistics object returned for Groups; its unit or granularity is bytes.
Developer identifier: `groups.subgroup_creation_level`
Subgroup Creation Level records who can create subgroups in this group. It is needed to distinguish Groups rows by the exact GitLab-returned subgroup creation level value.
* **Enables:** separate Groups rows by the exact GitLab-returned `subgroup_creation_level` label when comparing subgroup creation level.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.two_factor_grace_period`
Two Factor Grace Period records grace period in hours before 2FA enforcement. It is needed to measure the reported two factor grace period for one gitlab group record.
* **Enables:** measure and compare `two_factor_grace_period` per GitLab Group record in hours.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; its unit or granularity is hours.
Developer identifier: `groups.visibility`
Visibility records group visibility level (private, internal, or public). It is needed to distinguish Groups rows by the exact GitLab-returned visibility value.
* **Enables:** separate Groups rows by the exact GitLab-returned `visibility` label when comparing visibility.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `groups.web_url`
Web URL records URL to the group page in the GitLab web interface. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Groups record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is link at one GitLab Group record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `groups.wiki_access_level`
Wiki Access Level records access level for the group wiki. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Groups rows with the exact `wiki_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Group object returned for Groups; it is interpreted at one GitLab Group record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues`
Issues covers project issues.
* **Enables:** follow each returned issue from its repository or project and issue number through author, assignee, state, and update time.
* **Scope:** Project issues; the connector reads `/api/v4/projects/{id}/issues` as a changelog stream in incremental mode. The configured credential must grant the declared `read_api` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitLab record was deleted.
Developer identifier: `issues._links`
Links records related resource links for the issue. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `_links` while retaining the containing Issues record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is link at one GitLab Issue record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues._links.award_emoji`
Award Emoji records API URL for award emoji on this issue. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `award_emoji` while retaining the containing Issues record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Issue Links object returned for Issues; it is link at one GitLab Issue Links record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues._links.closed_as_duplicate_of`
Closed As Duplicate Of records API URL of the issue this was closed as a duplicate of. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `closed_as_duplicate_of` while retaining the containing Issues record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Issue Links object returned for Issues; it is link at one GitLab Issue Links record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues._links.notes`
Notes records API URL for notes on this issue. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `notes` while retaining the containing Issues record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Issue Links object returned for Issues; it is link at one GitLab Issue Links record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues._links.project`
Project records API URL for the project this issue belongs to. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `project` while retaining the containing Issues record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Issue Links object returned for Issues; it is link at one GitLab Issue Links record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues._links.self`
Self records API URL for this issue. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `self` while retaining the containing Issues record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Issue Links object returned for Issues; it is link at one GitLab Issue Links record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.assignees`
Assignees records array of users assigned to the issue. It is needed to preserve the nested assignees relationship or details on the parent GitLab Issue record.
* **Enables:** expand `assignees` to connect the containing GitLab Issue row to its returned assignees entries.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is one returned collection per containing GitLab Issue object.
Developer identifier: `issues.assignees.avatar_url`
Avatar URL records URL to the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab User Reference object returned for Issues; it is link at one GitLab User Reference record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.assignees.id`
ID records unique numeric user ID. It is needed to distinguish repeated deliveries of the same Issues row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Issues and match repeated rows carrying the same GitLab identifier.
* **Interpretation:** GitLab reports this value on the GitLab User Reference object returned for Issues; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `issues.assignees.locked`
Locked records whether the user account is locked. It is needed to distinguish Issues rows by the exact GitLab-returned locked value.
* **Enables:** select Issues rows where `locked` is true or false when comparing the condition described by Locked.
* **Interpretation:** GitLab reports this value on the GitLab User Reference object returned for Issues; it is interpreted at one GitLab User Reference record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.assignees.name`
Name records display name of the user. It is needed to attribute this Issues row to the returned person, account, or organization reference.
* **Enables:** attribute the Issues row to the returned person or account and match the exact `name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab User Reference object returned for Issues; it is interpreted at one GitLab User Reference record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `issues.assignees.public_email`
Public Email records public email address of the user, enriched by the ingestion service via the GitLab Users API. Absent when the user has no public email set or when the enrichment call is suppressed (e.g. rate-limited backfills). Silver layers must treat this field as optional. It is needed to distinguish Issues rows by the exact GitLab-returned public email value.
* **Enables:** separate Issues rows by the exact GitLab-returned `public_email` label when comparing public email.
* **Interpretation:** GitLab reports this value on the GitLab User Reference object returned for Issues; it is interpreted at one GitLab User Reference record per row; the schema uses the `Contact.Email` scalar; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.assignees.state`
State records user account state (e.g., active, blocked). It is needed to distinguish Issues rows by the exact GitLab-returned state value.
* **Enables:** separate Issues rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the GitLab User Reference object returned for Issues; it is interpreted at one GitLab User Reference record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.assignees.username`
User Name records GitLab username. It is needed to attribute this Issues row to the returned person, account, or organization reference.
* **Enables:** attribute the Issues row to the returned person or account and match the exact `username` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab User Reference object returned for Issues; it is interpreted at one GitLab User Reference record per row.
Developer identifier: `issues.assignees.web_url`
Web URL records URL to the user's GitLab profile. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab User Reference object returned for Issues; it is link at one GitLab User Reference record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.author`
Author records user who created the issue. It is needed to preserve the nested author relationship or details on the parent GitLab Issue record.
* **Enables:** expand `author` to connect the containing GitLab Issue row to its returned author entries.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is one nested object per containing GitLab Issue object when present.
Developer identifier: `issues.blocking_issues_count`
Blocking Issues Count records number of issues this issue is blocking. It is needed to measure the GitLab-reported number of issues this issue is blocking at one GitLab Issue record per row.
* **Enables:** measure and compare the GitLab-reported number of issues this issue is blocking in `blocking_issues_count` at one GitLab Issue record per row.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is a GitLab-reported count at one GitLab Issue record per row.
Developer identifier: `issues.closed_at`
Closed At records timestamp when the issue was closed. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `closed_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.closed_by`
Closed By records user who closed the issue. It is needed to preserve the nested closed by relationship or details on the parent GitLab Issue record.
* **Enables:** expand `closed_by` to connect the containing GitLab Issue row to its returned closed by entries.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is one nested object per containing GitLab Issue object when present.
Developer identifier: `issues.confidential`
Confidential records whether the issue is confidential. It is needed to distinguish Issues rows by the exact GitLab-returned confidential value.
* **Enables:** select Issues rows where `confidential` is true or false when comparing the condition described by Confidential.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.created_at`
Created At records timestamp when the issue was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.description`
Description records full issue description in Markdown. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is description text at one GitLab Issue record per row; the schema uses the `Text.Markdown` scalar; this is only the content included in the GitLab response for this record.
Developer identifier: `issues.discussion_locked`
Discussion Locked records whether discussion on the issue is locked. It is needed to distinguish Issues rows by the exact GitLab-returned discussion locked value.
* **Enables:** select Issues rows where `discussion_locked` is true or false when comparing the condition described by Discussion Locked.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.downvotes`
Downvotes records number of downvotes (thumbs down) on the issue. It is needed to measure the GitLab-reported number of downvotes (thumbs down) on the issue at one GitLab Issue record per row.
* **Enables:** measure and compare the GitLab-reported number of downvotes (thumbs down) on the issue in `downvotes` at one GitLab Issue record per row.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is a GitLab-reported count at one GitLab Issue record per row.
Developer identifier: `issues.due_date`
Due Date records due date for the issue in YYYY-MM-DD format. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `due_date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; the schema uses the `Temporal.Date` scalar.
Developer identifier: `issues.epic`
Epic records epic this issue belongs to. It is needed to preserve the nested epic relationship or details on the parent GitLab Issue record.
* **Enables:** expand `epic` to connect the containing GitLab Issue row to its returned epic entries.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is one nested object per containing GitLab Issue object when present.
Developer identifier: `issues.epic.group_id`
Group ID records ID of the group this epic belongs to. It is needed to refer to the same group across records without relying on display text.
* **Enables:** match `group_id` to group references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Epic Reference object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.epic.id`
ID records unique global numeric identifier for the epic. It is needed to refer to the same epic reference across records without relying on display text.
* **Enables:** match `id` to epic reference references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Epic Reference object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.epic.iid`
Iid records group-scoped epic number. It is needed to refer to the same iid across records without relying on display text.
* **Enables:** match `iid` to iid references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Epic Reference object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.epic.title`
Title records epic title. It is needed to inspect the exact title text included with this record.
* **Enables:** inspect the title text returned in `title` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Epic Reference object returned for Issues; it is title text at one GitLab Epic Reference record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `issues.epic.url`
URL records URL to view the epic in the GitLab web UI. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Epic Reference object returned for Issues; it is link at one GitLab Epic Reference record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.epic_iid`
Epic Iid records IID of the epic this issue belongs to. It is needed to refer to the same epic iid across records without relying on display text.
* **Enables:** match `epic_iid` to epic iid references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.has_tasks`
Has Tasks records whether the issue description contains task list items. It is needed to distinguish Issues rows by the exact GitLab-returned has tasks value.
* **Enables:** select Issues rows where `has_tasks` is true or false when comparing the condition described by Has Tasks.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.health_status`
Health Status records health status of the issue (`on_track`, `needs_attention`, `at_risk`). It is needed to distinguish Issues rows by the exact GitLab-returned health status value.
* **Enables:** separate Issues rows by the exact GitLab-returned `health_status` label when comparing health status.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.id`
ID records unique global numeric identifier for the issue. It is needed to distinguish repeated deliveries of the same Issues row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Issues and match repeated rows carrying the same GitLab identifier.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `issues.iid`
Iid records project-scoped issue number. It is needed to refer to the same iid across records without relying on display text.
* **Enables:** match `iid` to iid references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.imported`
Imported records whether this issue was imported from an external source. It is needed to distinguish Issues rows by the exact GitLab-returned imported value.
* **Enables:** select Issues rows where `imported` is true or false when comparing the condition described by Imported.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.imported_from`
Imported From records the source from which this issue was imported, if applicable. It is needed to inventory the exact GitLab-reported configuration or classification represented by this field.
* **Enables:** compare `imported_from` among Issues records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; the value is a GitLab-returned or configured label at the GitLab Issue grain rather than a universal taxonomy.
Developer identifier: `issues.issue_type`
Issue Type records type classification of the issue. It is needed to distinguish Issues rows by the exact GitLab-returned issue type value.
* **Enables:** separate Issues rows by the exact GitLab-returned `issue_type` label when comparing issue type.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.iteration`
Iteration records iteration this issue is assigned to. It is needed to preserve the nested iteration relationship or details on the parent GitLab Issue record.
* **Enables:** expand `iteration` to connect the containing GitLab Issue row to its returned iteration entries.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is one nested object per containing GitLab Issue object when present.
Developer identifier: `issues.iteration.created_at`
Created At records timestamp when the iteration was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Iteration object returned for Issues; it is interpreted at one GitLab Iteration record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.iteration.description`
Description records iteration description. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Iteration object returned for Issues; it is description text at one GitLab Iteration record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `issues.iteration.due_date`
Due Date records due date of the iteration. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `due_date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Iteration object returned for Issues; it is interpreted at one GitLab Iteration record per row; the schema uses the `Temporal.Date` scalar.
Developer identifier: `issues.iteration.group_id`
Group ID records ID of the group this iteration belongs to. It is needed to refer to the same group across records without relying on display text.
* **Enables:** match `group_id` to group references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Iteration object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.iteration.id`
ID records unique global numeric identifier for the iteration. It is needed to refer to the same iteration across records without relying on display text.
* **Enables:** match `id` to iteration references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Iteration object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.iteration.iid`
Iid records group-scoped iteration number. It is needed to refer to the same iid across records without relying on display text.
* **Enables:** match `iid` to iid references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Iteration object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.iteration.sequence`
Sequence records sequence number of the iteration. It is needed to measure the GitLab-reported number of sequence at one GitLab Iteration record per row.
* **Enables:** measure and compare the GitLab-reported number of sequence in `sequence` at one GitLab Iteration record per row.
* **Interpretation:** GitLab reports this value on the GitLab Iteration object returned for Issues; it is a GitLab-reported count at one GitLab Iteration record per row.
Developer identifier: `issues.iteration.start_date`
Start Date records start date of the iteration. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `start_date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Iteration object returned for Issues; it is interpreted at one GitLab Iteration record per row; the schema uses the `Temporal.Date` scalar.
Developer identifier: `issues.iteration.state`
State records iteration state as numeric value. It is needed to distinguish Issues rows by the exact GitLab-returned state value.
* **Enables:** separate Issues rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the GitLab Iteration object returned for Issues; it is interpreted at one GitLab Iteration record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.iteration.title`
Title records iteration title. It is needed to inspect the exact title text included with this record.
* **Enables:** inspect the title text returned in `title` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Iteration object returned for Issues; it is title text at one GitLab Iteration record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `issues.iteration.updated_at`
Updated At records timestamp when the iteration was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Iteration object returned for Issues; it is interpreted at one GitLab Iteration record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.iteration.web_url`
Web URL records URL to view the iteration in the GitLab web UI. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Iteration object returned for Issues; it is link at one GitLab Iteration record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.labels`
Labels records array of label names applied to the issue. It is needed to preserve the nested labels relationship or details on the parent GitLab Issue record.
* **Enables:** expand `labels` to connect the containing GitLab Issue row to its returned labels entries.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is one returned collection per containing GitLab Issue object.
Developer identifier: `issues.merge_requests_count`
Merge Requests Count records number of merge requests related to this issue. It is needed to measure the GitLab-reported number of merge requests related to this issue at one GitLab Issue record per row.
* **Enables:** measure and compare the GitLab-reported number of merge requests related to this issue in `merge_requests_count` at one GitLab Issue record per row.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is a GitLab-reported count at one GitLab Issue record per row.
Developer identifier: `issues.milestone`
Milestone records milestone the issue is assigned to. It is needed to preserve the nested milestone relationship or details on the parent GitLab Issue record.
* **Enables:** expand `milestone` to connect the containing GitLab Issue row to its returned milestone entries.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is one nested object per containing GitLab Issue object when present.
Developer identifier: `issues.milestone.created_at`
Created At records timestamp when the milestone was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Milestone object returned for Issues; it is interpreted at one GitLab Milestone record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.milestone.description`
Description records milestone description. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Milestone object returned for Issues; it is description text at one GitLab Milestone record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `issues.milestone.due_date`
Due Date records due date for the milestone. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `due_date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Milestone object returned for Issues; it is interpreted at one GitLab Milestone record per row; the schema uses the `Temporal.Date` scalar.
Developer identifier: `issues.milestone.expired`
Expired records whether the milestone is past its due date. It is needed to distinguish Issues rows by the exact GitLab-returned expired value.
* **Enables:** select Issues rows where `expired` is true or false when comparing the condition described by Expired.
* **Interpretation:** GitLab reports this value on the GitLab Milestone object returned for Issues; it is interpreted at one GitLab Milestone record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.milestone.group_id`
Group ID records ID of the group this milestone belongs to (for group milestones). It is needed to refer to the same group across records without relying on display text.
* **Enables:** match `group_id` to group references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Milestone object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.milestone.id`
ID records unique global numeric identifier for the milestone. It is needed to refer to the same milestone across records without relying on display text.
* **Enables:** match `id` to milestone references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Milestone object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.milestone.iid`
Iid records project-scoped milestone number. It is needed to refer to the same iid across records without relying on display text.
* **Enables:** match `iid` to iid references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Milestone object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.milestone.project_id`
Project ID records ID of the project this milestone belongs to. It is needed to refer to the same project across records without relying on display text.
* **Enables:** match `project_id` to project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Milestone object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.milestone.start_date`
Start Date records start date for the milestone. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `start_date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Milestone object returned for Issues; it is interpreted at one GitLab Milestone record per row; the schema uses the `Temporal.Date` scalar.
Developer identifier: `issues.milestone.state`
State records milestone state (active or closed). It is needed to distinguish Issues rows by the exact GitLab-returned state value.
* **Enables:** separate Issues rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the GitLab Milestone object returned for Issues; it is interpreted at one GitLab Milestone record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.milestone.title`
Title records milestone title. It is needed to inspect the exact title text included with this record.
* **Enables:** inspect the title text returned in `title` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Milestone object returned for Issues; it is title text at one GitLab Milestone record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `issues.milestone.updated_at`
Updated At records timestamp when the milestone was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Milestone object returned for Issues; it is interpreted at one GitLab Milestone record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.milestone.web_url`
Web URL records URL to view the milestone in the GitLab web UI. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Milestone object returned for Issues; it is link at one GitLab Milestone record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.moved_to_id`
Moved To ID records ID of the issue this was moved to, if moved. It is needed to refer to the same moved to across records without relying on display text.
* **Enables:** match `moved_to_id` to moved to references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.project_id`
Project ID records ID of the project this issue belongs to. It is needed to refer to the same project across records without relying on display text.
* **Enables:** match `project_id` to project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is an identifier, not a measured quantity.
Developer identifier: `issues.references`
References records short and full reference strings for the issue. It is needed to preserve the nested references relationship or details on the parent GitLab Issue record.
* **Enables:** expand `references` to connect the containing GitLab Issue row to its returned references entries.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is one nested object per containing GitLab Issue object when present.
Developer identifier: `issues.references.full`
Full records full reference including project path (e.g., group/project#123). It is needed to compare the returned full for individual Issues rows and select rows with a specific `full` value.
* **Enables:** trace the full relationship returned in `full` from the GitLab References row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the GitLab References object returned for Issues; it is interpreted at one GitLab References record per row.
Developer identifier: `issues.references.relative`
Relative records relative reference within the project. It is needed to link the row to the exact GitLab branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `relative` to the returned branch, tag, commit SHA, or work-item reference on related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab References object returned for Issues; it is interpreted at one GitLab References record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `issues.references.short`
Short records short reference (e.g., #123). It is needed to link the row to the exact GitLab branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `short` to the returned branch, tag, commit SHA, or work-item reference on related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab References object returned for Issues; it is interpreted at one GitLab References record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `issues.service_desk_reply_to`
Service Desk Reply To records email address for service desk replies. It is needed to attribute this Issues row to the returned person, account, or organization reference.
* **Enables:** attribute the Issues row to the returned person or account and match the exact `service_desk_reply_to` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `issues.severity`
Severity records severity level for incident-type issues. It is needed to distinguish Issues rows by the exact GitLab-returned severity value.
* **Enables:** separate Issues rows by the exact GitLab-returned `severity` label when comparing severity.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.state`
State records issue state (opened or closed). It is needed to distinguish Issues rows by the exact GitLab-returned state value.
* **Enables:** separate Issues rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.task_completion_status`
Task Completion Status records completion status of tasks within the issue description. It is needed to preserve the nested task completion status relationship or details on the parent GitLab Issue record.
* **Enables:** expand `task_completion_status` to connect the containing GitLab Issue row to its returned task completion status entries.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is one nested object per containing GitLab Issue object when present.
Developer identifier: `issues.task_completion_status.completed_count`
Completed Count records number of completed tasks. It is needed to measure the GitLab-reported number of completed tasks at one GitLab Task Completion Status record per row.
* **Enables:** measure and compare the GitLab-reported number of completed tasks in `completed_count` at one GitLab Task Completion Status record per row.
* **Interpretation:** GitLab reports this value on the GitLab Task Completion Status object returned for Issues; it is a GitLab-reported count at one GitLab Task Completion Status record per row.
Developer identifier: `issues.task_completion_status.count`
Count records total number of tasks. It is needed to measure the GitLab-reported number of tasks at one GitLab Task Completion Status record per row.
* **Enables:** measure and compare the GitLab-reported number of tasks in `count` at one GitLab Task Completion Status record per row.
* **Interpretation:** GitLab reports this value on the GitLab Task Completion Status object returned for Issues; it is a GitLab-reported count at one GitLab Task Completion Status record per row.
Developer identifier: `issues.task_status`
Task Status records human-readable task completion status string. It is needed to distinguish Issues rows by the exact GitLab-returned task status value.
* **Enables:** separate Issues rows by the exact GitLab-returned `task_status` label when comparing task status.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.time_stats`
Time Stats records time tracking statistics for the issue. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `time_stats`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is one nested object per containing GitLab Issue object when present.
Developer identifier: `issues.time_stats.human_time_estimate`
Human Time Estimate records human-readable time estimate string. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `human_time_estimate`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Time Stats object returned for Issues; it is interpreted at one GitLab Time Stats record per row.
Developer identifier: `issues.time_stats.human_total_time_spent`
Human Total Time Spent records human-readable total time spent string. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `human_total_time_spent`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Time Stats object returned for Issues; it is interpreted at one GitLab Time Stats record per row.
Developer identifier: `issues.time_stats.time_estimate`
Time Estimate records estimated time in seconds. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `time_estimate`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Time Stats object returned for Issues; its unit or granularity is seconds.
Developer identifier: `issues.time_stats.total_time_spent`
Total Time Spent records total time spent in seconds. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `total_time_spent`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Time Stats object returned for Issues; its unit or granularity is seconds.
Developer identifier: `issues.title`
Title records issue title. It is needed to inspect the exact title text included with this record.
* **Enables:** inspect the title text returned in `title` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is title text at one GitLab Issue record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `issues.type`
Type records issue type (e.g., issue, incident, `test_case`, task). It is needed to distinguish Issues rows by the exact GitLab-returned type value.
* **Enables:** separate Issues rows by the exact GitLab-returned `type` label when comparing type.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `issues.updated_at`
Updated At records timestamp when the issue was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Issues records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `issues.upvotes`
Upvotes records number of upvotes (thumbs up) on the issue. It is needed to measure the GitLab-reported number of upvotes (thumbs up) on the issue at one GitLab Issue record per row.
* **Enables:** measure and compare the GitLab-reported number of upvotes (thumbs up) on the issue in `upvotes` at one GitLab Issue record per row.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is a GitLab-reported count at one GitLab Issue record per row.
Developer identifier: `issues.user_notes_count`
User Notes Count records number of user-created notes (comments) on the issue. It is needed to measure the GitLab-reported number of user-created notes (comments) on the issue at one GitLab Issue record per row.
* **Enables:** measure and compare the GitLab-reported number of user-created notes (comments) on the issue in `user_notes_count` at one GitLab Issue record per row.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is a GitLab-reported count at one GitLab Issue record per row.
Developer identifier: `issues.web_url`
Web URL records URL to view the issue in the GitLab web UI. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Issues record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is link at one GitLab Issue record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `issues.weight`
Weight records issue weight (effort estimate). It is needed to compare the numeric weight reported for one GitLab Issue record without assuming an unstated unit.
* **Enables:** compare the numeric `weight` value per GitLab Issue record without assigning a unit not declared by the schema description.
* **Interpretation:** GitLab reports this value on the GitLab Issue object returned for Issues; it is interpreted at one GitLab Issue record per row.
Developer identifier: `merge_request_notes`
Merge Request Notes covers notes (comments) on merge requests.
* **Enables:** attribute each returned review comment or note to its work item, author, file or diff position, and time where those fields are present.
* **Scope:** Notes (comments) on merge requests; the connector reads `/api/v4/projects/{project_id}/merge_requests/{iid}/notes` as a changelog stream in incremental mode. The configured credential must grant the declared `read_api` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitLab record was deleted.
Developer identifier: `merge_request_notes.attachment`
Attachment records the filename of an attachment on the note, if any. It is needed to inspect the exact attachment filename returned for this GitLab Merge Request Note record.
* **Enables:** attribute the attachment filename in `attachment` to the containing Merge Request Notes identifier, owner or author, status, and update time where returned.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; this is only the attachment filename included in the GitLab response for this record.
Developer identifier: `merge_request_notes.author`
Author records the user who authored the note. It is needed to preserve the nested author relationship or details on the parent GitLab Merge Request Note record.
* **Enables:** expand `author` to connect the containing GitLab Merge Request Note row to its returned author entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is one nested object per containing GitLab Merge Request Note object when present.
Developer identifier: `merge_request_notes.author.avatar_url`
Avatar URL records URL to the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Merge Request Notes record as provenance.
* **Interpretation:** GitLab reports this value on the Note Author object returned for Merge Request Notes; it is link at one Note Author record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `merge_request_notes.author.email`
Email records the email address of the user (may be empty if private). It is needed to attribute this Merge Request Notes row to the returned person, account, or organization reference.
* **Enables:** attribute the Merge Request Notes row to the returned person or account and match the exact `email` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the Note Author object returned for Merge Request Notes; it is interpreted at one Note Author record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `merge_request_notes.author.id`
ID records unique identifier of the user. It is needed to refer to the same note author across records without relying on display text.
* **Enables:** match `id` to note author references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Note Author object returned for Merge Request Notes; it is an identifier, not a measured quantity.
Developer identifier: `merge_request_notes.author.locked`
Locked records whether the user account is locked. It is needed to distinguish Merge Request Notes rows by the exact GitLab-returned locked value.
* **Enables:** select Merge Request Notes rows where `locked` is true or false when comparing the condition described by Locked.
* **Interpretation:** GitLab reports this value on the Note Author object returned for Merge Request Notes; it is interpreted at one Note Author record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.author.name`
Name records the display name of the user. It is needed to attribute this Merge Request Notes row to the returned person, account, or organization reference.
* **Enables:** attribute the Merge Request Notes row to the returned person or account and match the exact `name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the Note Author object returned for Merge Request Notes; it is interpreted at one Note Author record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `merge_request_notes.author.public_email`
Public Email records public email address, enriched by the ingestion service via the GitLab Users API. Absent when the user has no public email set or when enrichment is suppressed (e.g. rate-limited backfills). Silver layers must treat this field as optional. It is needed to distinguish Merge Request Notes rows by the exact GitLab-returned public email value.
* **Enables:** separate Merge Request Notes rows by the exact GitLab-returned `public_email` label when comparing public email.
* **Interpretation:** GitLab reports this value on the Note Author object returned for Merge Request Notes; it is interpreted at one Note Author record per row; the schema uses the `Contact.Email` scalar; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.author.state`
State records the current state of the user account. It is needed to distinguish Merge Request Notes rows by the exact GitLab-returned state value.
* **Enables:** separate Merge Request Notes rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the Note Author object returned for Merge Request Notes; it is interpreted at one Note Author record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.author.username`
User Name records the username/handle of the user. It is needed to attribute this Merge Request Notes row to the returned person, account, or organization reference.
* **Enables:** attribute the Merge Request Notes row to the returned person or account and match the exact `username` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the Note Author object returned for Merge Request Notes; it is interpreted at one Note Author record per row.
Developer identifier: `merge_request_notes.author.web_url`
Web URL records URL to the user's GitLab profile page. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Merge Request Notes record as provenance.
* **Interpretation:** GitLab reports this value on the Note Author object returned for Merge Request Notes; it is link at one Note Author record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `merge_request_notes.body`
Body records the text content of the note/comment. It is needed to inspect the exact comment body included with this record.
* **Enables:** inspect the comment body returned in `body` and attribute it to the same record's repository or project, revision, file path, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is comment body at one GitLab Merge Request Note record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `merge_request_notes.change_position`
Change Position records updated position information if the diff has changed since the note was created. It is needed to preserve the nested change position relationship or details on the parent GitLab Merge Request Note record.
* **Enables:** expand `change_position` to connect the containing GitLab Merge Request Note row to its returned change position entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is one nested object per containing GitLab Merge Request Note object when present.
Developer identifier: `merge_request_notes.change_position.base_sha`
Base Sha records the base commit SHA of the diff. It is needed to refer to the same base across records without relying on display text.
* **Enables:** match `base_sha` to base references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Diff Position object returned for Merge Request Notes; it is an identifier, not a measured quantity.
Developer identifier: `merge_request_notes.change_position.head_sha`
Head Sha records the head commit SHA of the diff. It is needed to refer to the same head across records without relying on display text.
* **Enables:** match `head_sha` to head references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Diff Position object returned for Merge Request Notes; it is an identifier, not a measured quantity.
Developer identifier: `merge_request_notes.change_position.height`
Height records height of the image, for image diff notes. It is needed to compare the numeric height reported for one Diff Position record without assuming an unstated unit.
* **Enables:** compare the numeric `height` value per Diff Position record without assigning a unit not declared by the schema description.
* **Interpretation:** GitLab reports this value on the Diff Position object returned for Merge Request Notes; it is interpreted at one Diff Position record per row.
Developer identifier: `merge_request_notes.change_position.line_range`
Line Range records the range of lines this note covers, for multi-line diff notes. It is needed to preserve the nested line range relationship or details on the parent Diff Position record.
* **Enables:** expand `line_range` to connect the containing Diff Position row to its returned line range entries.
* **Interpretation:** GitLab reports this value on the Diff Position object returned for Merge Request Notes; it is one nested object per containing Diff Position object when present.
Developer identifier: `merge_request_notes.change_position.line_range.end`
End records the end position of the line range. It is needed to preserve the nested end relationship or details on the parent Line Range record.
* **Enables:** expand `end` to connect the containing Line Range row to its returned end entries.
* **Interpretation:** GitLab reports this value on the Line Range object returned for Merge Request Notes; it is one nested object per containing Line Range object when present.
Developer identifier: `merge_request_notes.change_position.line_range.end.line_code`
Line Code records the internal line code identifier. It is needed to refer to the same line code across records without relying on display text.
* **Enables:** match `line_code` to line code references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Line Position object returned for Merge Request Notes; it is an identifier, not a measured quantity; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.change_position.line_range.end.new_line`
New Line records the line number in the new version. It is needed to compare the exact new line configuration returned for this Line Position record.
* **Enables:** compare the exact `new_line` configuration returned for each Line Position record and select records with the configuration under review.
* **Interpretation:** GitLab reports this value on the Line Position object returned for Merge Request Notes; it is interpreted at one Line Position record per row.
Developer identifier: `merge_request_notes.change_position.line_range.end.old_line`
Old Line records the line number in the old version. It is needed to compare the exact old line configuration returned for this Line Position record.
* **Enables:** compare the exact `old_line` configuration returned for each Line Position record and select records with the configuration under review.
* **Interpretation:** GitLab reports this value on the Line Position object returned for Merge Request Notes; it is interpreted at one Line Position record per row.
Developer identifier: `merge_request_notes.change_position.line_range.end.type`
Type records the type of line (new or old). It is needed to distinguish Merge Request Notes rows by the exact GitLab-returned type value.
* **Enables:** separate Merge Request Notes rows by the exact GitLab-returned `type` label when comparing type.
* **Interpretation:** GitLab reports this value on the Line Position object returned for Merge Request Notes; it is interpreted at one Line Position record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.change_position.line_range.start`
Start records the start position of the line range. It is needed to preserve the nested start relationship or details on the parent Line Range record.
* **Enables:** expand `start` to connect the containing Line Range row to its returned start entries.
* **Interpretation:** GitLab reports this value on the Line Range object returned for Merge Request Notes; it is one nested object per containing Line Range object when present.
Developer identifier: `merge_request_notes.change_position.new_line`
New Line records the line number in the new version of the file. It is needed to compare the exact new line configuration returned for this Diff Position record.
* **Enables:** compare the exact `new_line` configuration returned for each Diff Position record and select records with the configuration under review.
* **Interpretation:** GitLab reports this value on the Diff Position object returned for Merge Request Notes; it is interpreted at one Diff Position record per row.
Developer identifier: `merge_request_notes.change_position.new_path`
New Path records the file path in the new version of the diff. It is needed to compare the exact new path configuration returned for this Diff Position record.
* **Enables:** compare the exact `new_path` configuration returned for each Diff Position record and select records with the configuration under review.
* **Interpretation:** GitLab reports this value on the Diff Position object returned for Merge Request Notes; it is interpreted at one Diff Position record per row.
Developer identifier: `merge_request_notes.change_position.old_line`
Old Line records the line number in the old version of the file. It is needed to compare the exact old line configuration returned for this Diff Position record.
* **Enables:** compare the exact `old_line` configuration returned for each Diff Position record and select records with the configuration under review.
* **Interpretation:** GitLab reports this value on the Diff Position object returned for Merge Request Notes; it is interpreted at one Diff Position record per row.
Developer identifier: `merge_request_notes.change_position.old_path`
Old Path records the file path in the old version of the diff. It is needed to compare the exact old path configuration returned for this Diff Position record.
* **Enables:** compare the exact `old_path` configuration returned for each Diff Position record and select records with the configuration under review.
* **Interpretation:** GitLab reports this value on the Diff Position object returned for Merge Request Notes; it is interpreted at one Diff Position record per row.
Developer identifier: `merge_request_notes.change_position.position_type`
Position Type records the type of position (e.g., text, image, file). It is needed to distinguish Merge Request Notes rows by the exact GitLab-returned position type value.
* **Enables:** separate Merge Request Notes rows by the exact GitLab-returned `position_type` label when comparing position type.
* **Interpretation:** GitLab reports this value on the Diff Position object returned for Merge Request Notes; it is interpreted at one Diff Position record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.change_position.start_sha`
Start Sha records the start commit SHA of the diff. It is needed to refer to the same start across records without relying on display text.
* **Enables:** match `start_sha` to start references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Diff Position object returned for Merge Request Notes; it is an identifier, not a measured quantity.
Developer identifier: `merge_request_notes.change_position.width`
Width records width of the image, for image diff notes. It is needed to compare the numeric width reported for one Diff Position record without assuming an unstated unit.
* **Enables:** compare the numeric `width` value per Diff Position record without assigning a unit not declared by the schema description.
* **Interpretation:** GitLab reports this value on the Diff Position object returned for Merge Request Notes; it is interpreted at one Diff Position record per row.
Developer identifier: `merge_request_notes.change_position.x`
X Coordinate records x coordinate on the image, for image diff notes. It is needed to measure the reported x coordinate for one diff position record.
* **Enables:** measure and compare `x` per Diff Position record in provider-reported geographic coordinates.
* **Interpretation:** GitLab reports this value on the Diff Position object returned for Merge Request Notes; its unit or granularity is provider-reported geographic coordinates.
Developer identifier: `merge_request_notes.change_position.y`
Y Coordinate records y coordinate on the image, for image diff notes. It is needed to measure the reported y coordinate for one diff position record.
* **Enables:** measure and compare `y` per Diff Position record in provider-reported geographic coordinates.
* **Interpretation:** GitLab reports this value on the Diff Position object returned for Merge Request Notes; its unit or granularity is provider-reported geographic coordinates.
Developer identifier: `merge_request_notes.commands_changes`
Commands Changes records quick action commands that were applied when the note was created. It is needed to preserve the exact GitLab configuration or execution metadata attached to this GitLab Merge Request Note record.
* **Enables:** inspect the keys in `commands_changes` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the GitLab response and can vary by resource type or configuration.
Developer identifier: `merge_request_notes.commit_id`
Commit ID records the commit SHA this diff note references, if applicable. It is needed to refer to the same commit across records without relying on display text.
* **Enables:** match `commit_id` to commit references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is an identifier, not a measured quantity.
Developer identifier: `merge_request_notes.confidential`
Confidential records whether this note is confidential (visible only to project members with Reporter role or above). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Merge Request Notes rows with the exact `confidential` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.created_at`
Created At records when the note was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Request Notes records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `merge_request_notes.id`
ID records unique identifier of the note. It is needed to distinguish repeated deliveries of the same Merge Request Notes row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Merge Request Notes and match repeated rows carrying the same GitLab identifier.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `merge_request_notes.imported`
Imported records whether this note was imported from an external source. It is needed to distinguish Merge Request Notes rows by the exact GitLab-returned imported value.
* **Enables:** select Merge Request Notes rows where `imported` is true or false when comparing the condition described by Imported.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.imported_from`
Imported From records the source from which this note was imported, if applicable. It is needed to inventory the exact GitLab-reported configuration or classification represented by this field.
* **Enables:** compare `imported_from` among Merge Request Notes records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; the value is a GitLab-returned or configured label at the GitLab Merge Request Note grain rather than a universal taxonomy.
Developer identifier: `merge_request_notes.internal`
Internal records whether this note is internal (same as confidential in newer API versions). It is needed to distinguish Merge Request Notes rows by the exact GitLab-returned internal value.
* **Enables:** select Merge Request Notes rows where `internal` is true or false when comparing the condition described by Internal.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.line_type`
Line Type records for diff notes, whether the comment is on an old or new line. It is needed to distinguish Merge Request Notes rows by the exact GitLab-returned line type value.
* **Enables:** separate Merge Request Notes rows by the exact GitLab-returned `line_type` label when comparing line type.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.noteable_id`
Noteable ID records ID of the merge request this note belongs to. It is needed to refer to the same noteable across records without relying on display text.
* **Enables:** match `noteable_id` to noteable references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is an identifier, not a measured quantity.
Developer identifier: `merge_request_notes.noteable_iid`
Noteable Iid records internal ID (IID) of the merge request within the project. It is needed to refer to the same noteable iid across records without relying on display text.
* **Enables:** match `noteable_iid` to noteable iid references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is an identifier, not a measured quantity.
Developer identifier: `merge_request_notes.noteable_type`
Noteable Type records the type of the parent noteable object (e.g., MergeRequest). It is needed to distinguish Merge Request Notes rows by the exact GitLab-returned noteable type value.
* **Enables:** separate Merge Request Notes rows by the exact GitLab-returned `noteable_type` label when comparing noteable type.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.position`
Position records position information for diff notes, indicating the file and line location. It is needed to preserve the nested position relationship or details on the parent GitLab Merge Request Note record.
* **Enables:** expand `position` to connect the containing GitLab Merge Request Note row to its returned position entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is one nested object per containing GitLab Merge Request Note object when present.
Developer identifier: `merge_request_notes.project_id`
Project ID records ID of the project containing the merge request. It is needed to refer to the same project across records without relying on display text.
* **Enables:** match `project_id` to project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab's child response does not supply this field; the connector injects parent context into each child row; it is an identifier, not a measured quantity.
Developer identifier: `merge_request_notes.resolvable`
Resolvable records whether this note is a resolvable discussion thread. It is needed to distinguish Merge Request Notes rows by the exact GitLab-returned resolvable value.
* **Enables:** select Merge Request Notes rows where `resolvable` is true or false when comparing the condition described by Resolvable.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.resolved`
Resolved records whether this resolvable note has been resolved. It is needed to distinguish Merge Request Notes rows by the exact GitLab-returned resolved value.
* **Enables:** select Merge Request Notes rows where `resolved` is true or false when comparing the condition described by Resolved.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.resolved_at`
Resolved At records timestamp when the note was resolved. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Request Notes records by `resolved_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `merge_request_notes.resolved_by`
Resolved By records the user who resolved this note, if resolved. It is needed to preserve the nested resolved by relationship or details on the parent GitLab Merge Request Note record.
* **Enables:** expand `resolved_by` to connect the containing GitLab Merge Request Note row to its returned resolved by entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is one nested object per containing GitLab Merge Request Note object when present.
Developer identifier: `merge_request_notes.suggestions`
Suggestions records inline code suggestions attached to a diff note, enriched by the ingestion service via a follow-up call to the GitLab Notes Suggestions API. Absent on non-diff notes or when enrichment is suppressed. Silver layers must treat this field as optional and JSON-encoded. It is needed to compare the exact suggestions configuration returned for this GitLab Merge Request Note record.
* **Enables:** compare the exact `suggestions` configuration returned for each GitLab Merge Request Note record and select records with the configuration under review.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `merge_request_notes.system`
System records whether this is a system-generated note (e.g., status changes, label additions). It is needed to measure the GitLab-reported number of system at one GitLab Merge Request Note record per row.
* **Enables:** measure and compare the GitLab-reported number of system in `system` at one GitLab Merge Request Note record per row.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is a GitLab-reported count at one GitLab Merge Request Note record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.type`
Type records the type of the note (e.g., DiffNote, DiscussionNote, or null for regular notes). It is needed to distinguish Merge Request Notes rows by the exact GitLab-returned type value.
* **Enables:** separate Merge Request Notes rows by the exact GitLab-returned `type` label when comparing type.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_request_notes.updated_at`
Updated At records when the note was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Request Notes records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request Note object returned for Merge Request Notes; it is interpreted at one GitLab Merge Request Note record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `merge_requests`
Merge Requests covers project merge requests.
* **Enables:** follow each returned code-review request from its repository or project and source revision through reviewer, state, and merge outcome.
* **Scope:** Project merge requests; the connector reads `/api/v4/projects/{id}/merge_requests` as a changelog stream in incremental mode. The configured credential must grant the declared `read_api` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitLab record was deleted.
Developer identifier: `merge_requests.allow_collaboration`
Allow Collaboration records whether collaboration from upstream members is allowed on the source branch. It is needed to distinguish Merge Requests rows by the exact GitLab-returned allow collaboration value.
* **Enables:** select Merge Requests rows where `allow_collaboration` is true or false when comparing the condition described by Allow Collaboration.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.allow_maintainer_to_push`
Allow Maintainer To Push records deprecated alias for `allow_collaboration`. It is needed to distinguish Merge Requests rows by the exact GitLab-returned allow maintainer to push value.
* **Enables:** select Merge Requests rows where `allow_maintainer_to_push` is true or false when comparing the condition described by Allow Maintainer To Push.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.approvals_before_merge`
Approvals Before Merge records number of approvals required before merge (project-level setting override). It is needed to measure the GitLab-reported number of approvals required before merge (project-level setting override) at one GitLab Merge Request record per row.
* **Enables:** measure and compare the GitLab-reported number of approvals required before merge (project-level setting override) in `approvals_before_merge` at one GitLab Merge Request record per row.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is a GitLab-reported count at one GitLab Merge Request record per row.
Developer identifier: `merge_requests.assignees`
Assignees records array of users assigned to review the MR. It is needed to preserve the nested assignees relationship or details on the parent GitLab Merge Request record.
* **Enables:** expand `assignees` to connect the containing GitLab Merge Request row to its returned assignees entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is one returned collection per containing GitLab Merge Request object.
Developer identifier: `merge_requests.assignees.avatar_url`
Avatar URL records URL to the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Merge Requests record as provenance.
* **Interpretation:** GitLab reports this value on the User Reference object returned for Merge Requests; it is link at one User Reference record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `merge_requests.assignees.id`
ID records unique numeric user ID. It is needed to distinguish repeated deliveries of the same Merge Requests row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Merge Requests and match repeated rows carrying the same GitLab identifier.
* **Interpretation:** GitLab reports this value on the User Reference object returned for Merge Requests; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `merge_requests.assignees.locked`
Locked records whether the user account is locked. It is needed to distinguish Merge Requests rows by the exact GitLab-returned locked value.
* **Enables:** select Merge Requests rows where `locked` is true or false when comparing the condition described by Locked.
* **Interpretation:** GitLab reports this value on the User Reference object returned for Merge Requests; it is interpreted at one User Reference record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.assignees.name`
Name records display name of the user. It is needed to attribute this Merge Requests row to the returned person, account, or organization reference.
* **Enables:** attribute the Merge Requests row to the returned person or account and match the exact `name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the User Reference object returned for Merge Requests; it is interpreted at one User Reference record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `merge_requests.assignees.public_email`
Public Email records public email address, enriched by the ingestion service via the GitLab Users API. Absent when the user has no public email set or when enrichment is suppressed (e.g. rate-limited backfills). Silver layers must treat this field as optional. It is needed to distinguish Merge Requests rows by the exact GitLab-returned public email value.
* **Enables:** separate Merge Requests rows by the exact GitLab-returned `public_email` label when comparing public email.
* **Interpretation:** GitLab reports this value on the User Reference object returned for Merge Requests; it is interpreted at one User Reference record per row; the schema uses the `Contact.Email` scalar; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.assignees.state`
State records user account state (e.g., active, blocked). It is needed to distinguish Merge Requests rows by the exact GitLab-returned state value.
* **Enables:** separate Merge Requests rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the User Reference object returned for Merge Requests; it is interpreted at one User Reference record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.assignees.username`
User Name records GitLab username. It is needed to attribute this Merge Requests row to the returned person, account, or organization reference.
* **Enables:** attribute the Merge Requests row to the returned person or account and match the exact `username` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the User Reference object returned for Merge Requests; it is interpreted at one User Reference record per row.
Developer identifier: `merge_requests.assignees.web_url`
Web URL records URL to the user's GitLab profile. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Merge Requests record as provenance.
* **Interpretation:** GitLab reports this value on the User Reference object returned for Merge Requests; it is link at one User Reference record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `merge_requests.author`
Author records user who created the merge request. It is needed to preserve the nested author relationship or details on the parent GitLab Merge Request record.
* **Enables:** expand `author` to connect the containing GitLab Merge Request row to its returned author entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is one nested object per containing GitLab Merge Request object when present.
Developer identifier: `merge_requests.blocking_discussions_resolved`
Blocking Discussions Resolved records whether all blocking discussions have been resolved. It is needed to distinguish Merge Requests rows by the exact GitLab-returned blocking discussions resolved value.
* **Enables:** select Merge Requests rows where `blocking_discussions_resolved` is true or false when comparing the condition described by Blocking Discussions Resolved.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.changes_count`
Changes Count records number of file changes as a string (may be '100+' for large diffs). It is needed to measure the GitLab-reported number of file changes as a string (may be '100+' for large diffs) at one GitLab Merge Request record per row.
* **Enables:** measure and compare the GitLab-reported number of file changes as a string (may be '100+' for large diffs) in `changes_count` at one GitLab Merge Request record per row.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is a GitLab-reported count at one GitLab Merge Request record per row.
Developer identifier: `merge_requests.closed_at`
Closed At records timestamp when the MR was closed, null if not closed. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `closed_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `merge_requests.closed_by`
Closed By records user who closed the MR. It is needed to preserve the nested closed by relationship or details on the parent GitLab Merge Request record.
* **Enables:** expand `closed_by` to connect the containing GitLab Merge Request row to its returned closed by entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is one nested object per containing GitLab Merge Request object when present.
Developer identifier: `merge_requests.closed_by.avatar_url`
Avatar URL records URL to the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Merge Requests record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab User Ref object returned for Merge Requests; it is link at one GitLab User Ref record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `merge_requests.closed_by.id`
ID records unique numeric user ID. It is needed to refer to the same user ref across records without relying on display text.
* **Enables:** match `id` to user ref references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab User Ref object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.closed_by.locked`
Locked records whether the user account is locked. It is needed to distinguish Merge Requests rows by the exact GitLab-returned locked value.
* **Enables:** select Merge Requests rows where `locked` is true or false when comparing the condition described by Locked.
* **Interpretation:** GitLab reports this value on the GitLab User Ref object returned for Merge Requests; it is interpreted at one GitLab User Ref record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.closed_by.name`
Name records display name of the user. It is needed to attribute this Merge Requests row to the returned person, account, or organization reference.
* **Enables:** attribute the Merge Requests row to the returned person or account and match the exact `name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab User Ref object returned for Merge Requests; it is interpreted at one GitLab User Ref record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `merge_requests.closed_by.public_email`
Public Email records public email address returned by GitLab when present. Silver layers must treat this field as optional. It is needed to distinguish Merge Requests rows by the exact GitLab-returned public email value.
* **Enables:** separate Merge Requests rows by the exact GitLab-returned `public_email` label when comparing public email.
* **Interpretation:** GitLab reports this value on the GitLab User Ref object returned for Merge Requests; it is interpreted at one GitLab User Ref record per row; the schema uses the `Contact.Email` scalar; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.closed_by.state`
State records user account state (e.g., active, blocked). It is needed to distinguish Merge Requests rows by the exact GitLab-returned state value.
* **Enables:** separate Merge Requests rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the GitLab User Ref object returned for Merge Requests; it is interpreted at one GitLab User Ref record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.closed_by.username`
User Name records GitLab username. It is needed to attribute this Merge Requests row to the returned person, account, or organization reference.
* **Enables:** attribute the Merge Requests row to the returned person or account and match the exact `username` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab User Ref object returned for Merge Requests; it is interpreted at one GitLab User Ref record per row.
Developer identifier: `merge_requests.closed_by.web_url`
Web URL records URL to the user's GitLab profile. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Merge Requests record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab User Ref object returned for Merge Requests; it is link at one GitLab User Ref record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `merge_requests.created_at`
Created At records timestamp when the MR was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `merge_requests.description`
Description records merge request description body, may contain Markdown. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is description text at one GitLab Merge Request record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `merge_requests.detailed_merge_status`
Detailed Merge Status records detailed merge readiness status with specific blocking reasons. It is needed to distinguish Merge Requests rows by the exact GitLab-returned detailed merge status value.
* **Enables:** separate Merge Requests rows by the exact GitLab-returned `detailed_merge_status` label when comparing detailed merge status.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.diff_refs`
Diff Refs records references to the base, head, and start SHAs for the diff. It is needed to preserve the nested diff refs relationship or details on the parent GitLab Merge Request record.
* **Enables:** expand `diff_refs` to connect the containing GitLab Merge Request row to its returned diff refs entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is one nested object per containing GitLab Merge Request object when present.
Developer identifier: `merge_requests.diff_refs.base_sha`
Base Sha records SHA of the merge base commit. It is needed to refer to the same base across records without relying on display text.
* **Enables:** match `base_sha` to base references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Diff Refs object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.diff_refs.head_sha`
Head Sha records SHA of the head commit of the source branch. It is needed to refer to the same head across records without relying on display text.
* **Enables:** match `head_sha` to head references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Diff Refs object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.diff_refs.start_sha`
Start Sha records SHA of the start commit for the diff. It is needed to refer to the same start across records without relying on display text.
* **Enables:** match `start_sha` to start references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Diff Refs object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.discussion_locked`
Discussion Locked records whether discussions on the MR are locked. It is needed to distinguish Merge Requests rows by the exact GitLab-returned discussion locked value.
* **Enables:** select Merge Requests rows where `discussion_locked` is true or false when comparing the condition described by Discussion Locked.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.downvotes`
Downvotes records number of downvote (thumbs down) reactions. It is needed to measure the GitLab-reported number of downvote (thumbs down) reactions at one GitLab Merge Request record per row.
* **Enables:** measure and compare the GitLab-reported number of downvote (thumbs down) reactions in `downvotes` at one GitLab Merge Request record per row.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is a GitLab-reported count at one GitLab Merge Request record per row.
Developer identifier: `merge_requests.draft`
Draft records whether the merge request is a draft (work in progress). It is needed to distinguish Merge Requests rows by the exact GitLab-returned draft value.
* **Enables:** select Merge Requests rows where `draft` is true or false when comparing the condition described by Draft.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.force_remove_source_branch`
Force Remove Source Branch records whether the source branch will be force-removed after merge. It is needed to distinguish Merge Requests rows by the exact GitLab-returned force remove source branch value.
* **Enables:** select Merge Requests rows where `force_remove_source_branch` is true or false when comparing the condition described by Force Remove Source Branch.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.has_conflicts`
Has Conflicts records whether the MR has merge conflicts. It is needed to distinguish Merge Requests rows by the exact GitLab-returned has conflicts value.
* **Enables:** select Merge Requests rows where `has_conflicts` is true or false when comparing the condition described by Has Conflicts.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.head_pipeline`
Head Pipeline records pipeline running on the head commit of the source branch. It is needed to preserve the nested head pipeline relationship or details on the parent GitLab Merge Request record.
* **Enables:** expand `head_pipeline` to connect the containing GitLab Merge Request row to its returned head pipeline entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is one nested object per containing GitLab Merge Request object when present.
Developer identifier: `merge_requests.head_pipeline.created_at`
Created At records timestamp when the pipeline was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Pipeline Reference object returned for Merge Requests; it is interpreted at one Pipeline Reference record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `merge_requests.head_pipeline.id`
ID records unique pipeline ID. It is needed to refer to the same pipeline reference across records without relying on display text.
* **Enables:** match `id` to pipeline reference references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Pipeline Reference object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.head_pipeline.iid`
Iid records project-scoped pipeline ID. It is needed to refer to the same iid across records without relying on display text.
* **Enables:** match `iid` to iid references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Pipeline Reference object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.head_pipeline.project_id`
Project ID records ID of the project the pipeline belongs to. It is needed to refer to the same project across records without relying on display text.
* **Enables:** match `project_id` to project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Pipeline Reference object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.head_pipeline.ref`
Ref records branch or tag name the pipeline ran on. It is needed to link the row to the exact GitLab branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `ref` to the returned branch, tag, commit SHA, or work-item reference on related GitLab records.
* **Interpretation:** GitLab reports this value on the Pipeline Reference object returned for Merge Requests; it is interpreted at one Pipeline Reference record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `merge_requests.head_pipeline.sha`
Sha records SHA of the commit the pipeline ran on. It is needed to refer to the same pipeline reference across records without relying on display text.
* **Enables:** match `sha` to pipeline reference references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Pipeline Reference object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.head_pipeline.source`
Source records source that triggered the pipeline (e.g., push, `merge_request_event`). It is needed to distinguish Merge Requests rows by the exact GitLab-returned source value.
* **Enables:** separate Merge Requests rows by the exact GitLab-returned `source` label when comparing source.
* **Interpretation:** GitLab reports this value on the Pipeline Reference object returned for Merge Requests; it is interpreted at one Pipeline Reference record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.head_pipeline.status`
Status records pipeline status (e.g., running, pending, success, failed, canceled, skipped). It is needed to distinguish Merge Requests rows by the exact GitLab-returned status value.
* **Enables:** separate Merge Requests rows by the exact GitLab-returned `status` label when comparing status.
* **Interpretation:** GitLab reports this value on the Pipeline Reference object returned for Merge Requests; it is interpreted at one Pipeline Reference record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.head_pipeline.updated_at`
Updated At records timestamp when the pipeline was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Pipeline Reference object returned for Merge Requests; it is interpreted at one Pipeline Reference record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `merge_requests.head_pipeline.web_url`
Web URL records URL to view the pipeline in the GitLab web UI. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Merge Requests record as provenance.
* **Interpretation:** GitLab reports this value on the Pipeline Reference object returned for Merge Requests; it is link at one Pipeline Reference record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `merge_requests.id`
ID records unique global numeric identifier for the merge request. It is needed to distinguish repeated deliveries of the same Merge Requests row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Merge Requests and match repeated rows carrying the same GitLab identifier.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `merge_requests.iid`
Iid records project-scoped merge request number. It is needed to refer to the same iid across records without relying on display text.
* **Enables:** match `iid` to iid references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.imported`
Imported records whether this merge request was imported from an external source. It is needed to distinguish Merge Requests rows by the exact GitLab-returned imported value.
* **Enables:** select Merge Requests rows where `imported` is true or false when comparing the condition described by Imported.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.imported_from`
Imported From records the source from which this merge request was imported, if applicable. It is needed to inventory the exact GitLab-reported configuration or classification represented by this field.
* **Enables:** compare `imported_from` among Merge Requests records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; the value is a GitLab-returned or configured label at the GitLab Merge Request grain rather than a universal taxonomy.
Developer identifier: `merge_requests.labels`
Labels records array of label names applied to the MR. It is needed to preserve the nested labels relationship or details on the parent GitLab Merge Request record.
* **Enables:** expand `labels` to connect the containing GitLab Merge Request row to its returned labels entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is one returned collection per containing GitLab Merge Request object.
Developer identifier: `merge_requests.merge_after`
Merge After records timestamp after which the merge request may be merged (auto-merge scheduling). It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `merge_after`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `merge_requests.merge_commit_sha`
Merge Commit Sha records SHA of the merge commit, null if not yet merged. It is needed to refer to the same merge commit across records without relying on display text.
* **Enables:** match `merge_commit_sha` to merge commit references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.merge_status`
Merge Status records merge readiness status of the MR. It is needed to distinguish Merge Requests rows by the exact GitLab-returned merge status value.
* **Enables:** separate Merge Requests rows by the exact GitLab-returned `merge_status` label when comparing merge status.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.merge_user`
Merge User records user who triggered the merge (may differ from `merged_by` for auto-merge). It is needed to preserve the nested merge user relationship or details on the parent GitLab Merge Request record.
* **Enables:** expand `merge_user` to connect the containing GitLab Merge Request row to its returned merge user entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is one nested object per containing GitLab Merge Request object when present.
Developer identifier: `merge_requests.merge_when_pipeline_succeeds`
Merge When Pipeline Succeeds records whether auto-merge is enabled when the pipeline succeeds. It is needed to distinguish Merge Requests rows by the exact GitLab-returned merge when pipeline succeeds value.
* **Enables:** select Merge Requests rows where `merge_when_pipeline_succeeds` is true or false when comparing the condition described by Merge When Pipeline Succeeds.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.merged_at`
Merged At records timestamp when the MR was merged, null if not yet merged. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `merged_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `merge_requests.merged_by`
Merged By records user who merged the MR. It is needed to preserve the nested merged by relationship or details on the parent GitLab Merge Request record.
* **Enables:** expand `merged_by` to connect the containing GitLab Merge Request row to its returned merged by entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is one nested object per containing GitLab Merge Request object when present.
Developer identifier: `merge_requests.milestone`
Milestone records milestone associated with the MR. It is needed to preserve the nested milestone relationship or details on the parent GitLab Merge Request record.
* **Enables:** expand `milestone` to connect the containing GitLab Merge Request row to its returned milestone entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is one nested object per containing GitLab Merge Request object when present.
Developer identifier: `merge_requests.milestone.created_at`
Created At records timestamp when the milestone was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Milestone object returned for Merge Requests; it is interpreted at one Milestone record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `merge_requests.milestone.description`
Description records milestone description. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the Milestone object returned for Merge Requests; it is description text at one Milestone record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `merge_requests.milestone.due_date`
Due Date records due date for the milestone. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `due_date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Milestone object returned for Merge Requests; it is interpreted at one Milestone record per row; the schema uses the `Temporal.Date` scalar.
Developer identifier: `merge_requests.milestone.expired`
Expired records whether the milestone is past its due date. It is needed to distinguish Merge Requests rows by the exact GitLab-returned expired value.
* **Enables:** select Merge Requests rows where `expired` is true or false when comparing the condition described by Expired.
* **Interpretation:** GitLab reports this value on the Milestone object returned for Merge Requests; it is interpreted at one Milestone record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.milestone.group_id`
Group ID records ID of the group the milestone belongs to (for group milestones). It is needed to refer to the same group across records without relying on display text.
* **Enables:** match `group_id` to group references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Milestone object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.milestone.id`
ID records global milestone ID. It is needed to refer to the same milestone across records without relying on display text.
* **Enables:** match `id` to milestone references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Milestone object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.milestone.iid`
Iid records project-scoped milestone ID. It is needed to refer to the same iid across records without relying on display text.
* **Enables:** match `iid` to iid references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Milestone object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.milestone.project_id`
Project ID records ID of the project the milestone belongs to. It is needed to refer to the same project across records without relying on display text.
* **Enables:** match `project_id` to project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Milestone object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.milestone.start_date`
Start Date records start date for the milestone. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `start_date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Milestone object returned for Merge Requests; it is interpreted at one Milestone record per row; the schema uses the `Temporal.Date` scalar.
Developer identifier: `merge_requests.milestone.state`
State records milestone state (active or closed). It is needed to distinguish Merge Requests rows by the exact GitLab-returned state value.
* **Enables:** separate Merge Requests rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the Milestone object returned for Merge Requests; it is interpreted at one Milestone record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.milestone.title`
Title records milestone title. It is needed to inspect the exact title text included with this record.
* **Enables:** inspect the title text returned in `title` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the Milestone object returned for Merge Requests; it is title text at one Milestone record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `merge_requests.milestone.updated_at`
Updated At records timestamp when the milestone was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Milestone object returned for Merge Requests; it is interpreted at one Milestone record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `merge_requests.milestone.web_url`
Web URL records URL to view the milestone in the GitLab web UI. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Merge Requests record as provenance.
* **Interpretation:** GitLab reports this value on the Milestone object returned for Merge Requests; it is link at one Milestone record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `merge_requests.overflow`
Overflow records whether the diff is too large to display. It is needed to distinguish Merge Requests rows by the exact GitLab-returned overflow value.
* **Enables:** select Merge Requests rows where `overflow` is true or false when comparing the condition described by Overflow.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.pipeline`
Pipeline records latest pipeline associated with the MR. It is needed to preserve the nested pipeline relationship or details on the parent GitLab Merge Request record.
* **Enables:** expand `pipeline` to connect the containing GitLab Merge Request row to its returned pipeline entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is one nested object per containing GitLab Merge Request object when present.
Developer identifier: `merge_requests.prepared_at`
Prepared At records timestamp when the MR was marked as prepared. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `prepared_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `merge_requests.project_id`
Project ID records ID of the project this merge request belongs to. It is needed to refer to the same project across records without relying on display text.
* **Enables:** match `project_id` to project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab's child response does not supply this field; the connector injects parent context into each child row; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.rebase_in_progress`
Rebase In Progress records whether a rebase operation is currently in progress. It is needed to distinguish Merge Requests rows by the exact GitLab-returned rebase in progress value.
* **Enables:** select Merge Requests rows where `rebase_in_progress` is true or false when comparing the condition described by Rebase In Progress.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.reference`
Reference records short reference string for the MR (e.g., !123). It is needed to link the row to the exact GitLab branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `reference` to the returned branch, tag, commit SHA, or work-item reference on related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `merge_requests.references`
References records short and full reference strings for the MR. It is needed to preserve the nested references relationship or details on the parent GitLab Merge Request record.
* **Enables:** expand `references` to connect the containing GitLab Merge Request row to its returned references entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is one nested object per containing GitLab Merge Request object when present.
Developer identifier: `merge_requests.references.full`
Full records full reference including namespace and project path. It is needed to compare the returned full for individual Merge Requests rows and select rows with a specific `full` value.
* **Enables:** trace the full relationship returned in `full` from the References row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the References object returned for Merge Requests; it is interpreted at one References record per row.
Developer identifier: `merge_requests.references.relative`
Relative records relative reference including project path. It is needed to compare the returned relative for individual Merge Requests rows and select rows with a specific `relative` value.
* **Enables:** trace the relative relationship returned in `relative` from the References row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the References object returned for Merge Requests; it is interpreted at one References record per row.
Developer identifier: `merge_requests.references.short`
Short records short reference (e.g., !123). It is needed to link the row to the exact GitLab branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `short` to the returned branch, tag, commit SHA, or work-item reference on related GitLab records.
* **Interpretation:** GitLab reports this value on the References object returned for Merge Requests; it is interpreted at one References record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `merge_requests.reviewers`
Reviewers records array of users designated as reviewers. It is needed to preserve the nested reviewers relationship or details on the parent GitLab Merge Request record.
* **Enables:** expand `reviewers` to connect the containing GitLab Merge Request row to its returned reviewers entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is one returned collection per containing GitLab Merge Request object.
Developer identifier: `merge_requests.sha`
Sha records SHA of the latest commit on the source branch at the head of the MR. It is needed to refer to the same merge request across records without relying on display text.
* **Enables:** match `sha` to merge request references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.should_remove_source_branch`
Should Remove Source Branch records whether the source branch should be deleted after merge. It is needed to distinguish Merge Requests rows by the exact GitLab-returned should remove source branch value.
* **Enables:** select Merge Requests rows where `should_remove_source_branch` is true or false when comparing the condition described by Should Remove Source Branch.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.source_branch`
Source Branch records name of the source branch. It is needed to distinguish Merge Requests rows by the exact GitLab-returned source branch value.
* **Enables:** separate Merge Requests rows by the exact GitLab-returned `source_branch` label when comparing source branch.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.source_project_id`
Source Project ID records ID of the source project (may differ from `project_id` for cross-project MRs). It is needed to refer to the same source project across records without relying on display text.
* **Enables:** match `source_project_id` to source project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is an identifier, not a measured quantity; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.squash`
Squash records whether commits will be squashed on merge. It is needed to distinguish Merge Requests rows by the exact GitLab-returned squash value.
* **Enables:** select Merge Requests rows where `squash` is true or false when comparing the condition described by Squash.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.squash_commit_sha`
Squash Commit Sha records SHA of the squash commit, null if squash was not used. It is needed to refer to the same squash commit across records without relying on display text.
* **Enables:** match `squash_commit_sha` to squash commit references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.squash_on_merge`
Squash On Merge records whether squash on merge is enabled. It is needed to distinguish Merge Requests rows by the exact GitLab-returned squash on merge value.
* **Enables:** select Merge Requests rows where `squash_on_merge` is true or false when comparing the condition described by Squash On Merge.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.state`
State records current state of the merge request. It is needed to distinguish Merge Requests rows by the exact GitLab-returned state value.
* **Enables:** separate Merge Requests rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `merge_requests.target_branch`
Target Branch records name of the target branch. It is needed to link the row to the exact GitLab branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `target_branch` to the returned branch, tag, commit SHA, or work-item reference on related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `merge_requests.target_project_id`
Target Project ID records ID of the target project. It is needed to refer to the same target project across records without relying on display text.
* **Enables:** match `target_project_id` to target project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is an identifier, not a measured quantity.
Developer identifier: `merge_requests.task_completion_status`
Task Completion Status records completion status of tasks/checklists in the MR description. It is needed to preserve the nested task completion status relationship or details on the parent GitLab Merge Request record.
* **Enables:** expand `task_completion_status` to connect the containing GitLab Merge Request row to its returned task completion status entries.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is one nested object per containing GitLab Merge Request object when present.
Developer identifier: `merge_requests.task_completion_status.completed_count`
Completed Count records number of completed tasks. It is needed to measure the GitLab-reported number of completed tasks at one Task Completion Status record per row.
* **Enables:** measure and compare the GitLab-reported number of completed tasks in `completed_count` at one Task Completion Status record per row.
* **Interpretation:** GitLab reports this value on the Task Completion Status object returned for Merge Requests; it is a GitLab-reported count at one Task Completion Status record per row.
Developer identifier: `merge_requests.task_completion_status.count`
Count records total number of tasks. It is needed to measure the GitLab-reported number of tasks at one Task Completion Status record per row.
* **Enables:** measure and compare the GitLab-reported number of tasks in `count` at one Task Completion Status record per row.
* **Interpretation:** GitLab reports this value on the Task Completion Status object returned for Merge Requests; it is a GitLab-reported count at one Task Completion Status record per row.
Developer identifier: `merge_requests.time_stats`
Time Stats records time tracking statistics for the MR. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `time_stats`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is one nested object per containing GitLab Merge Request object when present.
Developer identifier: `merge_requests.time_stats.human_time_estimate`
Human Time Estimate records human-readable estimated time (e.g., '3h 30m'). It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `human_time_estimate`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Time Stats object returned for Merge Requests; it is interpreted at one Time Stats record per row.
Developer identifier: `merge_requests.time_stats.human_total_time_spent`
Human Total Time Spent records human-readable total time spent. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `human_total_time_spent`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Time Stats object returned for Merge Requests; it is interpreted at one Time Stats record per row.
Developer identifier: `merge_requests.time_stats.time_estimate`
Time Estimate records estimated time in seconds. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `time_estimate`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Time Stats object returned for Merge Requests; its unit or granularity is seconds.
Developer identifier: `merge_requests.time_stats.total_time_spent`
Total Time Spent records total time spent in seconds. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `total_time_spent`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Time Stats object returned for Merge Requests; its unit or granularity is seconds.
Developer identifier: `merge_requests.title`
Title records merge request title. It is needed to inspect the exact title text included with this record.
* **Enables:** inspect the title text returned in `title` and attribute it to the same record's repository or project, work-item number, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is title text at one GitLab Merge Request record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `merge_requests.updated_at`
Updated At records timestamp when the MR was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Merge Requests records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `merge_requests.upvotes`
Upvotes records number of upvote (thumbs up) reactions. It is needed to measure the GitLab-reported number of upvote (thumbs up) reactions at one GitLab Merge Request record per row.
* **Enables:** measure and compare the GitLab-reported number of upvote (thumbs up) reactions in `upvotes` at one GitLab Merge Request record per row.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is a GitLab-reported count at one GitLab Merge Request record per row.
Developer identifier: `merge_requests.user_notes_count`
User Notes Count records number of user-created notes (comments) on the MR. It is needed to measure the GitLab-reported number of user-created notes (comments) on the MR at one GitLab Merge Request record per row.
* **Enables:** measure and compare the GitLab-reported number of user-created notes (comments) on the MR in `user_notes_count` at one GitLab Merge Request record per row.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is a GitLab-reported count at one GitLab Merge Request record per row.
Developer identifier: `merge_requests.web_url`
Web URL records URL to view the merge request in the GitLab web UI. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Merge Requests record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is link at one GitLab Merge Request record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `merge_requests.work_in_progress`
Work In Progress records deprecated alias for draft. It is needed to distinguish Merge Requests rows by the exact GitLab-returned work in progress value.
* **Enables:** select Merge Requests rows where `work_in_progress` is true or false when comparing the condition described by Work In Progress.
* **Interpretation:** GitLab reports this value on the GitLab Merge Request object returned for Merge Requests; it is interpreted at one GitLab Merge Request record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines`
Pipelines covers project CI/CD pipelines.
* **Enables:** trace each returned CI/CD pipeline to its project, revision, trigger source, status, user, and timing values.
* **Scope:** Project CI/CD pipelines; the connector reads `/api/v4/projects/{id}/pipelines` as a changelog stream in incremental mode. The configured credential must grant the declared `read_api` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitLab record was deleted.
Developer identifier: `pipelines.before_sha`
Before Sha records SHA of the commit just before the pipeline source commit. It is needed to refer to the same before across records without relying on display text.
* **Enables:** match `before_sha` to before references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is an identifier, not a measured quantity.
Developer identifier: `pipelines.committed_at`
Committed At records timestamp of the commit that triggered the pipeline. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pipelines records by `committed_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is interpreted at one GitLab Pipeline record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pipelines.coverage`
Coverage records code coverage percentage reported by the pipeline. It is needed to measure the code-coverage percentage reported for this pipeline execution.
* **Enables:** compare `coverage` at one pipeline grain while preserving the project, revision, and pipeline identifiers.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; its unit or granularity is percent; the value is a GitLab-reported percentage string and does not by itself establish test quality or change causality.
Developer identifier: `pipelines.created_at`
Created At records timestamp when the pipeline was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pipelines records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is interpreted at one GitLab Pipeline record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pipelines.duration`
Duration records total duration of the pipeline in seconds (wall time from start to finish). It is needed to measure the exact duration reported for one GitLab Pipeline record using the GitLab duration encoding described by the field.
* **Enables:** measure and compare `duration` per GitLab Pipeline record in seconds.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; its unit or granularity is seconds.
Developer identifier: `pipelines.finished_at`
Finished At records timestamp when the pipeline finished. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pipelines records by `finished_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is interpreted at one GitLab Pipeline record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pipelines.id`
ID records unique numeric identifier for the pipeline. It is needed to distinguish repeated deliveries of the same Pipelines row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Pipelines and match repeated rows carrying the same GitLab identifier.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `pipelines.iid`
Iid records project-scoped pipeline number, human-readable reference. It is needed to refer to the same iid across records without relying on display text.
* **Enables:** match `iid` to iid references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is an identifier, not a measured quantity.
Developer identifier: `pipelines.name`
Name records name of the pipeline, if set via workflow:name in CI config. It is needed to compare the exact name configuration returned for this GitLab Pipeline record.
* **Enables:** compare the exact `name` configuration returned for each GitLab Pipeline record and select records with the configuration under review.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is interpreted at one GitLab Pipeline record per row.
Developer identifier: `pipelines.project_id`
Project ID records ID of the project this pipeline belongs to. It is needed to refer to the same project across records without relying on display text.
* **Enables:** match `project_id` to project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is an identifier, not a measured quantity.
Developer identifier: `pipelines.queued_duration`
Queued Duration records total time in seconds the pipeline spent queued before running. It is needed to measure the exact duration reported for one GitLab Pipeline record using the GitLab duration encoding described by the field.
* **Enables:** measure and compare `queued_duration` per GitLab Pipeline record in seconds.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; its unit or granularity is seconds.
Developer identifier: `pipelines.ref`
Ref records branch or tag name that triggered the pipeline. It is needed to link the row to the exact GitLab branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `ref` to the returned branch, tag, commit SHA, or work-item reference on related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is interpreted at one GitLab Pipeline record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `pipelines.sha`
Sha records full commit SHA that triggered the pipeline. It is needed to refer to the same pipeline across records without relying on display text.
* **Enables:** match `sha` to pipeline references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is an identifier, not a measured quantity.
Developer identifier: `pipelines.source`
Source records what triggered the pipeline. It is needed to distinguish Pipelines rows by the exact GitLab-returned source value.
* **Enables:** separate Pipelines rows by the exact GitLab-returned `source` label when comparing source.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is interpreted at one GitLab Pipeline record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.started_at`
Started At records timestamp when the pipeline started running. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pipelines records by `started_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is interpreted at one GitLab Pipeline record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pipelines.status`
Status records current status of the pipeline. It is needed to distinguish Pipelines rows by the exact GitLab-returned status value.
* **Enables:** separate Pipelines rows by the exact GitLab-returned `status` label when comparing status.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is interpreted at one GitLab Pipeline record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.tag`
Tag records whether the pipeline was triggered by a tag. It is needed to distinguish Pipelines rows by the exact GitLab-returned tag value.
* **Enables:** select Pipelines rows where `tag` is true or false when comparing the condition described by Tag.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is interpreted at one GitLab Pipeline record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.updated_at`
Updated At records timestamp when the pipeline was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Pipelines records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is interpreted at one GitLab Pipeline record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `pipelines.user`
User records the user who triggered the pipeline. It is needed to preserve the nested user relationship or details on the parent GitLab Pipeline record.
* **Enables:** expand `user` to connect the containing GitLab Pipeline row to its returned user entries.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is one nested object per containing GitLab Pipeline object when present.
Developer identifier: `pipelines.user.avatar_url`
Avatar URL records URL to the user's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Pipelines record as provenance.
* **Interpretation:** GitLab reports this value on the Pipeline User object returned for Pipelines; it is link at one Pipeline User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pipelines.user.id`
ID records unique numeric identifier of the user. It is needed to refer to the same pipeline user across records without relying on display text.
* **Enables:** match `id` to pipeline user references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Pipeline User object returned for Pipelines; it is an identifier, not a measured quantity.
Developer identifier: `pipelines.user.locked`
Locked records whether the user account is locked. It is needed to distinguish Pipelines rows by the exact GitLab-returned locked value.
* **Enables:** select Pipelines rows where `locked` is true or false when comparing the condition described by Locked.
* **Interpretation:** GitLab reports this value on the Pipeline User object returned for Pipelines; it is interpreted at one Pipeline User record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.user.name`
Name records display name of the user. It is needed to attribute this Pipelines row to the returned person, account, or organization reference.
* **Enables:** attribute the Pipelines row to the returned person or account and match the exact `name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the Pipeline User object returned for Pipelines; it is interpreted at one Pipeline User record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `pipelines.user.state`
State records account state of the user (e.g., active, blocked). It is needed to distinguish Pipelines rows by the exact GitLab-returned state value.
* **Enables:** separate Pipelines rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the Pipeline User object returned for Pipelines; it is interpreted at one Pipeline User record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `pipelines.user.username`
User Name records GitLab username. It is needed to attribute this Pipelines row to the returned person, account, or organization reference.
* **Enables:** attribute the Pipelines row to the returned person or account and match the exact `username` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the Pipeline User object returned for Pipelines; it is interpreted at one Pipeline User record per row.
Developer identifier: `pipelines.user.web_url`
Web URL records URL to the user's GitLab profile page. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Pipelines record as provenance.
* **Interpretation:** GitLab reports this value on the Pipeline User object returned for Pipelines; it is link at one Pipeline User record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pipelines.web_url`
Web URL records URL to view the pipeline in the GitLab web interface. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Pipelines record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is link at one GitLab Pipeline record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `pipelines.yaml_errors`
Yaml Errors records errors found in the CI YAML configuration, if any. It is needed to compare the exact yaml errors configuration returned for this GitLab Pipeline record.
* **Enables:** compare the exact `yaml_errors` configuration returned for each GitLab Pipeline record and select records with the configuration under review.
* **Interpretation:** GitLab reports this value on the GitLab Pipeline object returned for Pipelines; it is interpreted at one GitLab Pipeline record per row.
Developer identifier: `project_commits`
Project Commits covers project repository commits.
* **Enables:** trace each returned revision to its repository or project, author and committer identities, message, and provider-reported commit times.
* **Scope:** Project repository commits; the connector reads `/api/v4/projects/{id}/repository/commits` as an event stream in incremental mode. The configured credential must grant the declared `read_api` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitLab record was deleted.
Developer identifier: `project_commits.author_email`
Author Email records email of the commit author. Used for cross-system identity resolution. It is needed to attribute this Project Commits row to the returned person, account, or organization reference.
* **Enables:** attribute the Project Commits row to the returned person or account and match the exact `author_email` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is interpreted at one GitLab Project Commit record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `project_commits.author_name`
Author Name records name of the commit author as recorded in Git. It is needed to attribute this Project Commits row to the returned person, account, or organization reference.
* **Enables:** attribute the Project Commits row to the returned person or account and match the exact `author_name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is interpreted at one GitLab Project Commit record per row.
Developer identifier: `project_commits.authored_date`
Authored Date records timestamp when the commit was originally authored. Tracks when code was actually written. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Project Commits records by `authored_date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is interpreted at one GitLab Project Commit record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `project_commits.committed_date`
Committed Date records timestamp when the commit was committed. Used as incremental sync cursor and activity timeline signal. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Project Commits records by `committed_date`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is interpreted at one GitLab Project Commit record per row; the connector also declares it for record ordering; the schema assigns the `event_time` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `project_commits.committer_email`
Committer Email records email of the committer. It is needed to attribute this Project Commits row to the returned person, account, or organization reference.
* **Enables:** attribute the Project Commits row to the returned person or account and match the exact `committer_email` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is interpreted at one GitLab Project Commit record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `project_commits.committer_name`
Committer Name records name of the person who committed the code (may differ from author in rebases/cherry-picks). It is needed to attribute this Project Commits row to the returned person, account, or organization reference.
* **Enables:** attribute the Project Commits row to the returned person or account and match the exact `committer_name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is interpreted at one GitLab Project Commit record per row.
Developer identifier: `project_commits.created_at`
Created At records timestamp when the commit record was created in GitLab. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Project Commits records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is interpreted at one GitLab Project Commit record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `project_commits.extended_trailers`
Extended Trailers records extended Git trailers from the commit message, supporting multiple values per key. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `extended_trailers` and attribute it to the same record's repository or project, revision, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is commit message at one GitLab Project Commit record per row; the schema uses the `Generic.JSON` scalar; this is only the content included in the GitLab response for this record.
Developer identifier: `project_commits.id`
ID records full SHA hash of the commit. Primary key for commit-level attribution and cross-referencing. It is needed to distinguish repeated deliveries of the same Project Commits row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Project Commits and match repeated rows carrying the same GitLab identifier.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `project_commits.last_pipeline`
Last Pipeline records summary of the last CI/CD pipeline that ran for this commit. It is needed to preserve the nested last pipeline relationship or details on the parent GitLab Project Commit record.
* **Enables:** expand `last_pipeline` to connect the containing GitLab Project Commit row to its returned last pipeline entries.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is one nested object per containing GitLab Project Commit object when present.
Developer identifier: `project_commits.last_pipeline.created_at`
Created At records timestamp when the pipeline was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Project Commits records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Commit Pipeline object returned for Project Commits; it is interpreted at one Commit Pipeline record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `project_commits.last_pipeline.id`
ID records numeric ID of the pipeline. It is needed to refer to the same commit pipeline across records without relying on display text.
* **Enables:** match `id` to commit pipeline references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Commit Pipeline object returned for Project Commits; it is an identifier, not a measured quantity.
Developer identifier: `project_commits.last_pipeline.ref`
Ref records branch or tag name that triggered the pipeline. It is needed to link the row to the exact GitLab branch, tag, revision, or work-item reference named by this field.
* **Enables:** match `ref` to the returned branch, tag, commit SHA, or work-item reference on related GitLab records.
* **Interpretation:** GitLab reports this value on the Commit Pipeline object returned for Project Commits; it is interpreted at one Commit Pipeline record per row; the value is a provider reference at the containing record grain and may be a name, shorthand, or immutable revision depending on the field description.
Developer identifier: `project_commits.last_pipeline.sha`
Sha records SHA of the commit the pipeline ran against. It is needed to refer to the same commit pipeline across records without relying on display text.
* **Enables:** match `sha` to commit pipeline references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Commit Pipeline object returned for Project Commits; it is an identifier, not a measured quantity.
Developer identifier: `project_commits.last_pipeline.status`
Status records current status of the pipeline. It is needed to distinguish Project Commits rows by the exact GitLab-returned status value.
* **Enables:** separate Project Commits rows by the exact GitLab-returned `status` label when comparing status.
* **Interpretation:** GitLab reports this value on the Commit Pipeline object returned for Project Commits; it is interpreted at one Commit Pipeline record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `project_commits.last_pipeline.updated_at`
Updated At records timestamp when the pipeline was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Project Commits records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the Commit Pipeline object returned for Project Commits; it is interpreted at one Commit Pipeline record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `project_commits.last_pipeline.web_url`
Web URL records URL to view the pipeline in the GitLab web interface. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Project Commits record as provenance.
* **Interpretation:** GitLab reports this value on the Commit Pipeline object returned for Project Commits; it is link at one Commit Pipeline record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `project_commits.message`
Message records full commit message including title and body. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `message` and attribute it to the same record's repository or project, revision, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is commit message at one GitLab Project Commit record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `project_commits.parent_ids`
Parent IDs records array of parent commit SHA hashes. Merge commits will have multiple parents. It is needed to preserve the nested parent i ds relationship or details on the parent GitLab Project Commit record.
* **Enables:** expand `parent_ids` to connect the containing GitLab Project Commit row to its returned parent i ds entries.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is one returned collection per containing GitLab Project Commit object.
Developer identifier: `project_commits.project_id`
Project ID records parent project id injected by the ingestor when iterating per-project (from the (id) path parameter in the `project_commits` endpoint). Not part of the upstream GitLab API response; written into each row at bronze ingestion time. It is needed to refer to the same project across records without relying on display text.
* **Enables:** match `project_id` to project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab's child response does not supply this field; the connector injects parent context into each child row; it is an identifier, not a measured quantity.
Developer identifier: `project_commits.short_id`
Short ID records short SHA hash of the commit, typically 8 characters. Human-readable commit reference. It is needed to refer to the same short across records without relying on display text.
* **Enables:** match `short_id` to short references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is an identifier, not a measured quantity.
Developer identifier: `project_commits.stats`
Stats records diff statistics for the commit including lines added, deleted, and total changes. Only present when `with_stats`=true. It is needed to preserve the nested stats relationship or details on the parent GitLab Project Commit record.
* **Enables:** expand `stats` to connect the containing GitLab Project Commit row to its returned stats entries.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is one nested object per containing GitLab Project Commit object when present.
Developer identifier: `project_commits.stats.additions`
Additions records number of lines added in this commit. Quantifies code contribution volume. It is needed to measure the GitLab-reported number of lines added in this commit. Quantifies code contribution volume at one Commit Stats record per row.
* **Enables:** measure and compare the GitLab-reported number of lines added in this commit. Quantifies code contribution volume in `additions` at one Commit Stats record per row.
* **Interpretation:** GitLab reports this value on the Commit Stats object returned for Project Commits; it is a GitLab-reported count at one Commit Stats record per row.
Developer identifier: `project_commits.stats.deletions`
Deletions records number of lines deleted in this commit. It is needed to measure the GitLab-reported number of lines deleted in this commit at one Commit Stats record per row.
* **Enables:** measure and compare the GitLab-reported number of lines deleted in this commit in `deletions` at one Commit Stats record per row.
* **Interpretation:** GitLab reports this value on the Commit Stats object returned for Project Commits; it is a GitLab-reported count at one Commit Stats record per row.
Developer identifier: `project_commits.stats.total`
Total records total number of lines changed (additions + deletions). It is needed to measure the GitLab-reported number of lines changed (additions + deletions) at one Commit Stats record per row.
* **Enables:** measure and compare the GitLab-reported number of lines changed (additions + deletions) in `total` at one Commit Stats record per row.
* **Interpretation:** GitLab reports this value on the Commit Stats object returned for Project Commits; it is a GitLab-reported count at one Commit Stats record per row.
Developer identifier: `project_commits.status`
Status records status of the latest pipeline associated with this commit, if any. It is needed to distinguish Project Commits rows by the exact GitLab-returned status value.
* **Enables:** separate Project Commits rows by the exact GitLab-returned `status` label when comparing status.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is interpreted at one GitLab Project Commit record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `project_commits.title`
Title records first line of the commit message. Enables commit message analysis for work categorization. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `title` and attribute it to the same record's repository or project, revision, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is commit message at one GitLab Project Commit record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `project_commits.trailers`
Trailers records git trailers parsed from the commit message as key-value pairs (e.g., Signed-off-by, Co-authored-by). It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `trailers` and attribute it to the same record's repository or project, revision, author, and timestamp where returned.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is commit message at one GitLab Project Commit record per row; the schema uses the `Generic.JSON` scalar; this is only the content included in the GitLab response for this record.
Developer identifier: `project_commits.web_url`
Web URL records URL to view the commit in the GitLab web interface. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Project Commits record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project Commit object returned for Project Commits; it is link at one GitLab Project Commit record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `project_members`
Project Members covers members of a project (including inherited members).
* **Enables:** map the GitLab accounts and memberships represented by Project Members records and trace a returned access assignment to its account or group.
* **Scope:** Members of a project (including inherited members); the connector reads `/api/v4/projects/{id}/members/all` as a snapshot stream in full mode. The configured credential must grant the declared `read_api` access scope; records outside that access are not returned. A successful full collection can reveal a previously returned row as absent, but a credential or permission change can produce the same observation.
Developer identifier: `project_members.access_level`
Access Level records permission level granted to the member (10=Guest, 20=Reporter, 30=Developer, 40=Maintainer, 50=Owner). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `access_level` access value with the resource, account, or membership represented by the same Project Members row.
* **Interpretation:** GitLab reports this value on the GitLab Project Member object returned for Project Members; it is interpreted at one GitLab Project Member record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `project_members.avatar_url`
Avatar URL records URL to the member's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Project Members record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project Member object returned for Project Members; it is link at one GitLab Project Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target. A connector directive maps this field to the person's identity photo.
Developer identifier: `project_members.created_at`
Created At records timestamp when the membership was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Project Members records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Project Member object returned for Project Members; it is interpreted at one GitLab Project Member record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `project_members.created_by`
Created By records user who added this member to the project. It is needed to preserve the nested created by relationship or details on the parent GitLab Project Member record.
* **Enables:** expand `created_by` to connect the containing GitLab Project Member row to its returned created by entries.
* **Interpretation:** GitLab reports this value on the GitLab Project Member object returned for Project Members; it is one nested object per containing GitLab Project Member object when present.
Developer identifier: `project_members.created_by.avatar_url`
Avatar URL records URL to the creator's avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Project Members record as provenance.
* **Interpretation:** GitLab reports this value on the Member Created By object returned for Project Members; it is link at one Member Created By record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `project_members.created_by.id`
ID records user ID of the creator. It is needed to refer to the same member created by across records without relying on display text.
* **Enables:** match `id` to member created by references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Member Created By object returned for Project Members; it is an identifier, not a measured quantity.
Developer identifier: `project_members.created_by.name`
Name records display name of the creator. It is needed to attribute this Project Members row to the returned person, account, or organization reference.
* **Enables:** attribute the Project Members row to the returned person or account and match the exact `name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the Member Created By object returned for Project Members; it is interpreted at one Member Created By record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `project_members.created_by.state`
State records account state of the creator. It is needed to distinguish Project Members rows by the exact GitLab-returned state value.
* **Enables:** separate Project Members rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the Member Created By object returned for Project Members; it is interpreted at one Member Created By record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `project_members.created_by.username`
User Name records GitLab username of the creator. It is needed to attribute this Project Members row to the returned person, account, or organization reference.
* **Enables:** attribute the Project Members row to the returned person or account and match the exact `username` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the Member Created By object returned for Project Members; it is interpreted at one Member Created By record per row.
Developer identifier: `project_members.created_by.web_url`
Web URL records URL to the creator's GitLab profile page. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Project Members record as provenance.
* **Interpretation:** GitLab reports this value on the Member Created By object returned for Project Members; it is link at one Member Created By record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `project_members.email`
Email records email address of the member, if visible. It is needed to attribute this Project Members row to the returned person, account, or organization reference.
* **Enables:** attribute the Project Members row to the returned person or account and match the exact `email` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Project Member object returned for Project Members; it is interpreted at one GitLab Project Member record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `project_members.expires_at`
Expires At records membership expiration date if set (YYYY-MM-DD format). It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Project Members records by `expires_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Project Member object returned for Project Members; it is interpreted at one GitLab Project Member record per row; the schema uses the `Temporal.Date` scalar.
Developer identifier: `project_members.group_saml_identity`
Group SAML Identity records SAML identity information if the member authenticated via group SAML. It is needed to preserve the nested group saml identity relationship or details on the parent GitLab Project Member record.
* **Enables:** expand `group_saml_identity` to connect the containing GitLab Project Member row to its returned group saml identity entries.
* **Interpretation:** GitLab reports this value on the GitLab Project Member object returned for Project Members; it is one nested object per containing GitLab Project Member object when present.
Developer identifier: `project_members.group_saml_identity.extern_uid`
Extern Uid records external UID from the SAML identity provider. It is needed to refer to the same extern uid across records without relying on display text.
* **Enables:** match `extern_uid` to extern uid references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Group Saml Identity object returned for Project Members; it is an identifier, not a measured quantity.
Developer identifier: `project_members.group_saml_identity.provider`
Provider records name of the SAML identity provider. It is needed to inventory the exact GitLab-reported configuration or classification represented by this field.
* **Enables:** compare `provider` among Project Members records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitLab reports this value on the Group Saml Identity object returned for Project Members; it is interpreted at one Group Saml Identity record per row; the value is a GitLab-returned or configured label at the Group Saml Identity grain rather than a universal taxonomy.
Developer identifier: `project_members.group_saml_identity.saml_provider_id`
SAML Provider ID records ID of the SAML provider configuration. It is needed to refer to the same saml provider across records without relying on display text.
* **Enables:** match `saml_provider_id` to saml provider references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the Group Saml Identity object returned for Project Members; it is an identifier, not a measured quantity.
Developer identifier: `project_members.id`
**ID.** GitLab's numeric user ID of the member.
* **Enables:** Connect each project membership to the member's GitLab account through `project_members.id`.
* **Interpretation:** GitLab reports this value in its user namespace. The same value repeats once for every project the member belongs to, including inherited memberships, so it does not identify a row on its own. A connector directive maps this field to account identity.
Developer identifier: `project_members.is_using_seat`
Is Using Seat records whether the member is using a license seat. It is needed to distinguish Project Members rows by the exact GitLab-returned is using seat value.
* **Enables:** select Project Members rows where `is_using_seat` is true or false when comparing the condition described by Is Using Seat.
* **Interpretation:** GitLab reports this value on the GitLab Project Member object returned for Project Members; it is interpreted at one GitLab Project Member record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `project_members.membership_key`
**Membership Key.** Parable-generated SHA-1 digest of `project_id` and `id`, joined with `|`.
* **Enables:** Deduplicate each project membership on its own, so a member who belongs to several GitLab projects keeps one row per project.
* **Interpretation:** Parable calculates `membership_key` at ingestion. It identifies one project-to-member relationship, not the member or the project by itself, and is not a GitLab identifier. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `project_members.membership_state`
Membership State records state of the membership (active, awaiting, etc.). It is needed to distinguish Project Members rows by the exact GitLab-returned membership state value.
* **Enables:** separate Project Members rows by the exact GitLab-returned `membership_state` label when comparing membership state.
* **Interpretation:** GitLab reports this value on the GitLab Project Member object returned for Project Members; it is interpreted at one GitLab Project Member record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `project_members.name`
Name records display name of the member. It is needed to attribute this Project Members row to the returned person, account, or organization reference.
* **Enables:** attribute the Project Members row to the returned person or account and match the exact `name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Project Member object returned for Project Members; it is interpreted at one GitLab Project Member record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `project_members.project_id`
**Project ID.** The GitLab project this membership belongs to, copied from the parent project because the project members operation does not return it.
* **Enables:** Join each membership to `projects.id` and list the projects a member belongs to.
* **Interpretation:** Parable copies the project ID from the parent traversal record into each member row; the value is in GitLab's project namespace. Rows ingested before the connector injected it have no value.
Developer identifier: `project_members.state`
State records account state of the user (active, blocked, etc.). It is needed to distinguish Project Members rows by the exact GitLab-returned state value.
* **Enables:** separate Project Members rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the GitLab Project Member object returned for Project Members; it is interpreted at one GitLab Project Member record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `project_members.username`
User Name records GitLab username of the member. It is needed to attribute this Project Members row to the returned person, account, or organization reference.
* **Enables:** attribute the Project Members row to the returned person or account and match the exact `username` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Project Member object returned for Project Members; it is interpreted at one GitLab Project Member record per row.
Developer identifier: `project_members.web_url`
Web URL records URL to the member's GitLab profile page. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Project Members record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project Member object returned for Project Members; it is link at one GitLab Project Member record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects`
Projects covers GitLab projects the authenticated user is a member of.
* **Enables:** inventory returned projects and correlate each project with its namespace, owner, visibility, default branch, and last reported update.
* **Scope:** GitLab projects the authenticated user is a member of; the connector reads `/api/v4/projects` as a snapshot stream in incremental mode. The configured credential must grant the declared `read_api` access scope; records outside that access are not returned. This stream has no deletion signal, so a missing row does not establish that the GitLab record was deleted.
Provider-defined fields may also be returned for this data stream.
Developer identifier: `projects._links`
Links records hypermedia links for the project. GitLab returns this object under the \_links key; the whole object was dropped when declared as links. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `_links` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is link at one GitLab Project record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects._links.cluster_agents`
Cluster Agents records API URL for cluster agents. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `cluster_agents` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project Links object returned for Projects; it is link at one GitLab Project Links record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects._links.events`
Events records API URL for project events. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `events` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project Links object returned for Projects; it is link at one GitLab Project Links record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects._links.issues`
Issues records API URL for project issues. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `issues` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project Links object returned for Projects; it is link at one GitLab Project Links record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects._links.labels`
Labels records API URL for project labels. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `labels` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project Links object returned for Projects; it is link at one GitLab Project Links record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects._links.members`
Members records API URL for project members. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `members` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project Links object returned for Projects; it is link at one GitLab Project Links record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects._links.merge_requests`
Merge Requests records API URL for project merge requests. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `merge_requests` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project Links object returned for Projects; it is link at one GitLab Project Links record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects._links.repo_branches`
Repo Branches records API URL for repository branches. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `repo_branches` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project Links object returned for Projects; it is link at one GitLab Project Links record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects._links.self`
Self records API URL for this project. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `self` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project Links object returned for Projects; it is link at one GitLab Project Links record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.allow_merge_on_skipped_pipeline`
Allow Merge On Skipped Pipeline records whether merges are allowed when the pipeline is skipped. It is needed to distinguish Projects rows by the exact GitLab-returned allow merge on skipped pipeline value.
* **Enables:** select Projects rows where `allow_merge_on_skipped_pipeline` is true or false when comparing the condition described by Allow Merge On Skipped Pipeline.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.analytics_access_level`
Analytics Access Level records access level for analytics. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `analytics_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.archived`
Archived records whether the project is archived. It is needed to distinguish Projects rows by the exact GitLab-returned archived value.
* **Enables:** select Projects rows where `archived` is true or false when comparing the condition described by Archived.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.auto_cancel_pending_pipelines`
Auto Cancel Pending Pipelines records whether pending pipelines are auto-cancelled. It is needed to distinguish Projects rows by the exact GitLab-returned auto cancel pending pipelines value.
* **Enables:** select Projects rows where `auto_cancel_pending_pipelines` is true or false when comparing the condition described by Auto Cancel Pending Pipelines.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.auto_devops_deploy_strategy`
Auto Devops Deploy Strategy records auto DevOps deployment strategy. It is needed to distinguish Projects rows by the exact GitLab-returned auto devops deploy strategy value.
* **Enables:** separate Projects rows by the exact GitLab-returned `auto_devops_deploy_strategy` label when comparing auto devops deploy strategy.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.auto_devops_enabled`
Auto Devops Enabled records whether Auto DevOps is enabled. It is needed to distinguish Projects rows by the exact GitLab-returned auto devops enabled value.
* **Enables:** select Projects rows where `auto_devops_enabled` is true or false when comparing the condition described by Auto Devops Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.autoclose_referenced_issues`
Autoclose Referenced Issues records whether referenced issues are automatically closed on merge. It is needed to distinguish Projects rows by the exact GitLab-returned autoclose referenced issues value.
* **Enables:** select Projects rows where `autoclose_referenced_issues` is true or false when comparing the condition described by Autoclose Referenced Issues.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.avatar_url`
Avatar URL records URL to the project avatar image. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is link at one GitLab Project record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.build_coverage_regex`
Build Coverage Regex records regex for extracting code coverage from build output. It is needed to measure the code-coverage percentage reported for this pipeline execution.
* **Enables:** compare `build_coverage_regex` at one pipeline grain while preserving the project, revision, and pipeline identifiers.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; the value is a GitLab-reported percentage string and does not by itself establish test quality or change causality.
Developer identifier: `projects.build_git_strategy`
Build Git Strategy records git strategy for CI/CD builds (fetch or clone). It is needed to inventory the exact GitLab-reported configuration or classification represented by this field.
* **Enables:** compare `build_git_strategy` among Projects records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; the value is a GitLab-returned or configured label at the GitLab Project grain rather than a universal taxonomy.
Developer identifier: `projects.build_timeout`
Build Timeout records CI/CD build timeout in seconds. It is needed to measure the reported build timeout for one gitlab project record.
* **Enables:** measure and compare `build_timeout` per GitLab Project record in seconds.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; its unit or granularity is seconds.
Developer identifier: `projects.builds_access_level`
Builds Access Level records access level for CI/CD builds. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `builds_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.can_create_merge_request_in`
Can Create Merge Request In records whether the current user can create merge requests in this project. It is needed to distinguish Projects rows by the exact GitLab-returned can create merge request in value.
* **Enables:** select Projects rows where `can_create_merge_request_in` is true or false when comparing the condition described by Can Create Merge Request In.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.ci_allow_fork_pipelines_to_run_in_parent_project`
Ci Allow Fork Pipelines To Run In Parent Project records whether fork pipelines can run in the parent project. It is needed to distinguish Projects rows by the exact GitLab-returned ci allow fork pipelines to run in parent project value.
* **Enables:** select Projects rows where `ci_allow_fork_pipelines_to_run_in_parent_project` is true or false when comparing the condition described by Ci Allow Fork Pipelines To Run In Parent Project.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.ci_config_path`
Ci Config Path records path to the CI/CD configuration file. It is needed to compare the exact ci config path configuration returned for this GitLab Project record.
* **Enables:** compare the exact `ci_config_path` configuration returned for each GitLab Project record and select records with the configuration under review.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row.
Developer identifier: `projects.ci_default_git_depth`
Ci Default Git Depth records default git depth for CI/CD pipelines. It is needed to distinguish Projects rows by the exact GitLab-returned ci default git depth value.
* **Enables:** separate Projects rows by the exact GitLab-returned `ci_default_git_depth` label when comparing ci default git depth.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.ci_forward_deployment_enabled`
Ci Forward Deployment Enabled records whether forward deployment is enabled for CI/CD. It is needed to distinguish Projects rows by the exact GitLab-returned ci forward deployment enabled value.
* **Enables:** select Projects rows where `ci_forward_deployment_enabled` is true or false when comparing the condition described by Ci Forward Deployment Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.ci_forward_deployment_rollback_allowed`
Ci Forward Deployment Rollback Allowed records whether rollback is allowed for forward deployments. It is needed to distinguish Projects rows by the exact GitLab-returned ci forward deployment rollback allowed value.
* **Enables:** select Projects rows where `ci_forward_deployment_rollback_allowed` is true or false when comparing the condition described by Ci Forward Deployment Rollback Allowed.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.ci_job_token_scope_enabled`
Ci Job Token Scope Enabled records whether CI job token scope is enabled. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `ci_job_token_scope_enabled` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.ci_restrict_pipeline_cancellation_role`
Ci Restrict Pipeline Cancellation Role records role required to cancel pipelines. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `ci_restrict_pipeline_cancellation_role` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.ci_separated_caches`
Ci Separated Caches records whether CI/CD caches are separated by ref. It is needed to distinguish Projects rows by the exact GitLab-returned ci separated caches value.
* **Enables:** select Projects rows where `ci_separated_caches` is true or false when comparing the condition described by Ci Separated Caches.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.compliance_frameworks`
Compliance Frameworks records compliance frameworks applied to the project. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `compliance_frameworks` to examine the returned compliance frameworks details for the containing GitLab Project record.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is one returned collection per containing GitLab Project object; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; a returned framework label or feature setting does not demonstrate that a framework requirement is satisfied.
Developer identifier: `projects.container_registry_access_level`
Container Registry Access Level records access level for the container registry. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `container_registry_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.container_registry_enabled`
Container Registry Enabled records whether the container registry is enabled. It is needed to distinguish Projects rows by the exact GitLab-returned container registry enabled value.
* **Enables:** select Projects rows where `container_registry_enabled` is true or false when comparing the condition described by Container Registry Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.container_registry_image_prefix`
Container Registry Image Prefix records prefix for container registry images. It is needed to inventory the exact GitLab-reported configuration or classification represented by this field.
* **Enables:** compare `container_registry_image_prefix` among Projects records when reconciling this specific configuration, source, or classification.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; the value is a GitLab-returned or configured label at the GitLab Project grain rather than a universal taxonomy.
Developer identifier: `projects.created_at`
Created At records timestamp when the project was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Projects records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `projects.creator_id`
Creator ID records user ID of the project creator. It is needed to refer to the same creator across records without relying on display text.
* **Enables:** match `creator_id` to creator references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is an identifier, not a measured quantity.
Developer identifier: `projects.default_branch`
Default Branch records name of the default branch (e.g., main, master). It is needed to distinguish Projects rows by the exact GitLab-returned default branch value.
* **Enables:** separate Projects rows by the exact GitLab-returned `default_branch` label when comparing default branch.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.description`
Description records project description text. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, owner, and update time where returned.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is description text at one GitLab Project record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `projects.description_html`
Description HTML records HTML-rendered project description. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description_html` and attribute it to the same record's repository or project, owner, and update time where returned.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is description text at one GitLab Project record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `projects.emails_disabled`
Emails Disabled records whether email notifications are disabled. It is needed to distinguish Projects rows by the exact GitLab-returned emails disabled value.
* **Enables:** select Projects rows where `emails_disabled` is true or false when comparing the condition described by Emails Disabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.emails_enabled`
Emails Enabled records whether email notifications are enabled. It is needed to distinguish Projects rows by the exact GitLab-returned emails enabled value.
* **Enables:** select Projects rows where `emails_enabled` is true or false when comparing the condition described by Emails Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.empty_repo`
Empty Repo records whether the repository is empty (no commits). It is needed to distinguish Projects rows by the exact GitLab-returned empty repo value.
* **Enables:** select Projects rows where `empty_repo` is true or false when comparing the condition described by Empty Repo.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.enforce_auth_checks_on_uploads`
Enforce Auth Checks On Uploads records whether authorization checks are enforced on file uploads. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `enforce_auth_checks_on_uploads` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.environments_access_level`
Environments Access Level records access level for environments. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `environments_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.external_authorization_classification_label`
External Authorization Classification Label records classification label used for external authorization. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `external_authorization_classification_label` access value with the resource, account, or membership represented by the same Projects row.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `projects.feature_flags_access_level`
Feature Flags Access Level records access level for feature flags. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `feature_flags_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.forked_from_project`
Forked From Project records the project this was forked from, if applicable. It is needed to preserve the nested forked from project relationship or details on the parent GitLab Project record.
* **Enables:** expand `forked_from_project` to connect the containing GitLab Project row to its returned forked from project entries.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is one nested object per containing GitLab Project object when present.
Developer identifier: `projects.forked_from_project.avatar_url`
Avatar URL records avatar URL of the upstream project. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is link at one GitLab Forked From Project record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.forked_from_project.created_at`
Created At records creation timestamp of the upstream project. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Projects records by `created_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is interpreted at one GitLab Forked From Project record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `projects.forked_from_project.default_branch`
Default Branch records default branch of the upstream project. It is needed to distinguish Projects rows by the exact GitLab-returned default branch value.
* **Enables:** separate Projects rows by the exact GitLab-returned `default_branch` label when comparing default branch.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is interpreted at one GitLab Forked From Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.forked_from_project.description`
Description records description of the upstream project. It is needed to inspect the exact description text included with this record.
* **Enables:** inspect the description text returned in `description` and attribute it to the same record's repository or project, owner, and update time where returned.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is description text at one GitLab Forked From Project record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `projects.forked_from_project.forks_count`
Forks Count records fork count of the upstream project. It is needed to measure the GitLab-reported number of forks at one GitLab Forked From Project record per row.
* **Enables:** measure and compare the GitLab-reported number of forks in `forks_count` at one GitLab Forked From Project record per row.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is a GitLab-reported count at one GitLab Forked From Project record per row.
Developer identifier: `projects.forked_from_project.http_url_to_repo`
HTTP URL To Repo records HTTP clone URL of the upstream project. It is needed to reproduce the returned code or dependency configuration for this Projects record.
* **Enables:** use `http_url_to_repo` to locate the configured source, package, or repository when reproducing the same job or repository setup.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is interpreted at one GitLab Forked From Project record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.forked_from_project.id`
ID records ID of the upstream project. It is needed to refer to the same forked from project across records without relying on display text.
* **Enables:** match `id` to forked from project references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is an identifier, not a measured quantity.
Developer identifier: `projects.forked_from_project.last_activity_at`
Last Activity At records last activity timestamp of the upstream project. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Projects records by `last_activity_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is interpreted at one GitLab Forked From Project record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `projects.forked_from_project.name`
Name records name of the upstream project. It is needed to compare the returned name for individual Projects rows and select rows with a specific `name` value.
* **Enables:** locate Projects rows whose returned name exactly matches `name` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is interpreted at one GitLab Forked From Project record per row.
Developer identifier: `projects.forked_from_project.name_with_namespace`
Name With Namespace records full name with namespace of the upstream project. It is needed to compare the returned name with namespace for individual Projects rows and select rows with a specific `name_with_namespace` value.
* **Enables:** locate Projects rows whose returned name with namespace exactly matches `name_with_namespace` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is interpreted at one GitLab Forked From Project record per row.
Developer identifier: `projects.forked_from_project.namespace`
Namespace records namespace of the upstream project. It is needed to preserve the nested namespace relationship or details on the parent GitLab Forked From Project record.
* **Enables:** expand `namespace` to connect the containing GitLab Forked From Project row to its returned namespace entries.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is one nested object per containing GitLab Forked From Project object when present.
Developer identifier: `projects.forked_from_project.namespace.avatar_url`
Avatar URL records URL to the namespace avatar. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Namespace object returned for Projects; it is link at one GitLab Namespace record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.forked_from_project.namespace.full_path`
Full Path records full path of the namespace including parent groups. It is needed to compare the returned full path for individual Projects rows and select rows with a specific `full_path` value.
* **Enables:** trace the full path relationship returned in `full_path` from the GitLab Namespace row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the GitLab Namespace object returned for Projects; it is interpreted at one GitLab Namespace record per row.
Developer identifier: `projects.forked_from_project.namespace.id`
ID records unique identifier for the namespace. It is needed to refer to the same namespace across records without relying on display text.
* **Enables:** match `id` to namespace references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Namespace object returned for Projects; it is an identifier, not a measured quantity.
Developer identifier: `projects.forked_from_project.namespace.kind`
Kind records kind of namespace (group or user). It is needed to distinguish Projects rows by the exact GitLab-returned kind value.
* **Enables:** separate Projects rows by the exact GitLab-returned `kind` label when comparing kind.
* **Interpretation:** GitLab reports this value on the GitLab Namespace object returned for Projects; it is interpreted at one GitLab Namespace record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.forked_from_project.namespace.name`
Name records name of the namespace. It is needed to compare the returned name for individual Projects rows and select rows with a specific `name` value.
* **Enables:** locate Projects rows whose returned name exactly matches `name` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the GitLab Namespace object returned for Projects; it is interpreted at one GitLab Namespace record per row.
Developer identifier: `projects.forked_from_project.namespace.parent_id`
Parent ID records ID of the parent namespace, if any. It is needed to refer to the same parent across records without relying on display text.
* **Enables:** match `parent_id` to parent references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Namespace object returned for Projects; it is an identifier, not a measured quantity.
Developer identifier: `projects.forked_from_project.namespace.path`
Path records URL-safe path of the namespace. It is needed to compare the returned path for individual Projects rows and select rows with a specific `path` value.
* **Enables:** trace the path relationship returned in `path` from the GitLab Namespace row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the GitLab Namespace object returned for Projects; it is interpreted at one GitLab Namespace record per row.
Developer identifier: `projects.forked_from_project.namespace.web_url`
Web URL records web URL to the namespace. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Namespace object returned for Projects; it is link at one GitLab Namespace record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.forked_from_project.path`
Path records path slug of the upstream project. It is needed to compare the returned path for individual Projects rows and select rows with a specific `path` value.
* **Enables:** trace the path relationship returned in `path` from the GitLab Forked From Project row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is interpreted at one GitLab Forked From Project record per row.
Developer identifier: `projects.forked_from_project.path_with_namespace`
Path With Namespace records full path with namespace of the upstream project. It is needed to compare the returned path with namespace for individual Projects rows and select rows with a specific `path_with_namespace` value.
* **Enables:** locate Projects rows whose returned path with namespace exactly matches `path_with_namespace` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is interpreted at one GitLab Forked From Project record per row.
Developer identifier: `projects.forked_from_project.readme_url`
Readme URL records README URL of the upstream project. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `readme_url` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is link at one GitLab Forked From Project record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.forked_from_project.ssh_url_to_repo`
SSH URL To Repo records SSH clone URL of the upstream project. It is needed to reproduce the returned code or dependency configuration for this Projects record.
* **Enables:** use `ssh_url_to_repo` to locate the configured source, package, or repository when reproducing the same job or repository setup.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is interpreted at one GitLab Forked From Project record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.forked_from_project.star_count`
Star Count records star count of the upstream project. It is needed to measure the GitLab-reported number of star at one GitLab Forked From Project record per row.
* **Enables:** measure and compare the GitLab-reported number of star in `star_count` at one GitLab Forked From Project record per row.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is a GitLab-reported count at one GitLab Forked From Project record per row.
Developer identifier: `projects.forked_from_project.tag_list`
Tag List records tags of the upstream project. It is needed to preserve the nested tag list relationship or details on the parent GitLab Forked From Project record.
* **Enables:** expand `tag_list` to connect the containing GitLab Forked From Project row to its returned tag list entries.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is one returned collection per containing GitLab Forked From Project object.
Developer identifier: `projects.forked_from_project.topics`
Topics records topics of the upstream project. It is needed to preserve the nested topics relationship or details on the parent GitLab Forked From Project record.
* **Enables:** expand `topics` to connect the containing GitLab Forked From Project row to its returned topics entries.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is one returned collection per containing GitLab Forked From Project object.
Developer identifier: `projects.forked_from_project.web_url`
Web URL records web URL of the upstream project. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Forked From Project object returned for Projects; it is link at one GitLab Forked From Project record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.forking_access_level`
Forking Access Level records access level for forking. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `forking_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.forks_count`
Forks Count records number of forks of this project. It is needed to measure the GitLab-reported number of forks of this project at one GitLab Project record per row.
* **Enables:** measure and compare the GitLab-reported number of forks of this project in `forks_count` at one GitLab Project record per row.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is a GitLab-reported count at one GitLab Project record per row.
Developer identifier: `projects.group_runners_enabled`
Group Runners Enabled records whether group runners are enabled. It is needed to distinguish Projects rows by the exact GitLab-returned group runners enabled value.
* **Enables:** select Projects rows where `group_runners_enabled` is true or false when comparing the condition described by Group Runners Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.http_url_to_repo`
HTTP URL To Repo records HTTP URL for cloning the repository. It is needed to reproduce the returned code or dependency configuration for this Projects record.
* **Enables:** use `http_url_to_repo` to locate the configured source, package, or repository when reproducing the same job or repository setup.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.id`
ID records unique numeric identifier for the project. It is needed to distinguish repeated deliveries of the same Projects row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Projects and match repeated rows carrying the same GitLab identifier.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `projects.import_error`
Import Error records error message from the project import. It is needed to inspect the exact error message included with this record.
* **Enables:** inspect the error message returned in `import_error` and attribute it to the same record's repository or project, owner, and update time where returned.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is error message at one GitLab Project record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `projects.import_status`
Import Status records status of the project import. It is needed to distinguish Projects rows by the exact GitLab-returned import status value.
* **Enables:** separate Projects rows by the exact GitLab-returned `import_status` label when comparing import status.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.import_type`
Import Type records type of import used to create the project. It is needed to distinguish Projects rows by the exact GitLab-returned import type value.
* **Enables:** separate Projects rows by the exact GitLab-returned `import_type` label when comparing import type.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.import_url`
Import URL records URL used to import the project. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `import_url` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is link at one GitLab Project record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.infrastructure_access_level`
Infrastructure Access Level records access level for infrastructure. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `infrastructure_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.issue_branch_template`
Issue Branch Template records custom template for issue branch names. It is needed to distinguish Projects rows by the exact GitLab-returned issue branch template value.
* **Enables:** separate Projects rows by the exact GitLab-returned `issue_branch_template` label when comparing issue branch template.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.issues_access_level`
Issues Access Level records access level for issues. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `issues_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.issues_enabled`
Issues Enabled records whether issues are enabled. It is needed to distinguish Projects rows by the exact GitLab-returned issues enabled value.
* **Enables:** select Projects rows where `issues_enabled` is true or false when comparing the condition described by Issues Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.jobs_enabled`
Jobs Enabled records whether CI/CD jobs are enabled. It is needed to distinguish Projects rows by the exact GitLab-returned jobs enabled value.
* **Enables:** select Projects rows where `jobs_enabled` is true or false when comparing the condition described by Jobs Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.keep_latest_artifact`
Keep Latest Artifact records whether the latest artifact is kept. It is needed to distinguish Projects rows by the exact GitLab-returned keep latest artifact value.
* **Enables:** select Projects rows where `keep_latest_artifact` is true or false when comparing the condition described by Keep Latest Artifact.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.last_activity_at`
Last Activity At records timestamp of the most recent activity on the project. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Projects records by `last_activity_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `projects.lfs_enabled`
Lfs Enabled records whether Git LFS is enabled. It is needed to distinguish Projects rows by the exact GitLab-returned lfs enabled value.
* **Enables:** select Projects rows where `lfs_enabled` is true or false when comparing the condition described by Lfs Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.marked_for_deletion_at`
Marked For Deletion At records date when the project was marked for deletion. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Projects records by `marked_for_deletion_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; the schema uses the `Temporal.Date` scalar.
Developer identifier: `projects.marked_for_deletion_on`
Marked For Deletion On records date when the project was marked for deletion. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Projects records by `marked_for_deletion_on`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; the schema uses the `Temporal.Date` scalar.
Developer identifier: `projects.merge_commit_template`
Merge Commit Template records custom template for merge commit messages. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `merge_commit_template` and attribute it to the same record's repository or project, owner, and update time where returned.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is commit message at one GitLab Project record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `projects.merge_method`
Merge Method records merge method used for the project. It is needed to distinguish Projects rows by the exact GitLab-returned merge method value.
* **Enables:** separate Projects rows by the exact GitLab-returned `merge_method` label when comparing merge method.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.merge_pipelines_enabled`
Merge Pipelines Enabled records whether merged results pipelines are enabled. It is needed to distinguish Projects rows by the exact GitLab-returned merge pipelines enabled value.
* **Enables:** select Projects rows where `merge_pipelines_enabled` is true or false when comparing the condition described by Merge Pipelines Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.merge_requests_access_level`
Merge Requests Access Level records access level for merge requests. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `merge_requests_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.merge_requests_enabled`
Merge Requests Enabled records whether merge requests are enabled. It is needed to distinguish Projects rows by the exact GitLab-returned merge requests enabled value.
* **Enables:** select Projects rows where `merge_requests_enabled` is true or false when comparing the condition described by Merge Requests Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.merge_trains_enabled`
Merge Trains Enabled records whether merge trains are enabled. It is needed to distinguish Projects rows by the exact GitLab-returned merge trains enabled value.
* **Enables:** select Projects rows where `merge_trains_enabled` is true or false when comparing the condition described by Merge Trains Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.mirror`
Mirror records whether the project is a mirror. It is needed to distinguish Projects rows by the exact GitLab-returned mirror value.
* **Enables:** select Projects rows where `mirror` is true or false when comparing the condition described by Mirror.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.model_experiments_access_level`
Model Experiments Access Level records access level for model experiments. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `model_experiments_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.model_registry_access_level`
Model Registry Access Level records access level for model registry. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `model_registry_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.monitor_access_level`
Monitor Access Level records access level for monitoring. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `monitor_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.mr_default_target_self`
Mr Default Target Self records whether MRs default to targeting the same project. It is needed to distinguish Projects rows by the exact GitLab-returned mr default target self value.
* **Enables:** select Projects rows where `mr_default_target_self` is true or false when comparing the condition described by Mr Default Target Self.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.name`
Name records human-readable project name. It is needed to compare the returned name for individual Projects rows and select rows with a specific `name` value.
* **Enables:** locate Projects rows whose returned name exactly matches `name` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row.
Developer identifier: `projects.name_with_namespace`
Name With Namespace records full name including namespace (e.g., 'Group / Subgroup / Project'). It is needed to compare the returned name with namespace for individual Projects rows and select rows with a specific `name_with_namespace` value.
* **Enables:** locate Projects rows whose returned name with namespace exactly matches `name_with_namespace` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row.
Developer identifier: `projects.namespace`
Namespace records the group/namespace this project belongs to. It is needed to preserve the nested namespace relationship or details on the parent GitLab Project record.
* **Enables:** expand `namespace` to connect the containing GitLab Project row to its returned namespace entries.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is one nested object per containing GitLab Project object when present.
Developer identifier: `projects.only_allow_merge_if_all_discussions_are_resolved`
Only Allow Merge If All Discussions Are Resolved records whether merges require all discussions to be resolved. It is needed to distinguish Projects rows by the exact GitLab-returned only allow merge if all discussions are resolved value.
* **Enables:** select Projects rows where `only_allow_merge_if_all_discussions_are_resolved` is true or false when comparing the condition described by Only Allow Merge If All Discussions Are Resolved.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.only_allow_merge_if_pipeline_succeeds`
Only Allow Merge If Pipeline Succeeds records whether merges require a successful pipeline. It is needed to distinguish Projects rows by the exact GitLab-returned only allow merge if pipeline succeeds value.
* **Enables:** select Projects rows where `only_allow_merge_if_pipeline_succeeds` is true or false when comparing the condition described by Only Allow Merge If Pipeline Succeeds.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.open_issues_count`
Open Issues Count records number of open issues in this project. It is needed to measure the GitLab-reported number of open issues in this project at one GitLab Project record per row.
* **Enables:** measure and compare the GitLab-reported number of open issues in this project in `open_issues_count` at one GitLab Project record per row.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is a GitLab-reported count at one GitLab Project record per row.
Developer identifier: `projects.owner`
Owner records owner of the project (present for personal projects). It is needed to preserve the nested owner relationship or details on the parent GitLab Project record.
* **Enables:** expand `owner` to connect the containing GitLab Project row to its returned owner entries.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is one nested object per containing GitLab Project object when present.
Developer identifier: `projects.owner.avatar_url`
Avatar URL records URL to the user avatar. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `avatar_url` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Owner object returned for Projects; it is link at one GitLab Owner record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.owner.id`
ID records unique identifier for the user. It is needed to refer to the same owner across records without relying on display text.
* **Enables:** match `id` to owner references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Owner object returned for Projects; it is an identifier, not a measured quantity.
Developer identifier: `projects.owner.locked`
Locked records whether the user account is locked. It is needed to distinguish Projects rows by the exact GitLab-returned locked value.
* **Enables:** select Projects rows where `locked` is true or false when comparing the condition described by Locked.
* **Interpretation:** GitLab reports this value on the GitLab Owner object returned for Projects; it is interpreted at one GitLab Owner record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.owner.name`
Name records display name of the owner. It is needed to attribute this Projects row to the returned person, account, or organization reference.
* **Enables:** attribute the Projects row to the returned person or account and match the exact `name` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Owner object returned for Projects; it is interpreted at one GitLab Owner record per row.
Developer identifier: `projects.owner.state`
State records account state (e.g., active, blocked). It is needed to distinguish Projects rows by the exact GitLab-returned state value.
* **Enables:** separate Projects rows by the exact GitLab-returned `state` label when comparing state.
* **Interpretation:** GitLab reports this value on the GitLab Owner object returned for Projects; it is interpreted at one GitLab Owner record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.owner.username`
User Name records username of the owner. It is needed to attribute this Projects row to the returned person, account, or organization reference.
* **Enables:** attribute the Projects row to the returned person or account and match the exact `username` value where it recurs in GitLab.
* **Interpretation:** GitLab reports this value on the GitLab Owner object returned for Projects; it is interpreted at one GitLab Owner record per row.
Developer identifier: `projects.owner.web_url`
Web URL records web URL to the user profile. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Owner object returned for Projects; it is link at one GitLab Owner record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.packages_enabled`
Packages Enabled records whether the package registry is enabled. It is needed to distinguish Projects rows by the exact GitLab-returned packages enabled value.
* **Enables:** select Projects rows where `packages_enabled` is true or false when comparing the condition described by Packages Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.pages_access_level`
Pages Access Level records access level for GitLab Pages. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `pages_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.path`
Path records URL-safe project path slug. It is needed to compare the returned path for individual Projects rows and select rows with a specific `path` value.
* **Enables:** trace the path relationship returned in `path` from the GitLab Project row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row.
Developer identifier: `projects.path_with_namespace`
Path With Namespace records full path including group namespace (e.g., group/subgroup/project). It is needed to compare the returned path with namespace for individual Projects rows and select rows with a specific `path_with_namespace` value.
* **Enables:** locate Projects rows whose returned path with namespace exactly matches `path_with_namespace` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row.
Developer identifier: `projects.permissions`
Permissions records current user permissions on this project. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `permissions` to examine the returned permissions details for the containing GitLab Project record.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is one nested object per containing GitLab Project object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `projects.permissions.group_access`
Group Access records access inherited from group membership. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `group_access` to examine the returned group access details for the containing GitLab Permissions record.
* **Interpretation:** GitLab reports this value on the GitLab Permissions object returned for Projects; it is one nested object per containing GitLab Permissions object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `projects.permissions.group_access.access_level`
Access Level records numeric access level (10=Guest, 20=Reporter, 30=Developer, 40=Maintainer, 50=Owner). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `access_level` access value with the resource, account, or membership represented by the same Projects row.
* **Interpretation:** GitLab reports this value on the GitLab Access Level object returned for Projects; it is interpreted at one GitLab Access Level record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `projects.permissions.group_access.notification_level`
Notification Level records notification level setting. It is needed to compare the exact notification level configuration returned for this GitLab Access Level record.
* **Enables:** compare the exact `notification_level` configuration returned for each GitLab Access Level record and select records with the configuration under review.
* **Interpretation:** GitLab reports this value on the GitLab Access Level object returned for Projects; it is interpreted at one GitLab Access Level record per row.
Developer identifier: `projects.permissions.project_access`
Project Access records direct project-level access. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `project_access` to examine the returned project access details for the containing GitLab Permissions record.
* **Interpretation:** GitLab reports this value on the GitLab Permissions object returned for Projects; it is one nested object per containing GitLab Permissions object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `projects.printing_merge_request_link_enabled`
Printing Merge Request Link Enabled records whether the merge request link is printed after a push. It is needed to distinguish Projects rows by the exact GitLab-returned printing merge request link enabled value.
* **Enables:** select Projects rows where `printing_merge_request_link_enabled` is true or false when comparing the condition described by Printing Merge Request Link Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.public_jobs`
Public Jobs records whether CI/CD job logs are public. It is needed to distinguish Projects rows by the exact GitLab-returned public jobs value.
* **Enables:** select Projects rows where `public_jobs` is true or false when comparing the condition described by Public Jobs.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.readme_url`
Readme URL records URL to the project README file. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `readme_url` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is link at one GitLab Project record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.releases_access_level`
Releases Access Level records access level for releases. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `releases_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.remove_source_branch_after_merge`
Remove Source Branch After Merge records whether source branches are removed after merge. It is needed to distinguish Projects rows by the exact GitLab-returned remove source branch after merge value.
* **Enables:** select Projects rows where `remove_source_branch_after_merge` is true or false when comparing the condition described by Remove Source Branch After Merge.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.repository_access_level`
Repository Access Level records access level for the repository. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `repository_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.repository_object_format`
Repository Object Format records object format of the repository (e.g., sha1, sha256). It is needed to distinguish Projects rows by the exact GitLab-returned repository object format value.
* **Enables:** separate Projects rows by the exact GitLab-returned `repository_object_format` label when comparing repository object format.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.request_access_enabled`
Request Access Enabled records whether users can request access to the project. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `request_access_enabled` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.requirements_access_level`
Requirements Access Level records access level for the requirements feature. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `requirements_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.resolve_outdated_diff_discussions`
Resolve Outdated Diff Discussions records whether outdated diff discussions are automatically resolved. It is needed to distinguish Projects rows by the exact GitLab-returned resolve outdated diff discussions value.
* **Enables:** select Projects rows where `resolve_outdated_diff_discussions` is true or false when comparing the condition described by Resolve Outdated Diff Discussions.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.restrict_user_defined_variables`
Restrict User Defined Variables records whether user-defined CI/CD variables are restricted. It is needed to inspect the exact metadata included with this record.
* **Enables:** inspect the exact metadata keys returned in `restrict_user_defined_variables` and associate them with the containing Projects record.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; keys and availability follow this GitLab response and may vary by object type or GitLab configuration; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.runner_token_expiration_interval`
Runner Token Expiration Interval records runner token expiration interval in seconds. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `runner_token_expiration_interval` access value with the resource, account, or membership represented by the same Projects row.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; its unit or granularity is seconds; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `projects.security_and_compliance_access_level`
Security And Compliance Access Level records access level for security and compliance features. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `security_and_compliance_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; a returned framework label or feature setting does not demonstrate that a framework requirement is satisfied; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.security_and_compliance_enabled`
Security And Compliance Enabled records whether the security and compliance features are enabled. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `security_and_compliance_enabled` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; a returned framework label or feature setting does not demonstrate that a framework requirement is satisfied; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.service_desk_address`
Service Desk Address records email address for the service desk. It is needed to preserve the GitLab-reported configured or derived address and place context for the same record.
* **Enables:** compare the GitLab-reported configured or derived address and place context in `service_desk_address` for individual Projects rows without treating it as a verified physical location.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; the schema uses the `Contact.Email` scalar; the value is configured or derived address and place context; this GitLab-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `projects.service_desk_enabled`
Service Desk Enabled records whether the service desk is enabled. It is needed to distinguish Projects rows by the exact GitLab-returned service desk enabled value.
* **Enables:** select Projects rows where `service_desk_enabled` is true or false when comparing the condition described by Service Desk Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.shared_runners_enabled`
Shared Runners Enabled records whether shared runners are enabled. It is needed to distinguish Projects rows by the exact GitLab-returned shared runners enabled value.
* **Enables:** select Projects rows where `shared_runners_enabled` is true or false when comparing the condition described by Shared Runners Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.shared_with_groups`
Shared With Groups records groups this project is shared with. It is needed to preserve the nested shared with groups relationship or details on the parent GitLab Project record.
* **Enables:** expand `shared_with_groups` to connect the containing GitLab Project row to its returned shared with groups entries.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is one returned collection per containing GitLab Project object.
Developer identifier: `projects.shared_with_groups.expires_at`
Expires At records expiration date of the share. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Projects records by `expires_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Shared Group object returned for Projects; it is interpreted at one GitLab Shared Group record per row; the schema uses the `Temporal.Date` scalar.
Developer identifier: `projects.shared_with_groups.group_access_level`
Group Access Level records access level granted to the shared group. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `group_access_level` access value with the resource, account, or membership represented by the same Projects row.
* **Interpretation:** GitLab reports this value on the GitLab Shared Group object returned for Projects; it is interpreted at one GitLab Shared Group record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `projects.shared_with_groups.group_full_path`
Group Full Path records full path of the shared group. It is needed to compare the returned group full path for individual Projects rows and select rows with a specific `group_full_path` value.
* **Enables:** trace the group full path relationship returned in `group_full_path` from the GitLab Shared Group row to its named GitLab context.
* **Interpretation:** GitLab reports this value on the GitLab Shared Group object returned for Projects; it is interpreted at one GitLab Shared Group record per row.
Developer identifier: `projects.shared_with_groups.group_id`
Group ID records ID of the shared group.
* **Enables:** Match Projects elements carrying the same GitLab `group_id`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** GitLab reports this value on the GitLab Shared Group object returned for Projects; it is an identifier, not a measured quantity.
Developer identifier: `projects.shared_with_groups.group_name`
Group Name records name of the shared group. It is needed to compare the returned group name for individual Projects rows and select rows with a specific `group_name` value.
* **Enables:** locate Projects rows whose returned group name exactly matches `group_name` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the GitLab Shared Group object returned for Projects; it is interpreted at one GitLab Shared Group record per row.
Developer identifier: `projects.snippets_access_level`
Snippets Access Level records access level for snippets. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `snippets_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.snippets_enabled`
Snippets Enabled records whether snippets are enabled. It is needed to distinguish Projects rows by the exact GitLab-returned snippets enabled value.
* **Enables:** select Projects rows where `snippets_enabled` is true or false when comparing the condition described by Snippets Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.squash_commit_template`
Squash Commit Template records custom template for squash commit messages. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `squash_commit_template` and attribute it to the same record's repository or project, owner, and update time where returned.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is commit message at one GitLab Project record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `projects.squash_option`
Squash Option records squash option for merge requests. It is needed to distinguish Projects rows by the exact GitLab-returned squash option value.
* **Enables:** separate Projects rows by the exact GitLab-returned `squash_option` label when comparing squash option.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.ssh_url_to_repo`
SSH URL To Repo records SSH URL for cloning the repository. It is needed to reproduce the returned code or dependency configuration for this Projects record.
* **Enables:** use `ssh_url_to_repo` to locate the configured source, package, or repository when reproducing the same job or repository setup.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.star_count`
Star Count records number of stars on this project. It is needed to measure the GitLab-reported number of stars on this project at one GitLab Project record per row.
* **Enables:** measure and compare the GitLab-reported number of stars on this project in `star_count` at one GitLab Project record per row.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is a GitLab-reported count at one GitLab Project record per row.
Developer identifier: `projects.statistics`
Statistics records project storage and usage statistics. It is needed to preserve the nested statistics relationship or details on the parent GitLab Project record.
* **Enables:** expand `statistics` to connect the containing GitLab Project row to its returned statistics entries.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is one nested object per containing GitLab Project object when present.
Developer identifier: `projects.statistics.commit_count`
Commit Count records total number of commits. It is needed to measure the GitLab-reported number of commits at one GitLab Project Statistics record per row.
* **Enables:** measure and compare the GitLab-reported number of commits in `commit_count` at one GitLab Project Statistics record per row.
* **Interpretation:** GitLab reports this value on the GitLab Project Statistics object returned for Projects; it is a GitLab-reported count at one GitLab Project Statistics record per row.
Developer identifier: `projects.statistics.container_registry_size`
Container Registry Size records container registry size in bytes. It is needed to measure the reported container registry size for one gitlab project statistics record.
* **Enables:** measure and compare `container_registry_size` per GitLab Project Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the GitLab Project Statistics object returned for Projects; its unit or granularity is bytes.
Developer identifier: `projects.statistics.job_artifacts_size`
Job Artifacts Size records job artifacts size in bytes. It is needed to measure the reported job artifacts size for one gitlab project statistics record.
* **Enables:** measure and compare `job_artifacts_size` per GitLab Project Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the GitLab Project Statistics object returned for Projects; its unit or granularity is bytes.
Developer identifier: `projects.statistics.lfs_objects_size`
Lfs Objects Size records LFS objects size in bytes. It is needed to measure the reported lfs objects size for one gitlab project statistics record.
* **Enables:** measure and compare `lfs_objects_size` per GitLab Project Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the GitLab Project Statistics object returned for Projects; its unit or granularity is bytes.
Developer identifier: `projects.statistics.packages_size`
Packages Size records packages size in bytes. It is needed to measure the reported packages size for one gitlab project statistics record.
* **Enables:** measure and compare `packages_size` per GitLab Project Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the GitLab Project Statistics object returned for Projects; its unit or granularity is bytes.
Developer identifier: `projects.statistics.pipeline_artifacts_size`
Pipeline Artifacts Size records pipeline artifacts size in bytes. It is needed to measure the reported pipeline artifacts size for one gitlab project statistics record.
* **Enables:** measure and compare `pipeline_artifacts_size` per GitLab Project Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the GitLab Project Statistics object returned for Projects; its unit or granularity is bytes.
Developer identifier: `projects.statistics.repository_size`
Repository Size records repository size in bytes. It is needed to measure the reported repository size for one gitlab project statistics record.
* **Enables:** measure and compare `repository_size` per GitLab Project Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the GitLab Project Statistics object returned for Projects; its unit or granularity is bytes.
Developer identifier: `projects.statistics.snippets_size`
Snippets Size records snippets size in bytes. It is needed to measure the reported snippets size for one gitlab project statistics record.
* **Enables:** measure and compare `snippets_size` per GitLab Project Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the GitLab Project Statistics object returned for Projects; its unit or granularity is bytes.
Developer identifier: `projects.statistics.storage_size`
Storage Size records total storage size in bytes. It is needed to measure the reported storage size for one gitlab project statistics record.
* **Enables:** measure and compare `storage_size` per GitLab Project Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the GitLab Project Statistics object returned for Projects; its unit or granularity is bytes.
Developer identifier: `projects.statistics.uploads_size`
Uploads Size records uploads size in bytes. It is needed to measure the reported uploads size for one gitlab project statistics record.
* **Enables:** measure and compare `uploads_size` per GitLab Project Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the GitLab Project Statistics object returned for Projects; its unit or granularity is bytes.
Developer identifier: `projects.statistics.wiki_size`
Wiki Size records wiki size in bytes. It is needed to measure the reported wiki size for one gitlab project statistics record.
* **Enables:** measure and compare `wiki_size` per GitLab Project Statistics record in bytes.
* **Interpretation:** GitLab reports this value on the GitLab Project Statistics object returned for Projects; its unit or granularity is bytes.
Developer identifier: `projects.suggestion_commit_message`
Suggestion Commit Message records custom commit message template for suggestions. It is needed to inspect the exact commit message included with this record.
* **Enables:** inspect the commit message returned in `suggestion_commit_message` and attribute it to the same record's repository or project, owner, and update time where returned.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is commit message at one GitLab Project record per row; this is only the content included in the GitLab response for this record.
Developer identifier: `projects.tag_list`
Tag List records deprecated array of topic tags (use topics instead). It is needed to preserve the nested tag list relationship or details on the parent GitLab Project record.
* **Enables:** expand `tag_list` to connect the containing GitLab Project row to its returned tag list entries.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is one returned collection per containing GitLab Project object.
Developer identifier: `projects.topics`
Topics records array of topic tags assigned to the project. It is needed to preserve the nested topics relationship or details on the parent GitLab Project record.
* **Enables:** expand `topics` to connect the containing GitLab Project row to its returned topics entries.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is one returned collection per containing GitLab Project object.
Developer identifier: `projects.updated_at`
Updated At records timestamp when the project was last updated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Projects records by `updated_at`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `projects.visibility`
Visibility records project visibility level. It is needed to distinguish Projects rows by the exact GitLab-returned visibility value.
* **Enables:** separate Projects rows by the exact GitLab-returned `visibility` label when comparing visibility.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.warn_about_potentially_unwanted_characters`
Warn About Potentially Unwanted Characters records whether warnings about potentially unwanted characters are shown. It is needed to distinguish Projects rows by the exact GitLab-returned warn about potentially unwanted characters value.
* **Enables:** select Projects rows where `warn_about_potentially_unwanted_characters` is true or false when comparing the condition described by Warn About Potentially Unwanted Characters.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.web_url`
Web URL records web URL to the project in the GitLab UI. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact GitLab resource referenced by `web_url` while retaining the containing Projects record as provenance.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is link at one GitLab Project record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `projects.wiki_access_level`
Wiki Access Level records access level for the wiki. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Projects rows with the exact `wiki_access_level` access-related value being investigated.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `projects.wiki_enabled`
Wiki Enabled records whether the wiki is enabled. It is needed to distinguish Projects rows by the exact GitLab-returned wiki enabled value.
* **Enables:** select Projects rows where `wiki_enabled` is true or false when comparing the condition described by Wiki Enabled.
* **Interpretation:** GitLab reports this value on the GitLab Project object returned for Projects; it is interpreted at one GitLab Project record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `repos`
Repository Files covers project repository file tree.
* **Enables:** inventory returned repositories or project files and correlate each record with its owner, namespace, visibility, default branch, and update time where present.
* **Scope:** Project repository file tree; the connector reads `/api/v4/projects/{id}/repository/tree` as a snapshot stream in full mode. The configured credential must grant the declared `read_api` access scope; records outside that access are not returned. A successful full collection can reveal a previously returned row as absent, but a credential or permission change can produce the same observation.
Developer identifier: `repos.id`
ID records SHA-1 hash identifier of the tree entry (blob or tree object id). It is needed to refer to the same repo tree entry across records without relying on display text.
* **Enables:** match `id` to repo tree entry references carrying the same GitLab-issued value in related GitLab records.
* **Interpretation:** GitLab reports this value on the GitLab Repo Tree Entry object returned for Repository Files; it is an identifier, not a measured quantity.
Developer identifier: `repos.mode`
Mode records unix file mode string (e.g. '100644' for a regular file, '040000' for a directory). It is needed to distinguish Repository Files rows by the exact GitLab-returned mode value.
* **Enables:** separate Repository Files rows by the exact GitLab-returned `mode` label when comparing mode.
* **Interpretation:** GitLab reports this value on the GitLab Repo Tree Entry object returned for Repository Files; it is interpreted at one GitLab Repo Tree Entry record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
Developer identifier: `repos.name`
Name records file or directory name (last path segment). It is needed to compare the returned name for individual Repository Files rows and select rows with a specific `name` value.
* **Enables:** locate Repository Files rows whose returned name exactly matches `name` and retain the GitLab identifier for any cross-record match.
* **Interpretation:** GitLab reports this value on the GitLab Repo Tree Entry object returned for Repository Files; it is interpreted at one GitLab Repo Tree Entry record per row.
Developer identifier: `repos.path`
Path records full path of the entry from the repository root. It is needed to distinguish repeated deliveries of the same Repository Files row using the declared ingestion key.
* **Enables:** use `path` as the declared ingestion deduplication key for Repository Files and match repeated rows carrying the same GitLab identifier.
* **Interpretation:** GitLab reports this value on the GitLab Repo Tree Entry object returned for Repository Files; it is interpreted at one GitLab Repo Tree Entry record per row; the connector declares it as an ingestion deduplication key; the schema uses the `Asset.FilePath` scalar.
Developer identifier: `repos.type`
Type records entry type: 'tree' for a directory, 'blob' for a file. It is needed to distinguish Repository Files rows by the exact GitLab-returned type value.
* **Enables:** separate Repository Files rows by the exact GitLab-returned `type` label when comparing type.
* **Interpretation:** GitLab reports this value on the GitLab Repo Tree Entry object returned for Repository Files; it is interpreted at one GitLab Repo Tree Entry record per row; classification values are GitLab-returned labels rather than a universal taxonomy.
### Request limits
Independent project and group reads can overlap. Pages within one parent
remain sequential, and every attempt shares the connector's 2,000
requests/minute budget. There is no separate concurrency cap; request
pacing and local response capacity bound how many requests overlap.
The catalog also applies GitLab.com's current endpoint limits: 2,000
project-list requests per ten minutes, 50 group-list requests per minute,
and one shared 200 requests/minute budget for inherited project and group
membership reads. These are shared user allowances, not separate grants
for each project or group. See [GitLab.com rate limits](https://docs.gitlab.com/user/gitlab_com/rate_limits/)
and [membership rate limits](https://docs.gitlab.com/rate_limits/api/projects/).
A `429` pauses the budgets used by that request for `Retry-After`. If the
header is absent or invalid, each paced budget waits its declared window.
Response quota headers do not raise these limits. Self-managed instances
can have different limits, and other traffic from the same user or egress
IP can consume shared allowance. This policy assumes one ingestion producer
for the credential; it does not coordinate other clients or pods.
| Error | Meaning | Solution |
| - | - | - |
| `401 Unauthorized` | Invalid token | Verify token is correct and not expired |
| `403 Forbidden` | Insufficient scope | Add required scope and regenerate |
| `404 Not Found` | No access to resource | Check user has project/group membership |
| `429 Rate Limited` | Too many requests | If this occurs during setup, wait briefly, then click **Save & test connection** again. If this occurs during syncing, Parable retries automatically for a limited time. If the sync still fails, review the connection error before retrying. |
#### Common Issues
#### Token expired
GitLab PATs have expiration dates. Generate a new token with a longer expiration.
#### Can't access group projects
Ensure your GitLab user has at least Reporter access to the group.
**[GitLab API](https://docs.gitlab.com/ee/api/)** — Official API documentation
**[Token Types](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)** — Access token guide
# Gong API
Source: https://docs.parable.work/plugins/provider-plugins/gong
Gong is a revenue intelligence platform that captures and analyzes customer interactions (calls, meetings, emails) to provide insights for sales teams. It offers conversation analytics, deal intelligence, coaching scorecards, and CRM integration capabilities. The Gong API (v2) provides programmatic access to calls, transcripts, users, activity statistics, scorecards, trackers, workspaces, CRM entities, and audit logs.
Gong is a revenue intelligence platform that captures and analyzes customer interactions (calls, meetings, emails) to provide insights for sales teams. It offers conversation analytics, deal intelligence, coaching scorecards, and CRM integration capabilities. The Gong API (v2) provides programmatic access to calls, transcripts, users, activity statistics, scorecards, trackers, workspaces, CRM entities, and audit logs.
### Gong
Connect Parable to Gong for calls, CRM, meetings, and workspace analytics using HTTP Basic authentication with a workspace-scoped Access Key and Secret.
#### Conversations & CRM
Call recordings, transcripts, CRM associations, meetings
#### People & workspace
Users, workspaces, scorecards, trackers, audit logs
### Gong (OAuth)
Connect Parable to Gong using OAuth 2.0 with Parable's in-app authorization wizard. You create a Gong OAuth application, register Parable's redirect URI, set **API Base URL** under Connection Settings, then authorize from the Provider page. Parable exchanges the authorization code, stores tokens securely, and may update **API Base URL** from Gong when the token response includes a regional endpoint.
You do not paste a refresh token manually.
#### Conversations & CRM
Call recordings, transcripts, CRM associations, meetings
#### People & workspace
Users, workspaces, scorecards, trackers, audit logs
## Data streams
This Provider Plugin defines 20 data streams.
| Stream | Description | Sync |
| - | - | - |
| `calls` | List all calls by date range from Gong. Returns basic call metadata including call ID, title, scheduled time, duration, direction, and participants. | incremental |
| `calls_extensive` | Retrieve detailed/extensive call data from Gong including topics, trackers, parties, key points, highlights, and other rich content fields. Uses POST with filter and content selector. | incremental |
| `call_transcripts` | Retrieve call transcripts from Gong. Returns transcript segments with speaker identification, timestamps, and text for each call. NOTE: Gong does not expose a per-transcript modified timestamp; the watermark is the run window's end (`fromDateTime`), not a record-level cursor. Re-running an overlapping window refetches transcripts (PK = callId). Bronze stores every run as a new partition; downstream Silver/Gold layers are responsible for dedup-on-`callId`-keep-latest. | incremental |
| `users` | List all Gong users in the organization. Returns user profiles including name, email, role, and activity status. | full |
| `user_settings_history` | Retrieve the settings change history for each Gong user. Returns historical records of user settings changes over time, useful for tracking configuration changes and compliance auditing. This is a child endpoint of users — it iterates over all users and fetches settings history for each one via GET /v2/users//settings-history. | full |
| `scorecards` | Retrieve all scorecard definitions/settings from Gong. Returns scorecard templates with their questions and scoring criteria. | full |
| `answered_scorecards` | Retrieve answered/completed scorecards for calls within a date range. Returns scorecard responses with scores, answers, and reviewer information. | incremental |
| `trackers` | Retrieve all keyword tracker definitions from Gong. Returns tracker configurations including keywords, phrases, and associated settings. | full |
| `workspaces` | List all company workspaces in Gong. Returns workspace definitions with names and configuration. | full |
| `library_folders` | List all public library folders in Gong. Returns folder hierarchy for organizing call recordings. | full |
| `logs` | List log entries from Gong by type and time range. Returns audit/activity log entries for compliance and monitoring. | incremental |
| `manual_crm_associations` | List calls that have been manually associated with CRM objects since a given time. Returns association mappings between calls and CRM entities. | incremental |
| `daily_activity` | Retrieve day-by-day activity statistics for users. Returns one row per user (with a `dayActivity` array) snapshotting the configured incremental window. NOTE: snapshot semantics — PK = userId; rerunning with an overlapping window emits a fresh snapshot row per user for that window. Bronze appends every run as a new partition; Silver/Gold are responsible for dedup-on-userId-keep-latest. `cursorField` is `fromDate`, the window-start filter sent in the request body, since aggregate responses have no per-record timestamp. | incremental |
| `interaction_stats` | Retrieves interaction statistics for users including coaching and whisper call metrics. Provides data on manager-rep interaction patterns. | incremental |
| `crm_entities` | DISABLED: Gong has no list CRM entities API. GET /v2/crm/entities only fetches objects by known CRM IDs (dev verification). Use calls\_extensive (Extended context) and manual\_crm\_associations for CRM data. Enable only for explicit ID-based enrichment follow-ups. | full |
| `meetings` | DISABLED: Gong has no list meetings API. Meeting metadata (meetingUrl, calendarEventId, schedule) is available on calls and calls\_extensive. Enable only if a future Gong list endpoint is added. | incremental |
| `activity_aggregate` | Retrieve aggregated user activity statistics from Gong. Returns one row per user summarising the configured incremental window. NOTE: snapshot semantics — PK = userId; rerunning with an overlapping window emits a fresh snapshot row per user for that window. Bronze appends every run as a new partition; Silver/Gold are responsible for dedup-on-userId-keep-latest. `cursorField` is `fromDate`, the window-start filter sent in the request body. | incremental |
| `activity_aggregate_by_period` | Retrieve user activity statistics aggregated by time period from Gong. Same metrics as activity\_aggregate broken down by configurable time buckets. NOTE: snapshot semantics — PK = userId; rerunning with an overlapping window emits a fresh snapshot row per user for that window. Bronze appends every run as a new partition; Silver/Gold are responsible for dedup-on-userId-keep-latest. `cursorField` is `fromDate`, the window-start filter sent in the request body. | incremental |
| `permission_profiles` | Retrieve all permission profiles from Gong for each workspace. Returns workspace permission profiles including profile IDs, names, and access settings. | full |
| `crm_integrations` | Retrieve CRM integration configuration from Gong. Returns details about connected CRM systems, schema fields, deal stages, and object mappings. | full |
### Gong
#### What You'll Need
| Credential | What it is |
| - | - |
| **Access Key** | Workspace API access key from Gong |
| **Access Key Secret** | Secret shown once when the key is created |
| **API Base URL** | Gong API host (`https://api.gong.io` or your regional URL from Company Settings) |
> **Info:** **Setup access in Gong.** These steps require **Technical Administrator (to create API keys and manage scopes)**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Gong administrator.
* Your Gong **API Base URL**. Most workspaces use `https://api.gong.io`. Regional endpoints (for example `https://us-12345.api.gong.io`) appear under **Company Settings → Ecosystem → API**.
> **Info:** Gong API keys are workspace-scoped. They can expire; Gong notifies workspace admins before rotation.
#### Step 1: Open Gong API settings
1. Sign in to Gong as a Technical Administrator.
2. Open **Company Settings → Ecosystem → API** (or go to app.gong.io/company/api).
#### Step 2: Enable required API scopes
Each API key in Gong has scopes toggled individually. Enable only the scopes for the data categories you want Parable to collect.
| Scope | Purpose |
| - | - |
| `api:calls:read:basic` | Call recordings |
| `api:calls:read:extensive` | Call details & AI insights |
| `api:calls:read:transcript` | Call transcripts |
| `api:users:read` | Users & settings history |
| `api:settings:scorecards:read` | Scorecard definitions |
| `api:stats:scorecards` | Scorecard responses |
| `api:settings:trackers:read` | Tracker definitions |
| `api:workspaces:read` | Workspaces & library folders |
| `api:logs:read` | Audit logs |
| `api:crm-calls:manual-association:read` | CRM call associations |
| `api:stats:user-actions:detailed` | Daily user activity |
| `api:stats:interaction` | Interaction statistics |
| `api:stats:user-actions` | Activity aggregates |
| `api:crm:get-objects` | CRM entities (Accounts, Contacts, Deals) |
| `api:meetings:integration:status` | Meetings |
| `api:permission-profile:read` | Permission profiles |
| `api:crm:integrations:read` | CRM integrations |
> **Info:** `api:permission-profile:read` may need to be enabled by Gong Support on some tiers.
#### Step 3: Create API credentials
1. Click **Get API Key**.
2. Copy the **Access Key** and **Access Key Secret**. The secret is shown once — store it in a password manager before closing the page.
> **Warning:** **Copy your Access Key Secret now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
#### Step 4: Enter values in the form
1. **Access Key**, **Access Key Secret**, and **API Base URL**: Enter the values from Gong (use your regional base URL if applicable).
2. Click **Save & test connection**.
### Gong (OAuth)
#### What You'll Need
| Credential | What it is |
| - | - |
| **Client ID** | OAuth application client ID from Gong |
| **Client Secret** | OAuth application client secret |
| **API Base URL** | Gong API host. Default `https://api.gong.io`; use your regional URL when Gong provides one |
> **Info:** **Setup access in Gong.** These steps require **Technical Administrator (to create OAuth applications and manage scopes)**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Gong administrator.
* A Gong OAuth application with the API scopes you need enabled
* Permission to register redirect URIs on that OAuth application
* Your Gong **API Base URL**. Most workspaces use `https://api.gong.io`. Regional endpoints (for example `https://us-12345.api.gong.io`) appear under Gong **Settings → Technical Settings → API Authentication**.
#### Step 1: Create a Gong OAuth application
1. Sign in to Gong as a Technical Administrator.
2. Open **Company Settings → Ecosystem → API**.
3. Select the **Integrations** tab.
4. Create an OAuth application and note the **Client ID** and **Client Secret**.
#### Step 2: Enable required API scopes
Each OAuth application in Gong has scopes toggled individually. Enable only the scopes for the data categories you want Parable to collect.
| Scope | Purpose |
| - | - |
| `api:calls:read:basic` | Call recordings |
| `api:calls:read:extensive` | Call details & AI insights |
| `api:calls:read:transcript` | Call transcripts |
| `api:users:read` | Users & settings history |
| `api:settings:scorecards:read` | Scorecard definitions |
| `api:stats:scorecards` | Scorecard responses |
| `api:settings:trackers:read` | Tracker definitions |
| `api:workspaces:read` | Workspaces & library folders |
| `api:logs:read` | Audit logs |
| `api:crm-calls:manual-association:read` | CRM call associations |
| `api:stats:user-actions:detailed` | Daily user activity |
| `api:stats:interaction` | Interaction statistics |
| `api:stats:user-actions` | Activity aggregates |
| `api:crm:get-objects` | CRM entities (Accounts, Contacts, Deals) |
| `api:meetings:integration:status` | Meetings |
| `api:permission-profile:read` | Permission profiles |
| `api:crm:integrations:read` | CRM integrations |
> **Info:** `api:permission-profile:read` may need to be enabled by Gong Support on some tiers.
#### Step 3: Create the connection in Parable
1. Open the Gong **OAuth** Provider in Parable and click to add a connection.
2. Enter a **connection name**.
3. Under **Connection Settings**, set **API Base URL**. Leave the default (`https://api.gong.io`) unless Gong shows a regional endpoint (for example `https://us-12345.api.gong.io`).
4. Copy the **Redirect URI** shown on the form.
5. Click **Continue to OAuth setup**.
Parable creates the connection and opens the OAuth authorization screen.
#### Step 4: Register the redirect URI in Gong
1. In your Gong OAuth application settings, add the **Redirect URI** you copied from Parable as an allowed redirect URI.
2. Register it **exactly** as shown (including your workspace subdomain and path).
> **Info:** The redirect URI includes your workspace subdomain. Example: `https://{tenant-name}.parable.work/platform/providers/oauth/callback`. Do **not** register the apex host alone (`https://parable.work/...`). Gong must match the subdomain of the workspace where you started the connection.
#### Step 5: Authorize with Parable
1. On the OAuth authorization screen, enter your **Client ID** and **Client Secret**.
2. Click **Connect with OAuth**. You are redirected to Gong to approve permissions.
3. After you approve, Parable redirects back automatically, stores your tokens, and validates the connection. If Gong returns a regional API host in the token response, Parable updates **API Base URL** on the connection.
> **Info:** Parable validates credentials automatically after authorization. You do not paste a refresh token, and there is no separate **Save & test connection** step on the OAuth authorization screen.
To rotate credentials later, click **Re-authorize with OAuth** on the connection page.
Parable shows **API Base URL** under **Connection Settings** on the Gong OAuth create and connection forms (default `https://api.gong.io`). Syncs use this value as the Gong API host. After OAuth completes, if Gong returns a regional host with the tokens, Parable updates the same setting.
| Value | When to use |
| - | - |
| `https://api.gong.io` | Default for most Gong accounts |
| `https://us-12345.api.gong.io` (example) | Regional host shown in Gong **Settings → Technical Settings → API Authentication** |
### Gong
| Scope | Purpose |
| - | - |
| `api:calls:read:basic` | Call recordings |
| `api:calls:read:extensive` | Call details & AI insights |
| `api:calls:read:transcript` | Call transcripts |
| `api:users:read` | Users & settings history |
| `api:settings:scorecards:read` | Scorecard definitions |
| `api:stats:scorecards` | Scorecard responses |
| `api:settings:trackers:read` | Tracker definitions |
| `api:workspaces:read` | Workspaces & library folders |
| `api:logs:read` | Audit logs |
| `api:crm-calls:manual-association:read` | CRM call associations |
| `api:stats:user-actions:detailed` | Daily user activity |
| `api:stats:interaction` | Interaction statistics |
| `api:stats:user-actions` | Activity aggregates |
| `api:crm:get-objects` | CRM entities (Accounts, Contacts, Deals) |
| `api:meetings:integration:status` | Meetings |
| `api:permission-profile:read` | Permission profiles |
| `api:crm:integrations:read` | CRM integrations |
### Gong (OAuth)
| Scope | Purpose |
| - | - |
| `api:calls:read:basic` | Call recordings |
| `api:calls:read:extensive` | Call details & AI insights |
| `api:calls:read:transcript` | Call transcripts |
| `api:users:read` | Users & settings history |
| `api:settings:scorecards:read` | Scorecard definitions |
| `api:stats:scorecards` | Scorecard responses |
| `api:settings:trackers:read` | Tracker definitions |
| `api:workspaces:read` | Workspaces & library folders |
| `api:logs:read` | Audit logs |
| `api:crm-calls:manual-association:read` | CRM call associations |
| `api:stats:user-actions:detailed` | Daily user activity |
| `api:stats:interaction` | Interaction statistics |
| `api:stats:user-actions` | Activity aggregates |
| `api:crm:get-objects` | CRM entities (Accounts, Contacts, Deals) |
| `api:meetings:integration:status` | Meetings |
| `api:permission-profile:read` | Permission profiles |
| `api:crm:integrations:read` | CRM integrations |
> **Info:** `api:permission-profile:read` may need to be enabled by Gong Support on some tiers.
> **Success:** After authorization, Parable shows an authorized status and validates the connection automatically.
> **Tip:** **Rate Limits:** Gong enforces rate limits of **about 3 requests per second; Parable respects Retry-After**.
>
> Parable handles rate limiting automatically with exponential backoff, but initial syncs of large datasets may take longer due to these limits.
Developer identifier: `activity_aggregate`
**Activity Aggregate.** Retrieve aggregated user activity statistics from Gong. Returns one row per user summarising the configured incremental window. `cursorField` is `fromDate`, the window-start filter sent in the request body.
* **Enables:** Measure each user's provider-reported aggregate activity counts across the configured request window.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/stats/activity/aggregate` operation as a snapshot stream using incremental synchronization. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. Aggregate activity counts reflect Gong's definitions and the configured request window; they do not establish work quality or employee performance. This stream supplies no reliable deletion signal.
Developer identifier: `activity_aggregate.userAggregateActivityStats`
**User Aggregate Activity Stats.** Aggregated activity counts for the user over the window. It preserves the nested context needed to interpret the parent activity aggregate.
* **Enables:** Attribute user aggregate activity stats in `activity_aggregate.userAggregateActivityStats` to the parent activity aggregate; identify parent records where that nested user aggregate activity stats object is absent.
* **Interpretation:** Gong API reports user aggregate activity stats as a nested object on each activity aggregate; optional children may be absent from a valid response.
Developer identifier: `activity_aggregate.userAggregateActivityStats.callsAsHost`
**Calls As Host.** Total calls as host. It supplies the calls as host measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure calls as host through `activity_aggregate.userAggregateActivityStats.callsAsHost` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls as host as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userAggregateActivityStats.callsAttended`
**Calls Attended.** Total calls attended. It supplies the calls attended measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure calls attended through `activity_aggregate.userAggregateActivityStats.callsAttended` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls attended as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userAggregateActivityStats.callsCommentsGiven`
**Calls Comments Given.** Total comments given. It supplies the calls comments given measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure calls comments given through `activity_aggregate.userAggregateActivityStats.callsCommentsGiven` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls comments given as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userAggregateActivityStats.callsCommentsReceived`
**Calls Comments Received.** Total comments received. It supplies the calls comments received measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure calls comments received through `activity_aggregate.userAggregateActivityStats.callsCommentsReceived` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls comments received as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userAggregateActivityStats.callsGaveFeedback`
**Calls Gave Feedback.** Total calls where the user gave feedback. It supplies the calls gave feedback measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure calls gave feedback through `activity_aggregate.userAggregateActivityStats.callsGaveFeedback` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls gave feedback as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userAggregateActivityStats.callsMarkedAsFeedbackGiven`
**Calls Marked As Feedback Given.** Total calls marked as feedback given. It supplies the calls marked as feedback given measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure calls marked as feedback given through `activity_aggregate.userAggregateActivityStats.callsMarkedAsFeedbackGiven` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls marked as feedback given as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userAggregateActivityStats.callsMarkedAsFeedbackReceived`
**Calls Marked As Feedback Received.** Total calls marked as feedback received. It supplies the calls marked as feedback received measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure calls marked as feedback received through `activity_aggregate.userAggregateActivityStats.callsMarkedAsFeedbackReceived` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls marked as feedback received as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userAggregateActivityStats.callsReceivedFeedback`
**Calls Received Feedback.** Total calls where the user received feedback. It supplies the calls received feedback measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure calls received feedback through `activity_aggregate.userAggregateActivityStats.callsReceivedFeedback` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls received feedback as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userAggregateActivityStats.callsRequestedFeedback`
**Calls Requested Feedback.** Total calls where the user requested feedback. It supplies the calls requested feedback measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure calls requested feedback through `activity_aggregate.userAggregateActivityStats.callsRequestedFeedback` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls requested feedback as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userAggregateActivityStats.callsScorecardsFilled`
**Calls Scorecards Filled.** Total scorecards filled. It supplies the calls scorecards filled measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure calls scorecards filled through `activity_aggregate.userAggregateActivityStats.callsScorecardsFilled` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls scorecards filled as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userAggregateActivityStats.callsScorecardsReceived`
**Calls Scorecards Received.** Total scorecards received. It supplies the calls scorecards received measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure calls scorecards received through `activity_aggregate.userAggregateActivityStats.callsScorecardsReceived` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls scorecards received as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userAggregateActivityStats.callsSharedExternally`
**Calls Shared Externally.** Total calls shared externally. It supplies the calls shared externally measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure calls shared externally through `activity_aggregate.userAggregateActivityStats.callsSharedExternally` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls shared externally as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userAggregateActivityStats.callsSharedInternally`
**Calls Shared Internally.** Total calls shared internally. It supplies the calls shared internally measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure calls shared internally through `activity_aggregate.userAggregateActivityStats.callsSharedInternally` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls shared internally as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userAggregateActivityStats.othersCallsListenedTo`
**Others Calls Listened To.** Total others' calls listened to. It supplies the others calls listened to measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure others calls listened to through `activity_aggregate.userAggregateActivityStats.othersCallsListenedTo` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports others calls listened to as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userAggregateActivityStats.ownCallsListenedTo`
**Own Calls Listened To.** Total own calls listened to. It supplies the own calls listened to measure for the user aggregate activity stat at the provider's declared unit and grain.
* **Enables:** Measure own calls listened to through `activity_aggregate.userAggregateActivityStats.ownCallsListenedTo` for each user aggregate activity stat and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports own calls listened to as a measure on each user aggregate activity stat; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate.userEmailAddress`
**User Email Address.** Email address of the user. It supplies the provider-reported address or location facet for the activity aggregate, not a residency determination.
* **Enables:** Attribute each activity aggregate to a person or account by the exact user email address in `activity_aggregate.userEmailAddress`; identify addresses that do not match the Gong API directory.
* **Interpretation:** Gong API reports user email address as an address on each activity aggregate; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `activity_aggregate.userId`
**User ID.** User ID. It provides the reference needed to connect the activity aggregate to the corresponding provider object.
* **Enables:** Match repeated activity aggregate entries on user ID in `activity_aggregate.userId`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports user ID as an identifier in its user namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `activity_aggregate_by_period`
**Activity Aggregate By Period.** Retrieve user activity statistics aggregated by time period from Gong. Same metrics as activity\_aggregate broken down by configurable time buckets. `cursorField` is `fromDate`, the window-start filter sent in the request body.
* **Enables:** Compare each user's provider-reported activity counts across the configured period buckets.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/stats/activity/aggregate-by-period` operation as a snapshot stream using incremental synchronization. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. Period aggregates reflect Gong's definitions and requested buckets; they do not establish work quality or employee performance. This stream supplies no reliable deletion signal.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity`
**User Aggregate Activity.** Aggregated activity counts per time period. It preserves the nested context needed to interpret the parent activity aggregate by period.
* **Enables:** Measure each returned user aggregate activity in `activity_aggregate_by_period.userAggregateActivity` at its element and time grain; compare values only when Gong API reports the same unit and aggregation.
* **Interpretation:** Gong API returns user aggregate activity as an array of user aggregate activity entries on each activity aggregate by period; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.callsAsHost`
**Calls As Host.** Calls as host in period. It supplies the calls as host measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure calls as host through `activity_aggregate_by_period.userAggregateActivity.callsAsHost` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls as host as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.callsAttended`
**Calls Attended.** Calls attended in period. It supplies the calls attended measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure calls attended through `activity_aggregate_by_period.userAggregateActivity.callsAttended` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls attended as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.callsCommentsGiven`
**Calls Comments Given.** Comments given in period. It supplies the calls comments given measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure calls comments given through `activity_aggregate_by_period.userAggregateActivity.callsCommentsGiven` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls comments given as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.callsCommentsReceived`
**Calls Comments Received.** Comments received in period. It supplies the calls comments received measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure calls comments received through `activity_aggregate_by_period.userAggregateActivity.callsCommentsReceived` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls comments received as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.callsGaveFeedback`
**Calls Gave Feedback.** Calls where the user gave feedback in period. It supplies the calls gave feedback measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure calls gave feedback through `activity_aggregate_by_period.userAggregateActivity.callsGaveFeedback` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls gave feedback as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.callsMarkedAsFeedbackGiven`
**Calls Marked As Feedback Given.** Calls marked as feedback given in period. It supplies the calls marked as feedback given measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure calls marked as feedback given through `activity_aggregate_by_period.userAggregateActivity.callsMarkedAsFeedbackGiven` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls marked as feedback given as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.callsMarkedAsFeedbackReceived`
**Calls Marked As Feedback Received.** Calls marked as feedback received in period. It supplies the calls marked as feedback received measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure calls marked as feedback received through `activity_aggregate_by_period.userAggregateActivity.callsMarkedAsFeedbackReceived` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls marked as feedback received as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.callsReceivedFeedback`
**Calls Received Feedback.** Calls where the user received feedback in period. It supplies the calls received feedback measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure calls received feedback through `activity_aggregate_by_period.userAggregateActivity.callsReceivedFeedback` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls received feedback as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.callsRequestedFeedback`
**Calls Requested Feedback.** Calls where the user requested feedback in period. It supplies the calls requested feedback measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure calls requested feedback through `activity_aggregate_by_period.userAggregateActivity.callsRequestedFeedback` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls requested feedback as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.callsScorecardsFilled`
**Calls Scorecards Filled.** Scorecards filled in period. It supplies the calls scorecards filled measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure calls scorecards filled through `activity_aggregate_by_period.userAggregateActivity.callsScorecardsFilled` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls scorecards filled as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.callsScorecardsReceived`
**Calls Scorecards Received.** Scorecards received in period. It supplies the calls scorecards received measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure calls scorecards received through `activity_aggregate_by_period.userAggregateActivity.callsScorecardsReceived` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls scorecards received as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.callsSharedExternally`
**Calls Shared Externally.** Calls shared externally in period. It supplies the calls shared externally measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure calls shared externally through `activity_aggregate_by_period.userAggregateActivity.callsSharedExternally` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls shared externally as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.callsSharedInternally`
**Calls Shared Internally.** Calls shared internally in period. It supplies the calls shared internally measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure calls shared internally through `activity_aggregate_by_period.userAggregateActivity.callsSharedInternally` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls shared internally as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.fromDate`
**From Date.** Start of the period in ISO-8601. It anchors the activity aggregate by period on the provider's reported timeline.
* **Enables:** Match repeated user aggregate activity entries on from date in `activity_aggregate_by_period.userAggregateActivity.fromDate`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports from date as a timestamp on each user aggregate activity; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.othersCallsListenedTo`
**Others Calls Listened To.** Others' calls listened to in period. It supplies the others calls listened to measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure others calls listened to through `activity_aggregate_by_period.userAggregateActivity.othersCallsListenedTo` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports others calls listened to as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.ownCallsListenedTo`
**Own Calls Listened To.** Own calls listened to in period. It supplies the own calls listened to measure for the user aggregate activity at the provider's declared unit and grain.
* **Enables:** Measure own calls listened to through `activity_aggregate_by_period.userAggregateActivity.ownCallsListenedTo` for each user aggregate activity and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports own calls listened to as a measure on each user aggregate activity; compare only records with the same unit and aggregation grain.
Developer identifier: `activity_aggregate_by_period.userAggregateActivity.toDate`
**To Date.** End of the period in ISO-8601. It anchors the activity aggregate by period on the provider's reported timeline.
* **Enables:** Order Activity Aggregate By Period by to date in `activity_aggregate_by_period.userAggregateActivity.toDate` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports to date as a timestamp on each user aggregate activity; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `activity_aggregate_by_period.userEmailAddress`
**User Email Address.** Email address of the user. It supplies the provider-reported address or location facet for the activity aggregate by period, not a residency determination.
* **Enables:** Attribute each activity aggregate by period to a person or account by the exact user email address in `activity_aggregate_by_period.userEmailAddress`; identify addresses that do not match the Gong API directory.
* **Interpretation:** Gong API reports user email address as an address on each activity aggregate by period; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `activity_aggregate_by_period.userId`
**User ID.** User ID. It provides the reference needed to connect the activity aggregate by period to the corresponding provider object.
* **Enables:** Match repeated activity aggregate by period entries on user ID in `activity_aggregate_by_period.userId`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports user ID as an identifier in its user namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `answered_scorecards`
**Answered Scorecards.** Retrieve answered/completed scorecards for calls within a date range. Returns scorecard responses with scores, answers, and reviewer information.
* **Enables:** Match provider-entered scorecard answers to calls, questions, reviewers, and completion times.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/stats/activity/scorecards` operation as an event stream using incremental synchronization. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. Answers, scores, and reviewer context are entered or calculated in Gong and must remain within their scorecard and call context. This stream supplies no reliable deletion signal.
Developer identifier: `answered_scorecards.answeredScorecardId`
**Answered Scorecard ID.** Unique identifier. It provides the reference needed to connect the answered scorecard to the corresponding provider object.
* **Enables:** Match repeated answered scorecard entries on answered scorecard ID in `answered_scorecards.answeredScorecardId`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports answered scorecard ID as an identifier in its answered scorecard namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `answered_scorecards.answers`
**Answers.** Answers given for each scorecard question. It preserves the nested context needed to interpret the parent answered scorecard.
* **Enables:** Search the returned answers content in `answered_scorecards.answers` while preserving element order and attribution to the parent answered scorecard.
* **Interpretation:** Gong API returns answers as ordered content or provider-generated content metadata on each answered scorecard; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `answered_scorecards.answers.answerText`
**Answer Text.** Free-text answer or numeric score as text. Nullable. It defines the content surface available for this answered scorecard.
* **Enables:** Locate answer records by answer text in `answered_scorecards.answers.answerText`; attribute each text match to its parent answered scorecard and, when present, its reported author.
* **Interpretation:** Gong supplies this call content; provider-generated excerpts or summaries may omit context and are not Parable-authored assessments.
Developer identifier: `answered_scorecards.answers.isOverall`
**Is Overall.** The provider-reported is overall for each answer in Answered Scorecards. It distinguishes the provider-defined is overall state or classification for the answer.
* **Enables:** Filter Answered Scorecards by whether is overall in `answered_scorecards.answers.isOverall`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports is overall as a boolean on each answer; a missing field is unknown, not false.
Developer identifier: `answered_scorecards.answers.notApplicable`
**Not Applicable.** Whether the reviewer marked the question not applicable. It distinguishes the provider-defined not applicable state or classification for the answer.
* **Enables:** Filter Answered Scorecards by whether the reviewer marked the question not applicable in `answered_scorecards.answers.notApplicable`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports the reviewer marked the question not applicable as a boolean on each answer; a missing field is unknown, not false.
Developer identifier: `answered_scorecards.answers.questionId`
**Question ID.** The provider-reported question ID for each answer in Answered Scorecards. It provides the reference needed to connect the answered scorecard to the corresponding provider object.
* **Enables:** Match repeated answer entries on question ID in `answered_scorecards.answers.questionId`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports question ID as an identifier in its question namespace; it is not a universal identity outside Gong API.
Developer identifier: `answered_scorecards.answers.questionRevisionId`
**Question Revision ID.** The provider-reported question revision ID for each answer in Answered Scorecards. It provides the reference needed to connect the answered scorecard to the corresponding provider object.
* **Enables:** Connect each answer in Answered Scorecards to the referenced question revision through `answered_scorecards.answers.questionRevisionId`; flag question revision ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports question revision ID as an identifier in its question revision namespace; it is not a universal identity outside Gong API.
Developer identifier: `answered_scorecards.answers.score`
**Score.** Numeric score for the question, if applicable. It supplies the returned score text needed to understand the answer in context.
* **Enables:** Search the returned score text in `answered_scorecards.answers.score` and attribute each match to its parent answered scorecard and reported author when available.
* **Interpretation:** Gong API supplies score as returned text on each answer; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `answered_scorecards.answers.selectedOptions`
**Selected Options.** Selected answer options for choice questions. Nullable. It preserves the nested context needed to interpret the parent answered scorecard.
* **Enables:** Compare the exact Gong API-configured selected options set in `answered_scorecards.answers.selectedOptions` for each answer; preserve provider labels and unknown entries.
* **Interpretation:** Gong API returns selected options as an array of selected option value entries on each answer; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `answered_scorecards.callId`
**Call ID.** Call ID that was scored. It provides the reference needed to connect the answered scorecard to the corresponding provider object.
* **Enables:** Connect each answered scorecard in Answered Scorecards to the referenced call through `answered_scorecards.callId`; flag call ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports call ID as an identifier in its call namespace; it is not a universal identity outside Gong API.
Developer identifier: `answered_scorecards.callStartTime`
**Call Start Time.** Call start time. It anchors the answered scorecard on the provider's reported timeline.
* **Enables:** Filter Answered Scorecards by call start time in `answered_scorecards.callStartTime`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** Gong API reports call start time as a timestamp on each answered scorecard; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `answered_scorecards.editorUserId`
**Editor User ID.** User who last edited the answered scorecard. Nullable. It provides the reference needed to connect the answered scorecard to the corresponding provider object.
* **Enables:** Connect each answered scorecard in Answered Scorecards to the referenced editor user through `answered_scorecards.editorUserId`; flag editor user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports editor user ID as an identifier in its editor user namespace; it is not a universal identity outside Gong API.
Developer identifier: `answered_scorecards.reviewedUserId`
**Reviewed User ID.** User being reviewed. It provides the reference needed to connect the answered scorecard to the corresponding provider object.
* **Enables:** Connect each answered scorecard in Answered Scorecards to the referenced reviewed user through `answered_scorecards.reviewedUserId`; flag reviewed user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports reviewed user ID as an identifier in its reviewed user namespace; it is not a universal identity outside Gong API.
Developer identifier: `answered_scorecards.reviewerUserId`
**Reviewer User ID.** Reviewer user ID. Null when the scorecard was filled automatically. It provides the reference needed to connect the answered scorecard to the corresponding provider object.
* **Enables:** Connect each answered scorecard in Answered Scorecards to the referenced reviewer user through `answered_scorecards.reviewerUserId`; flag reviewer user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports reviewer user ID as an identifier in its reviewer user namespace; it is not a universal identity outside Gong API.
Developer identifier: `answered_scorecards.reviewMethod`
**Review Method.** How the scorecard was completed (e.g., MANUAL, AUTOMATIC). It distinguishes the provider-defined review method state or classification for the answered scorecard.
* **Enables:** Filter Answered Scorecards by the exact Gong API-defined review method in `answered_scorecards.reviewMethod` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies review method from its own taxonomy on each answered scorecard; preserve unknown and newly introduced labels.
Developer identifier: `answered_scorecards.reviewTime`
**Review Time.** Review completion time. It is needed to place the answered scorecard on the provider timeline at the field's stated precision.
* **Enables:** Order Answered Scorecards by the provider-reported instant in `answered_scorecards.reviewTime` and isolate records inside the same time window and precision.
* **Interpretation:** Gong API reports review time as a time value for each answered scorecard; format, timezone, precision, and absolute-versus-relative meaning follow this field's contract. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `answered_scorecards.scorecardId`
**Scorecard ID.** Scorecard template ID. It provides the reference needed to connect the answered scorecard to the corresponding provider object.
* **Enables:** Connect each answered scorecard in Answered Scorecards to the referenced scorecard through `answered_scorecards.scorecardId`; flag scorecard ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports scorecard ID as an identifier in its scorecard namespace; it is not a universal identity outside Gong API.
Developer identifier: `answered_scorecards.scorecardName`
**Scorecard Name.** Scorecard name. It gives the answered scorecard a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each answered scorecard with scorecard name from `answered_scorecards.scorecardName`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports scorecard name as display text for each answered scorecard; names are mutable and are not stable identities.
Developer identifier: `answered_scorecards.visibilityType`
**Visibility Type.** Visibility setting. It distinguishes the provider-defined visibility type state or classification for the answered scorecard.
* **Enables:** Segment answered scorecard entries in Answered Scorecards by visibility type in `answered_scorecards.visibilityType`; compare counts only within the same Gong API taxonomy.
* **Interpretation:** Gong API reports visibility type as a label from its own taxonomy on each answered scorecard; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `call_transcripts`
**Call Transcripts.** Retrieve call transcripts from Gong. Returns transcript segments with speaker identification, timestamps, and text for each call. Gong does not expose a per-transcript modified timestamp, so the plan's request window supplies `fromDateTime` and `toDateTime`.
* **Enables:** Locate transcript sentences by call, speaker, and offset for conversation review.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/calls/transcript` operation as an event stream using incremental synchronization. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. The stream contains provider transcript text with speaker labels and offsets, not recording audio or video. This stream supplies no reliable deletion signal.
Developer identifier: `call_transcripts.callId`
**Call ID.** Unique identifier of the call. It provides the reference needed to connect the call transcript to the corresponding provider object.
* **Enables:** Match repeated call transcript entries on call ID in `call_transcripts.callId`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports call ID as an identifier in its call namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `call_transcripts.transcript`
**Transcript.** Array of transcript segments. It preserves the nested context needed to interpret the parent call transcript.
* **Enables:** Reconstruct the returned transcript in `call_transcripts.transcript` by preserving sentence order, speaker attribution, and call-relative offsets for the parent call transcript.
* **Interpretation:** Gong API returns transcript as ordered content or provider-generated content metadata on each call transcript; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `call_transcripts.transcript.sentences`
**Sentences.** The provider-returned sentences collection nested under the transcript structure for each call transcript; needed to retain every element with its parent relationship.
* **Enables:** Reconstruct the returned transcript in `call_transcripts.transcript.sentences` by preserving sentence order, speaker attribution, and call-relative offsets for the parent call transcript.
* **Interpretation:** Gong API returns sentences as ordered content or provider-generated content metadata on each transcript; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `call_transcripts.transcript.sentences.end`
**End.** End time in ms. It supplies the end measure for the sentence at the provider's declared unit and grain.
* **Enables:** Order call excerpts by the numeric end in `call_transcripts.transcript.sentences.end`; pair start and end positions before calculating a span.
* **Interpretation:** Gong API reports end as milliseconds on each sentence; compare only records with the same unit and aggregation grain. Gong returns a call-relative position in the stated unit; it is not a wall-clock timestamp.
Developer identifier: `call_transcripts.transcript.sentences.start`
**Start.** Start time in ms. It supplies the start measure for the sentence at the provider's declared unit and grain.
* **Enables:** Order call excerpts by the numeric start in `call_transcripts.transcript.sentences.start`; pair start and end positions before calculating a span.
* **Interpretation:** Gong API reports start as milliseconds on each sentence; compare only records with the same unit and aggregation grain. Gong returns a call-relative position in the stated unit; it is not a wall-clock timestamp.
Developer identifier: `call_transcripts.transcript.sentences.text`
**Text.** Transcribed text. It defines the content surface available for this call transcript.
* **Enables:** Locate sentence records by text in `call_transcripts.transcript.sentences.text`; attribute each text match to its parent call transcript and, when present, its reported author.
* **Interpretation:** This is provider transcript data, not the source audio or video, and speaker attribution can reflect provider labeling limits.
Developer identifier: `call_transcripts.transcript.speakerId`
**Speaker ID.** Speaker ID. It provides the reference needed to connect the call transcript to the corresponding provider object.
* **Enables:** Match repeated transcript entries on speaker ID in `call_transcripts.transcript.speakerId`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports speaker ID as an identifier in its speaker namespace; it is not a universal identity outside Gong API.
Developer identifier: `call_transcripts.transcript.topic`
**Topic.** Topic label. It supplies the returned topic text needed to understand the transcript in context.
* **Enables:** Search the returned topic text in `call_transcripts.transcript.topic` and attribute each match to its parent call transcript and reported author when available.
* **Interpretation:** Gong API supplies topic as returned text on each transcript; truncation, formatting, and access boundaries can limit completeness. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls`
**Calls.** List all calls by date range from Gong. Returns basic call metadata including call ID, title, scheduled time, duration, direction, and participants.
* **Enables:** Inventory Gong call metadata by date range and attribute each call to its participants, direction, and scheduled time.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/calls` operation as a changelog stream using incremental synchronization. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. The stream contains basic call metadata, not transcript text, recordings, or the richer provider-generated content from the extensive-call operation. This stream supplies no reliable deletion signal.
Developer identifier: `calls.calendarEventId`
**Calendar Event ID.** Associated calendar event ID. It provides the reference needed to connect the call to the corresponding provider object.
* **Enables:** Connect each call in Calls to the referenced calendar event through `calls.calendarEventId`; flag calendar event ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports calendar event ID as an identifier in its calendar event namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls.clientUniqueId`
**Client Unique ID.** Client-provided unique identifier. It provides the reference needed to connect the call to the corresponding provider object.
* **Enables:** Connect each call in Calls to the referenced client unique through `calls.clientUniqueId`; flag client unique ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports client unique ID as an identifier in its client unique namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls.customData`
**Custom Data.** Custom data associated with the call. It must be interpreted with the enclosing provider field name, type, or custom schema for the call.
* **Enables:** Interpret `calls.customData` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Gong API reports custom data under the enclosing custom or typed field contract on each call; compare it only with values from the same provider key and type.
Developer identifier: `calls.direction`
**Direction.** Direction of the call (Inbound or Outbound). It distinguishes the provider-defined direction state or classification for the call.
* **Enables:** Filter Calls by the exact Gong API-defined direction in `calls.direction` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies direction from its own taxonomy on each call; preserve unknown and newly introduced labels.
Developer identifier: `calls.duration`
**Duration.** Duration of the call in seconds. It supplies the duration measure for the call at the provider's declared unit and grain.
* **Enables:** Measure duration through `calls.duration` for each call and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports duration as a measure on each call; compare only records with the same unit and aggregation grain.
Developer identifier: `calls.id`
**ID.** Unique identifier for the call. It provides the reference needed to connect the call to the corresponding provider object.
* **Enables:** Match repeated call entries on ID in `calls.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports ID as an identifier in its call namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `calls.isPrivate`
**Is Private.** Whether the call is private. It distinguishes the provider-defined is private state or classification for the call.
* **Enables:** Filter Calls by whether the call is private in `calls.isPrivate`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports the call is private as a boolean on each call; a missing field is unknown, not false.
Developer identifier: `calls.language`
**Language.** Language of the call. It supplies the language profile facet used to reconcile or attribute the call.
* **Enables:** Reconcile the call's language in `calls.language` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Gong API reports language as a mutable profile or directory attribute on each call; it may be absent, shared, or non-unique.
Developer identifier: `calls.media`
**Media.** Media type of the call. It distinguishes the provider-defined media state or classification for the call.
* **Enables:** Filter Calls by the exact Gong API-defined media in `calls.media` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies media from its own taxonomy on each call; preserve unknown and newly introduced labels.
Developer identifier: `calls.meetingUrl`
**Meeting URL.** Meeting URL for the call. It locates the provider resource or path associated with the call.
* **Enables:** Associate each call with the resource identified by meeting URL in `calls.meetingUrl`; verify the link resolves to the expected Gong API object.
* **Interpretation:** Gong API reports meeting URL as a resource locator for each call; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `calls.primaryUserId`
**Primary User ID.** ID of the primary Gong user associated with the call. It provides the reference needed to connect the call to the corresponding provider object.
* **Enables:** Connect each call in Calls to the referenced primary user through `calls.primaryUserId`; flag primary user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports primary user ID as an identifier in its primary user namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls.purpose`
**Purpose.** Purpose of the call. It supplies the returned purpose text needed to understand the call in context.
* **Enables:** Search the returned purpose text in `calls.purpose` and attribute each match to its parent call and reported author when available.
* **Interpretation:** Gong API supplies purpose as returned text on each call; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `calls.scheduled`
**Scheduled.** Scheduled time of the call in ISO-8601 format. It is needed to place the call on the provider timeline at the field's stated precision.
* **Enables:** Order Calls by the provider-reported instant in `calls.scheduled` and isolate records inside the same time window and precision.
* **Interpretation:** Gong API reports scheduled as a time value for each call; format, timezone, precision, and absolute-versus-relative meaning follow this field's contract.
Developer identifier: `calls.scope`
**Scope.** Scope of the call (Internal/External). It distinguishes the provider-defined scope state or classification for the call.
* **Enables:** Filter Calls by the exact Gong API-defined scope in `calls.scope` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies scope from its own taxonomy on each call; preserve unknown and newly introduced labels.
Developer identifier: `calls.sdrDisposition`
**Sdr Disposition.** Sales-development representative disposition tag. It distinguishes the provider-defined sdr disposition state or classification for the call.
* **Enables:** Filter Calls by the exact Gong API-defined sdr disposition in `calls.sdrDisposition` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies sdr disposition from its own taxonomy on each call; preserve unknown and newly introduced labels.
Developer identifier: `calls.started`
**Started.** Actual start time of the call in ISO-8601 format. It anchors the call on the provider's reported timeline.
* **Enables:** Order Calls by started in `calls.started` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports started as a timestamp on each call; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `calls.system`
**System.** Telephony or conferencing system used. It distinguishes the provider-defined system state or classification for the call.
* **Enables:** Filter Calls by the exact Gong API-defined system in `calls.system` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies system from its own taxonomy on each call; preserve unknown and newly introduced labels.
Developer identifier: `calls.title`
**Title.** Title or subject of the call. It supplies the returned title text needed to understand the call in context.
* **Enables:** Label each call with title from `calls.title`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports title as display text for each call; names are mutable and are not stable identities.
Developer identifier: `calls.url`
**URL.** URL to view the call in Gong. It locates the provider resource or path associated with the call.
* **Enables:** Associate each call with the resource identified by URL in `calls.url`; verify the link resolves to the expected Gong API object.
* **Interpretation:** Gong API reports URL as a resource locator for each call; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `calls.workspaceId`
**Workspace ID.** Workspace the call belongs to. It provides the reference needed to connect the call to the corresponding provider object.
* **Enables:** Connect each call in Calls to the referenced workspace through `calls.workspaceId`; flag workspace ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports workspace ID as an identifier in its workspace namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive`
**Calls Extensive.** Retrieve detailed/extensive call data from Gong including topics, trackers, parties, key points, highlights, and other rich content fields. Uses POST with filter and content selector.
* **Enables:** Review Gong-provided topics, trackers, highlights, comments, and interaction measures in the context of each call.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/calls/extensive` operation as a changelog stream using incremental synchronization. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. Gong supplies topics, trackers, highlights, summaries, and classifications; they may be incomplete and are not independent Parable assessments. Transcript text and recording bytes are not part of this operation. This stream supplies no reliable deletion signal.
Developer identifier: `calls_extensive.collaboration`
**Collaboration.** Collaboration data (public comments) on the call. It preserves the nested context needed to interpret the parent extensive call.
* **Enables:** Attribute collaboration in `calls_extensive.collaboration` to the parent extensive call; identify parent records where that nested collaboration object is absent.
* **Interpretation:** Gong API reports collaboration as a nested object on each extensive call; optional children may be absent from a valid response.
Developer identifier: `calls_extensive.collaboration.publicComments`
**Public Comments.** The provider-returned public comments collection nested under the collaboration structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Search the returned public comments content in `calls_extensive.collaboration.publicComments` while preserving element order and attribution to the parent extensive call.
* **Interpretation:** Gong API returns public comments as ordered content or provider-generated content metadata on each collaboration; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `calls_extensive.collaboration.publicComments.audioEndTime`
**Audio End Time.** The provider-reported audio end time for each public comment in extensive call. It supplies the audio end time measure for the public comment at the provider's declared unit and grain.
* **Enables:** Order call excerpts by the numeric audio end time in `calls_extensive.collaboration.publicComments.audioEndTime`; pair start and end positions before calculating a span.
* **Interpretation:** Gong API reports audio end time as a number at the parent record's grain on each public comment; compare only records with the same unit and aggregation grain. Gong returns a numeric call-relative position here, but this declaration does not state a unit; do not interpret it as a wall-clock timestamp.
Developer identifier: `calls_extensive.collaboration.publicComments.audioStartTime`
**Audio Start Time.** The provider-reported audio start time for each public comment in extensive call. It supplies the audio start time measure for the public comment at the provider's declared unit and grain.
* **Enables:** Order call excerpts by the numeric audio start time in `calls_extensive.collaboration.publicComments.audioStartTime`; pair start and end positions before calculating a span.
* **Interpretation:** Gong API reports audio start time as a number at the parent record's grain on each public comment; compare only records with the same unit and aggregation grain. Gong returns a numeric call-relative position here, but this declaration does not state a unit; do not interpret it as a wall-clock timestamp.
Developer identifier: `calls_extensive.collaboration.publicComments.comment`
**Comment.** The provider-reported comment for each public comment in extensive call. It defines the content surface available for this extensive call.
* **Enables:** Locate public comment records by comment in `calls_extensive.collaboration.publicComments.comment`; attribute each text match to its parent extensive call and, when present, its reported author.
* **Interpretation:** Gong supplies this call content; provider-generated excerpts or summaries may omit context and are not Parable-authored assessments.
Developer identifier: `calls_extensive.collaboration.publicComments.commenterUserId`
**Commenter User ID.** The provider-reported commenter user ID for each public comment in extensive call. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each public comment in extensive call to the referenced commenter user through `calls_extensive.collaboration.publicComments.commenterUserId`; flag commenter user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports commenter user ID as an identifier in its commenter user namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.collaboration.publicComments.duringCall`
**During Call.** The provider-reported during call for each public comment in extensive call. It distinguishes the provider-defined during call state or classification for the public comment.
* **Enables:** Filter extensive call by whether during call in `calls_extensive.collaboration.publicComments.duringCall`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports during call as a boolean on each public comment; a missing field is unknown, not false.
Developer identifier: `calls_extensive.collaboration.publicComments.id`
**ID.** The provider-reported ID for each public comment in extensive call. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each public comment in extensive call to the referenced public comment through `calls_extensive.collaboration.publicComments.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports ID as an identifier in its public comment namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.collaboration.publicComments.inReplyTo`
**In Reply To.** The provider-reported in reply to for each public comment in extensive call. It identifies the related provider object that gives the public comment its parent, owner, or container context.
* **Enables:** Connect each public comment to the related in reply to in `calls_extensive.collaboration.publicComments.inReplyTo` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** Gong API reports in reply to as relationship context on each public comment; resolve it in the named provider namespace rather than by display text alone.
Developer identifier: `calls_extensive.collaboration.publicComments.posted`
**Posted.** ISO-8601 timestamp. It is needed to place the public comment on the provider timeline at the field's stated precision.
* **Enables:** Order Calls Extensive by the provider-reported instant in `calls_extensive.collaboration.publicComments.posted` and isolate records inside the same time window and precision.
* **Interpretation:** Gong API reports posted as a time value for each public comment; format, timezone, precision, and absolute-versus-relative meaning follow this field's contract.
Developer identifier: `calls_extensive.content`
**Content.** Rich content for the call (topics, trackers, brief, highlights, etc.). It preserves the nested context needed to interpret the parent extensive call.
* **Enables:** Attribute content in `calls_extensive.content` to the parent extensive call; identify parent records where that nested content object is absent.
* **Interpretation:** Gong API reports content as a nested object on each extensive call; optional children may be absent from a valid response. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.brief`
**Brief.** AI-generated brief summary of the call. It defines the content surface available for this extensive call.
* **Enables:** Locate content records by brief in `calls_extensive.content.brief`; attribute each text match to its parent extensive call and, when present, its reported author.
* **Interpretation:** Gong supplies this call content; provider-generated excerpts or summaries may omit context and are not Parable-authored assessments. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.callOutcome`
**Call Outcome.** The structured call outcome details attached to each content in extensive call. It preserves the nested context needed to interpret the parent extensive call.
* **Enables:** Attribute call outcome in `calls_extensive.content.callOutcome` to the parent extensive call; identify parent records where that nested call outcome object is absent.
* **Interpretation:** Gong API reports call outcome as a nested object on each content; optional children may be absent from a valid response.
Developer identifier: `calls_extensive.content.callOutcome.category`
**Category.** The provider-reported category for each call outcome in extensive call. It distinguishes the provider-defined category state or classification for the call outcome.
* **Enables:** Segment call outcome entries in extensive call by category in `calls_extensive.content.callOutcome.category`; compare counts only within the same Gong API taxonomy.
* **Interpretation:** Gong API reports category as a label from its own taxonomy on each call outcome; preserve unknown labels rather than mapping them by assumption. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.callOutcome.id`
**ID.** The provider-reported ID for each call outcome in extensive call. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each call outcome in extensive call to the referenced call outcome through `calls_extensive.content.callOutcome.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports ID as an identifier in its call outcome namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.content.callOutcome.name`
**Name.** The provider-reported name for each call outcome in extensive call. It gives the call outcome a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each call outcome with name from `calls_extensive.content.callOutcome.name`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports name as display text for each call outcome; names are mutable and are not stable identities.
Developer identifier: `calls_extensive.content.highlights`
**Highlights.** The provider-returned highlights collection nested under the content structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Review each provider-generated highlight in `calls_extensive.content.highlights` within its parent extensive call; retain element order and attribution without treating it as a Parable judgment.
* **Interpretation:** Gong API returns highlights as ordered content or provider-generated content metadata on each content; truncation, omission, and inaccessible source media can limit completeness. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.highlights.items`
**Items.** The provider-returned items collection nested under the highlight structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Review each provider-generated item in `calls_extensive.content.highlights.items` within its parent extensive call; retain element order and attribution without treating it as a Parable judgment.
* **Interpretation:** Gong API returns items as ordered content or provider-generated content metadata on each highlight; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `calls_extensive.content.highlights.items.startTimes`
**Start Times.** The provider-returned start times collection nested under the item structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Order the returned start times values in `calls_extensive.content.highlights.items.startTimes` at the provider's declared unit and pair interval boundaries before measuring elapsed time for the parent extensive call.
* **Interpretation:** Gong API returns start times as ordered time values on each item; unit, timezone, and absolute-versus-relative meaning follow the provider field and must not be guessed.
Developer identifier: `calls_extensive.content.highlights.items.text`
**Text.** The provider-reported text for each item in extensive call. It defines the content surface available for this extensive call.
* **Enables:** Locate item records by text in `calls_extensive.content.highlights.items.text`; attribute each text match to its parent extensive call and, when present, its reported author.
* **Interpretation:** Gong supplies this call content; provider-generated excerpts or summaries may omit context and are not Parable-authored assessments.
Developer identifier: `calls_extensive.content.highlights.title`
**Title.** The provider-reported title for each highlight in extensive call. It gives the highlight a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each highlight with title from `calls_extensive.content.highlights.title`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports title as display text for each highlight; names are mutable and are not stable identities.
Developer identifier: `calls_extensive.content.keyPoints`
**Key Points.** The provider-returned key points collection nested under the content structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Connect the parent extensive call to every referenced key point in `calls_extensive.content.keyPoints`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Gong API returns key points as an array of key point entries on each content; missing, empty, and permission-redacted arrays are not equivalent. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.keyPoints.text`
**Text.** The provider-reported text for each key point in extensive call. It defines the content surface available for this extensive call.
* **Enables:** Locate key point records by text in `calls_extensive.content.keyPoints.text`; attribute each text match to its parent extensive call and, when present, its reported author.
* **Interpretation:** Gong supplies this call content; provider-generated excerpts or summaries may omit context and are not Parable-authored assessments.
Developer identifier: `calls_extensive.content.outline`
**Outline.** The provider-returned outline collection nested under the content structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Review each provider-generated outline in `calls_extensive.content.outline` within its parent extensive call; retain element order and attribution without treating it as a Parable judgment.
* **Interpretation:** Gong API returns outline as ordered content or provider-generated content metadata on each content; truncation, omission, and inaccessible source media can limit completeness. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.outline.duration`
**Duration.** The provider-reported duration for each outline in extensive call. It supplies the duration measure for the outline at the provider's declared unit and grain.
* **Enables:** Measure duration through `calls_extensive.content.outline.duration` for each outline and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports duration as a measure on each outline; compare only records with the same unit and aggregation grain.
Developer identifier: `calls_extensive.content.outline.items`
**Items.** The provider-returned items collection nested under the outline structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Review each provider-generated item in `calls_extensive.content.outline.items` within its parent extensive call; retain element order and attribution without treating it as a Parable judgment.
* **Interpretation:** Gong API returns items as ordered content or provider-generated content metadata on each outline; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `calls_extensive.content.outline.items.startTime`
**Start Time.** The provider-reported start time for each item in extensive call. It supplies the start time measure for the item at the provider's declared unit and grain.
* **Enables:** Order call excerpts by the numeric start time in `calls_extensive.content.outline.items.startTime`; pair start and end positions before calculating a span.
* **Interpretation:** Gong API reports start time as a number at the parent record's grain on each item; compare only records with the same unit and aggregation grain. Gong returns a numeric call-relative position here, but this declaration does not state a unit; do not interpret it as a wall-clock timestamp.
Developer identifier: `calls_extensive.content.outline.items.text`
**Text.** The provider-reported text for each item in extensive call. It defines the content surface available for this extensive call.
* **Enables:** Locate item records by text in `calls_extensive.content.outline.items.text`; attribute each text match to its parent extensive call and, when present, its reported author.
* **Interpretation:** Gong supplies this call content; provider-generated excerpts or summaries may omit context and are not Parable-authored assessments.
Developer identifier: `calls_extensive.content.outline.section`
**Section.** The provider-reported section for each outline in extensive call. It supplies the returned section text needed to understand the outline in context.
* **Enables:** Search the returned section text in `calls_extensive.content.outline.section` and attribute each match to its parent calls extensive and reported author when available.
* **Interpretation:** Gong API supplies section as returned text on each outline; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `calls_extensive.content.outline.startTime`
**Start Time.** The provider-reported start time for each outline in extensive call. It supplies the start time measure for the outline at the provider's declared unit and grain.
* **Enables:** Order call excerpts by the numeric start time in `calls_extensive.content.outline.startTime`; pair start and end positions before calculating a span.
* **Interpretation:** Gong API reports start time as a number at the parent record's grain on each outline; compare only records with the same unit and aggregation grain. Gong returns a numeric call-relative position here, but this declaration does not state a unit; do not interpret it as a wall-clock timestamp.
Developer identifier: `calls_extensive.content.pointsOfInterest`
**Points Of Interest.** The structured points of interest details attached to each content in extensive call. It preserves the nested context needed to interpret the parent extensive call.
* **Enables:** Attribute points of interest in `calls_extensive.content.pointsOfInterest` to the parent extensive call; identify parent records where that nested points of interest object is absent.
* **Interpretation:** Gong API reports points of interest as a nested object on each content; optional children may be absent from a valid response.
Developer identifier: `calls_extensive.content.pointsOfInterest.actionItems`
**Action Items.** The provider-returned action items collection nested under the points of interest structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Search the returned action items content in `calls_extensive.content.pointsOfInterest.actionItems` while preserving element order and attribution to the parent extensive call.
* **Interpretation:** Gong API returns action items as ordered content or provider-generated content metadata on each points-of-interest group; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `calls_extensive.content.pointsOfInterest.actionItems.snippet`
**Snippet.** The provider-reported snippet for each action item in extensive call. It defines the content surface available for this extensive call.
* **Enables:** Locate extensive call records whose snippet in `calls_extensive.content.pointsOfInterest.actionItems.snippet` contains the search term; open the Gong API record when the excerpt lacks needed context.
* **Interpretation:** This is an excerpt supplied by the provider, not the complete body or an attachment.
Developer identifier: `calls_extensive.content.pointsOfInterest.actionItems.snippetEndTime`
**Snippet End Time.** The provider-reported snippet end time for each action item in extensive call. It defines the content surface available for this extensive call.
* **Enables:** Locate extensive call records whose snippet end time in `calls_extensive.content.pointsOfInterest.actionItems.snippetEndTime` contains the search term; open the Gong API record when the excerpt lacks needed context.
* **Interpretation:** This is an excerpt supplied by the provider, not the complete body or an attachment. Gong returns a numeric call-relative position here, but this declaration does not state a unit; do not interpret it as a wall-clock timestamp.
Developer identifier: `calls_extensive.content.pointsOfInterest.actionItems.snippetStartTime`
**Snippet Start Time.** The provider-reported snippet start time for each action item in extensive call. It defines the content surface available for this extensive call.
* **Enables:** Locate extensive call records whose snippet start time in `calls_extensive.content.pointsOfInterest.actionItems.snippetStartTime` contains the search term; open the Gong API record when the excerpt lacks needed context.
* **Interpretation:** This is an excerpt supplied by the provider, not the complete body or an attachment. Gong returns a numeric call-relative position here, but this declaration does not state a unit; do not interpret it as a wall-clock timestamp.
Developer identifier: `calls_extensive.content.pointsOfInterest.actionItems.speakerId`
**Speaker ID.** The provider-reported speaker ID for each action item in extensive call. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each action item in extensive call to the referenced speaker through `calls_extensive.content.pointsOfInterest.actionItems.speakerId`; flag speaker ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports speaker ID as an identifier in its speaker namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.content.structure`
**Structure.** The provider-returned structure collection nested under the content structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Search the returned structure content in `calls_extensive.content.structure` while preserving element order and attribution to the parent extensive call.
* **Interpretation:** Gong API returns structure as ordered content or provider-generated content metadata on each content; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `calls_extensive.content.structure.duration`
**Duration.** Section duration in seconds. It supplies the duration measure for the structure at the provider's declared unit and grain.
* **Enables:** Measure duration through `calls_extensive.content.structure.duration` for each structure and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports duration as a measure on each structure; compare only records with the same unit and aggregation grain.
Developer identifier: `calls_extensive.content.structure.name`
**Name.** Section name (e.g., Discussion, Setup). It supplies the returned name text needed to understand the structure in context.
* **Enables:** Label each structure with name from `calls_extensive.content.structure.name`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports name as display text for each structure; names are mutable and are not stable identities.
Developer identifier: `calls_extensive.content.topics`
**Topics.** The provider-returned topics collection nested under the content structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Review each provider-generated topic in `calls_extensive.content.topics` within its parent extensive call; retain element order and attribution without treating it as a Parable judgment.
* **Interpretation:** Gong API returns topics as ordered content or provider-generated content metadata on each content; truncation, omission, and inaccessible source media can limit completeness. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.topics.duration`
**Duration.** Total seconds spent on this topic. It supplies the duration measure for the topic at the provider's declared unit and grain.
* **Enables:** Measure duration through `calls_extensive.content.topics.duration` for each topic and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports duration as a measure on each topic; compare only records with the same unit and aggregation grain. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.topics.name`
**Name.** Topic name. It supplies the returned name text needed to understand the topic in context.
* **Enables:** Label each topic with name from `calls_extensive.content.topics.name`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports name as display text for each topic; names are mutable and are not stable identities. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.trackerOccurrences`
**Tracker Occurrences.** The provider-returned tracker occurrences collection nested under the content structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Review each provider-generated tracker occurrence in `calls_extensive.content.trackerOccurrences` within its parent extensive call; retain element order and attribution without treating it as a Parable judgment.
* **Interpretation:** Gong API returns tracker occurrences as ordered content or provider-generated content metadata on each content; truncation, omission, and inaccessible source media can limit completeness. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.trackerOccurrences.speakerId`
**Speaker ID.** The provider-reported speaker ID for each tracker occurrence in extensive call. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each tracker occurrence in extensive call to the referenced speaker through `calls_extensive.content.trackerOccurrences.speakerId`; flag speaker ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports speaker ID as an identifier in its speaker namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.content.trackerOccurrences.startTime`
**Start Time.** The provider-reported start time for each tracker occurrence in extensive call. It supplies the start time measure for the tracker occurrence at the provider's declared unit and grain.
* **Enables:** Order call excerpts by the numeric start time in `calls_extensive.content.trackerOccurrences.startTime`; pair start and end positions before calculating a span.
* **Interpretation:** Gong API reports start time as a number at the parent record's grain on each tracker occurrence; compare only records with the same unit and aggregation grain. Gong returns a numeric call-relative position here, but this declaration does not state a unit; do not interpret it as a wall-clock timestamp.
Developer identifier: `calls_extensive.content.trackerOccurrences.trackerId`
**Tracker ID.** The provider-reported tracker ID for each tracker occurrence in extensive call. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each tracker occurrence in extensive call to the referenced tracker through `calls_extensive.content.trackerOccurrences.trackerId`; flag tracker ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports tracker ID as an identifier in its tracker namespace; it is not a universal identity outside Gong API. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.trackers`
**Trackers.** The provider-returned trackers collection nested under the content structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Compare the exact Gong API-configured trackers set in `calls_extensive.content.trackers` for each content; preserve provider labels and unknown entries.
* **Interpretation:** Gong API returns trackers as an array of tracker entries on each content; missing, empty, and permission-redacted arrays are not equivalent. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.trackers.count`
**Count.** Number of times the tracker fired. It supplies the count measure for the tracker at the provider's declared unit and grain.
* **Enables:** Measure count through `calls_extensive.content.trackers.count` for each tracker and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports count as a measure on each tracker; compare only records with the same unit and aggregation grain. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.trackers.id`
**ID.** Tracker ID. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each tracker in extensive call to the referenced tracker through `calls_extensive.content.trackers.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports ID as an identifier in its tracker namespace; it is not a universal identity outside Gong API. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.trackers.name`
**Name.** Tracker name. It gives the tracker a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each tracker with name from `calls_extensive.content.trackers.name`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports name as display text for each tracker; names are mutable and are not stable identities. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.content.trackers.occurrences`
**Occurrences.** The provider-returned occurrences collection nested under the tracker structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Review each provider-generated occurrence in `calls_extensive.content.trackers.occurrences` within its parent extensive call; retain element order and attribution without treating it as a Parable judgment.
* **Interpretation:** Gong API returns occurrences as ordered content or provider-generated content metadata on each tracker; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `calls_extensive.content.trackers.occurrences.speakerId`
**Speaker ID.** The provider-reported speaker ID for each occurrence in extensive call. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each occurrence in extensive call to the referenced speaker through `calls_extensive.content.trackers.occurrences.speakerId`; flag speaker ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports speaker ID as an identifier in its speaker namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.content.trackers.occurrences.startTime`
**Start Time.** Start time in seconds from call start. It supplies the start time measure for the occurrence at the provider's declared unit and grain.
* **Enables:** Order call excerpts by the numeric start time in `calls_extensive.content.trackers.occurrences.startTime`; pair start and end positions before calculating a span.
* **Interpretation:** Gong API reports start time as seconds on each occurrence; compare only records with the same unit and aggregation grain. Gong returns a call-relative position in the stated unit; it is not a wall-clock timestamp.
Developer identifier: `calls_extensive.content.trackers.phrases`
**Phrases.** The provider-returned phrases collection nested under the tracker structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Review each provider-generated phrase in `calls_extensive.content.trackers.phrases` within its parent extensive call; retain element order and attribution without treating it as a Parable judgment.
* **Interpretation:** Gong API returns phrases as ordered content or provider-generated content metadata on each tracker; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `calls_extensive.content.trackers.phrases.count`
**Count.** The provider-reported count for each phrase in extensive call. It supplies the count measure for the phrase at the provider's declared unit and grain.
* **Enables:** Measure count through `calls_extensive.content.trackers.phrases.count` for each phrase and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports count as a measure on each phrase; compare only records with the same unit and aggregation grain.
Developer identifier: `calls_extensive.content.trackers.phrases.occurrences`
**Occurrences.** The provider-returned occurrences collection nested under the phrase structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Review each provider-generated occurrence in `calls_extensive.content.trackers.phrases.occurrences` within its parent extensive call; retain element order and attribution without treating it as a Parable judgment.
* **Interpretation:** Gong API returns occurrences as ordered content or provider-generated content metadata on each phrase; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `calls_extensive.content.trackers.phrases.occurrences.speakerId`
**Speaker ID.** The provider-reported speaker ID for each occurrence in extensive call. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each occurrence in extensive call to the referenced speaker through `calls_extensive.content.trackers.phrases.occurrences.speakerId`; flag speaker ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports speaker ID as an identifier in its speaker namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.content.trackers.phrases.occurrences.startTime`
**Start Time.** The provider-reported start time for each occurrence in extensive call. It supplies the start time measure for the occurrence at the provider's declared unit and grain.
* **Enables:** Order call excerpts by the numeric start time in `calls_extensive.content.trackers.phrases.occurrences.startTime`; pair start and end positions before calculating a span.
* **Interpretation:** Gong API reports start time as a number at the parent record's grain on each occurrence; compare only records with the same unit and aggregation grain. Gong returns a numeric call-relative position here, but this declaration does not state a unit; do not interpret it as a wall-clock timestamp.
Developer identifier: `calls_extensive.content.trackers.phrases.phrase`
**Phrase.** The provider-reported phrase for each phrase in extensive call. It supplies the returned phrase text needed to understand the phrase in context.
* **Enables:** Search the returned phrase text in `calls_extensive.content.trackers.phrases.phrase` and attribute each match to its parent calls extensive and reported author when available.
* **Interpretation:** Gong API supplies phrase as returned text on each phrase; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `calls_extensive.content.trackers.type`
**Type.** Tracker type (KEYWORD, SMART). It distinguishes the provider-defined type state or classification for the tracker.
* **Enables:** Segment tracker entries in extensive call by type in `calls_extensive.content.trackers.type`; compare counts only within the same Gong API taxonomy.
* **Interpretation:** Gong API reports type as a label from its own taxonomy on each tracker; preserve unknown labels rather than mapping them by assumption. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `calls_extensive.context`
**Context.** CRM context objects associated with the call (accounts, deals, contacts) from connected CRM systems. Populated when contentSelector.context is Extended. It preserves the nested context needed to interpret the parent extensive call.
* **Enables:** Attribute every returned context in `calls_extensive.context` to its parent extensive call; keep each relationship distinct and distinguish an absent array from an explicitly empty one.
* **Interpretation:** Gong API returns context as an array of context entries on each extensive call; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calls_extensive.context.objects`
**Objects.** CRM objects from this system associated with the call. It preserves the nested context needed to interpret the parent extensive call.
* **Enables:** Attribute every returned object in `calls_extensive.context.objects` to its parent extensive call; keep each relationship distinct and distinguish an absent array from an explicitly empty one.
* **Interpretation:** Gong API returns objects as an array of object entries on each context; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calls_extensive.context.objects.fields`
**Fields.** CRM field name/value pairs for the object. It preserves the nested context needed to interpret the parent extensive call.
* **Enables:** Compare the exact Gong API-configured fields set in `calls_extensive.context.objects.fields` for each object; preserve provider labels and unknown entries.
* **Interpretation:** Gong API returns fields as an array of field entries on each object; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calls_extensive.context.objects.fields.name`
**Name.** CRM field name. It gives the field a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each field with name from `calls_extensive.context.objects.fields.name`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports name as display text for each field; names are mutable and are not stable identities.
Developer identifier: `calls_extensive.context.objects.fields.value`
**Value.** CRM field value serialized as a string. It must be interpreted with the enclosing provider field name, type, or custom schema for the field.
* **Enables:** Interpret `calls_extensive.context.objects.fields.value` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Gong API reports value under the enclosing custom or typed field contract on each field; compare it only with values from the same provider key and type.
Developer identifier: `calls_extensive.context.objects.objectId`
**Object ID.** CRM object identifier. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each object in extensive call to the referenced object through `calls_extensive.context.objects.objectId`; flag object ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports object ID as an identifier in its object namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.context.objects.objectType`
**Object Type.** CRM object type (Account, Opportunity, Contact, etc.). It supplies the object type boundary, band, or unit needed to interpret the companion measure.
* **Enables:** Segment object entries in extensive call by object type in `calls_extensive.context.objects.objectType`; compare counts only within the same Gong API taxonomy.
* **Interpretation:** Gong API reports object type as a label from its own taxonomy on each object; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calls_extensive.context.system`
**System.** CRM system name (e.g., Salesforce). It distinguishes the provider-defined system state or classification for the context.
* **Enables:** Match repeated context entries on system in `calls_extensive.context.system`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports system on each context; missing and empty values can have different meanings.
Developer identifier: `calls_extensive.interaction`
**Interaction.** Interaction metrics for the call. It preserves the nested context needed to interpret the parent extensive call.
* **Enables:** Attribute interaction in `calls_extensive.interaction` to the parent extensive call; identify parent records where that nested interaction object is absent.
* **Interpretation:** Gong API reports interaction as a nested object on each extensive call; optional children may be absent from a valid response.
Developer identifier: `calls_extensive.interaction.interactionStats`
**Interaction Stats.** The provider-returned interaction stats collection nested under the interaction structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Measure each returned interaction stat in `calls_extensive.interaction.interactionStats` at its element and time grain; compare values only when Gong API reports the same unit and aggregation.
* **Interpretation:** Gong API returns interaction stats as an array of interaction stat entries on each interaction; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calls_extensive.interaction.interactionStats.name`
**Name.** Stat name (e.g., Interactivity, Patience). It gives the interaction stat a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each interaction stat with name from `calls_extensive.interaction.interactionStats.name`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports name as display text for each interaction stat; names are mutable and are not stable identities.
Developer identifier: `calls_extensive.interaction.interactionStats.value`
**Value.** Stat value. It must be interpreted with the enclosing provider field name, type, or custom schema for the interaction stat.
* **Enables:** Interpret `calls_extensive.interaction.interactionStats.value` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Gong API reports value under the enclosing custom or typed field contract on each interaction stat; compare it only with values from the same provider key and type.
Developer identifier: `calls_extensive.interaction.questions`
**Questions.** The structured questions details attached to each interaction in extensive call. It preserves the nested context needed to interpret the parent extensive call.
* **Enables:** Attribute questions in `calls_extensive.interaction.questions` to the parent extensive call; identify parent records where that nested questions object is absent.
* **Interpretation:** Gong API reports questions as a nested object on each interaction; optional children may be absent from a valid response.
Developer identifier: `calls_extensive.interaction.questions.companyCount`
**Company Count.** Questions asked by company-side participants. It supplies the company count measure for the question at the provider's declared unit and grain.
* **Enables:** Measure company count through `calls_extensive.interaction.questions.companyCount` for each question and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports company count as a measure on each question; compare only records with the same unit and aggregation grain.
Developer identifier: `calls_extensive.interaction.questions.nonCompanyCount`
**Non Company Count.** Questions asked by non-company participants. It supplies the non company count measure for the question at the provider's declared unit and grain.
* **Enables:** Measure non company count through `calls_extensive.interaction.questions.nonCompanyCount` for each question and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports non company count as a measure on each question; compare only records with the same unit and aggregation grain.
Developer identifier: `calls_extensive.interaction.speakers`
**Speakers.** The provider-returned speakers collection nested under the interaction structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Match every returned speaker in `calls_extensive.interaction.speakers` to the parent extensive call; use the element's provider identity or role to reconcile membership and attribution.
* **Interpretation:** Gong API returns speakers as an array of speaker entries on each interaction; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calls_extensive.interaction.speakers.id`
**ID.** Speaker ID; correlates with parties.speakerId. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each speaker in extensive call to the referenced speaker through `calls_extensive.interaction.speakers.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports ID as an identifier in its speaker namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.interaction.speakers.talkTime`
**Talk Time.** Total speaking time in seconds. It supplies the talk time measure for the speaker at the provider's declared unit and grain.
* **Enables:** Order call excerpts by the numeric talk time in `calls_extensive.interaction.speakers.talkTime`; pair start and end positions before calculating a span.
* **Interpretation:** Gong API reports talk time as seconds on each speaker; compare only records with the same unit and aggregation grain. Gong returns a call-relative position in the stated unit; it is not a wall-clock timestamp.
Developer identifier: `calls_extensive.interaction.speakers.userId`
**User ID.** Gong user ID if the speaker is a user. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each speaker in extensive call to the referenced user through `calls_extensive.interaction.speakers.userId`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports user ID as an identifier in its user namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.interaction.video`
**Video.** The provider-returned video collection nested under the interaction structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Associate each returned video metadata entry in `calls_extensive.interaction.video` with the parent extensive call; inventory the reference without assuming file, recording, or attachment bytes are present.
* **Interpretation:** Gong API returns video as file, recording, or attachment metadata on each interaction; the array does not imply that binary content was collected.
Developer identifier: `calls_extensive.interaction.video.duration`
**Duration.** The provider-reported duration for each video in extensive call. It supplies the duration measure for the video at the provider's declared unit and grain.
* **Enables:** Measure duration through `calls_extensive.interaction.video.duration` for each video and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports duration as a measure on each video; compare only records with the same unit and aggregation grain.
Developer identifier: `calls_extensive.interaction.video.name`
**Name.** Video metric name. It gives the video a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each video with name from `calls_extensive.interaction.video.name`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports name as display text for each video; names are mutable and are not stable identities.
Developer identifier: `calls_extensive.media`
**Media.** Media URLs for the call. It preserves the nested context needed to interpret the parent extensive call.
* **Enables:** Attribute media in `calls_extensive.media` to the parent extensive call; identify parent records where that nested media object is absent.
* **Interpretation:** Gong API reports media as a nested object on each extensive call; optional children may be absent from a valid response.
Developer identifier: `calls_extensive.media.audioUrl`
**Audio URL.** Pre-signed URL for the audio recording. It locates the provider resource or path associated with the media.
* **Enables:** Associate each media with the resource identified by audio URL in `calls_extensive.media.audioUrl`; verify the link resolves to the expected Gong API object.
* **Interpretation:** Gong API reports audio URL as a resource locator for each media; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `calls_extensive.media.videoUrl`
**Video URL.** Pre-signed URL for the video recording. It locates the provider resource or path associated with the media.
* **Enables:** Associate each media with the resource identified by video URL in `calls_extensive.media.videoUrl`; verify the link resolves to the expected Gong API object.
* **Interpretation:** Gong API reports video URL as a resource locator for each media; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `calls_extensive.metaData`
**Meta Data.** The structured meta data details attached to each extensive call in extensive call. It preserves the nested context needed to interpret the parent extensive call.
* **Enables:** Attribute meta data in `calls_extensive.metaData` to the parent extensive call; identify parent records where that nested meta data object is absent.
* **Interpretation:** Gong API reports meta data as a nested object on each extensive call; optional children may be absent from a valid response.
Developer identifier: `calls_extensive.metaData.calendarEventId`
**Calendar Event ID.** Associated calendar event ID. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each Gong call extensive metadata in extensive call to the referenced calendar event through `calls_extensive.GongCallExtensiveMetadata.calendarEventId`; flag calendar event ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports calendar event ID as an identifier in its calendar event namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.metaData.clientUniqueId`
**Client Unique ID.** Client-provided unique identifier. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each Gong call extensive metadata in extensive call to the referenced client unique through `calls_extensive.GongCallExtensiveMetadata.clientUniqueId`; flag client unique ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports client unique ID as an identifier in its client unique namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.metaData.customData`
**Custom Data.** Free-form custom data associated with the call. It must be interpreted with the enclosing provider field name, type, or custom schema for the Gong call extensive metadata.
* **Enables:** Interpret `calls_extensive.GongCallExtensiveMetadata.customData` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Gong API reports custom data under the enclosing custom or typed field contract on each Gong call extensive metadata; compare it only with values from the same provider key and type.
Developer identifier: `calls_extensive.metaData.direction`
**Direction.** Direction of the call (Inbound, Outbound, Conference, Unknown). It distinguishes the provider-defined direction state or classification for the Gong call extensive metadata.
* **Enables:** Filter Calls Extensive by the exact Gong API-defined direction in `calls_extensive.GongCallExtensiveMetadata.direction` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies direction from its own taxonomy on each Gong call extensive metadata; preserve unknown and newly introduced labels.
Developer identifier: `calls_extensive.metaData.duration`
**Duration.** Duration of the call in seconds. It supplies the duration measure for the Gong call extensive metadata at the provider's declared unit and grain.
* **Enables:** Measure duration through `calls_extensive.GongCallExtensiveMetadata.duration` for each Gong call extensive metadata and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports duration as a measure on each Gong call extensive metadata; compare only records with the same unit and aggregation grain.
Developer identifier: `calls_extensive.metaData.id`
**ID.** Unique identifier for the call. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Match repeated Gong call extensive metadata entries on ID in `calls_extensive.GongCallExtensiveMetadata.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports ID as an identifier in its Gong call extensive metadata namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `calls_extensive.metaData.isPrivate`
**Is Private.** Whether the call is private. It distinguishes the provider-defined is private state or classification for the Gong call extensive metadata.
* **Enables:** Filter extensive call by whether the call is private in `calls_extensive.GongCallExtensiveMetadata.isPrivate`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports the call is private as a boolean on each Gong call extensive metadata; a missing field is unknown, not false.
Developer identifier: `calls_extensive.metaData.language`
**Language.** Language of the call (BCP-47 tag). It supplies the language profile facet used to reconcile or attribute the Gong call extensive metadata.
* **Enables:** Reconcile the calls extensive's language in `calls_extensive.GongCallExtensiveMetadata.language` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Gong API reports language as a mutable profile or directory attribute on each Gong call extensive metadata; it may be absent, shared, or non-unique.
Developer identifier: `calls_extensive.metaData.media`
**Media.** Media type of the call (Audio, Video). It distinguishes the provider-defined media state or classification for the Gong call extensive metadata.
* **Enables:** Filter Calls Extensive by the exact Gong API-defined media in `calls_extensive.GongCallExtensiveMetadata.media` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies media from its own taxonomy on each Gong call extensive metadata; preserve unknown and newly introduced labels.
Developer identifier: `calls_extensive.metaData.meetingUrl`
**Meeting URL.** Meeting URL for the call. It locates the provider resource or path associated with the Gong call extensive metadata.
* **Enables:** Associate each Gong call extensive metadata with the resource identified by meeting URL in `calls_extensive.GongCallExtensiveMetadata.meetingUrl`; verify the link resolves to the expected Gong API object.
* **Interpretation:** Gong API reports meeting URL as a resource locator for each Gong call extensive metadata; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `calls_extensive.metaData.primaryUserId`
**Primary User ID.** Primary Gong user associated with the call. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each Gong call extensive metadata in extensive call to the referenced primary user through `calls_extensive.GongCallExtensiveMetadata.primaryUserId`; flag primary user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports primary user ID as an identifier in its primary user namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.metaData.purpose`
**Purpose.** Purpose of the call. It supplies the returned purpose text needed to understand the Gong call extensive metadata in context.
* **Enables:** Search the returned purpose text in `calls_extensive.GongCallExtensiveMetadata.purpose` and attribute each match to its parent calls extensive and reported author when available.
* **Interpretation:** Gong API supplies purpose as returned text on each Gong call extensive metadata; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `calls_extensive.metaData.scheduled`
**Scheduled.** Scheduled time of the call (ISO-8601). It is needed to place the Gong call extensive metadata on the provider timeline at the field's stated precision.
* **Enables:** Order Calls Extensive by the provider-reported instant in `calls_extensive.GongCallExtensiveMetadata.scheduled` and isolate records inside the same time window and precision.
* **Interpretation:** Gong API reports scheduled as a time value for each Gong call extensive metadata; format, timezone, precision, and absolute-versus-relative meaning follow this field's contract.
Developer identifier: `calls_extensive.metaData.scope`
**Scope.** Scope of the call (Internal, External, Unknown). It distinguishes the provider-defined scope state or classification for the Gong call extensive metadata.
* **Enables:** Filter Calls Extensive by the exact Gong API-defined scope in `calls_extensive.GongCallExtensiveMetadata.scope` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies scope from its own taxonomy on each Gong call extensive metadata; preserve unknown and newly introduced labels.
Developer identifier: `calls_extensive.metaData.sdrDisposition`
**Sdr Disposition.** Sales-development representative disposition tag. It distinguishes the provider-defined sdr disposition state or classification for the Gong call extensive metadata.
* **Enables:** Filter Calls Extensive by the exact Gong API-defined sdr disposition in `calls_extensive.GongCallExtensiveMetadata.sdrDisposition` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies sdr disposition from its own taxonomy on each Gong call extensive metadata; preserve unknown and newly introduced labels.
Developer identifier: `calls_extensive.metaData.started`
**Started.** Actual start time of the call (ISO-8601). It anchors the extensive call on the provider's reported timeline.
* **Enables:** Order extensive call by started in `calls_extensive.GongCallExtensiveMetadata.started` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports started as a timestamp on each Gong call extensive metadata; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `calls_extensive.metaData.system`
**System.** Telephony or conferencing system used. It distinguishes the provider-defined system state or classification for the Gong call extensive metadata.
* **Enables:** Filter Calls Extensive by the exact Gong API-defined system in `calls_extensive.GongCallExtensiveMetadata.system` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies system from its own taxonomy on each Gong call extensive metadata; preserve unknown and newly introduced labels.
Developer identifier: `calls_extensive.metaData.title`
**Title.** Title or subject of the call. It supplies the returned title text needed to understand the Gong call extensive metadata in context.
* **Enables:** Label each Gong call extensive metadata with title from `calls_extensive.GongCallExtensiveMetadata.title`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports title as display text for each Gong call extensive metadata; names are mutable and are not stable identities.
Developer identifier: `calls_extensive.metaData.url`
**URL.** URL to view the call in Gong. It locates the provider resource or path associated with the Gong call extensive metadata.
* **Enables:** Associate each Gong call extensive metadata with the resource identified by URL in `calls_extensive.GongCallExtensiveMetadata.url`; verify the link resolves to the expected Gong API object.
* **Interpretation:** Gong API reports URL as a resource locator for each Gong call extensive metadata; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `calls_extensive.metaData.workspaceId`
**Workspace ID.** Workspace the call belongs to. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each Gong call extensive metadata in extensive call to the referenced workspace through `calls_extensive.GongCallExtensiveMetadata.workspaceId`; flag workspace ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports workspace ID as an identifier in its workspace namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.parties`
**Parties.** Parties (people) on the call. It preserves the nested context needed to interpret the parent extensive call.
* **Enables:** Match every returned party in `calls_extensive.parties` to the parent extensive call; use the element's provider identity or role to reconcile membership and attribution.
* **Interpretation:** Gong API returns parties as an array of party entries on each extensive call; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calls_extensive.parties.affiliation`
**Affiliation.** Internal | External | Unknown. It distinguishes the provider-defined affiliation state or classification for the party.
* **Enables:** Filter Calls Extensive by the exact Gong API-defined affiliation in `calls_extensive.parties.affiliation` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies affiliation from its own taxonomy on each party; preserve unknown and newly introduced labels.
Developer identifier: `calls_extensive.parties.context`
**Context.** CRM contact / lead context for the party. It preserves the nested context needed to interpret the parent extensive call.
* **Enables:** Attribute every returned context in `calls_extensive.parties.context` to its parent extensive call; keep each relationship distinct and distinguish an absent array from an explicitly empty one.
* **Interpretation:** Gong API returns context as an array of context entries on each party; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calls_extensive.parties.context.objects`
**Objects.** The provider-returned objects collection nested under the context structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Attribute every returned object in `calls_extensive.parties.context.objects` to its parent extensive call; keep each relationship distinct and distinguish an absent array from an explicitly empty one.
* **Interpretation:** Gong API returns objects as an array of object entries on each context; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calls_extensive.parties.context.objects.fields`
**Fields.** The provider-returned fields collection nested under the object structure for each extensive call; needed to retain every element with its parent relationship.
* **Enables:** Compare the exact Gong API-configured fields set in `calls_extensive.parties.context.objects.fields` for each object; preserve provider labels and unknown entries.
* **Interpretation:** Gong API returns fields as an array of field entries on each object; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calls_extensive.parties.context.objects.fields.name`
**Name.** The provider-reported name for each field in extensive call. It gives the field a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each field with name from `calls_extensive.parties.context.objects.fields.name`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports name as display text for each field; names are mutable and are not stable identities.
Developer identifier: `calls_extensive.parties.context.objects.fields.value`
**Value.** The provider-reported value for each field in extensive call. It must be interpreted with the enclosing provider field name, type, or custom schema for the field.
* **Enables:** Interpret `calls_extensive.parties.context.objects.fields.value` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Gong API reports value under the enclosing custom or typed field contract on each field; compare it only with values from the same provider key and type.
Developer identifier: `calls_extensive.parties.context.objects.objectId`
**Object ID.** The provider-reported object ID for each object in extensive call. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each object in extensive call to the referenced object through `calls_extensive.parties.context.objects.objectId`; flag object ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports object ID as an identifier in its object namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.parties.context.objects.objectType`
**Object Type.** The provider-reported object type for each object in extensive call. It distinguishes the provider-defined object type state or classification for the object.
* **Enables:** Segment object entries in extensive call by object type in `calls_extensive.parties.context.objects.objectType`; compare counts only within the same Gong API taxonomy.
* **Interpretation:** Gong API reports object type as a label from its own taxonomy on each object; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calls_extensive.parties.context.system`
**System.** CRM system the context comes from. It distinguishes the provider-defined system state or classification for the context.
* **Enables:** Filter Calls Extensive by the exact Gong API-defined system in `calls_extensive.parties.context.system` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies system from its own taxonomy on each context; preserve unknown and newly introduced labels.
Developer identifier: `calls_extensive.parties.emailAddress`
**Email Address.** Email address of the party. It supplies the provider-reported address or location facet for the party, not a residency determination.
* **Enables:** Attribute each party to a person or account by the exact email address in `calls_extensive.parties.emailAddress`; identify addresses that do not match the Gong API directory.
* **Interpretation:** Gong API reports email address as an address on each party; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `calls_extensive.parties.id`
**ID.** Party ID within the call. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Match repeated party entries on ID in `calls_extensive.parties.id`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports ID as an identifier in its party namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.parties.methods`
**Methods.** How the party joined (Invitee, Attendee, etc.). It preserves the nested context needed to interpret the parent extensive call.
* **Enables:** Compare the exact Gong API-configured methods set in `calls_extensive.parties.methods` for each party; preserve provider labels and unknown entries.
* **Interpretation:** Gong API returns methods as an array of method value entries on each party; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calls_extensive.parties.name`
**Name.** Display name of the party. It gives the party a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each party with name from `calls_extensive.parties.name`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports name as display text for each party; names are mutable and are not stable identities.
Developer identifier: `calls_extensive.parties.phoneNumber`
**Phone Number.** The provider-reported phone number for each party in extensive call. It supplies the phone number profile facet used to reconcile or attribute the party.
* **Enables:** Reconcile the calls extensive's phone number in `calls_extensive.parties.phoneNumber` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Gong API reports phone number as a mutable profile or directory attribute on each party; it may be absent, shared, or non-unique.
Developer identifier: `calls_extensive.parties.speakerId`
**Speaker ID.** Speaker ID used to correlate with transcript segments. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each party in extensive call to the referenced speaker through `calls_extensive.parties.speakerId`; flag speaker ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports speaker ID as an identifier in its speaker namespace; it is not a universal identity outside Gong API.
Developer identifier: `calls_extensive.parties.title`
**Title.** Job title of the party. It gives the party a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each party with title from `calls_extensive.parties.title`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports title as display text for each party; names are mutable and are not stable identities.
Developer identifier: `calls_extensive.parties.userId`
**User ID.** Gong user ID if the party is a Gong user. It provides the reference needed to connect the extensive call to the corresponding provider object.
* **Enables:** Connect each party in extensive call to the referenced user through `calls_extensive.parties.userId`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports user ID as an identifier in its user namespace; it is not a universal identity outside Gong API.
Developer identifier: `crm_entities`
**CRM Entities.** DISABLED: Gong has no list CRM entities API. GET /v2/CRM/entities only fetches objects by known CRM IDs (dev verification). Use calls\_extensive (Extended context) and manual\_crm\_associations for CRM data. Enable only for explicit ID-based enrichment follow-ups.
* **Enables:** Support explicit known-ID CRM enrichment only; this declaration cannot enumerate CRM entities.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/crm/entities` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. This stream is disabled because Gong exposes lookup by known CRM IDs rather than a list operation; use extensive-call context or manual associations for enumerated CRM relationships. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `crm_entities.createdDate`
**Created Date.** Creation timestamp. It anchors the CRM entity on the provider's reported timeline.
* **Enables:** Order CRM Entities by created date in `crm_entities.createdDate` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports created date as a calendar date on each CRM entity; its grain is one day and no time of day should be inferred.
Developer identifier: `crm_entities.fields`
**Fields.** Field name/value pairs for the CRM object. It preserves the nested context needed to interpret the parent CRM entity.
* **Enables:** Compare the exact Gong API-configured fields set in `crm_entities.fields` for each CRM entity; preserve provider labels and unknown entries.
* **Interpretation:** Gong API returns fields as an array of field entries on each CRM entity; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `crm_entities.fields.modifiedDate`
**Modified Date.** Last-modified date for the field (ISO-8601). It anchors the CRM entity on the provider's reported timeline.
* **Enables:** Order CRM Entities by modified date in `crm_entities.fields.modifiedDate` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports modified date as a calendar date on each field; its grain is one day and no time of day should be inferred.
Developer identifier: `crm_entities.fields.name`
**Name.** CRM field name. It gives the field a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Match repeated field entries on name in `crm_entities.fields.name`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports name as display text for each field; names are mutable and are not stable identities.
Developer identifier: `crm_entities.fields.value`
**Value.** CRM field value (stringified). It must be interpreted with the enclosing provider field name, type, or custom schema for the field.
* **Enables:** Interpret `crm_entities.fields.value` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Gong API reports value under the enclosing custom or typed field contract on each field; compare it only with values from the same provider key and type.
Developer identifier: `crm_entities.modifiedDate`
**Modified Date.** Last modified timestamp. It anchors the CRM entity on the provider's reported timeline.
* **Enables:** Order CRM Entities by modified date in `crm_entities.modifiedDate` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports modified date as a calendar date on each CRM entity; its grain is one day and no time of day should be inferred. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `crm_entities.objectId`
**Object ID.** Unique identifier. It provides the reference needed to connect the CRM entity to the corresponding provider object.
* **Enables:** Match repeated CRM entity entries on object ID in `crm_entities.objectId`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports object ID as an identifier in its object namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `crm_entities.objectType`
**Object Type.** CRM entity type. It distinguishes the provider-defined object type state or classification for the CRM entity.
* **Enables:** Segment CRM entity entries in CRM Entities by object type in `crm_entities.objectType`; compare counts only within the same Gong API taxonomy.
* **Interpretation:** Gong API reports object type as a label from its own taxonomy on each CRM entity; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `crm_entities.systemId`
**System ID.** ID in source CRM. It provides the reference needed to connect the CRM entity to the corresponding provider object.
* **Enables:** Connect each CRM entity in CRM Entities to the referenced system through `crm_entities.systemId`; flag system ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports system ID as an identifier in its system namespace; it is not a universal identity outside Gong API.
Developer identifier: `crm_entities.title`
**Title.** Display title. It gives the CRM entity a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each CRM entity with title from `crm_entities.title`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports title as display text for each CRM entity; names are mutable and are not stable identities.
Developer identifier: `crm_entities.url`
**URL.** URL in source CRM. It locates the provider resource or path associated with the CRM entity.
* **Enables:** Associate each CRM entity with the resource identified by URL in `crm_entities.url`; verify the link resolves to the expected Gong API object.
* **Interpretation:** Gong API reports URL as a resource locator for each CRM entity; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `crm_integrations`
**CRM Integrations.** Retrieve CRM integration configuration from Gong. Returns details about connected CRM systems, schema fields, deal stages, and object mappings.
* **Enables:** Inventory connected CRM systems and reconcile their object mappings, schema fields, and deal-stage configuration.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/crm/integrations` operation as a snapshot stream using full synchronization. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `crm_integrations.crmType`
**CRM Type.** Type of CRM (e.g., Salesforce, HubSpot). It distinguishes the provider-defined CRM type state or classification for the CRM integration.
* **Enables:** Segment CRM integration entries in CRM Integrations by CRM type in `crm_integrations.crmType`; compare counts only within the same Gong API taxonomy.
* **Interpretation:** Gong API reports CRM type as a label from its own taxonomy on each CRM integration; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `crm_integrations.dealStages`
**Deal Stages.** Deal-stage mapping for the CRM integration. It preserves the nested context needed to interpret the parent CRM integration.
* **Enables:** Compare the exact Gong API-configured deal stages set in `crm_integrations.dealStages` for each CRM integration; preserve provider labels and unknown entries.
* **Interpretation:** Gong API returns deal stages as an array of deal stage entries on each CRM integration; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `crm_integrations.dealStages.isClosedWon`
**Is Closed Won.** The provider-reported is closed won for each deal stage in CRM Integrations. It distinguishes the provider-defined is closed won state or classification for the deal stage.
* **Enables:** Filter CRM Integrations by whether is closed won in `crm_integrations.dealStages.isClosedWon`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports is closed won as a boolean on each deal stage; a missing field is unknown, not false.
Developer identifier: `crm_integrations.dealStages.stageId`
**Stage ID.** CRM stage ID. It provides the reference needed to connect the CRM integration to the corresponding provider object.
* **Enables:** Match repeated deal stage entries on stage ID in `crm_integrations.dealStages.stageId`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports stage ID as an identifier in its stage namespace; it is not a universal identity outside Gong API.
Developer identifier: `crm_integrations.dealStages.stageName`
**Stage Name.** The provider-reported stage name for each deal stage in CRM Integrations. It gives the deal stage a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each deal stage with stage name from `crm_integrations.dealStages.stageName`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports stage name as display text for each deal stage; names are mutable and are not stable identities.
Developer identifier: `crm_integrations.dealStages.stageOrder`
**Stage Order.** Display order of the stage in the funnel. It distinguishes the provider-defined stage order state or classification for the deal stage.
* **Enables:** Filter CRM Integrations by the exact Gong API-defined stage order in `crm_integrations.dealStages.stageOrder` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies stage order from its own taxonomy on each deal stage; preserve unknown and newly introduced labels.
Developer identifier: `crm_integrations.integrationId`
**Integration ID.** Unique identifier for the CRM integration. It provides the reference needed to connect the CRM integration to the corresponding provider object.
* **Enables:** Match repeated CRM integration entries on integration ID in `crm_integrations.integrationId`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports integration ID as an identifier in its integration namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `crm_integrations.objectTypes`
**Object Types.** CRM object types configured for this integration. It preserves the nested context needed to interpret the parent CRM integration.
* **Enables:** Compare the exact Gong API-configured object types set in `crm_integrations.objectTypes` for each CRM integration; preserve provider labels and unknown entries.
* **Interpretation:** Gong API returns object types as an array of object type entries on each CRM integration; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `crm_integrations.objectTypes.objectType`
**Object Type.** CRM object type name. It distinguishes the provider-defined object type state or classification for the object type.
* **Enables:** Match repeated object type entries on object type in `crm_integrations.objectTypes.objectType`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports object type as a label from its own taxonomy on each object type; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `crm_integrations.objectTypes.schemaFields`
**Schema Fields.** Schema fields for this object type. It preserves the nested context needed to interpret the parent CRM integration.
* **Enables:** Compare the exact Gong API-configured schema fields set in `crm_integrations.objectTypes.schemaFields` for each object type; preserve provider labels and unknown entries.
* **Interpretation:** Gong API returns schema fields as an array of schema field entries on each object type; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `crm_integrations.status`
**Status.** Integration status. It distinguishes the provider-defined status state or classification for the CRM integration.
* **Enables:** Segment CRM integration entries in CRM Integrations by status in `crm_integrations.status`; compare counts only within the same Gong API taxonomy.
* **Interpretation:** Gong API reports status as a label from its own taxonomy on each CRM integration; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `daily_activity`
**Daily Activity.** Retrieve day-by-day activity statistics for users. Returns one row per user (with a `dayActivity` array) snapshotting the configured incremental window. `cursorField` is `fromDate`, the window-start filter sent in the request body, since aggregate responses have no per-record timestamp.
* **Enables:** Measure each user's provider-reported daily activity counts inside the configured request window.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/stats/activity/day-by-day` operation as a snapshot stream using incremental synchronization. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. Aggregate activity counts reflect Gong's definitions and the configured request window; they do not establish work quality or employee performance. This stream supplies no reliable deletion signal.
Developer identifier: `daily_activity.userDailyActivityStats`
**User Daily Activity Stats.** Daily activity records. Each metric is an array of call IDs contributing to that metric for the day window. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Measure each returned user daily activity stat in `daily_activity.userDailyActivityStats` at its element and time grain; compare values only when Gong API reports the same unit and aggregation.
* **Interpretation:** Gong API returns user daily activity stats as an array of user daily activity stat entries on each daily activity; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.callsAsHost`
**Calls As Host.** Call IDs where the user was host. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Connect the parent daily activity to every referenced calls as host value in `daily_activity.userDailyActivityStats.callsAsHost`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Gong API returns calls as host as an array of calls as host value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.callsAttended`
**Calls Attended.** Call IDs the user attended. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Connect the parent daily activity to every referenced calls attended value in `daily_activity.userDailyActivityStats.callsAttended`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Gong API returns calls attended as an array of calls attended value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.callsCommentsGiven`
**Calls Comments Given.** Call IDs where the user gave comments. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Connect the parent daily activity to every referenced calls comments given value in `daily_activity.userDailyActivityStats.callsCommentsGiven`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Gong API returns calls comments given as an array of calls comments given value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.callsCommentsReceived`
**Calls Comments Received.** Call IDs where the user received comments. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Connect the parent daily activity to every referenced calls comments received value in `daily_activity.userDailyActivityStats.callsCommentsReceived`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Gong API returns calls comments received as an array of calls comments received value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.callsGaveFeedback`
**Calls Gave Feedback.** Call IDs where the user gave feedback. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Connect the parent daily activity to every referenced calls gave feedback value in `daily_activity.userDailyActivityStats.callsGaveFeedback`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Gong API returns calls gave feedback as an array of calls gave feedback value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.callsMarkedAsFeedbackGiven`
**Calls Marked As Feedback Given.** Call IDs marked as feedback given. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Connect the parent daily activity to every referenced calls marked as feedback given value in `daily_activity.userDailyActivityStats.callsMarkedAsFeedbackGiven`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Gong API returns calls marked as feedback given as an array of calls marked as feedback given value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.callsMarkedAsFeedbackReceived`
**Calls Marked As Feedback Received.** Call IDs marked as feedback received. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Connect the parent daily activity to every referenced calls marked as feedback received value in `daily_activity.userDailyActivityStats.callsMarkedAsFeedbackReceived`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Gong API returns calls marked as feedback received as an array of calls marked as feedback received value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.callsReceivedFeedback`
**Calls Received Feedback.** Call IDs where the user received feedback. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Connect the parent daily activity to every referenced calls received feedback value in `daily_activity.userDailyActivityStats.callsReceivedFeedback`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Gong API returns calls received feedback as an array of calls received feedback value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.callsRequestedFeedback`
**Calls Requested Feedback.** Call IDs where the user requested feedback. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Connect the parent daily activity to every referenced calls requested feedback value in `daily_activity.userDailyActivityStats.callsRequestedFeedback`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Gong API returns calls requested feedback as an array of calls requested feedback value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.callsScorecardsFilled`
**Calls Scorecards Filled.** Call IDs with scorecards filled. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Connect the parent daily activity to every referenced calls scorecards filled value in `daily_activity.userDailyActivityStats.callsScorecardsFilled`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Gong API returns calls scorecards filled as an array of calls scorecards filled value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.callsScorecardsReceived`
**Calls Scorecards Received.** Call IDs with scorecards received. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Connect the parent daily activity to every referenced calls scorecards received value in `daily_activity.userDailyActivityStats.callsScorecardsReceived`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Gong API returns calls scorecards received as an array of calls scorecards received value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.callsSharedExternally`
**Calls Shared Externally.** Call IDs shared externally. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Connect the parent daily activity to every referenced calls shared externally value in `daily_activity.userDailyActivityStats.callsSharedExternally`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Gong API returns calls shared externally as an array of calls shared externally value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.callsSharedInternally`
**Calls Shared Internally.** Call IDs shared internally. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Connect the parent daily activity to every referenced calls shared internally value in `daily_activity.userDailyActivityStats.callsSharedInternally`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Gong API returns calls shared internally as an array of calls shared internally value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.fromDate`
**From Date.** Start of the day window (ISO-8601). It anchors the daily activity on the provider's reported timeline.
* **Enables:** Match repeated user daily activity stat entries on from date in `daily_activity.userDailyActivityStats.fromDate`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports from date as a timestamp on each user daily activity stat; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `daily_activity.userDailyActivityStats.othersCallsListenedTo`
**Others Calls Listened To.** Others' call IDs listened to. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Attribute each returned others calls listened to value in `daily_activity.userDailyActivityStats.othersCallsListenedTo` to the parent daily activity; preserve whether the field represents an attendee, To, Cc, or Bcc relationship.
* **Interpretation:** Gong API returns others calls listened to as an array of others calls listened to value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.ownCallsListenedTo`
**Own Calls Listened To.** Own call IDs listened to. It preserves the nested context needed to interpret the parent daily activity.
* **Enables:** Attribute each returned own calls listened to value in `daily_activity.userDailyActivityStats.ownCallsListenedTo` to the parent daily activity; preserve whether the field represents an attendee, To, Cc, or Bcc relationship.
* **Interpretation:** Gong API returns own calls listened to as an array of own calls listened to value entries on each user daily activity stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `daily_activity.userDailyActivityStats.toDate`
**To Date.** End of the day window (ISO-8601). It anchors the daily activity on the provider's reported timeline.
* **Enables:** Order Daily Activity by to date in `daily_activity.userDailyActivityStats.toDate` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports to date as a timestamp on each user daily activity stat; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `daily_activity.userEmailAddress`
**User Email Address.** Email address of the user. It supplies the provider-reported address or location facet for the daily activity, not a residency determination.
* **Enables:** Attribute each daily activity to a person or account by the exact user email address in `daily_activity.userEmailAddress`; identify addresses that do not match the Gong API directory.
* **Interpretation:** Gong API reports user email address as an address on each daily activity; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `daily_activity.userId`
**User ID.** User ID. It provides the reference needed to connect the daily activity to the corresponding provider object.
* **Enables:** Match repeated daily activity entries on user ID in `daily_activity.userId`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports user ID as an identifier in its user namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `interaction_stats`
**Interaction Stats.** Retrieves interaction statistics for users including coaching and whisper call metrics. Provides data on manager-rep interaction patterns.
* **Enables:** Measure provider-reported manager and representative interaction, coaching, and whisper-call counts by user and period.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/stats/interaction` operation as an event stream using incremental synchronization. This stream is opt-in. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. Coaching and interaction measures reflect Gong's definitions and do not establish work quality or employee performance. This stream supplies no reliable deletion signal.
Developer identifier: `interaction_stats.personInteractionStats`
**Person Interaction Stats.** Interaction statistics for the user. Metric names include: Longest Monologue, Longest Customer Story, Interactivity, Patience, Question Rate. It preserves the nested context needed to interpret the parent interaction stat.
* **Enables:** Measure each returned person interaction stat in `interaction_stats.personInteractionStats` at its element and time grain; compare values only when Gong API reports the same unit and aggregation.
* **Interpretation:** Gong API returns person interaction stats as an array of person interaction stat entries on each interaction stat; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `interaction_stats.personInteractionStats.name`
**Name.** Name of the interaction metric. It gives the person interaction stat a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Match repeated person interaction stat entries on name in `interaction_stats.personInteractionStats.name`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports name as display text for each person interaction stat; names are mutable and are not stable identities.
Developer identifier: `interaction_stats.personInteractionStats.value`
**Value.** Numeric value of the metric. It must be interpreted with the enclosing provider field name, type, or custom schema for the person interaction stat.
* **Enables:** Interpret `interaction_stats.personInteractionStats.value` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Gong API reports value under the enclosing custom or typed field contract on each person interaction stat; compare it only with values from the same provider key and type.
Developer identifier: `interaction_stats.userEmailAddress`
**User Email Address.** Email address of the Gong user. It supplies the provider-reported address or location facet for the interaction stat, not a residency determination.
* **Enables:** Attribute each interaction stat to a person or account by the exact user email address in `interaction_stats.userEmailAddress`; identify addresses that do not match the Gong API directory.
* **Interpretation:** Gong API reports user email address as an address on each interaction stat; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `interaction_stats.userId`
**User ID.** Gong's unique numeric identifier for the user. It provides the reference needed to connect the interaction stat to the corresponding provider object.
* **Enables:** Match repeated interaction stat entries on user ID in `interaction_stats.userId`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports user ID as an identifier in its user namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `library_folders`
**Library Folders.** List all public library folders in Gong. Returns folder hierarchy for organizing call recordings.
* **Enables:** Reconstruct the public call-library folder hierarchy and match folders to their parent folder and creator references.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/library/folders` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `library_folders.callsCount`
**Calls Count.** Number of calls. It supplies the calls count measure for the library folder at the provider's declared unit and grain.
* **Enables:** Measure calls count through `library_folders.callsCount` for each library folder and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports calls count as a measure on each library folder; compare only records with the same unit and aggregation grain.
Developer identifier: `library_folders.creationDateTime`
**Creation Date Time.** Creation timestamp. It anchors the library folder on the provider's reported timeline.
* **Enables:** Order Library Folders by creation date time in `library_folders.creationDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports creation date time as a timestamp on each library folder; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `library_folders.creatorUserId`
**Creator User ID.** Creator user ID. It provides the reference needed to connect the library folder to the corresponding provider object.
* **Enables:** Connect each library folder in Library Folders to the referenced creator user through `library_folders.creatorUserId`; flag creator user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports creator user ID as an identifier in its creator user namespace; it is not a universal identity outside Gong API.
Developer identifier: `library_folders.description`
**Description.** Folder description. It defines the content surface available for this library folder.
* **Enables:** Locate library folder records by description in `library_folders.description`; attribute each text match to its parent library folder and, when present, its reported author.
* **Interpretation:** Gong supplies this call content; provider-generated excerpts or summaries may omit context and are not Parable-authored assessments.
Developer identifier: `library_folders.id`
**ID.** Unique identifier. It provides the reference needed to connect the library folder to the corresponding provider object.
* **Enables:** Match repeated library folder entries on ID in `library_folders.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports ID as an identifier in its library folder namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `library_folders.name`
**Name.** Display name. It gives the library folder a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each library folder with name from `library_folders.name`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports name as display text for each library folder; names are mutable and are not stable identities.
Developer identifier: `library_folders.parentId`
**Parent ID.** Parent folder ID. It provides the reference needed to connect the library folder to the corresponding provider object.
* **Enables:** Connect each library folder in Library Folders to the referenced parent through `library_folders.parentId`; flag parent ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports parent ID as an identifier in its parent namespace; it is not a universal identity outside Gong API.
Developer identifier: `library_folders.subFoldersCount`
**Sub Folders Count.** Number of sub-folders. It supplies the sub folders count measure for the library folder at the provider's declared unit and grain.
* **Enables:** Measure sub folders count through `library_folders.subFoldersCount` for each library folder and compare only values with the same unit and record grain.
* **Interpretation:** Gong API reports sub folders count as a measure on each library folder; compare only records with the same unit and aggregation grain.
Developer identifier: `library_folders.updatedDateTime`
**Updated Date Time.** Last update timestamp. It anchors the library folder on the provider's reported timeline.
* **Enables:** Order Library Folders by updated date time in `library_folders.updatedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports updated date time as a timestamp on each library folder; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `library_folders.workspaceId`
**Workspace ID.** Workspace ID. It provides the reference needed to connect the library folder to the corresponding provider object.
* **Enables:** Connect each library folder in Library Folders to the referenced workspace through `library_folders.workspaceId`; flag workspace ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports workspace ID as an identifier in its workspace namespace; it is not a universal identity outside Gong API.
Developer identifier: `logs`
**Logs.** List log entries from Gong by type and time range. Returns audit/activity log entries for compliance and monitoring.
* **Enables:** Trace provider log entries to their log type, actor or user, affected object, and reported time window.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/logs` operation as an event stream using incremental synchronization. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. This stream supplies no reliable deletion signal.
Developer identifier: `logs.eventTime`
**Event Time.** Timestamp of the event. It anchors the log on the provider's reported timeline.
* **Enables:** Match repeated log entries on event time in `logs.eventTime`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports event time as a timestamp on each log; timezone and precision follow this API field, and absence is not an inferred event time. The connector explicitly marks this field as a transform deduplication key. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `logs.logRecord`
**Log Record.** Per-log-type record payload. Shape varies with the logType request parameter (e.g., UserActivityLog carries auditId, tableChanges, customData, httpRequest). Stored as an opaque key-value map; downstream consumers branch on the requested logType. It preserves the nested context needed to interpret the parent log.
* **Enables:** Attribute log record in `logs.logRecord` to the parent log; identify parent records where that nested log record object is absent.
* **Interpretation:** Gong API reports log record as a nested object on each log; optional children may be absent from a valid response.
Provider-defined fields may also be returned for this field.
Developer identifier: `logs.userEmailAddress`
**User Email Address.** Email of the user. It supplies the provider-reported address or location facet for the log, not a residency determination.
* **Enables:** Attribute each log to a person or account by the exact user email address in `logs.userEmailAddress`; identify addresses that do not match the Gong API directory.
* **Interpretation:** Gong API reports user email address as an address on each log; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `logs.userFullName`
**User Full Name.** Full name of the user. It gives the log a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each log with user full name from `logs.userFullName`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports user full name as display text for each log; names are mutable and are not stable identities.
Developer identifier: `logs.userId`
**User ID.** User who triggered the event. It provides the reference needed to connect the log to the corresponding provider object.
* **Enables:** Connect each log in Logs to the referenced user through `logs.userId`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports user ID as an identifier in its user namespace; it is not a universal identity outside Gong API.
Developer identifier: `manual_crm_associations`
**Manual CRM Associations.** List calls that have been manually associated with CRM objects since a given time. Returns association mappings between calls and CRM entities.
* **Enables:** Match each manual association to its Gong call, CRM object type, CRM object identifier, and association timestamp.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/calls/manual-crm-associations` operation as an event stream using incremental synchronization. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. This stream supplies no reliable deletion signal.
Developer identifier: `manual_crm_associations.associatedCrmObjects`
**Associated CRM Objects.** List of all association objects for the call. It preserves the nested context needed to interpret the parent manual CRM association.
* **Enables:** Attribute every returned associated CRM object in `manual_crm_associations.associatedCrmObjects` to its parent manual CRM association; keep each relationship distinct and distinguish an absent array from an explicitly empty one.
* **Interpretation:** Gong API returns associated CRM objects as an array of associated CRM object entries on each manual CRM association; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `manual_crm_associations.associatedCrmObjects.accountCrmId`
**Account Crm ID.** CRM account ID. It provides the reference needed to connect the manual CRM association to the corresponding provider object.
* **Enables:** Match repeated associated CRM object entries on account CRM ID in `manual_crm_associations.associatedCrmObjects.accountCrmId`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports account CRM ID as an identifier in its account CRM namespace; it is not a universal identity outside Gong API.
Developer identifier: `manual_crm_associations.associatedCrmObjects.dealCrmId`
**Deal Crm ID.** CRM deal/opportunity ID, if a deal was associated. It provides the reference needed to connect the manual CRM association to the corresponding provider object.
* **Enables:** Connect each associated CRM object in Manual CRM Associations to the referenced deal CRM through `manual_crm_associations.associatedCrmObjects.dealCrmId`; flag deal CRM ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports deal CRM ID as an identifier in its deal CRM namespace; it is not a universal identity outside Gong API.
Developer identifier: `manual_crm_associations.callId`
**Call ID.** Gong's unique numeric identifier for the call. It provides the reference needed to connect the manual CRM association to the corresponding provider object.
* **Enables:** Match repeated manual CRM association entries on call ID in `manual_crm_associations.callId`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports call ID as an identifier in its call namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `manual_crm_associations.created`
**Created.** The association date (ISO-8601). It anchors the manual CRM association on the provider's reported timeline.
* **Enables:** Order Manual CRM Associations by created in `manual_crm_associations.created` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports created as a timestamp on each manual CRM association; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `manual_crm_associations.userId`
**User ID.** ID of the user who performed the association. It provides the reference needed to connect the manual CRM association to the corresponding provider object.
* **Enables:** Connect each manual CRM association in Manual CRM Associations to the referenced user through `manual_crm_associations.userId`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports user ID as an identifier in its user namespace; it is not a universal identity outside Gong API.
Developer identifier: `meetings`
**Meetings.** DISABLED: Gong has no list meetings API. Meeting metadata (meetingUrl, calendarEventId, schedule) is available on calls and calls\_extensive. Enable only if a future Gong list endpoint is added.
* **Enables:** Reserve the disabled meeting shape for a future list operation; current meeting metadata must be read from call records.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/meetings` operation as a changelog stream using incremental synchronization. This stream is opt-in. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. This stream is disabled because Gong exposes no meeting-list operation; call records remain the supported source of meeting URL, calendar event, and schedule metadata. This stream supplies no reliable deletion signal.
Developer identifier: `meetings.attendees`
**Attendees.** List of meeting attendees. It preserves the nested context needed to interpret the parent meeting.
* **Enables:** Attribute each returned attendee in `meetings.attendees` to the parent meeting; preserve whether the field represents an attendee, To, Cc, or Bcc relationship.
* **Interpretation:** Gong API returns attendees as an array of attendee entries on each meeting; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `meetings.attendees.emailAddress`
**Email Address.** Attendee email address. It supplies the provider-reported address or location facet for the attendee, not a residency determination.
* **Enables:** Match repeated attendee entries on email address in `meetings.attendees.emailAddress`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports email address as an address on each attendee; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `meetings.attendees.name`
**Name.** Attendee display name. It gives the attendee a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each attendee with name from `meetings.attendees.name`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports name as display text for each attendee; names are mutable and are not stable identities.
Developer identifier: `meetings.callId`
**Call ID.** Associated call ID if the meeting was recorded. It provides the reference needed to connect the meeting to the corresponding provider object.
* **Enables:** Connect each meeting in Meetings to the referenced call through `meetings.callId`; flag call ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports call ID as an identifier in its call namespace; it is not a universal identity outside Gong API.
Developer identifier: `meetings.id`
**ID.** Unique identifier for the meeting. It provides the reference needed to connect the meeting to the corresponding provider object.
* **Enables:** Match repeated meeting entries on ID in `meetings.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports ID as an identifier in its meeting namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `meetings.meetingUrl`
**Meeting URL.** URL of the meeting. It locates the provider resource or path associated with the meeting.
* **Enables:** Associate each meeting with the resource identified by meeting URL in `meetings.meetingUrl`; verify the link resolves to the expected Gong API object.
* **Interpretation:** Gong API reports meeting URL as a resource locator for each meeting; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `meetings.organizerEmailAddress`
**Organizer Email Address.** Email address of the meeting organizer. It supplies the provider-reported address or location facet for the meeting, not a residency determination.
* **Enables:** Attribute each meeting to a person or account by the exact organizer email address in `meetings.organizerEmailAddress`; identify addresses that do not match the Gong API directory.
* **Interpretation:** Gong API reports organizer email address as an address on each meeting; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `meetings.scheduledTime`
**Scheduled Time.** Scheduled time of the meeting in ISO-8601 format. It is needed to place the meeting on the provider timeline at the field's stated precision.
* **Enables:** Order Meetings by the provider-reported instant in `meetings.scheduledTime` and isolate records inside the same time window and precision.
* **Interpretation:** Gong API reports scheduled time as a time value for each meeting; format, timezone, precision, and absolute-versus-relative meaning follow this field's contract. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `meetings.title`
**Title.** Title or subject of the meeting. It supplies the returned title text needed to understand the meeting in context.
* **Enables:** Label each meeting with title from `meetings.title`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports title as display text for each meeting; names are mutable and are not stable identities.
Developer identifier: `meetings.workspaceId`
**Workspace ID.** Workspace the meeting belongs to. It provides the reference needed to connect the meeting to the corresponding provider object.
* **Enables:** Connect each meeting in Meetings to the referenced workspace through `meetings.workspaceId`; flag workspace ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports workspace ID as an identifier in its workspace namespace; it is not a universal identity outside Gong API.
Developer identifier: `permission_profiles`
**Permission Profiles.** Retrieve all permission profiles from Gong for each workspace. Returns workspace permission profiles including profile IDs, names, and access settings.
* **Enables:** Match each workspace to its Gong permission profiles, names, and provider-defined access settings.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/all-permission-profiles` operation as a snapshot stream using full synchronization. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Provider-defined fields may also be returned for this data stream.
Developer identifier: `permission_profiles.description`
**Description.** Permission profile description. It defines the content surface available for this permission profile.
* **Enables:** Locate permission profile records by description in `permission_profiles.description`; attribute each text match to its parent permission profile and, when present, its reported author.
* **Interpretation:** Gong supplies this call content; provider-generated excerpts or summaries may omit context and are not Parable-authored assessments.
Developer identifier: `permission_profiles.id`
**ID.** Unique identifier for the permission profile. It provides the reference needed to connect the permission profile to the corresponding provider object.
* **Enables:** Match repeated permission profile entries on ID in `permission_profiles.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports ID as an identifier in its permission profile namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `permission_profiles.name`
**Name.** Display name of the permission profile. It gives the permission profile a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each permission profile with name from `permission_profiles.name`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports name as display text for each permission profile; names are mutable and are not stable identities.
Developer identifier: `scorecards`
**Scorecards.** Retrieve all scorecard definitions/settings from Gong. Returns scorecard templates with their questions and scoring criteria.
* **Enables:** Inventory scorecard definitions and match their questions, scoring criteria, creator, visibility, and active state.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/settings/scorecards` operation as a snapshot stream using full synchronization. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. Scorecard questions and criteria are authored in Gong; they are not independent Parable assessments of employee performance. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `scorecards.created`
**Created.** ISO-8601 timestamp of creation. It anchors the scorecard on the provider's reported timeline.
* **Enables:** Order Scorecards by created in `scorecards.created` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports created as a timestamp on each scorecard; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `scorecards.enabled`
**Enabled.** Whether the scorecard is enabled. It distinguishes the provider-defined enabled state or classification for the scorecard.
* **Enables:** Filter Scorecards by whether the scorecard is enabled in `scorecards.enabled`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports the scorecard is enabled as a boolean on each scorecard; a missing field is unknown, not false.
Developer identifier: `scorecards.questions`
**Questions.** Questions defined in the scorecard. It preserves the nested context needed to interpret the parent scorecard.
* **Enables:** Search the returned questions content in `scorecards.questions` while preserving element order and attribution to the parent scorecard.
* **Interpretation:** Gong API returns questions as ordered content or provider-generated content metadata on each scorecard; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `scorecards.questions.answerGuide`
**Answer Guide.** Scoring guidance/rubric for the question (may contain HTML). It defines the content surface available for this scorecard.
* **Enables:** Locate question records by answer guide in `scorecards.questions.answerGuide`; attribute each text match to its parent scorecard and, when present, its reported author.
* **Interpretation:** Gong supplies this call content; provider-generated excerpts or summaries may omit context and are not Parable-authored assessments.
Developer identifier: `scorecards.questions.answerOptions`
**Answer Options.** Predefined answer options for choice questions. It preserves the nested context needed to interpret the parent scorecard.
* **Enables:** Search the returned answer options content in `scorecards.questions.answerOptions` while preserving element order and attribution to the parent scorecard.
* **Interpretation:** Gong API returns answer options as ordered content or provider-generated content metadata on each question; truncation, omission, and inaccessible source media can limit completeness.
Provider-defined fields may also be returned for this field.
Developer identifier: `scorecards.questions.created`
**Created.** ISO-8601 timestamp when the question was created. It anchors the scorecard on the provider's reported timeline.
* **Enables:** Order Scorecards by created in `scorecards.questions.created` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports created as a timestamp on each question; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `scorecards.questions.isOverall`
**Is Overall.** Whether this is the overall scorecard rating. It distinguishes the provider-defined is overall state or classification for the question.
* **Enables:** Filter Scorecards by whether this is the overall scorecard rating in `scorecards.questions.isOverall`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports this is the overall scorecard rating as a boolean on each question; a missing field is unknown, not false.
Developer identifier: `scorecards.questions.maxRange`
**Max Range.** Maximum value for RANGE questions. It supplies the max range boundary, band, or unit needed to interpret the companion measure.
* **Enables:** Interpret `scorecards.questions.maxRange` with its companion minimum, maximum, interval, or unit before comparing the max range across like-for-like records.
* **Interpretation:** Gong API reports max range as a boundary, band, interval, or unit on each question; it is meaningful only with its companion measure and provider scale.
Developer identifier: `scorecards.questions.minRange`
**Min Range.** Minimum value for RANGE questions. It supplies the min range boundary, band, or unit needed to interpret the companion measure.
* **Enables:** Interpret `scorecards.questions.minRange` with its companion minimum, maximum, interval, or unit before comparing the min range across like-for-like records.
* **Interpretation:** Gong API reports min range as a boundary, band, interval, or unit on each question; it is meaningful only with its companion measure and provider scale.
Developer identifier: `scorecards.questions.questionId`
**Question ID.** The provider-reported question ID for each question in Scorecards. It provides the reference needed to connect the scorecard to the corresponding provider object.
* **Enables:** Match repeated question entries on question ID in `scorecards.questions.questionId`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports question ID as an identifier in its question namespace; it is not a universal identity outside Gong API.
Developer identifier: `scorecards.questions.questionRevisionId`
**Question Revision ID.** The provider-reported question revision ID for each question in Scorecards. It provides the reference needed to connect the scorecard to the corresponding provider object.
* **Enables:** Connect each question in Scorecards to the referenced question revision through `scorecards.questions.questionRevisionId`; flag question revision ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports question revision ID as an identifier in its question revision namespace; it is not a universal identity outside Gong API.
Developer identifier: `scorecards.questions.questionText`
**Question Text.** Text of the scorecard question. It defines the content surface available for this scorecard.
* **Enables:** Locate question records by question text in `scorecards.questions.questionText`; attribute each text match to its parent scorecard and, when present, its reported author.
* **Interpretation:** Gong supplies this call content; provider-generated excerpts or summaries may omit context and are not Parable-authored assessments.
Developer identifier: `scorecards.questions.questionType`
**Question Type.** Question answer type (e.g., RANGE, MULTIPLE\_CHOICE). It supplies the question type boundary, band, or unit needed to interpret the companion measure.
* **Enables:** Segment question entries in Scorecards by question type in `scorecards.questions.questionType`; compare counts only within the same Gong API taxonomy.
* **Interpretation:** Gong API reports question type as a label from its own taxonomy on each question; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `scorecards.questions.updated`
**Updated.** ISO-8601 timestamp when the question was last updated. It anchors the scorecard on the provider's reported timeline.
* **Enables:** Order Scorecards by updated in `scorecards.questions.updated` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports updated as a timestamp on each question; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `scorecards.questions.updaterUserId`
**Updater User ID.** ID of the user who last updated the question. It provides the reference needed to connect the scorecard to the corresponding provider object.
* **Enables:** Connect each question in Scorecards to the referenced updater user through `scorecards.questions.updaterUserId`; flag updater user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports updater user ID as an identifier in its updater user namespace; it is not a universal identity outside Gong API.
Developer identifier: `scorecards.reviewMethod`
**Review Method.** How the scorecard is reviewed (e.g., MANUAL, AUTOMATIC). It distinguishes the provider-defined review method state or classification for the scorecard.
* **Enables:** Filter Scorecards by the exact Gong API-defined review method in `scorecards.reviewMethod` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies review method from its own taxonomy on each scorecard; preserve unknown and newly introduced labels.
Developer identifier: `scorecards.scorecardId`
**Scorecard ID.** Unique identifier for the scorecard. It provides the reference needed to connect the scorecard to the corresponding provider object.
* **Enables:** Match repeated scorecard entries on scorecard ID in `scorecards.scorecardId`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports scorecard ID as an identifier in its scorecard namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `scorecards.scorecardName`
**Scorecard Name.** Name of the scorecard. It gives the scorecard a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each scorecard with scorecard name from `scorecards.scorecardName`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports scorecard name as display text for each scorecard; names are mutable and are not stable identities.
Developer identifier: `scorecards.updated`
**Updated.** ISO-8601 timestamp of last update. It anchors the scorecard on the provider's reported timeline.
* **Enables:** Order Scorecards by updated in `scorecards.updated` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports updated as a timestamp on each scorecard; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `scorecards.updaterUserId`
**Updater User ID.** ID of the user who last updated the scorecard. It provides the reference needed to connect the scorecard to the corresponding provider object.
* **Enables:** Connect each scorecard in Scorecards to the referenced updater user through `scorecards.updaterUserId`; flag updater user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports updater user ID as an identifier in its updater user namespace; it is not a universal identity outside Gong API.
Developer identifier: `scorecards.workspaceId`
**Workspace ID.** Workspace the scorecard belongs to. It provides the reference needed to connect the scorecard to the corresponding provider object.
* **Enables:** Connect each scorecard in Scorecards to the referenced workspace through `scorecards.workspaceId`; flag workspace ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports workspace ID as an identifier in its workspace namespace; it is not a universal identity outside Gong API.
Developer identifier: `trackers`
**Trackers.** Retrieve all keyword tracker definitions from Gong. Returns tracker configurations including keywords, phrases, and associated settings.
* **Enables:** Inventory Gong-defined tracker phrases and settings while preserving them as provider classifications rather than Parable judgments.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/settings/trackers` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. Tracker phrases and matches are Gong or administrator-defined classifications, not Parable-authored judgments. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `trackers.affiliation`
**Affiliation.** Who must say the keywords to match. Options: Anyone, Company, NonCompany. It distinguishes the provider-defined affiliation state or classification for the tracker.
* **Enables:** Filter Trackers by the exact Gong API-defined affiliation in `trackers.affiliation` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies affiliation from its own taxonomy on each tracker; preserve unknown and newly introduced labels.
Developer identifier: `trackers.created`
**Created.** Date/time the tracker was created (ISO-8601). It anchors the tracker on the provider's reported timeline.
* **Enables:** Order Trackers by created in `trackers.created` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports created as a timestamp on each tracker; timezone and precision follow this API field, and absence is not an inferred event time. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `trackers.creatorUserId`
**Creator User ID.** ID of the team member who created the tracker. Null when built-in. It provides the reference needed to connect the tracker to the corresponding provider object.
* **Enables:** Connect each tracker in Trackers to the referenced creator user through `trackers.creatorUserId`; flag creator user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports creator user ID as an identifier in its creator user namespace; it is not a universal identity outside Gong API. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `trackers.filterQuery`
**Filter Query.** JSON filter defining which calls to include. It must be interpreted with the enclosing provider field name, type, or custom schema for the tracker.
* **Enables:** Interpret `trackers.filterQuery` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Gong API reports filter query under the enclosing custom or typed field contract on each tracker; compare it only with values from the same provider key and type.
Developer identifier: `trackers.languageKeywords`
**Language Keywords.** Words and phrases defined for the tracker, grouped by language. It preserves the nested context needed to interpret the parent tracker.
* **Enables:** Reconcile each returned language keyword in `trackers.languageKeywords` with the parent tracker's provider profile; preserve distinct aliases, contact points, and organization attributes.
* **Interpretation:** Gong API returns language keywords as an array of language keyword entries on each tracker; missing, empty, and permission-redacted arrays are not equivalent. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `trackers.languageKeywords.includeRelatedForms`
**Include Related Forms.** When true, matches related word forms (e.g., organize/organized/organizes). It distinguishes the provider-defined include related forms state or classification for the language keyword.
* **Enables:** Filter Trackers by whether when true, matches related word forms (e.g., organize/organized/organizes) in `trackers.languageKeywords.includeRelatedForms`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports when true, matches related word forms (e.g., organize/organized/organizes) as a boolean on each language keyword; a missing field is unknown, not false.
Developer identifier: `trackers.languageKeywords.keywords`
**Keywords.** Words and phrases in the specified language. It preserves the nested context needed to interpret the parent tracker.
* **Enables:** Reconcile each returned keyword value in `trackers.languageKeywords.keywords` with the parent tracker's provider profile; preserve distinct aliases, contact points, and organization attributes.
* **Interpretation:** Gong API returns keywords as an array of keyword value entries on each language keyword; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `trackers.languageKeywords.language`
**Language.** ISO 639-2/B language code. 'mul' means keywords apply to all languages. It supplies the language profile facet used to reconcile or attribute the language keyword.
* **Enables:** Match repeated language keyword entries on language in `trackers.languageKeywords.language`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports language on each language keyword; missing and empty values can have different meanings.
Developer identifier: `trackers.partOfQuestion`
**Part Of Question.** When true, only matches keywords that are part of a question. It distinguishes the provider-defined part of question state or classification for the tracker.
* **Enables:** Filter Trackers by whether when true, only matches keywords that are part of a question in `trackers.partOfQuestion`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports when true, only matches keywords that are part of a question as a boolean on each tracker; a missing field is unknown, not false.
Developer identifier: `trackers.saidAt`
**Said At.** Where in the call to track keywords. Options: Anytime, First, Last. It distinguishes the provider-defined said at state or classification for the tracker.
* **Enables:** Filter Trackers by the exact Gong API-defined said at in `trackers.saidAt` and preserve unknown values as distinct categories.
* **Interpretation:** Gong API supplies said at from its own taxonomy on each tracker; preserve unknown and newly introduced labels.
Developer identifier: `trackers.saidAtInterval`
**Said At Interval.** Period of time to check (units depend on saidAtUnit). Nullable. It supplies the said at interval boundary, band, or unit needed to interpret the companion measure.
* **Enables:** Interpret `trackers.saidAtInterval` with its companion minimum, maximum, interval, or unit before comparing the said at interval across like-for-like records.
* **Interpretation:** Gong API reports said at interval as a boundary, band, interval, or unit on each tracker; it is meaningful only with its companion measure and provider scale.
Developer identifier: `trackers.saidAtUnit`
**Said At Unit.** Units for saidAtInterval (minutes or percent of call duration). Nullable. It supplies the said at unit boundary, band, or unit needed to interpret the companion measure.
* **Enables:** Interpret `trackers.saidAtUnit` with its companion minimum, maximum, interval, or unit before comparing the said at unit across like-for-like records.
* **Interpretation:** Gong API reports said at unit as a boundary, band, interval, or unit on each tracker; it is meaningful only with its companion measure and provider scale.
Developer identifier: `trackers.saidInTopics`
**Said In Topics.** Topics in the call where tracker terms should be picked up. It preserves the nested context needed to interpret the parent tracker.
* **Enables:** Review each provider-generated said in topic value in `trackers.saidInTopics` within its parent tracker; retain element order and attribution without treating it as a Parable judgment.
* **Interpretation:** Gong API returns said in topics as ordered content or provider-generated content metadata on each tracker; truncation, omission, and inaccessible source media can limit completeness. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `trackers.trackerId`
**Tracker ID.** Unique identifier. It provides the reference needed to connect the tracker to the corresponding provider object.
* **Enables:** Match repeated tracker entries on tracker ID in `trackers.trackerId`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports tracker ID as an identifier in its tracker namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `trackers.trackerName`
**Tracker Name.** Display name. It gives the tracker a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each tracker with tracker name from `trackers.trackerName`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports tracker name as display text for each tracker; names are mutable and are not stable identities. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `trackers.updated`
**Updated.** Date/time the tracker settings were last updated (ISO-8601). It anchors the tracker on the provider's reported timeline.
* **Enables:** Order Trackers by updated in `trackers.updated` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports updated as a timestamp on each tracker; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `trackers.updaterUserId`
**Updater User ID.** ID of the team member who last updated the tracker. Null when built-in. It provides the reference needed to connect the tracker to the corresponding provider object.
* **Enables:** Connect each tracker in Trackers to the referenced updater user through `trackers.updaterUserId`; flag updater user ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports updater user ID as an identifier in its updater user namespace; it is not a universal identity outside Gong API. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `trackers.workspaceId`
**Workspace ID.** ID of the workspace the tracker is in. Nullable. It provides the reference needed to connect the tracker to the corresponding provider object.
* **Enables:** Connect each tracker in Trackers to the referenced workspace through `trackers.workspaceId`; flag workspace ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports workspace ID as an identifier in its workspace namespace; it is not a universal identity outside Gong API. Gong API generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `user_settings_history`
**User Settings History.** Retrieve the settings change history for each Gong user. Returns historical records of user settings changes over time, useful for tracking configuration changes and compliance auditing. This is a child endpoint of users — it iterates over all users and fetches settings history for each one via GET /v2/users/ID/settings-history.
* **Enables:** Trace each user's provider setting changes over time and attribute each historical state to the parent Gong user.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/users/{id}/settings-history` operation as an event stream using full synchronization. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. This stream supplies no reliable deletion signal.
Developer identifier: `user_settings_history.setting`
**Setting.** The user capability that was changed (e.g., webConferencesRecorded, emailsImported, preventEmailImport, active, nonRecordedMeetingsImported, gongConnectEnabled, callsImported, interviewsRecorded, preventInterviewRecording). It must be interpreted with the enclosing provider field name, type, or custom schema for the user settings history.
* **Enables:** Interpret `user_settings_history.setting` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Gong API reports setting under the enclosing custom or typed field contract on each user settings history; compare it only with values from the same provider key and type.
Developer identifier: `user_settings_history.time`
**Time.** ISO-8601 timestamp of when the change was applied. It anchors the user settings history on the provider's reported timeline.
* **Enables:** Match repeated user settings history entries on time in `user_settings_history.time`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports time as a timestamp on each user settings history; timezone and precision follow this API field, and absence is not an inferred event time. The connector explicitly marks this field as a transform deduplication key. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `user_settings_history.value`
**Value.** The new value that was set for the capability. It distinguishes the provider-defined value state or classification for the user settings history.
* **Enables:** Filter User Settings History by whether the new value that was set for the capability in `user_settings_history.value`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports the new value that was set for the capability as a boolean on each user settings history; a missing field is unknown, not false.
Developer identifier: `users`
**Users.** List all Gong users in the organization. Returns user profiles including name, email, role, and activity status.
* **Enables:** Reconcile Gong user identities, email addresses, manager relationships, roles, licenses, and account status.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/users` operation as a snapshot stream using full synchronization. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. This stream supplies no reliable deletion signal.
Developer identifier: `users.active`
**Active.** Whether the user is active. It distinguishes the provider-defined active state or classification for the user.
* **Enables:** Filter Users by whether the user is active in `users.active`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports the user is active as a boolean on each user; a missing field is unknown, not false.
Developer identifier: `users.conferencingProviders`
**Conferencing Providers.** Web-conferencing providers connected for the user. It preserves the nested context needed to interpret the parent user.
* **Enables:** Compare the exact Gong API-configured conferencing providers set in `users.conferencingProviders` for each user; preserve provider labels and unknown entries.
* **Interpretation:** Gong API returns conferencing providers as an array of conferencing provider entries on each user; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `users.conferencingProviders.isDefault`
**Is Default.** Whether this is the user's default provider. It distinguishes the provider-defined is default state or classification for the conferencing provider.
* **Enables:** Filter Users by whether this is the user's default provider in `users.conferencingProviders.isDefault`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports this is the user's default provider as a boolean on each conferencing provider; a missing field is unknown, not false.
Developer identifier: `users.conferencingProviders.provider`
**Provider.** Provider name (e.g., Zoom). It distinguishes the provider-defined provider state or classification for the conferencing provider.
* **Enables:** Match repeated conferencing provider entries on provider in `users.conferencingProviders.provider`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports provider on each conferencing provider; missing and empty values can have different meanings.
Developer identifier: `users.created`
**Created.** ISO-8601 timestamp of user creation. It anchors the user on the provider's reported timeline.
* **Enables:** Order Users by created in `users.created` and isolate records inside an exact provider reporting window.
* **Interpretation:** Gong API reports created as a timestamp on each user; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `users.emailAddress`
**Email Address.** Email address of the user. It supplies the provider-reported address or location facet for the user, not a residency determination.
* **Enables:** Attribute each user to a person or account by the exact email address in `users.emailAddress`; identify addresses that do not match the Gong API directory.
* **Interpretation:** Gong API reports email address as an address on each user; aliases, casing, and unverified addresses can prevent a one-to-one person match. A connector directive maps this field to a person's email identity.
Developer identifier: `users.emailAliases`
**Email Aliases.** Additional email addresses associated with the user. It preserves the nested context needed to interpret the parent user.
* **Enables:** Reconcile each returned email aliase in `users.emailAliases` with the parent user's provider profile; preserve distinct aliases, contact points, and organization attributes.
* **Interpretation:** Gong API returns email aliases as an array of email aliase entries on each user; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `users.extension`
**Extension.** Phone extension. It supplies the extension profile facet used to reconcile or attribute the user.
* **Enables:** Reconcile the user's extension in `users.extension` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Gong API reports extension as a mutable profile or directory attribute on each user; it may be absent, shared, or non-unique.
Developer identifier: `users.firstName`
**First Name.** First name of the user. It gives the user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each user with first name from `users.firstName`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports first name as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.id`
**ID.** Unique identifier for the user. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Match repeated user entries on ID in `users.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports ID as an identifier in its user namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key. A connector directive maps this field to account identity.
Developer identifier: `users.lastName`
**Last Name.** Last name of the user. It gives the user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each user with last name from `users.lastName`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports last name as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.managerId`
**Manager ID.** ID of the user's manager. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Connect each user in Users to the referenced manager through `users.managerId`; flag manager ID values that do not resolve in that provider namespace.
* **Interpretation:** Gong API reports manager ID as an identifier in its manager namespace; it is not a universal identity outside Gong API.
Developer identifier: `users.meetingConsentPageUrl`
**Meeting Consent Page URL.** URL of the user's recording-consent page. It locates the provider resource or path associated with the user.
* **Enables:** Associate each user with the resource identified by meeting consent page URL in `users.meetingConsentPageUrl`; verify the link resolves to the expected Gong API object.
* **Interpretation:** Gong API reports meeting consent page URL as a resource locator for each user; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `users.personalMeetingUrls`
**Personal Meeting URLs.** Personal meeting URLs. It preserves the nested context needed to interpret the parent user.
* **Enables:** Associate every returned personal meeting URL value in `users.personalMeetingUrls` with the parent user; use the provider locator for reference without inferring that linked content was collected.
* **Interpretation:** Gong API returns personal meeting URLs as an array of personal meeting URL value entries on each user; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `users.phoneNumber`
**Phone Number.** Phone number of the user. It supplies the phone number profile facet used to reconcile or attribute the user.
* **Enables:** Reconcile the user's phone number in `users.phoneNumber` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Gong API reports phone number as a mutable profile or directory attribute on each user; it may be absent, shared, or non-unique.
Developer identifier: `users.settings`
**Settings.** User-level Gong settings flags. Flag set varies by tenant/plan; additionalProperties allows capture of settings not enumerated here. It preserves the nested context needed to interpret the parent user.
* **Enables:** Attribute settings in `users.settings` to the parent user; identify parent records where that nested settings object is absent.
* **Interpretation:** Gong API reports settings as a nested object on each user; optional children may be absent from a valid response.
Provider-defined fields may also be returned for this field.
Developer identifier: `users.settings.emailsImported`
**Emails Imported.** The provider-reported emails imported for each setting in Users. It distinguishes the provider-defined emails imported state or classification for the setting.
* **Enables:** Filter Users by whether emails imported in `users.settings.emailsImported`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports emails imported as a boolean on each setting; a missing field is unknown, not false.
Developer identifier: `users.settings.gongConnectEnabled`
**Gong Connect Enabled.** The provider-reported Gong connect enabled for each setting in Users. It distinguishes the provider-defined Gong connect enabled state or classification for the setting.
* **Enables:** Filter Users by whether Gong connect enabled in `users.settings.gongConnectEnabled`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports Gong connect enabled as a boolean on each setting; a missing field is unknown, not false.
Developer identifier: `users.settings.nonRecordedMeetingsImported`
**Non Recorded Meetings Imported.** The provider-reported non recorded meetings imported for each setting in Users. It distinguishes the provider-defined non recorded meetings imported state or classification for the setting.
* **Enables:** Filter Users by whether non recorded meetings imported in `users.settings.nonRecordedMeetingsImported`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports non recorded meetings imported as a boolean on each setting; a missing field is unknown, not false.
Developer identifier: `users.settings.preventEmailImport`
**Prevent Email Import.** The provider-reported prevent email import for each setting in Users. It distinguishes the provider-defined prevent email import state or classification for the setting.
* **Enables:** Filter Users by whether prevent email import in `users.settings.preventEmailImport`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports prevent email import as a boolean on each setting; a missing field is unknown, not false.
Developer identifier: `users.settings.preventWebConferenceRecording`
**Prevent Web Conference Recording.** The provider-reported prevent web conference recording for each setting in Users. It distinguishes the provider-defined prevent web conference recording state or classification for the setting.
* **Enables:** Filter Users by whether prevent web conference recording in `users.settings.preventWebConferenceRecording`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports prevent web conference recording as a boolean on each setting; a missing field is unknown, not false.
Developer identifier: `users.settings.telephonyCallsImported`
**Telephony Calls Imported.** The provider-reported telephony calls imported for each setting in Users. It distinguishes the provider-defined telephony calls imported state or classification for the setting.
* **Enables:** Filter Users by whether telephony calls imported in `users.settings.telephonyCallsImported`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports telephony calls imported as a boolean on each setting; a missing field is unknown, not false.
Developer identifier: `users.settings.webConferencesRecorded`
**Web Conferences Recorded.** The provider-reported web conferences recorded for each setting in Users. It distinguishes the provider-defined web conferences recorded state or classification for the setting.
* **Enables:** Filter Users by whether web conferences recorded in `users.settings.webConferencesRecorded`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports web conferences recorded as a boolean on each setting; a missing field is unknown, not false.
Developer identifier: `users.spokenLanguages`
**Spoken Languages.** Languages the user speaks. It preserves the nested context needed to interpret the parent user.
* **Enables:** Reconcile each returned spoken language in `users.spokenLanguages` with the parent user's provider profile; preserve distinct aliases, contact points, and organization attributes.
* **Interpretation:** Gong API returns spoken languages as an array of spoken language entries on each user; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `users.spokenLanguages.language`
**Language.** BCP-47 language tag. It supplies the language profile facet used to reconcile or attribute the spoken language.
* **Enables:** Match repeated spoken language entries on language in `users.spokenLanguages.language`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Gong API reports language on each spoken language; missing and empty values can have different meanings.
Developer identifier: `users.spokenLanguages.primary`
**Primary.** Whether this is the primary language. It distinguishes the provider-defined primary state or classification for the spoken language.
* **Enables:** Filter Users by whether this is the primary language in `users.spokenLanguages.primary`; count true, false, and missing results separately.
* **Interpretation:** Gong API reports this is the primary language as a boolean on each spoken language; a missing field is unknown, not false.
Developer identifier: `users.title`
**Title.** Job title of the user. It gives the user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each user with title from `users.title`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports title as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.trustedEmailAddress`
**Trusted Email Address.** Email address considered trusted for the user. Nullable. It supplies the provider-reported address or location facet for the user, not a residency determination.
* **Enables:** Attribute each user to a person or account by the exact trusted email address in `users.trustedEmailAddress`; identify addresses that do not match the Gong API directory.
* **Interpretation:** Gong API reports trusted email address as an address on each user; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `workspaces`
**Workspaces.** List all company workspaces in Gong. Returns workspace definitions with names and configuration.
* **Enables:** Inventory Gong workspaces and connect their identities and configuration to workspace-scoped permission profiles.
* **Scope:** Reads the records selected by Gong API's `/{apiVersion}/workspaces` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the Gong API credential, workspace access, and the endpoint's content-selection settings. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `workspaces.description`
**Description.** Description of the workspace. It defines the content surface available for this workspace.
* **Enables:** Locate workspace records by description in `workspaces.description`; attribute each text match to its parent workspace and, when present, its reported author.
* **Interpretation:** Gong supplies this call content; provider-generated excerpts or summaries may omit context and are not Parable-authored assessments.
Developer identifier: `workspaces.id`
**ID.** Unique identifier. It provides the reference needed to connect the workspace to the corresponding provider object.
* **Enables:** Match repeated workspace entries on ID in `workspaces.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Gong API reports ID as an identifier in its workspace namespace; it is not a universal identity outside Gong API. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `workspaces.name`
**Name.** Name of the workspace. It gives the workspace a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each workspace with name from `workspaces.name`; distinguish records that share that display name but have different Gong API identifiers.
* **Interpretation:** Gong API reports name as display text for each workspace; names are mutable and are not stable identities.
### Gong
| Error | Meaning | Solution |
| - | - | - |
| `401 Unauthorized` | Bad Access Key or Secret | Re-generate the key from the API settings page |
| `401` after a working period | Key expired | Generate a fresh key; Gong rotates keys periodically |
| `403 Forbidden` on a specific endpoint | Missing API scope | Ask the Gong admin to enable the scope for that data category |
| `429 Too Many Requests` | Rate limit | Parable backs off using `Retry-After` |
| Connection shows a permissions error right after saving the key | Parable checks the key with `GET /v2/users` on the connection's **API Base URL**; Gong answered `403` | Enable the `api:users:read` scope for the key, and if the Gong workspace restricts API access by IP, allow Parable's addresses |
| Connection shows a configuration error right after saving the key | The same check got a response that is neither success nor `401`/`403`, usually because **API Base URL** is not a Gong API host | Set **API Base URL** to the value in Gong's API settings, for example `https://us-12345.api.gong.io`, not the `app.gong.io` web address |
| Empty data on `calls` | No calls in range | Calls need `fromDateTime` in the last 90 days per request |
#### Common Issues
#### Cannot find the API page
The **Ecosystem → API** menu appears only for users with the Technical Administrator role.
#### Permission Profiles returns 401 / 403
Requires `api:permission-profile:read` on the key. Some tiers need Gong support to enable the scope.
**[Gong API docs](https://app.gong.io/settings/api/documentation)** — Endpoint reference (requires login)
**[API access guide](https://help.gong.io/docs/receive-access-to-the-api)** — Customer-facing setup guide
### Gong (OAuth)
| Error | Meaning | Solution |
| - | - | - |
| `401 Unauthorized` | Invalid client credentials | Verify Client ID and Client Secret on the OAuth authorization screen |
| `403 Forbidden` | Missing OAuth scope | Enable the scope on the OAuth application |
| Authorization redirect fails | Redirect URI mismatch | Copy the redirect URI from Parable (must include your workspace subdomain, e.g. `{tenant-name}.parable.work`) and add it exactly to your Gong OAuth app |
| Authorized in Parable but sync fails | Wrong **API Base URL** or token issue | Confirm **API Base URL** under Connection Settings matches Gong (default or regional); click **Re-authorize with OAuth** and confirm validation succeeded |
| `429 Too Many Requests` | Rate limit | Parable backs off using `Retry-After` |
**[Gong API docs](https://app.gong.io/settings/api/documentation)** — Endpoint reference (requires login)
**[API access guide](https://help.gong.io/docs/receive-access-to-the-api)** — Customer-facing setup guide
# HiBob
Source: https://docs.parable.work/plugins/provider-plugins/hibob
Sync employee data from HiBob HR platform
Sync employee data from HiBob HR platform.
Connect Parable to HiBob using a service user for automated HR data access.
#### People Data
Profiles, employment, org structure
#### Time & Attendance
Time off, attendance records
## Data streams
This Provider Plugin defines 3 data streams.
| Stream | Description | Sync |
| - | - | - |
| `employee` | All employees including inactive | full |
| `job_roles` | Job catalog roles | full |
| `position_budget` | Position budget entries | full |
### HiBob
#### What You'll Need
| Credential | What it is |
| - | - |
| **Service ID** | Bob service user identifier |
| **Token** | Service user API token |
> **Info:** **Setup access in HiBob.** These steps require **Administrator**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your HiBob administrator.
* **Admin** role in HiBob
* Permission to create service users
#### Step 1: Access Service Users
1. Log in to HiBob as admin
2. Go to **Settings** → **Integrations**
3. Click **Service Users**
#### Step 2: Create Service User
1. Click **Add Service User**
2. Fill in:
| Field | Value |
| - | - |
| Name | `Parable Integration` |
| Description | Integration user for Parable |
#### Step 3: Configure Permissions
Grant read permissions for:
* ✅ **People** — Employee data
* ✅ **Time Off** — Leave data
* ✅ **Reports** — Report access
* ✅ **Payroll** — If needed
> **Warning:** Only grant permissions for data you need to access.
#### Step 4: Generate Token
1. Click **Create** or **Save**
2. Copy the **Service User ID**
3. Generate and copy the **Token**
> **Warning:** Store the token securely — it won't be shown again!
#### Step 5: Enter values in the form
1. Enter **Service User ID**, **Token**, and **Service URL** in the Provider form.
2. Click **Save & test connection**.
Developer identifier: `employee`
**Employee.** All employees including inactive.
* **Enables:** Reconcile active and inactive HiBob employee records to work identity, organization, manager, site, and employment dates.
* **Scope:** Reads the records selected by HiBob's `/v1/people/search` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the HiBob service user's granted data categories and employee population. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `employee.about`
**About.** About section. It preserves the nested context needed to interpret the parent employee.
* **Enables:** Attribute about in `employee.about` to the parent employee; identify parent records where that nested about object is absent.
* **Interpretation:** HiBob reports about as a nested object on each employee; optional children may be absent from a valid response.
Developer identifier: `employee.creationDateTime`
**Creation Date Time.** Record creation timestamp. It anchors the employee on the provider's reported timeline.
* **Enables:** Order Employee by creation date time in `employee.creationDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** HiBob reports creation date time as a timestamp on each employee; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `employee.displayName`
**Display Name.** Display name. It distinguishes the provider-defined display name state or classification for the employee.
* **Enables:** Label each employee with display name from `employee.displayName`; distinguish records that share that display name but have different HiBob identifiers.
* **Interpretation:** HiBob reports display name as display text for each employee; names are mutable and are not stable identities. A connector directive maps this field to a person's display name.
Developer identifier: `employee.email`
**Email.** Employee email address. It supplies the provider-reported address or location facet for the employee, not a residency determination.
* **Enables:** Attribute each employee to a person or account by the exact email in `employee.email`; identify addresses that do not match the HiBob directory.
* **Interpretation:** HiBob reports email as an address on each employee; aliases, casing, and unverified addresses can prevent a one-to-one person match. A connector directive maps this field to a person's email identity.
Developer identifier: `employee.firstName`
**First Name.** First name. It gives the employee a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each employee with first name from `employee.firstName`; distinguish records that share that display name but have different HiBob identifiers.
* **Interpretation:** HiBob reports first name as display text for each employee; names are mutable and are not stable identities.
Developer identifier: `employee.id`
**ID.** Unique employee identifier. It provides the reference needed to connect the employee to the corresponding provider object.
* **Enables:** Match repeated employee entries on ID in `employee.id`; collapse only entries that share this declared transform key.
* **Interpretation:** HiBob reports ID as an identifier in its employee namespace; it is not a universal identity outside HiBob. The connector explicitly marks this field as a transform deduplication key. A connector directive maps this field to account identity.
Developer identifier: `employee.internal`
**Internal.** Internal HR fields including lifecycle status. It preserves the nested context needed to interpret the parent employee.
* **Enables:** Attribute internal in `employee.internal` to the parent employee; identify parent records where that nested internal object is absent.
* **Interpretation:** HiBob reports internal as a nested object on each employee; optional children may be absent from a valid response.
Developer identifier: `employee.internal.lifecycleStatus`
**Lifecycle Status.** Current lifecycle status of the employee. It distinguishes the provider-defined lifecycle status state or classification for the HiBob employee internal.
* **Enables:** Segment HiBob employee internal entries in Employee by lifecycle status in `employee.HiBobEmployeeInternal.lifecycleStatus`; compare counts only within the same HiBob taxonomy.
* **Interpretation:** HiBob reports lifecycle status as a label from its own taxonomy on each HiBob employee internal; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `employee.internal.terminationDate`
**Termination Date.** Termination date if applicable. It anchors the employee on the provider's reported timeline.
* **Enables:** Order Employee by termination date in `employee.HiBobEmployeeInternal.terminationDate` and isolate records inside an exact provider reporting window.
* **Interpretation:** HiBob reports termination date as a calendar date on each HiBob employee internal; its grain is one day and no time of day should be inferred.
Developer identifier: `employee.internal.terminationReason`
**Termination Reason.** Reason for termination if applicable. It supplies the returned termination reason text needed to understand the HiBob employee internal in context.
* **Enables:** Search the returned termination reason text in `employee.HiBobEmployeeInternal.terminationReason` and attribute each match to its parent employee and reported author when available.
* **Interpretation:** HiBob supplies termination reason as returned text on each HiBob employee internal; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `employee.payroll`
**Payroll.** Payroll details. It preserves the nested context needed to interpret the parent employee.
* **Enables:** Attribute payroll in `employee.payroll` to the parent employee; identify parent records where that nested payroll object is absent.
* **Interpretation:** HiBob reports payroll as a nested object on each employee; optional children may be absent from a valid response.
Developer identifier: `employee.personal`
**Personal.** Personal details. It preserves the nested context needed to interpret the parent employee.
* **Enables:** Attribute personal in `employee.personal` to the parent employee; identify parent records where that nested personal object is absent.
* **Interpretation:** HiBob reports personal as a nested object on each employee; optional children may be absent from a valid response.
Developer identifier: `employee.surname`
**Surname.** Employee surname (HiBob wire key; not lastName). It supplies the surname profile facet used to reconcile or attribute the employee.
* **Enables:** Reconcile the employee's surname in `employee.surname` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** HiBob reports surname as a mutable profile or directory attribute on each employee; it may be absent, shared, or non-unique.
Developer identifier: `employee.work`
**Work.** Work details including title, department, and manager. It preserves the nested context needed to interpret the parent employee.
* **Enables:** Attribute work in `employee.work` to the parent employee; identify parent records where that nested work object is absent.
* **Interpretation:** HiBob reports work as a nested object on each employee; optional children may be absent from a valid response.
Developer identifier: `employee.work.custom`
**Custom.** Custom work fields. It preserves the nested context needed to interpret the parent employee.
* **Enables:** Attribute custom in `employee.HiBobEmployeeWork.custom` to the parent employee; identify parent records where that nested custom object is absent.
* **Interpretation:** HiBob reports custom as a nested object on each HiBob employee work; optional children may be absent from a valid response.
Developer identifier: `employee.work.department`
**Department.** Department name. It supplies the department profile facet used to reconcile or attribute the HiBob employee work.
* **Enables:** Reconcile the employee's department in `employee.HiBobEmployeeWork.department` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** HiBob reports department as a mutable profile or directory attribute on each HiBob employee work; it may be absent, shared, or non-unique.
Developer identifier: `employee.work.manager`
**Manager.** Manager display name. It identifies the related provider object that gives the HiBob employee work its parent, owner, or container context.
* **Enables:** Connect each HiBob employee work to the related manager in `employee.HiBobEmployeeWork.manager` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** HiBob reports manager as relationship context on each HiBob employee work; resolve it in the named provider namespace rather than by display text alone.
Developer identifier: `employee.work.reportsTo`
**Reports To.** Reports-to reference. It preserves the nested context needed to interpret the parent employee.
* **Enables:** Attribute reports to in `employee.HiBobEmployeeWork.reportsTo` to the parent employee; identify parent records where that nested reports to object is absent.
* **Interpretation:** HiBob reports reports to as a nested object on each HiBob employee work; optional children may be absent from a valid response.
Developer identifier: `employee.work.site`
**Site.** Work site or office location. It supplies the provider-reported address or location facet for the HiBob employee work, not a residency determination.
* **Enables:** Group Employee by site in `employee.HiBobEmployeeWork.site` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** HiBob reports site as a user, device, request, or resource location attribute on each HiBob employee work; it does not establish where data is stored or processed.
Developer identifier: `employee.work.startDate`
**Start Date.** Employment start date. It anchors the employee on the provider's reported timeline.
* **Enables:** Filter Employee by start date in `employee.HiBobEmployeeWork.startDate`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** HiBob reports start date as a calendar date on each HiBob employee work; its grain is one day and no time of day should be inferred.
Developer identifier: `employee.work.tenure`
**Tenure.** Tenure details. It preserves the nested context needed to interpret the parent employee.
* **Enables:** Attribute tenure in `employee.HiBobEmployeeWork.tenure` to the parent employee; identify parent records where that nested tenure object is absent.
* **Interpretation:** HiBob reports tenure as a nested object on each HiBob employee work; optional children may be absent from a valid response.
Developer identifier: `employee.work.title`
**Title.** Job title. It gives the HiBob employee work a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each HiBob employee work with title from `employee.HiBobEmployeeWork.title`; distinguish records that share that display name but have different HiBob identifiers.
* **Interpretation:** HiBob reports title as display text for each HiBob employee work; names are mutable and are not stable identities.
Developer identifier: `job_roles`
**Job Roles.** Job catalog roles.
* **Enables:** Verify the lifecycle and assignment of each HiBob job role.
* **Scope:** Reads the records selected by HiBob's `/v1/job-catalog/job-roles` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the HiBob service user's granted data categories and employee population. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `job_roles./jobRole/description`
**Job Role Description.** Job role description. It preserves the nested context needed to interpret the parent job role.
* **Enables:** Attribute job role description in `job_roles./jobRole/description` to the parent job role; identify parent records where that nested job role description object is absent.
* **Interpretation:** HiBob reports job role description as a nested object on each job role; optional children may be absent from a valid response.
Developer identifier: `job_roles./jobRole/description.humanReadable`
**Human Readable.** Human-readable representation of the value when includeHumanReadable is set. It gives the HiBob path keyed value a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Display the human readable from `job_roles.HiBobPathKeyedValue.humanReadable` for each HiBob path keyed value; resolve duplicate or changed labels through the provider ID rather than the text.
* **Interpretation:** HiBob supplies human readable as mutable display text on each HiBob path keyed value; it is not a stable identity.
Developer identifier: `job_roles./jobRole/description.value`
**Value.** Raw field value (string, number, boolean, or object depending on field). It must be interpreted with the enclosing provider field name, type, or custom schema for the HiBob path keyed value.
* **Enables:** Interpret `job_roles.HiBobPathKeyedValue.value` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** HiBob reports value under the enclosing custom or typed field contract on each HiBob path keyed value; compare it only with values from the same provider key and type.
Developer identifier: `job_roles./jobRole/id`
**Job Role ID.** Job role ID. It preserves the nested context needed to interpret the parent job role.
* **Enables:** Match repeated job role entries on job role ID in `job_roles./jobRole/id`; collapse only entries that share this declared transform key.
* **Interpretation:** HiBob reports job role ID as a nested object on each job role; optional children may be absent from a valid response. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `job_roles./jobRole/name`
**Job Role Name.** Job role name. It preserves the nested context needed to interpret the parent job role.
* **Enables:** Attribute job role name in `job_roles./jobRole/name` to the parent job role; identify parent records where that nested job role name object is absent.
* **Interpretation:** HiBob reports job role name as a nested object on each job role; optional children may be absent from a valid response.
Developer identifier: `position_budget`
**Position Budget.** Position budget entries.
* **Enables:** Compare authorized position budget amounts by position, currency, pay period, and effective workforce-planning context.
* **Scope:** Reads the records selected by HiBob's `/v1/positions/position-budget/search` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the HiBob service user's granted data categories and employee population. Use is limited to authorized workforce and payroll reconciliation; the records are not invoices and do not support performance inference. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `position_budget./positionBudget/convertedTotalCostCurrencyValue`
**Position Budget Converted Total Cost Currency Value.** HiBob reports the position-budget attribute at /positionBudget/convertedTotalCostCurrencyValue. It preserves the nested context needed to interpret the parent position budget.
* **Enables:** Attribute position budget converted total cost currency value in `position_budget./positionBudget/convertedTotalCostCurrencyValue` to the parent position budget; identify parent records where that nested position budget converted total cost currency value object is absent.
* **Interpretation:** HiBob reports position budget converted total cost currency value as a nested object on each position budget; optional children may be absent from a valid response. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
Developer identifier: `position_budget./positionBudget/convertedTotalCostCurrencyValue.humanReadable`
**Human Readable.** Human-readable representation of the value when includeHumanReadable is set. It gives the HiBob path keyed value a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Display the human readable from `position_budget.HiBobPathKeyedValue.humanReadable` for each HiBob path keyed value; resolve duplicate or changed labels through the provider ID rather than the text.
* **Interpretation:** HiBob supplies human readable as mutable display text on each HiBob path keyed value; it is not a stable identity. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance.
Developer identifier: `position_budget./positionBudget/convertedTotalCostCurrencyValue.value`
**Value.** Raw field value (string, number, boolean, or object depending on field). It must be interpreted with the enclosing provider field name, type, or custom schema for the HiBob path keyed value.
* **Enables:** Interpret `position_budget.HiBobPathKeyedValue.value` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** HiBob reports value under the enclosing custom or typed field contract on each HiBob path keyed value; compare it only with values from the same provider key and type. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance.
Developer identifier: `position_budget./positionBudget/Currency`
**Position Budget Currency.** HiBob reports the position-budget attribute at /positionBudget/Currency. It preserves the nested context needed to interpret the parent position budget.
* **Enables:** Attribute position budget currency in `position_budget./positionBudget/Currency` to the parent position budget; identify parent records where that nested position budget currency object is absent.
* **Interpretation:** HiBob reports position budget currency as a nested object on each position budget; optional children may be absent from a valid response. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
Developer identifier: `position_budget./positionBudget/expectedBaseSalaryCurrencyValue`
**Position Budget Expected Base Salary Currency Value.** HiBob reports the position-budget attribute at /positionBudget/expectedBaseSalaryCurrencyValue. It preserves the nested context needed to interpret the parent position budget.
* **Enables:** Attribute position budget expected base salary currency value in `position_budget./positionBudget/expectedBaseSalaryCurrencyValue` to the parent position budget; identify parent records where that nested position budget expected base salary currency value object is absent.
* **Interpretation:** HiBob reports position budget expected base salary currency value as a nested object on each position budget; optional children may be absent from a valid response. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
Developer identifier: `position_budget./positionBudget/expectedVariablePayCurrencyValue`
**Position Budget Expected Variable Pay Currency Value.** HiBob reports the position-budget attribute at /positionBudget/expectedVariablePayCurrencyValue. It preserves the nested context needed to interpret the parent position budget.
* **Enables:** Attribute position budget expected variable pay currency value in `position_budget./positionBudget/expectedVariablePayCurrencyValue` to the parent position budget; identify parent records where that nested position budget expected variable pay currency value object is absent.
* **Interpretation:** HiBob reports position budget expected variable pay currency value as a nested object on each position budget; optional children may be absent from a valid response. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
Developer identifier: `position_budget./positionBudget/id`
**Position Budget ID.** HiBob reports the position-budget attribute at /positionBudget/ID. It preserves the nested context needed to interpret the parent position budget.
* **Enables:** Match repeated position budget entries on position budget ID in `position_budget./positionBudget/id`; collapse only entries that share this declared transform key.
* **Interpretation:** HiBob reports position budget ID as a nested object on each position budget; optional children may be absent from a valid response. The connector explicitly marks this field as a transform deduplication key. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
Developer identifier: `position_budget./positionBudget/proRatedCostCurrencyValue`
**Position Budget Pro Rated Cost Currency Value.** HiBob reports the position-budget attribute at /positionBudget/proRatedCostCurrencyValue. It preserves the nested context needed to interpret the parent position budget.
* **Enables:** Attribute position budget pro rated cost currency value in `position_budget./positionBudget/proRatedCostCurrencyValue` to the parent position budget; identify parent records where that nested position budget pro rated cost currency value object is absent.
* **Interpretation:** HiBob reports position budget pro rated cost currency value as a nested object on each position budget; optional children may be absent from a valid response. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
Developer identifier: `position_budget./positionBudget/salaryPayPeriod`
**Position Budget Salary Pay Period.** HiBob reports the position-budget attribute at /positionBudget/salaryPayPeriod. It preserves the nested context needed to interpret the parent position budget.
* **Enables:** Attribute position budget salary pay period in `position_budget./positionBudget/salaryPayPeriod` to the parent position budget; identify parent records where that nested position budget salary pay period object is absent.
* **Interpretation:** HiBob reports position budget salary pay period as a nested object on each position budget; optional children may be absent from a valid response. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
Developer identifier: `position_budget./positionBudget/totalPositionCostCurrencyValue`
**Position Budget Total Position Cost Currency Value.** HiBob reports the position-budget attribute at /positionBudget/totalPositionCostCurrencyValue. It preserves the nested context needed to interpret the parent position budget.
* **Enables:** Attribute position budget total position cost currency value in `position_budget./positionBudget/totalPositionCostCurrencyValue` to the parent position budget; identify parent records where that nested position budget total position cost currency value object is absent.
* **Interpretation:** HiBob reports position budget total position cost currency value as a nested object on each position budget; optional children may be absent from a valid response. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
Developer identifier: `position_budget./positionBudget/updateEffectiveDate`
**Position Budget Update Effective Date.** HiBob reports the position-budget attribute at /positionBudget/updateEffectiveDate. It preserves the nested context needed to interpret the parent position budget.
* **Enables:** Attribute position budget update effective date in `position_budget./positionBudget/updateEffectiveDate` to the parent position budget; identify parent records where that nested position budget update effective date object is absent.
* **Interpretation:** HiBob reports position budget update effective date as a nested object on each position budget; optional children may be absent from a valid response. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
Developer identifier: `position_budget./positionBudget/variablePayPeriod`
**Position Budget Variable Pay Period.** HiBob reports the position-budget attribute at /positionBudget/variablePayPeriod. It preserves the nested context needed to interpret the parent position budget.
* **Enables:** Attribute position budget variable pay period in `position_budget./positionBudget/variablePayPeriod` to the parent position budget; identify parent records where that nested position budget variable pay period object is absent.
* **Interpretation:** HiBob reports position budget variable pay period as a nested object on each position budget; optional children may be absent from a valid response. Use is limited to authorized workforce or payroll reconciliation and must not be used to infer employee performance. Any monetary amount is a provider HR or payroll record at its stated currency and pay basis, not an invoice.
| Error | Meaning | Solution |
| - | - | - |
| `401 Unauthorized` | Invalid credentials | Verify ID and token |
| `403 Forbidden` | Missing permission | Add required permission to service user |
| `404 Not Found` | Resource doesn't exist | Check endpoint path |
**[HiBob API](https://apidocs.hibob.com/)** — Official API documentation
# Jira Cloud
Source: https://docs.parable.work/plugins/provider-plugins/jiracloud
Sync issues, projects, and users from Jira Cloud
Sync issues, projects, and users from Jira Cloud.
## Jira Cloud setup
Parable lists one **Jira Cloud** Provider under Atlassian. In the connection wizard, use **Authentication method** to choose **Email + API Token** or **OAuth 2.0 Client Credentials (2LO)**.
Both methods sync the same taps: projects, users, issues, and changelogs.
## Data streams
This Provider Plugin defines 5 data streams.
| Stream | Description | Sync |
| - | - | - |
| `projects` | Jira Cloud projects | full |
| `users` | Jira Cloud users | full |
| `issues` | Jira Cloud issues via enhanced JQL search | incremental |
| `changelogs` | Issue change history | full |
| `comments` | Issue comments including author and updateAuthor user objects | full |
### Jira
#### What You'll Need
| Credential | What it is |
| - | - |
| **API Token** | Generated from Atlassian account settings |
| **Email Address** | Your Atlassian account email |
| **Base URL** | Your Jira instance URL (e.g., `https://your-company.atlassian.net`) |
| **Domain** | Your Atlassian domain (e.g., `your-company.atlassian.net`) |
| **Organization ID** | Your Atlassian organization ID |
#### Prerequisites
* **Global permission**: Administer Jira
* **Project permission**: Browse Projects
* User emails visible to "Anyone" in Atlassian profile settings
#### Setup
1. Create an API token at [https://id.atlassian.com/manage-profile/security/api-tokens](https://id.atlassian.com/manage-profile/security/api-tokens)
2. Find Organization ID in the Atlassian Admin Console URL
3. Note your Jira site URL (`https://your-company.atlassian.net`)
4. In Parable, select **Email + API Token**, enter credentials and connection settings, then **Save & test connection**
#### What You'll Need
| Credential | What it is |
| - | - |
| **Client ID** | From the service account OAuth 2.0 credential in Atlassian Administration |
| **Client Secret** | From the same OAuth 2.0 credential |
| **Cloud ID** | Site identifier for api.atlassian.com gateway URLs |
#### Prerequisites
* Atlassian organization admin access
* Service account with Jira product access on the target site
* OAuth scopes: `read:jira-work`, `read:jira-user`
* Jira permissions: Browse Projects, Browse users and groups
#### Setup
1. Create a service account in Atlassian Administration
2. Create OAuth 2.0 credentials with scopes `read:jira-work` and `read:jira-user`
3. Grant Browse Projects and Browse users and groups to the service account
4. Find Cloud ID via admin console or `GET https://api.atlassian.com/oauth/token/accessible-resources`
5. In Parable, select **OAuth 2.0 Client Credentials (2LO)**, enter Client ID, Client Secret, and Cloud ID, then **Save & test connection**
### Jira
| Endpoint | API Token permission | OAuth scope |
| - | - | - |
| `/rest/api/3/project/search` | Browse Projects | read:jira-work |
| `/rest/api/3/search/jql` | Browse Projects | read:jira-work |
| `/rest/api/3/users/search` | Browse users and groups | read:jira-user |
| `/rest/api/3/issue/{id}/changelog` | Browse Projects | read:jira-work |
Developer identifier: `changelogs`
Changelogs contain issue change history.
* **Enables:** reconstruct the field changes recorded for each parent issue.
* **Scope:** Reads the declared collection through `GET /rest/api/3/issue/{id}/changelog` as a full snapshot. Results contain only Jira records visible to the configured account; permission-hidden projects, issues, and comments are absent.
Developer identifier: `changelogs.author`
Author captures the user who made the change. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira cloud changelog record to the provider-reported actor represented by author.
* **Interpretation:** The provider supplies `author` as identity or attribution context on each jira cloud changelog record. In Jira Cloud, author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `changelogs.author.accountId`
Account ID captures the Atlassian account ID of the user. Unique, stable identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match changelog records to provider records that carry the same account ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `accountId` as a record-level identifier on `ChangelogAuthor`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `changelogs.author.accountType`
Account Type captures the type of account (e.g., atlassian, app, customer). It preserves the provider's current classification of this record.
* **Enables:** separate changelog records by the exact provider-reported account type value when describing their recorded state.
* **Interpretation:** The provider supplies `accountType` per changelog author record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, account type is the work record's classification, not an individual-performance measure.
Developer identifier: `changelogs.author.active`
Active indicates whether the user account is active. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select changelog records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per changelog author record; false and missing are distinct when the field is optional. In Jira Cloud, active is a condition on the work record, not an individual-performance measure.
Developer identifier: `changelogs.author.avatarUrls`
Avatar URLs records URLs for the user's avatar images in various sizes. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar urls on a changelog author record.
* **Interpretation:** The provider supplies `avatarUrls` as a URL or resource locator on each changelog author record. Availability still follows the provider's permissions and retention.
Developer identifier: `changelogs.author.avatarUrls.16x16`
16x16 records URL for the 16x16 pixel avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 16x16 on a avatar url record.
* **Interpretation:** The provider supplies `16x16` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `changelogs.author.avatarUrls.24x24`
24x24 records URL for the 24x24 pixel avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 24x24 on a avatar url record.
* **Interpretation:** The provider supplies `24x24` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `changelogs.author.avatarUrls.32x32`
32x32 records URL for the 32x32 pixel avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 32x32 on a avatar url record.
* **Interpretation:** The provider supplies `32x32` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `changelogs.author.avatarUrls.48x48`
48x48 records URL for the 48x48 pixel avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 48x48 on a avatar url record.
* **Interpretation:** The provider supplies `48x48` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `changelogs.author.displayName`
Display Name captures the display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the changelog author record to the provider-reported person or account represented by display name.
* **Interpretation:** The provider supplies `displayName` as identity or attribution context on each changelog author record. In Jira Cloud, display name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `changelogs.author.emailAddress`
Email Address captures the email address of the user, if visible. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the changelog author record to the provider-reported person or account represented by email address.
* **Interpretation:** The provider supplies `emailAddress` as identity or attribution context on each changelog author record. In Jira Cloud, email address is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `changelogs.author.self`
Self records REST API URL for this user resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a changelog author record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each changelog author record. Availability still follows the provider's permissions and retention.
Developer identifier: `changelogs.author.timeZone`
Time Zone captures the IANA time zone of the user. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for changelogs using the recorded time zone.
* **Interpretation:** The provider supplies `timeZone` as location or localization context per changelog author record; it does not establish a person's real-time physical location.
Developer identifier: `changelogs.created`
Created records ISO 8601 timestamp when the change was made. It anchors the named event or boundary on the record's timeline.
* **Enables:** place changelog records on a timeline by created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created` per jira cloud changelog record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `changelogs.historyMetadata`
History Metadata records metadata about the history record, including the activity that triggered the change. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested history metadata records contained by each jira cloud changelog record.
* **Interpretation:** The provider returns `historyMetadata` as a nested object or reference on `JiraCloudChangelog`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `changelogs.historyMetadata.activityDescription`
Activity Description contains a description of the activity that triggered the change. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact activity description value attached to each history metadata record.
* **Interpretation:** The provider supplies `activityDescription` at history metadata granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `changelogs.historyMetadata.activityDescriptionKey`
Activity Description Key captures the key of the activity description. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match changelog records to provider records that carry the same activity description key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `activityDescriptionKey` as a record-level identifier on `HistoryMetadata`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `changelogs.historyMetadata.actor`
Actor captures the user or system that performed the change. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the history metadata record to the provider-reported actor represented by actor.
* **Interpretation:** The provider supplies `actor` as identity or attribution context on each history metadata record. In Jira Cloud, actor is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `changelogs.historyMetadata.actor.avatarUrl`
Avatar URL captures the URL of the participant's avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar URL on a history metadata participant record.
* **Interpretation:** The provider supplies `avatarUrl` as a URL or resource locator on each history metadata participant record. Availability still follows the provider's permissions and retention.
Developer identifier: `changelogs.historyMetadata.actor.displayName`
Display Name captures the display name of the participant. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact display name value attached to each history metadata participant record.
* **Interpretation:** The provider supplies `displayName` at history metadata participant granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `changelogs.historyMetadata.actor.displayNameKey`
Display Name Key captures the key of the display name of the participant. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match changelog records to provider records that carry the same display name key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `displayNameKey` as a record-level identifier on `HistoryMetadataParticipant`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `changelogs.historyMetadata.actor.id`
ID captures the ID of the participant. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match changelog records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `HistoryMetadataParticipant`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `changelogs.historyMetadata.actor.type`
Type captures the type of the participant. It preserves the provider's current classification of this record.
* **Enables:** separate changelog records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per history metadata participant record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, type is the work record's classification, not an individual-performance measure.
Developer identifier: `changelogs.historyMetadata.actor.url`
URL captures the URL of the participant. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a history metadata participant record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each history metadata participant record. Availability still follows the provider's permissions and retention.
Developer identifier: `changelogs.historyMetadata.cause`
Cause captures the cause of the change (e.g., an automation rule or webhook). It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested cause object into its declared child fields for each history metadata record.
* **Interpretation:** The provider returns `cause` as a nested object or reference on `HistoryMetadata`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `changelogs.historyMetadata.description`
Description contains a description of the history record. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each history metadata record.
* **Interpretation:** The provider supplies `description` at history metadata granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `changelogs.historyMetadata.descriptionKey`
Description Key captures the description key of the history record. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match changelog records to provider records that carry the same description key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `descriptionKey` as a record-level identifier on `HistoryMetadata`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `changelogs.historyMetadata.emailDescription`
Email Description captures the description of the email address associated with the history record. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact email description value attached to each history metadata record.
* **Interpretation:** The provider supplies `emailDescription` at history metadata granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `changelogs.historyMetadata.emailDescriptionKey`
Email Description Key captures the description key of the email address. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match changelog records to provider records that carry the same email description key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `emailDescriptionKey` as a record-level identifier on `HistoryMetadata`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `changelogs.historyMetadata.extraData`
Extra Data records additional arbitrary metadata associated with the history record. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret extra data according to the provider and Workspace configuration that produced each changelog record.
* **Interpretation:** Keys and value shapes within `extraData` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `changelogs.historyMetadata.generator`
Generator captures the system or integration that generated the change. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested generator object into its declared child fields for each history metadata record.
* **Interpretation:** The provider returns `generator` as a nested object or reference on `HistoryMetadata`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `changelogs.historyMetadata.type`
Type captures the type of the history record. It preserves the provider's current classification of this record.
* **Enables:** separate changelog records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per history metadata record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, type is the work record's classification, not an individual-performance measure.
Developer identifier: `changelogs.id`
ID is the unique ID of the changelog entry. Primary key for deduplication. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same jira cloud changelog source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per jira cloud changelog record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `changelogs.issue_id`
Issue ID identifies parent issue's id, injected by the ingestion service from the issues tap's `parentContextFields`. Absent from the Jira changelog API response body itself. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match changelog records to provider records that carry the same issue ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `issue_id` as a record-level identifier on `JiraCloudChangelog`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `changelogs.issue_key`
Issue Key identifies parent issue's key (e.g. PROJ-42), injected by the ingestion service from the issues tap's `parentContextFields`. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match changelog records to provider records that carry the same issue key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `issue_key` as a record-level identifier on `JiraCloudChangelog`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `changelogs.items`
Items records array of individual field changes within this changelog entry. Each item describes what field changed and the before/after values. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested items records contained by each jira cloud changelog record.
* **Interpretation:** The provider returns `items` as a list on `JiraCloudChangelog`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `changelogs.items.field`
Field captures the human-readable name of the field that changed (e.g., 'status', 'assignee', 'priority'). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact field value attached to each changelog item record.
* **Interpretation:** The provider supplies `field` at changelog item granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `changelogs.items.fieldId`
Field ID captures the ID of the field that changed. For system fields this is the field name; for custom fields it is the custom field ID (e.g., '`customfield_10010`').
* **Enables:** Match changelog item entries on `fieldId`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** The provider supplies `fieldId` at one value per changelog item record.
Developer identifier: `changelogs.items.fieldtype`
Fieldtype captures the type of the field that changed (e.g., 'jira', 'custom'). It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret fieldtype according to the provider and Workspace configuration that produced each changelog record.
* **Interpretation:** Keys and value shapes within `fieldtype` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `changelogs.items.from`
From captures the ID or machine-readable value of the field before the change. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded from with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `from` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `changelogs.items.fromString`
From String captures the human-readable display value of the field before the change. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded from string with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `fromString` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `changelogs.items.tmpFromAccountId`
Tmp From Account ID captures the account ID of the user in the 'from' value, when the field change involves a user (e.g., assignee changes). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match changelog records to provider records that carry the same tmp from account ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `tmpFromAccountId` as a record-level identifier on `ChangelogItem`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `changelogs.items.tmpToAccountId`
Tmp To Account ID captures the account ID of the user in the 'to' value, when the field change involves a user (e.g., assignee changes). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match changelog records to provider records that carry the same tmp to account ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `tmpToAccountId` as a record-level identifier on `ChangelogItem`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `changelogs.items.to`
To captures the ID or machine-readable value of the field after the change. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded to with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `to` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `changelogs.items.toString`
To String captures the human-readable display value of the field after the change. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded to string with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `toString` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `comments`
Comments contain issue comments including author and `updateAuthor` user objects.
* **Enables:** inspect issue-comment content with author, updater, visibility, and timestamp context.
* **Scope:** Reads the declared collection through `GET /rest/api/3/issue/{id}/comment` as a full snapshot. Results contain only Jira records visible to the configured account; permission-hidden projects, issues, and comments are absent.
Developer identifier: `comments.author`
Author records user who authored the comment. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira cloud comment record to the provider-reported actor represented by author.
* **Interpretation:** The provider supplies `author` as identity or attribution context on each jira cloud comment record. In Jira Cloud, author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `comments.author.accountId`
Account ID captures the Atlassian account ID of the user. Unique, stable identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match comment records to provider records that carry the same account ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `accountId` as a record-level identifier on `CommentAuthor`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `comments.author.accountType`
Account Type captures the type of account (e.g., atlassian, app, customer). It preserves the provider's current classification of this record.
* **Enables:** separate comment records by the exact provider-reported account type value when describing their recorded state.
* **Interpretation:** The provider supplies `accountType` per comment author record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, account type is the work record's classification, not an individual-performance measure.
Developer identifier: `comments.author.active`
Active indicates whether the user account is active. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select comment records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per comment author record; false and missing are distinct when the field is optional. In Jira Cloud, active is a condition on the work record, not an individual-performance measure.
Developer identifier: `comments.author.avatarUrls`
Avatar URLs records URLs for the user's avatar images in various sizes. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar urls on a comment author record.
* **Interpretation:** The provider supplies `avatarUrls` as a URL or resource locator on each comment author record. Availability still follows the provider's permissions and retention.
Developer identifier: `comments.author.avatarUrls.16x16`
16x16 records URL for the 16x16 pixel avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 16x16 on a avatar url record.
* **Interpretation:** The provider supplies `16x16` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `comments.author.avatarUrls.24x24`
24x24 records URL for the 24x24 pixel avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 24x24 on a avatar url record.
* **Interpretation:** The provider supplies `24x24` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `comments.author.avatarUrls.32x32`
32x32 records URL for the 32x32 pixel avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 32x32 on a avatar url record.
* **Interpretation:** The provider supplies `32x32` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `comments.author.avatarUrls.48x48`
48x48 records URL for the 48x48 pixel avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 48x48 on a avatar url record.
* **Interpretation:** The provider supplies `48x48` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `comments.author.displayName`
Display Name captures the display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the comment author record to the provider-reported person or account represented by display name.
* **Interpretation:** The provider supplies `displayName` as identity or attribution context on each comment author record. In Jira Cloud, display name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `comments.author.emailAddress`
Email Address captures the email address of the user, if visible. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the comment author record to the provider-reported person or account represented by email address.
* **Interpretation:** The provider supplies `emailAddress` as identity or attribution context on each comment author record. In Jira Cloud, email address is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `comments.author.self`
Self records REST API URL for this user resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a comment author record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each comment author record. Availability still follows the provider's permissions and retention.
Developer identifier: `comments.author.timeZone`
Time Zone captures the IANA time zone of the user. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for comments using the recorded time zone.
* **Interpretation:** The provider supplies `timeZone` as location or localization context per comment author record; it does not establish a person's real-time physical location.
Developer identifier: `comments.body`
Body records comment body in Atlassian Document Format (ADF). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact body value attached to each jira cloud comment record.
* **Interpretation:** The provider supplies `body` at jira cloud comment granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `comments.created`
Created records the timestamp when the comment was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place comment records on a timeline by created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created` per jira cloud comment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `comments.id`
ID is the unique identifier for the comment. Primary key for deduplication. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same jira cloud comment source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per jira cloud comment record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `comments.issue_id`
Issue ID identifies parent issue's id, injected by the ingestion service from the issues tap's `parentContextFields`. Absent from the Jira comments API response body itself. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match comment records to provider records that carry the same issue ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `issue_id` as a record-level identifier on `JiraCloudComment`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `comments.issue_key`
Issue Key identifies parent issue's key (e.g. PROJ-42), injected by the ingestion service from the issues tap's `parentContextFields`. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match comment records to provider records that carry the same issue key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `issue_key` as a record-level identifier on `JiraCloudComment`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `comments.jsdPublic`
Jsd Public indicates whether the comment is visible to customers in Jira Service Desk. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select comment records for which the provider reports jsd public as true or false.
* **Interpretation:** The provider supplies `jsdPublic` as a boolean per jira cloud comment record; false and missing are distinct when the field is optional. In Jira Cloud, jsd public is a condition on the work record, not an individual-performance measure.
Developer identifier: `comments.self`
Self records REST API URL for this comment. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a jira cloud comment record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each jira cloud comment record. Availability still follows the provider's permissions and retention.
Developer identifier: `comments.updateAuthor`
Update Author records user who last updated the comment. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira cloud comment record to the provider-reported actor represented by update author.
* **Interpretation:** The provider supplies `updateAuthor` as identity or attribution context on each jira cloud comment record. In Jira Cloud, update author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `comments.updated`
Updated records the timestamp when the comment was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place comment records on a timeline by updated and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated` per jira cloud comment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `comments.visibility`
Visibility states visibility restriction for the comment. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported visibility attached to each jira cloud comment record.
* **Interpretation:** The provider supplies `visibility` at jira cloud comment granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `comments.visibility.identifier`
Identifier is the identifier of the group or role. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match comment records to provider records that carry the same identifier, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `identifier` as a record-level identifier on `VisibilityObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `comments.visibility.type`
Type states type of visibility restriction (group or role). It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported type attached to each visibility object record.
* **Interpretation:** The provider supplies `type` at visibility object granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Cloud, type is access or membership context, not an individual-performance measure.
Developer identifier: `comments.visibility.value`
Value records name of the group or role. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded value with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `value` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `issues`
Issues contain Jira Cloud issues via enhanced JQL search.
* **Enables:** report issue content, state, priority, assignment, and project context without treating work state as individual performance.
* **Scope:** Reads provider changes through `POST /rest/api/3/search/jql` using the declared incremental request boundary. Results contain only Jira records visible to the configured account; permission-hidden projects, issues, and comments are absent.
Provider-defined fields may also be returned for this data stream.
Developer identifier: `issues.changelog`
Changelog records changelog of field changes, present when `expand=changelog` is requested. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested changelog object into its declared child fields for each jira cloud issue record.
* **Interpretation:** The provider returns `changelog` as a nested object or reference on `JiraCloudIssue`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.changelog.histories`
Histories records list of changelog history entries. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested histories records contained by each changelog container record.
* **Interpretation:** The provider returns `histories` as a list on `ChangelogContainer`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.changelog.histories.author`
Author records user who made the changes. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the changelog history record to the provider-reported actor represented by author.
* **Interpretation:** The provider supplies `author` as identity or attribution context on each changelog history record. In Jira Cloud, author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.changelog.histories.author.accountId`
Account ID is the unique Atlassian account ID for the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same account ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `accountId` as a record-level identifier on `UserObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.changelog.histories.author.accountType`
Account Type states type of account (atlassian, app, customer). It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported account type value when describing their recorded state.
* **Interpretation:** The provider supplies `accountType` per user object record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, account type is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.changelog.histories.author.active`
Active indicates whether the user account is active. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per user object record; false and missing are distinct when the field is optional. In Jira Cloud, active is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.changelog.histories.author.avatarUrls`
Avatar URLs records avatar image URLs at various sizes. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar urls on a user object record.
* **Interpretation:** The provider supplies `avatarUrls` as a URL or resource locator on each user object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.changelog.histories.author.avatarUrls.16x16`
16x16 records 16x16 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 16x16 on a avatar url record.
* **Interpretation:** The provider supplies `16x16` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.changelog.histories.author.avatarUrls.24x24`
24x24 records 24x24 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 24x24 on a avatar url record.
* **Interpretation:** The provider supplies `24x24` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.changelog.histories.author.avatarUrls.32x32`
32x32 records 32x32 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 32x32 on a avatar url record.
* **Interpretation:** The provider supplies `32x32` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.changelog.histories.author.avatarUrls.48x48`
48x48 records 48x48 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 48x48 on a avatar url record.
* **Interpretation:** The provider supplies `48x48` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.changelog.histories.author.displayName`
Display Name records display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user object record to the provider-reported person or account represented by display name.
* **Interpretation:** The provider supplies `displayName` as identity or attribution context on each user object record. In Jira Cloud, display name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.changelog.histories.author.emailAddress`
Email Address records email address of the user (if visible). It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user object record to the provider-reported person or account represented by email address.
* **Interpretation:** The provider supplies `emailAddress` as identity or attribution context on each user object record. In Jira Cloud, email address is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.changelog.histories.author.self`
Self records REST API URL for this user. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a user object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each user object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.changelog.histories.author.timeZone`
Time Zone records user's configured timezone. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for issues using the recorded time zone.
* **Interpretation:** The provider supplies `timeZone` as location or localization context per user object record; it does not establish a person's real-time physical location.
Developer identifier: `issues.changelog.histories.created`
Created records the timestamp when the changes were made. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created` per changelog history record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.changelog.histories.id`
ID is the unique identifier for this changelog entry. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ChangelogHistory`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.changelog.histories.items`
Items records individual field changes in this changelog entry. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested items records contained by each changelog history record.
* **Interpretation:** The provider returns `items` as a list on `ChangelogHistory`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.changelog.histories.items.field`
Field records name of the field that changed. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact field value attached to each changelog item record.
* **Interpretation:** The provider supplies `field` at changelog item granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.changelog.histories.items.fieldId`
Field ID is the ID of the field that changed. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same field ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `fieldId` as a record-level identifier on `ChangelogItem`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.changelog.histories.items.fieldtype`
Fieldtype records type of the field (jira, custom). It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret fieldtype according to the provider and Workspace configuration that produced each issue record.
* **Interpretation:** Keys and value shapes within `fieldtype` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `issues.changelog.histories.items.from`
From records previous value ID or key. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded from with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `from` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `issues.changelog.histories.items.fromString`
From String records previous value as a display string. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded from string with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `fromString` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `issues.changelog.histories.items.to`
To records new value ID or key. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded to with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `to` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `issues.changelog.histories.items.toString`
To String records new value as a display string. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded to string with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `toString` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `issues.changelog.maxResults`
Max Results reports maximum number of history entries returned. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported max results for each changelog container record.
* **Interpretation:** The provider supplies `maxResults` at changelog container granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.changelog.startAt`
Start At identifies the pagination offset of the first changelog entry returned in the embedded page. It locates that page within the issue's complete history.
* **Enables:** detect partial changelog pages and continue interpretation with `maxResults` and `total`.
* **Interpretation:** The provider supplies `startAt` as a zero-based pagination offset, not a history count or business measure; zero denotes the first page.
Developer identifier: `issues.changelog.total`
Total reports the total number of history entries. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported total for each changelog container record.
* **Interpretation:** The provider supplies `total` at changelog container granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.expand`
Expand records comma-separated list of expanded sections in this response. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact expand when validating the configuration or technical definition of a jira cloud issue record.
* **Interpretation:** The provider supplies `expand` as configuration or technical metadata on `JiraCloudIssue`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `issues.fields`
Fields records all fields of the issue. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret fields according to the provider and Workspace configuration that produced each issue record.
* **Interpretation:** Keys and value shapes within `fields` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `issues.fields.aggregateprogress`
Aggregateprogress groups time spent, total estimated time, and completion percentage for the issue and its subtasks. It keeps the rollup separate from issue-only progress.
* **Enables:** compare aggregate spent time with the estimate and identify issue trees that are incomplete or overrunning plan.
* **Interpretation:** The provider supplies `aggregateprogress` as a nested progress object whose time fields are seconds and whose percent field uses a 0–100 scale; absence means no rollup was reported.
Developer identifier: `issues.fields.aggregateprogress.percent`
Percent reports issue completion on a 0–100 percentage scale. It summarizes the relationship between time spent and the total estimate.
* **Enables:** rank issue progress and distinguish not-started, partial, and complete work.
* **Interpretation:** The provider supplies `percent` as an integer percentage per progress object; zero and missing are not interchangeable.
Developer identifier: `issues.fields.aggregateprogress.progress`
Progress reports time spent in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by progress across issue records.
* **Interpretation:** The provider supplies `progress` per progress object record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.aggregateprogress.total`
Total reports the total estimated time in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by total across issue records.
* **Interpretation:** The provider supplies `total` per progress object record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.aggregatetimeestimate`
Aggregatetimeestimate reports aggregate remaining estimate including subtasks, in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by aggregatetimeestimate across issue records.
* **Interpretation:** The provider supplies `aggregatetimeestimate` per issue field record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.aggregatetimeoriginalestimate`
Aggregatetimeoriginalestimate reports aggregate original estimate including subtasks, in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by aggregatetimeoriginalestimate across issue records.
* **Interpretation:** The provider supplies `aggregatetimeoriginalestimate` per issue field record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.aggregatetimespent`
Aggregatetimespent reports aggregate time spent including subtasks, in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by aggregatetimespent across issue records.
* **Interpretation:** The provider supplies `aggregatetimespent` per issue field record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.assignee`
Assignee records user assigned to this issue. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the issue field record to the provider-reported actor represented by assignee.
* **Interpretation:** The provider supplies `assignee` as identity or attribution context on each issue field record. In Jira Cloud, assignee is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.attachment`
Attachment records file attachments on this issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested attachment records contained by each issue field record.
* **Interpretation:** The provider returns `attachment` as a list on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.attachment.author`
Author records user who uploaded the attachment. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the attachment object record to the provider-reported actor represented by author.
* **Interpretation:** The provider supplies `author` as identity or attribution context on each attachment object record. In Jira Cloud, author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.attachment.content`
Content records URL to download the attachment content. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact content value attached to each attachment object record.
* **Interpretation:** The provider supplies `content` at attachment object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.attachment.created`
Created records the timestamp when the attachment was uploaded. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created` per attachment object record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.attachment.filename`
Filename records name of the attached file. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact filename value attached to each attachment object record.
* **Interpretation:** The provider supplies `filename` at attachment object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.attachment.id`
ID is the unique identifier for the attachment. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `AttachmentObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.attachment.mimeType`
MIME Type states MIME type of the attachment. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported MIME type value when describing their recorded state.
* **Interpretation:** The provider supplies `mimeType` per attachment object record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, MIME type is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.attachment.self`
Self records REST API URL for this attachment. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a attachment object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each attachment object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.attachment.size`
Size reports the attachment's file size in bytes. It preserves the payload footprint associated with the issue.
* **Enables:** identify large attachments and estimate storage or transfer requirements.
* **Interpretation:** The provider supplies `size` as an integer byte count per attachment; zero and missing are not interchangeable.
Developer identifier: `issues.fields.attachment.thumbnail`
Thumbnail records URL for the attachment thumbnail. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by thumbnail on a attachment object record.
* **Interpretation:** The provider supplies `thumbnail` as a URL or resource locator on each attachment object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.closedSprints`
Closed Sprints records closed sprints this issue was part of. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by closed sprints and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `closedSprints` per issue field record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.closedSprints.boardId`
Board ID is the ID of the board this sprint belongs to. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same board ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `boardId` as a record-level identifier on `SprintObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.closedSprints.completeDate`
Completion Date records the date the sprint was completed. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by completion date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `completeDate` per sprint object record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.closedSprints.endDate`
End Date records end date of the sprint. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by end date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `endDate` per sprint object record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.closedSprints.goal`
Goal records goal of the sprint. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact goal value attached to each sprint object record.
* **Interpretation:** The provider supplies `goal` at sprint object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.closedSprints.id`
ID is the unique identifier for the sprint. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `SprintObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.closedSprints.name`
Name records name of the sprint. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each sprint object record.
* **Interpretation:** The provider supplies `name` at sprint object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.closedSprints.self`
Self records REST API URL for this sprint. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a sprint object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each sprint object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.closedSprints.startDate`
Start Date records start date of the sprint. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by start date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startDate` per sprint object record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.closedSprints.state`
State states current state of the sprint. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported state value when describing their recorded state.
* **Interpretation:** The provider supplies `state` per sprint object record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, state is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.comment`
Comment records comments on this issue. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact comment value attached to each issue field record.
* **Interpretation:** The provider supplies `comment` at issue field granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.comment.comments`
Comments records list of comments on the issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested comments records contained by each comment container record.
* **Interpretation:** The provider returns `comments` as a list on `CommentContainer`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.comment.comments.author`
Author records user who authored the comment. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the comment object record to the provider-reported actor represented by author.
* **Interpretation:** The provider supplies `author` as identity or attribution context on each comment object record. In Jira Cloud, author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.comment.comments.body`
Body records comment body in Atlassian Document Format (ADF). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact body value attached to each comment object record.
* **Interpretation:** The provider supplies `body` at comment object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.comment.comments.created`
Created records the timestamp when the comment was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created` per comment object record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.comment.comments.id`
ID is the unique identifier for the comment. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `CommentObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.comment.comments.jsdPublic`
Jsd Public indicates whether the comment is visible to customers in Jira Service Desk. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports jsd public as true or false.
* **Interpretation:** The provider supplies `jsdPublic` as a boolean per comment object record; false and missing are distinct when the field is optional. In Jira Cloud, jsd public is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.fields.comment.comments.self`
Self records REST API URL for this comment. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a comment object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each comment object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.comment.comments.updateAuthor`
Update Author records user who last updated the comment. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the comment object record to the provider-reported actor represented by update author.
* **Interpretation:** The provider supplies `updateAuthor` as identity or attribution context on each comment object record. In Jira Cloud, update author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.comment.comments.updated`
Updated records the timestamp when the comment was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by updated and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated` per comment object record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.comment.comments.visibility`
Visibility states visibility restriction for the comment. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported visibility attached to each comment object record.
* **Interpretation:** The provider supplies `visibility` at comment object granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `issues.fields.comment.comments.visibility.identifier`
Identifier is the identifier of the group or role. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same identifier, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `identifier` as a record-level identifier on `VisibilityObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.comment.comments.visibility.type`
Type states type of visibility restriction (group or role). It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported type attached to each visibility object record.
* **Interpretation:** The provider supplies `type` at visibility object granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Cloud, type is access or membership context, not an individual-performance measure.
Developer identifier: `issues.fields.comment.comments.visibility.value`
Value records name of the group or role. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded value with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `value` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `issues.fields.comment.maxResults`
Max Results reports maximum number of comments returned. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported max results for each comment container record.
* **Interpretation:** The provider supplies `maxResults` at comment container granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.fields.comment.startAt`
Start At identifies the pagination offset of the first comment returned in the embedded page. It locates that page within the issue's complete comment collection.
* **Enables:** detect partial comment pages and continue interpretation with `maxResults` and `total`.
* **Interpretation:** The provider supplies `startAt` as a zero-based pagination offset, not a comment count or business measure; zero denotes the first page.
Developer identifier: `issues.fields.comment.total`
Total reports the total number of comments on the issue. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported total for each comment container record.
* **Interpretation:** The provider supplies `total` at comment container granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.fields.components`
Components records components associated with this issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested components object into its declared child fields for each issue field record.
* **Interpretation:** The provider returns `components` as a list on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.components.description`
Description records description of the component. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each component object record.
* **Interpretation:** The provider supplies `description` at component object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.components.id`
ID is the unique identifier for the component. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ComponentObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.components.name`
Name records name of the component. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each component object record.
* **Interpretation:** The provider supplies `name` at component object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.components.self`
Self records REST API URL for this component. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a component object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each component object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.created`
Created records the timestamp when the issue was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created` per issue field record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.creator`
Creator records user who created this issue. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the issue field record to the provider-reported actor represented by creator.
* **Interpretation:** The provider supplies `creator` as identity or attribution context on each issue field record. In Jira Cloud, creator is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.description`
Description records issue description in Atlassian Document Format (ADF). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each issue field record.
* **Interpretation:** The provider supplies `description` at issue field granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.duedate`
Duedate records due date for the issue. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by duedate and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `duedate` per issue field record as a calendar date without a time of day; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.environment`
Environment states environment field in ADF format. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported environment value when describing their recorded state.
* **Interpretation:** The provider supplies `environment` per issue field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, environment is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.epic`
Epic records epic this issue belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested epic object into its declared child fields for each issue field record.
* **Interpretation:** The provider returns `epic` as a nested object or reference on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.epic.fields`
Fields records summary fields of the referenced issue. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret fields according to the provider and Workspace configuration that produced each issue record.
* **Interpretation:** Keys and value shapes within `fields` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `issues.fields.epic.fields.issuetype`
Issuetype states issue type of the referenced issue. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported issuetype value when describing their recorded state.
* **Interpretation:** The provider supplies `issuetype` per issue reference summary field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, issuetype is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.epic.fields.issuetype.description`
Description records description of the issue type. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each issue type object record.
* **Interpretation:** The provider supplies `description` at issue type object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.epic.fields.issuetype.hierarchyLevel`
Hierarchy Level states hierarchy level of this issue type. It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Jira Cloud issue type hierarchy level exposed by the nested object.
* **Interpretation:** The provider supplies `hierarchyLevel` per issue type object record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, hierarchy level is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.epic.fields.issuetype.iconUrl`
Icon URL records URL of the issue type icon. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by icon URL on a issue type object record.
* **Interpretation:** The provider supplies `iconUrl` as a URL or resource locator on each issue type object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.epic.fields.issuetype.id`
ID is the unique identifier for the issue type. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `IssueTypeObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.epic.fields.issuetype.name`
Name states name of the issue type. It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Jira Cloud issue type name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per issue type object record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, name is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.epic.fields.issuetype.self`
Self records REST API URL for this issue type. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a issue type object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each issue type object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.epic.fields.issuetype.subtask`
Subtask indicates whether this issue type represents subtasks. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports subtask as true or false.
* **Interpretation:** The provider supplies `subtask` as a boolean per issue type object record; false and missing are distinct when the field is optional. In Jira Cloud, subtask is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.fields.epic.fields.priority`
Priority states priority of the referenced issue. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported priority value when describing their recorded state.
* **Interpretation:** The provider supplies `priority` per issue reference summary field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, priority is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.epic.fields.priority.description`
Description records description of the priority. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each priority object record.
* **Interpretation:** The provider supplies `description` at priority object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.epic.fields.priority.iconUrl`
Icon URL records URL of the priority icon. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by icon URL on a priority object record.
* **Interpretation:** The provider supplies `iconUrl` as a URL or resource locator on each priority object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.epic.fields.priority.id`
ID is the unique identifier for the priority. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `PriorityObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.epic.fields.priority.name`
Name states name of the priority level. It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Jira Cloud priority name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per priority object record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, name is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.epic.fields.priority.self`
Self records REST API URL for this priority. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a priority object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each priority object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.epic.fields.status`
Status states status of the referenced issue. It preserves the provider's current classification of this record.
* **Enables:** filter issue records to a selected Jira status and group issue counts by that exact workflow classification.
* **Interpretation:** The provider supplies `status` per issue reference summary field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, status is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.epic.fields.status.description`
Description records description of the status. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each status object record.
* **Interpretation:** The provider supplies `description` at status object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.epic.fields.status.iconUrl`
Icon URL records URL of the status icon. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by icon URL on a status object record.
* **Interpretation:** The provider supplies `iconUrl` as a URL or resource locator on each status object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.epic.fields.status.id`
ID is the unique identifier for the status. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `StatusObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.epic.fields.status.name`
Name states display name of the status. It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Jira Cloud status name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per status object record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, name is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.epic.fields.status.self`
Self records REST API URL for this status. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a status object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each status object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.epic.fields.status.statusCategory`
Status Category states category grouping for this status. It preserves the provider's current classification of this record.
* **Enables:** filter issue records to a selected Jira status category and group issue counts by that exact workflow classification.
* **Interpretation:** The provider supplies `statusCategory` per status object record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, status category is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.epic.fields.status.statusCategory.colorName`
Color Name records color associated with this category. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied color name for the represented design or board object.
* **Interpretation:** The provider supplies `colorName` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `issues.fields.epic.fields.status.statusCategory.id`
ID is the unique identifier for the status category. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `StatusCategoryObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.epic.fields.status.statusCategory.key`
Key is the key of the status category. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `StatusCategoryObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.epic.fields.status.statusCategory.name`
Name states display name of the status category. It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Jira Cloud status category name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per status category object record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, name is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.epic.fields.status.statusCategory.self`
Self records REST API URL for this status category. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a status category object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each status category object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.epic.fields.summary`
Summary records summary of the referenced issue. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact summary value attached to each issue reference summary field record.
* **Interpretation:** The provider supplies `summary` at issue reference summary field granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.epic.id`
ID is the unique identifier of the referenced issue. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `IssueReference`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.epic.key`
Key identifies human-readable key of the referenced issue. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `IssueReference`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.epic.self`
Self records REST API URL for the referenced issue. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a issue reference record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each issue reference record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.fixVersions`
Fix Versions records fix versions associated with this issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested fix versions object into its declared child fields for each issue field record.
* **Interpretation:** The provider returns `fixVersions` as a list on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.fixVersions.archived`
Archived indicates whether this version is archived. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports archived as true or false.
* **Interpretation:** The provider supplies `archived` as a boolean per version object record; false and missing are distinct when the field is optional. In Jira Cloud, archived is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.fields.fixVersions.description`
Description records description of the version. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each version object record.
* **Interpretation:** The provider supplies `description` at version object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.fixVersions.id`
ID is the unique identifier for the version. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `VersionObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.fixVersions.name`
Name records name of the version. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each version object record.
* **Interpretation:** The provider supplies `name` at version object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.fixVersions.released`
Released indicates whether this version has been released. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports released as true or false.
* **Interpretation:** The provider supplies `released` as a boolean per version object record; false and missing are distinct when the field is optional. In Jira Cloud, released is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.fields.fixVersions.releaseDate`
Release Date records release date of the version. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by release date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `releaseDate` per version object record as a calendar date without a time of day; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.fixVersions.self`
Self records REST API URL for this version. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a version object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each version object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.issuelinks`
Issuelinks records links to other issues. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested issuelinks object into its declared child fields for each issue field record.
* **Interpretation:** The provider returns `issuelinks` as a list on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.issuelinks.id`
ID is the unique identifier for the issue link. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `IssueLinkObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.issuelinks.inwardIssue`
Inward Issue captures the inward issue in the link relationship. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by inward issue on each issue link object record.
* **Interpretation:** The provider returns `inwardIssue` as a nested object or reference on `IssueLinkObject`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.issuelinks.outwardIssue`
Outward Issue captures the outward issue in the link relationship. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by outward issue on each issue link object record.
* **Interpretation:** The provider returns `outwardIssue` as a nested object or reference on `IssueLinkObject`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.issuelinks.self`
Self records REST API URL for this link. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a issue link object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each issue link object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.issuelinks.type`
Type states type of the link relationship. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per issue link object record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, type is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.issuelinks.type.id`
ID is the unique identifier for the link type. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `IssueLinkTypeObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.issuelinks.type.inward`
Inward records inward description (e.g., 'is blocked by'). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact inward value attached to each issue link type object record.
* **Interpretation:** The provider supplies `inward` at issue link type object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.issuelinks.type.name`
Name records name of the link type. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each issue link type object record.
* **Interpretation:** The provider supplies `name` at issue link type object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.issuelinks.type.outward`
Outward records outward description (e.g., 'blocks'). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact outward value attached to each issue link type object record.
* **Interpretation:** The provider supplies `outward` at issue link type object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.issuelinks.type.self`
Self records REST API URL for this link type. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a issue link type object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each issue link type object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.issuetype`
Issuetype states type of issue (Bug, Story, Task, etc.). It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported issuetype value when describing their recorded state.
* **Interpretation:** The provider supplies `issuetype` per issue field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, issuetype is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.labels`
Labels records labels applied to the issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** apply the provider-defined labels classifications to each issue field record.
* **Interpretation:** The provider returns `labels` as a list on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.lastViewed`
Last Viewed records the timestamp when the current user last viewed this issue. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by last viewed and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastViewed` per issue field record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.parent`
Parent records parent issue reference (for subtasks or child issues in next-gen projects). It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by parent on each issue field record.
* **Interpretation:** The provider returns `parent` as a nested object or reference on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.priority`
Priority states priority level of the issue. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported priority value when describing their recorded state.
* **Interpretation:** The provider supplies `priority` per issue field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, priority is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.progress`
Progress groups time spent, total estimated time, and completion percentage for the issue itself. It preserves the time-tracking state without including subtask rollups.
* **Enables:** compare spent time with the issue estimate and identify incomplete or overrunning work.
* **Interpretation:** The provider supplies `progress` as a nested progress object whose time fields are seconds and whose percent field uses a 0–100 scale; absence means no issue progress was reported.
Developer identifier: `issues.fields.project`
Project records project this issue belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each issue field record with the specific provider container named by project.
* **Interpretation:** The provider returns `project` as a nested object or reference on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.project.avatarUrls`
Avatar URLs records project avatar URLs. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar urls on a project object record.
* **Interpretation:** The provider supplies `avatarUrls` as a URL or resource locator on each project object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.project.id`
ID is the unique identifier for the project. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ProjectObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.project.key`
Key identifies short key for the project (e.g., PROJ). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `ProjectObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.project.name`
Name records display name of the project. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each project object record.
* **Interpretation:** The provider supplies `name` at project object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.project.projectCategory`
Project Category states category of the project. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported project category value when describing their recorded state.
* **Interpretation:** The provider supplies `projectCategory` per project object record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, project category is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.project.projectCategory.description`
Description records description of the project category. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each project category object record.
* **Interpretation:** The provider supplies `description` at project category object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.project.projectCategory.id`
ID is the unique identifier for the project category. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ProjectCategoryObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.project.projectCategory.name`
Name states name of the project category. It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Jira Cloud project category name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per project category object record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, name is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.project.projectCategory.self`
Self records REST API URL for this category. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a project category object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each project category object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.project.projectTypeKey`
Project Type Key identifies type of project (software, business, `service_desk`). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same project type key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `projectTypeKey` as a record-level identifier on `ProjectObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.project.self`
Self records REST API URL for this project. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a project object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each project object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.project.simplified`
Simplified indicates whether this is a next-gen (simplified) project. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports simplified as true or false.
* **Interpretation:** The provider supplies `simplified` as a boolean per project object record; false and missing are distinct when the field is optional. In Jira Cloud, simplified is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.fields.reporter`
Reporter records user who reported this issue. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the issue field record to the provider-reported person or account represented by reporter.
* **Interpretation:** The provider supplies `reporter` as identity or attribution context on each issue field record. In Jira Cloud, reporter is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.resolution`
Resolution states resolution of the issue if resolved. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported resolution value when describing their recorded state.
* **Interpretation:** The provider supplies `resolution` per issue field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, resolution is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.resolution.description`
Description records description of the resolution. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each resolution object record.
* **Interpretation:** The provider supplies `description` at resolution object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.resolution.id`
ID is the unique identifier for the resolution. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ResolutionObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.resolution.name`
Name states name of the resolution (e.g., Done, Won't Do). It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Jira Cloud resolution name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per resolution object record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, name is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.resolution.self`
Self records REST API URL for this resolution. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a resolution object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each resolution object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.resolutiondate`
Resolutiondate records the timestamp when the issue was resolved. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by resolutiondate and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `resolutiondate` per issue field record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.security`
Security states security level of this issue. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported security value when describing their recorded state.
* **Interpretation:** The provider supplies `security` per issue field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, security is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.security.description`
Description records description of the security level. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each security level object record.
* **Interpretation:** The provider supplies `description` at security level object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.security.id`
ID is the unique identifier for the security level. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `SecurityLevelObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.security.name`
Name records name of the security level. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each security level object record.
* **Interpretation:** The provider supplies `name` at security level object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.security.self`
Self records REST API URL for this security level. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a security level object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each security level object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.sprint`
Sprint states active sprint this issue is in (from Jira Software). It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported sprint value when describing their recorded state.
* **Interpretation:** The provider supplies `sprint` per issue field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, sprint is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.status`
Status states current workflow status of the issue. It preserves the provider's current classification of this record.
* **Enables:** filter issue records to a selected Jira status and group issue counts by that exact workflow classification.
* **Interpretation:** The provider supplies `status` per issue field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, status is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.statuscategorychangedate`
Statuscategorychangedate records the timestamp when the status category last changed. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by statuscategorychangedate and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `statuscategorychangedate` per issue field record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.storyPoints`
Story Points records story points estimate (custom field, commonly mapped). It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret story points according to the provider and Workspace configuration that produced each issue record.
* **Interpretation:** Keys and value shapes within `storyPoints` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `issues.fields.subtasks`
Subtasks records subtasks of this issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by subtasks on each issue field record.
* **Interpretation:** The provider returns `subtasks` as a list on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.summary`
Summary records short title describing the issue. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact summary value attached to each issue field record.
* **Interpretation:** The provider supplies `summary` at issue field granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.timeestimate`
Timeestimate reports remaining time estimate in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by timeestimate across issue records.
* **Interpretation:** The provider supplies `timeestimate` per issue field record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.timeoriginalestimate`
Timeoriginalestimate reports original time estimate in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by timeoriginalestimate across issue records.
* **Interpretation:** The provider supplies `timeoriginalestimate` per issue field record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.timespent`
Timespent reports the total time spent in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by timespent across issue records.
* **Interpretation:** The provider supplies `timespent` per issue field record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.timetracking`
Timetracking records time tracking information. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested timetracking object into its declared child fields for each issue field record.
* **Interpretation:** The provider returns `timetracking` as a nested object or reference on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.timetracking.originalEstimate`
Original Estimate records the issue's original planned duration in Jira's human-readable format. It preserves the planning interval alongside its seconds representation.
* **Enables:** compare planned effort across issues and display the estimate in the provider's own duration syntax.
* **Interpretation:** The provider supplies `originalEstimate` as duration text such as `5d 2h`; consumers must use Jira's unit conventions rather than treat the string as an ordinal.
Developer identifier: `issues.fields.timetracking.originalEstimateSeconds`
Original Estimate Seconds reports original estimate in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by original estimate seconds across issue records.
* **Interpretation:** The provider supplies `originalEstimateSeconds` per time tracking object record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.timetracking.remainingEstimate`
Remaining Estimate records the issue's remaining planned duration in Jira's human-readable format. It preserves the current forecast alongside its seconds representation.
* **Enables:** compare outstanding effort across issues and display the estimate in the provider's own duration syntax.
* **Interpretation:** The provider supplies `remainingEstimate` as provider-formatted duration text; consumers must use Jira's unit conventions rather than treat the string as an ordinal.
Developer identifier: `issues.fields.timetracking.remainingEstimateSeconds`
Remaining Estimate Seconds reports remaining estimate in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by remaining estimate seconds across issue records.
* **Interpretation:** The provider supplies `remainingEstimateSeconds` per time tracking object record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.timetracking.timeSpent`
Time Spent reports human-readable total time spent. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by time spent across issue records.
* **Interpretation:** The provider supplies `timeSpent` per time tracking object record in the unit stated by the provider description; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.timetracking.timeSpentSeconds`
Time Spent Seconds reports the total time spent in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by time spent seconds across issue records.
* **Interpretation:** The provider supplies `timeSpentSeconds` per time tracking object record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.updated`
Updated records the timestamp when the issue was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by updated and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated` per issue field record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.versions`
Versions records affects versions associated with this issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested versions object into its declared child fields for each issue field record.
* **Interpretation:** The provider returns `versions` as a list on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.votes`
Votes records vote information for this issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested votes object into its declared child fields for each issue field record.
* **Interpretation:** The provider returns `votes` as a nested object or reference on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.votes.hasVoted`
Has Voted indicates whether the current user has voted. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports has voted as true or false.
* **Interpretation:** The provider supplies `hasVoted` as a boolean per votes object record; false and missing are distinct when the field is optional. In Jira Cloud, has voted is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.fields.votes.self`
Self records REST API URL for votes. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a votes object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each votes object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.votes.votes`
Votes reports the number of votes. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported votes for each votes object record.
* **Interpretation:** The provider supplies `votes` at votes object granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.fields.watches`
Watches records watch information for this issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested watches object into its declared child fields for each issue field record.
* **Interpretation:** The provider returns `watches` as a nested object or reference on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.watches.isWatching`
Is Watching indicates whether the current user is watching. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports is watching as true or false.
* **Interpretation:** The provider supplies `isWatching` as a boolean per watches object record; false and missing are distinct when the field is optional. In Jira Cloud, is watching is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.fields.watches.self`
Self records REST API URL for watches. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a watches object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each watches object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.watches.watchCount`
Watch Count reports the number of watchers. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported watch count for each watches object record.
* **Interpretation:** The provider supplies `watchCount` at watches object granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.fields.worklog`
Worklog records worklogs on this issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested worklog records contained by each issue field record.
* **Interpretation:** The provider returns `worklog` as a nested object or reference on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.worklog.maxResults`
Max Results reports maximum number of worklogs returned. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported max results for each worklog container record.
* **Interpretation:** The provider supplies `maxResults` at worklog container granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.fields.worklog.startAt`
Start At identifies the pagination offset of the first worklog returned in the embedded page. It locates that page within the issue's complete worklog collection.
* **Enables:** detect partial worklog pages and continue interpretation with `maxResults` and `total`.
* **Interpretation:** The provider supplies `startAt` as a zero-based pagination offset, not a worklog count or business measure; zero denotes the first page.
Developer identifier: `issues.fields.worklog.total`
Total reports the total number of worklogs on the issue. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported total for each worklog container record.
* **Interpretation:** The provider supplies `total` at worklog container granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.fields.worklog.worklogs`
Worklogs records list of worklogs on the issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested worklogs records contained by each worklog container record.
* **Interpretation:** The provider returns `worklogs` as a list on `WorklogContainer`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.worklog.worklogs.author`
Author records user who created the worklog. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the worklog object record to the provider-reported actor represented by author.
* **Interpretation:** The provider supplies `author` as identity or attribution context on each worklog object record. In Jira Cloud, author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.worklog.worklogs.comment`
Comment records worklog comment in ADF format. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact comment value attached to each worklog object record.
* **Interpretation:** The provider supplies `comment` at worklog object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.worklog.worklogs.created`
Created records the timestamp when the worklog was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created` per worklog object record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.worklog.worklogs.id`
ID is the unique identifier for the worklog. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `WorklogObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.worklog.worklogs.issueId`
Issue ID is the ID of the issue this worklog belongs to. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same issue ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `issueId` as a record-level identifier on `WorklogObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.worklog.worklogs.self`
Self records REST API URL for this worklog. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a worklog object record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each worklog object record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.worklog.worklogs.started`
Started records the timestamp when the work was started. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by started and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `started` per worklog object record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.worklog.worklogs.timeSpent`
Time Spent reports human-readable time spent (e.g., '3h 20m'). It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by time spent across issue records.
* **Interpretation:** The provider supplies `timeSpent` per worklog object record in the unit stated by the provider description; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.worklog.worklogs.timeSpentSeconds`
Time Spent Seconds reports time spent in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by time spent seconds across issue records.
* **Interpretation:** The provider supplies `timeSpentSeconds` per worklog object record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.worklog.worklogs.updateAuthor`
Update Author records user who last updated the worklog. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the worklog object record to the provider-reported actor represented by update author.
* **Interpretation:** The provider supplies `updateAuthor` as identity or attribution context on each worklog object record. In Jira Cloud, update author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.worklog.worklogs.updated`
Updated records the timestamp when the worklog was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by updated and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated` per worklog object record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.worklog.worklogs.visibility`
Visibility states visibility restriction for the worklog. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported visibility attached to each worklog object record.
* **Interpretation:** The provider supplies `visibility` at worklog object granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `issues.fields.workratio`
Workratio reports the issue's work ratio as a percentage. It relates recorded work to the available estimate.
* **Enables:** identify issues consuming more or less effort than planned and separate issues that lack an estimate.
* **Interpretation:** The provider supplies `workratio` as an integer percentage and uses `-1` when no estimate applies; `-1`, zero, and missing have different meanings.
Developer identifier: `issues.id`
ID is the unique numeric identifier for the issue. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same jira cloud issue source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per jira cloud issue record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `issues.key`
Key identifies human-readable issue key like PROJ-123. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `JiraCloudIssue`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.names`
Names records map of field IDs to human-readable field names, present when `expand=names` is requested. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact names when validating the configuration or technical definition of a jira cloud issue record.
* **Interpretation:** The provider supplies `names` as configuration or technical metadata on `JiraCloudIssue`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `issues.operations`
Operations records available operations on this issue. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact operations when validating the configuration or technical definition of a jira cloud issue record.
* **Interpretation:** The provider supplies `operations` as configuration or technical metadata on `JiraCloudIssue`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `issues.project_key`
Project Key identifies parent key injected by the ingestor from the projects to issues traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same project key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `project_key` as a record-level identifier on `JiraCloudIssue`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.renderedFields`
Rendered Fields records HTML-rendered versions of fields, present when expand=`renderedFields` is requested. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact rendered fields when validating the configuration or technical definition of a jira cloud issue record.
* **Interpretation:** The provider supplies `renderedFields` as configuration or technical metadata on `JiraCloudIssue`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `issues.self`
Self records REST API URL for this issue. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a jira cloud issue record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each jira cloud issue record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.transitions`
Transitions records available workflow transitions for this issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested transitions object into its declared child fields for each jira cloud issue record.
* **Interpretation:** The provider returns `transitions` as a list on `JiraCloudIssue`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.transitions.hasScreen`
Has Screen indicates whether the transition has an associated screen. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports has screen as true or false.
* **Interpretation:** The provider supplies `hasScreen` as a boolean per issue transition record; false and missing are distinct when the field is optional. In Jira Cloud, has screen is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.transitions.id`
ID is the unique identifier for the transition. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same issue transition source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per issue transition record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `issues.transitions.isConditional`
Is Conditional indicates whether this transition has conditions. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports is conditional as true or false.
* **Interpretation:** The provider supplies `isConditional` as a boolean per issue transition record; false and missing are distinct when the field is optional. In Jira Cloud, is conditional is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.transitions.isGlobal`
Is Global indicates whether this is a global transition. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports is global as true or false.
* **Interpretation:** The provider supplies `isGlobal` as a boolean per issue transition record; false and missing are distinct when the field is optional. In Jira Cloud, is global is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.transitions.isInitial`
Is Initial indicates whether this is the initial transition. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports is initial as true or false.
* **Interpretation:** The provider supplies `isInitial` as a boolean per issue transition record; false and missing are distinct when the field is optional. In Jira Cloud, is initial is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.transitions.name`
Name records name of the transition. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each issue transition record.
* **Interpretation:** The provider supplies `name` at issue transition granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.transitions.to`
To states target status of the transition. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported to value when describing their recorded state.
* **Interpretation:** The provider supplies `to` per issue transition record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, to is the work record's classification, not an individual-performance measure.
Developer identifier: `projects`
Projects contain Jira Cloud projects.
* **Enables:** map Jira Cloud issues to their project containers and project metadata.
* **Scope:** Reads the declared collection through `GET /rest/api/3/project/search` as a full snapshot. Results contain only Jira records visible to the configured account; permission-hidden projects, issues, and comments are absent.
Developer identifier: `projects.archived`
Archived indicates whether the project is archived. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports archived as true or false.
* **Interpretation:** The provider supplies `archived` as a boolean per jira cloud project record; false and missing are distinct when the field is optional. In Jira Cloud, archived is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.archivedBy`
Archived By captures the user who archived the project. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported archived by value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedBy` per jira cloud project record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, archived by is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.archivedBy.accountId`
Account ID identifies atlassian account ID of the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same account ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `accountId` as a record-level identifier on `UserSummary`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.archivedBy.accountType`
Account Type states type of the user account. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported account type value when describing their recorded state.
* **Interpretation:** The provider supplies `accountType` per user summary record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, account type is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.archivedBy.active`
Active indicates whether the user account is active. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per user summary record; false and missing are distinct when the field is optional. In Jira Cloud, active is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.archivedBy.avatarUrls`
Avatar URLs records avatar URLs for the user in various sizes. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar urls on a user summary record.
* **Interpretation:** The provider supplies `avatarUrls` as a URL or resource locator on each user summary record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.archivedBy.avatarUrls.16x16`
16x16 records URL for the 16x16 pixel avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 16x16 on a avatar url record.
* **Interpretation:** The provider supplies `16x16` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.archivedBy.avatarUrls.24x24`
24x24 records URL for the 24x24 pixel avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 24x24 on a avatar url record.
* **Interpretation:** The provider supplies `24x24` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.archivedBy.avatarUrls.32x32`
32x32 records URL for the 32x32 pixel avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 32x32 on a avatar url record.
* **Interpretation:** The provider supplies `32x32` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.archivedBy.avatarUrls.48x48`
48x48 records URL for the 48x48 pixel avatar. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 48x48 on a avatar url record.
* **Interpretation:** The provider supplies `48x48` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.archivedBy.displayName`
Display Name records display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user summary record to the provider-reported person or account represented by display name.
* **Interpretation:** The provider supplies `displayName` as identity or attribution context on each user summary record. In Jira Cloud, display name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.archivedBy.emailAddress`
Email Address records email address of the user (if visible). It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user summary record to the provider-reported person or account represented by email address.
* **Interpretation:** The provider supplies `emailAddress` as identity or attribution context on each user summary record. In Jira Cloud, email address is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.archivedBy.self`
Self records REST API URL for this user resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a user summary record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each user summary record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.archivedBy.timeZone`
Time Zone records time zone of the user. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for projects using the recorded time zone.
* **Interpretation:** The provider supplies `timeZone` as location or localization context per user summary record; it does not establish a person's real-time physical location.
Developer identifier: `projects.archivedDate`
Archived Date records the date when the project was archived. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported archived date value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedDate` per jira cloud project record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, archived date is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.avatarUrls`
Avatar URLs records URLs for the project avatar in various sizes. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar urls on a jira cloud project record.
* **Interpretation:** The provider supplies `avatarUrls` as a URL or resource locator on each jira cloud project record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.deleted`
Deleted indicates whether the project has been moved to the trash and is pending deletion. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports deleted as true or false.
* **Interpretation:** The provider supplies `deleted` as a boolean per jira cloud project record; false and missing are distinct when the field is optional. In Jira Cloud, deleted is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.deletedBy`
Deleted By captures the user who deleted the project. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported deleted by value when describing their recorded state.
* **Interpretation:** The provider supplies `deletedBy` per jira cloud project record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, deleted by is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.deletedDate`
Deleted Date records the date when the project was moved to the trash. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported deleted date value when describing their recorded state.
* **Interpretation:** The provider supplies `deletedDate` per jira cloud project record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, deleted date is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.description`
Description records project description text, may contain Atlassian Document Format or plain text. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each jira cloud project record.
* **Interpretation:** The provider supplies `description` at jira cloud project granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects.entityId`
Entity ID identifies entity ID used for cross-product identification. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same entity ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `entityId` as a record-level identifier on `JiraCloudProject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.expand`
Expand records comma-separated list of expanded fields included in this response. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact expand when validating the configuration or technical definition of a jira cloud project record.
* **Interpretation:** The provider supplies `expand` as configuration or technical metadata on `JiraCloudProject`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `projects.id`
ID is the unique numeric identifier for the project (returned as string). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `JiraCloudProject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.insight`
Provider Attribute records insight information about the project's recent activity. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each jira cloud project record with the specific provider container named by provider attribute.
* **Interpretation:** The provider returns `insight` as a nested object or reference on `JiraCloudProject`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `projects.insight.lastIssueUpdateTime`
Last Issue Update Time records the timestamp of the most recent issue update in the project. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project records on a timeline by last issue update time and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastIssueUpdateTime` per project insight record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `projects.insight.totalIssueCount`
Total Issue Count reports the total number of issues in the project. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported total issue count for each project insight record.
* **Interpretation:** The provider supplies `totalIssueCount` at project insight granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `projects.isPrivate`
Is Private indicates whether the project is private and only visible to its members. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported is private attached to each jira cloud project record.
* **Interpretation:** The provider supplies `isPrivate` at jira cloud project granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `projects.issueTypes`
Issue Types records issue types available in this project (present when expand includes `issueTypes`). It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each jira cloud project record with the specific provider container named by issue types.
* **Interpretation:** The provider returns `issueTypes` as a list on `JiraCloudProject`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `projects.issueTypes.description`
Description records description of the issue type. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each project issue type record.
* **Interpretation:** The provider supplies `description` at project issue type granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects.issueTypes.hierarchyLevel`
Hierarchy Level states hierarchy level of this issue type. It preserves the provider's current classification of this record.
* **Enables:** filter and group project records by the Jira Cloud project issue type hierarchy level exposed by the nested object.
* **Interpretation:** The provider supplies `hierarchyLevel` per project issue type record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, hierarchy level is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.issueTypes.iconUrl`
Icon URL records URL of the issue type icon. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by icon URL on a project issue type record.
* **Interpretation:** The provider supplies `iconUrl` as a URL or resource locator on each project issue type record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.issueTypes.id`
ID is the unique identifier for the issue type. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same project issue type source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per project issue type record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `projects.issueTypes.name`
Name states name of the issue type. It preserves the provider's current classification of this record.
* **Enables:** filter and group project records by the Jira Cloud project issue type name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per project issue type record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, name is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.issueTypes.self`
Self records REST API URL for this issue type. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a project issue type record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each project issue type record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.issueTypes.subtask`
Subtask indicates whether this issue type represents subtasks. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports subtask as true or false.
* **Interpretation:** The provider supplies `subtask` as a boolean per project issue type record; false and missing are distinct when the field is optional. In Jira Cloud, subtask is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.key`
Key identifies short alphanumeric project key (e.g., PROJ) used in issue keys. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same jira cloud project source row before constructing its represented state.
* **Interpretation:** The provider supplies `key` at one value per jira cloud project record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `projects.landingPageInfo`
Landing Page Info records information about the project landing page configuration. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact landing page info when validating the configuration or technical definition of a jira cloud project record.
* **Interpretation:** The provider supplies `landingPageInfo` as configuration or technical metadata on `JiraCloudProject`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `projects.landingPageInfo.boardId`
Board ID identifies board ID if the landing page is a board. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same board ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `boardId` as a record-level identifier on `ProjectLandingPageInfo`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.landingPageInfo.projectKey`
Project Key identifies project key associated with the landing page. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same project key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `projectKey` as a record-level identifier on `ProjectLandingPageInfo`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.landingPageInfo.projectType`
Project Type states project type for the landing page. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported project type value when describing their recorded state.
* **Interpretation:** The provider supplies `projectType` per project landing page info record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, project type is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.landingPageInfo.queueId`
Queue ID identifies queue ID if the landing page is a service desk queue. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same queue ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `queueId` as a record-level identifier on `ProjectLandingPageInfo`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.landingPageInfo.simplified`
Simplified indicates whether the landing page uses simplified view. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports simplified as true or false.
* **Interpretation:** The provider supplies `simplified` as a boolean per project landing page info record; false and missing are distinct when the field is optional. In Jira Cloud, simplified is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.landingPageInfo.url`
URL records URL of the project landing page. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a project landing page info record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each project landing page info record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.lead`
Lead captures the user designated as the project lead. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira cloud project record to the provider-reported person or account represented by lead.
* **Interpretation:** The provider supplies `lead` as identity or attribution context on each jira cloud project record. In Jira Cloud, lead is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.lead.accountId`
Account ID identifies atlassian account ID of the project lead. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same account ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `accountId` as a record-level identifier on `ProjectLead`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.lead.accountType`
Account Type states type of the user account. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported account type value when describing their recorded state.
* **Interpretation:** The provider supplies `accountType` per project lead record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, account type is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.lead.active`
Active indicates whether the user account is active. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per project lead record; false and missing are distinct when the field is optional. In Jira Cloud, active is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.lead.avatarUrls`
Avatar URLs records avatar URLs for the project lead in various sizes. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar urls on a project lead record.
* **Interpretation:** The provider supplies `avatarUrls` as a URL or resource locator on each project lead record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.lead.displayName`
Display Name records display name of the project lead. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the project lead record to the provider-reported person or account represented by display name.
* **Interpretation:** The provider supplies `displayName` as identity or attribution context on each project lead record. In Jira Cloud, display name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.lead.emailAddress`
Email Address records email address of the project lead (if visible). It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the project lead record to the provider-reported person or account represented by email address.
* **Interpretation:** The provider supplies `emailAddress` as identity or attribution context on each project lead record. In Jira Cloud, email address is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.lead.self`
Self records REST API URL for this user resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a project lead record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each project lead record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.lead.timeZone`
Time Zone records time zone of the project lead. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for projects using the recorded time zone.
* **Interpretation:** The provider supplies `timeZone` as location or localization context per project lead record; it does not establish a person's real-time physical location.
Developer identifier: `projects.name`
Name records display name of the project. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each jira cloud project record.
* **Interpretation:** The provider supplies `name` at jira cloud project granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects.permissions`
Permissions states permissions the current user has on this project. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported permissions attached to each jira cloud project record.
* **Interpretation:** The provider supplies `permissions` at jira cloud project granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `projects.permissions.canEdit`
Can Edit indicates whether the user can edit the project configuration. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports can edit as true or false.
* **Interpretation:** The provider supplies `canEdit` as a boolean per project permission record; false and missing are distinct when the field is optional. In Jira Cloud, can edit is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.projectCategory`
Project Category captures the category assigned to this project. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported project category value when describing their recorded state.
* **Interpretation:** The provider supplies `projectCategory` per jira cloud project record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, project category is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.projectCategory.description`
Description records description of the project category. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each project category record.
* **Interpretation:** The provider supplies `description` at project category granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects.projectCategory.id`
ID is the unique identifier for the project category. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ProjectCategory`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.projectCategory.name`
Name states name of the project category. It preserves the provider's current classification of this record.
* **Enables:** filter and group project records by the Jira Cloud project category name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per project category record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, name is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.projectCategory.self`
Self records REST API URL for this project category resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a project category record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each project category record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.projectKeys`
Project Keys records alternate project keys for this project (present when expand includes `projectKeys`). It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each jira cloud project record with the specific provider container named by project keys.
* **Interpretation:** The provider returns `projectKeys` as a list on `JiraCloudProject`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `projects.projectTypeKey`
Project Type Key identifies type of project (software, `service_desk`, business). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same project type key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `projectTypeKey` as a record-level identifier on `JiraCloudProject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.properties`
Properties records arbitrary project properties as key-value metadata. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret properties according to the provider and Workspace configuration that produced each project record.
* **Interpretation:** Keys and value shapes within `properties` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `projects.retentionTillDate`
Retention Till Date records the date until which a deleted project will be retained before permanent deletion. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project records on a timeline by retention till date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `retentionTillDate` per jira cloud project record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `projects.self`
Self records REST API URL for this project resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a jira cloud project record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each jira cloud project record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.simplified`
Simplified indicates whether the project is a simplified (next-gen/team-managed) project. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports simplified as true or false.
* **Interpretation:** The provider supplies `simplified` as a boolean per jira cloud project record; false and missing are distinct when the field is optional. In Jira Cloud, simplified is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.style`
Style states project style indicating management methodology (classic or next-gen). It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported style value when describing their recorded state.
* **Interpretation:** The provider supplies `style` per jira cloud project record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, style is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.url`
URL records URL to the project in the Jira web interface. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a jira cloud project record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each jira cloud project record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.uuid`
UUID is the unique UUID for the project. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same UUID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `uuid` as a record-level identifier on `JiraCloudProject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `users`
Users contain Jira Cloud users.
* **Enables:** resolve Jira Cloud account identities referenced by issues, comments, and changes.
* **Scope:** Reads the declared collection through `GET /rest/api/3/users/search` as a full snapshot. Results contain only Jira records visible to the configured account; permission-hidden projects, issues, and comments are absent.
Developer identifier: `users.accountId`
Account ID is the unique Atlassian account identifier for the user. Primary key for cross-system identity resolution across Atlassian products. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same jira cloud user source row before constructing its represented state.
* **Interpretation:** The provider supplies `accountId` at one value per jira cloud user record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `users.accountType`
Account Type states type of account: atlassian (normal user), app (service/bot account), or customer (Jira Service Management customer). It preserves the provider's current classification of this record.
* **Enables:** separate user records by the exact provider-reported account type value when describing their recorded state.
* **Interpretation:** The provider supplies `accountType` per jira cloud user record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, account type is the work record's classification, not an individual-performance measure.
Developer identifier: `users.active`
Active indicates whether the user account is currently active. False indicates a deactivated account. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select user records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per jira cloud user record; false and missing are distinct when the field is optional. In Jira Cloud, active is a condition on the work record, not an individual-performance measure.
Developer identifier: `users.applicationRoles`
Application Roles states application roles assigned to the user. Only present when expanded. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported application roles attached to each jira cloud user record.
* **Interpretation:** The provider supplies `applicationRoles` at jira cloud user granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Cloud, application roles is access or membership context, not an individual-performance measure.
Developer identifier: `users.applicationRoles.callback`
Callback records callback metadata. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact callback when validating the configuration or technical definition of a paginated application role list record.
* **Interpretation:** The provider supplies `callback` as configuration or technical metadata on `PaginatedApplicationRoleList`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `users.applicationRoles.items`
Items captures the list of application role items. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported items attached to each paginated application role list record.
* **Interpretation:** The provider supplies `items` at paginated application role list granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Cloud, items is access or membership context, not an individual-performance measure.
Developer identifier: `users.applicationRoles.items.defaultGroups`
Default Groups states default groups for this application role. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported default groups attached to each application role item record.
* **Interpretation:** The provider supplies `defaultGroups` at application role item granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Cloud, default groups is access or membership context, not an individual-performance measure.
Developer identifier: `users.applicationRoles.items.defined`
Defined indicates whether this role is defined. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select user records for which the provider reports defined as true or false.
* **Interpretation:** The provider supplies `defined` as a boolean per application role item record; false and missing are distinct when the field is optional. In Jira Cloud, defined is a condition on the work record, not an individual-performance measure.
Developer identifier: `users.applicationRoles.items.groups`
Groups states groups associated with this application role. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported groups attached to each application role item record.
* **Interpretation:** The provider supplies `groups` at application role item granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Cloud, groups is access or membership context, not an individual-performance measure.
Developer identifier: `users.applicationRoles.items.hasUnlimitedSeats`
Has Unlimited Seats indicates whether this role has unlimited seats. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select user records for which the provider reports has unlimited seats as true or false.
* **Interpretation:** The provider supplies `hasUnlimitedSeats` as a boolean per application role item record; false and missing are distinct when the field is optional. In Jira Cloud, has unlimited seats is a condition on the work record, not an individual-performance measure.
Developer identifier: `users.applicationRoles.items.key`
Key captures the key of the application role. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match user records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `ApplicationRoleItem`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `users.applicationRoles.items.name`
Name captures the display name of the application role. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported name attached to each application role item record.
* **Interpretation:** The provider supplies `name` at application role item granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Cloud, name is access or membership context, not an individual-performance measure.
Developer identifier: `users.applicationRoles.items.numberOfSeats`
Number Of Seats reports the number of seats for this application role. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported number of seats attached to each application role item record.
* **Interpretation:** The provider supplies `numberOfSeats` at application role item granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Cloud, number of seats is access or membership context, not an individual-performance measure.
Developer identifier: `users.applicationRoles.items.platform`
Platform indicates whether this is a platform role. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select user records for which the provider reports platform as true or false.
* **Interpretation:** The provider supplies `platform` as a boolean per application role item record; false and missing are distinct when the field is optional. In Jira Cloud, platform is a condition on the work record, not an individual-performance measure.
Developer identifier: `users.applicationRoles.items.remainingSeats`
Remaining Seats reports the number of remaining seats for this application role. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported remaining seats attached to each application role item record.
* **Interpretation:** The provider supplies `remainingSeats` at application role item granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Cloud, remaining seats is access or membership context, not an individual-performance measure.
Developer identifier: `users.applicationRoles.items.selectedByDefault`
Selected By Default indicates whether this role is selected by default. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select user records for which the provider reports selected by default as true or false.
* **Interpretation:** The provider supplies `selectedByDefault` as a boolean per application role item record; false and missing are distinct when the field is optional. In Jira Cloud, selected by default is a condition on the work record, not an individual-performance measure.
Developer identifier: `users.applicationRoles.items.userCount`
User Count reports the number of users with this application role. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported user count attached to each application role item record.
* **Interpretation:** The provider supplies `userCount` at application role item granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Cloud, user count is access or membership context, not an individual-performance measure.
Developer identifier: `users.applicationRoles.items.userCountDescription`
User Count Description reports human-readable description of the user count. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported user count description for each application role item record.
* **Interpretation:** The provider supplies `userCountDescription` at application role item granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `users.applicationRoles.max-results`
Max Results reports maximum number of results per page. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported max results for each paginated application role list record.
* **Interpretation:** The provider supplies `max-results` at paginated application role list granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `users.applicationRoles.pagingCallback`
Paging Callback records paging callback metadata. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact paging callback when validating the configuration or technical definition of a paginated application role list record.
* **Interpretation:** The provider supplies `pagingCallback` as configuration or technical metadata on `PaginatedApplicationRoleList`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `users.applicationRoles.size`
Size reports the number of application roles returned in the current page. It records page occupancy for the paginated collection.
* **Enables:** verify page boundaries and distinguish a short or empty role page from the configured maximum.
* **Interpretation:** The provider supplies `size` as an integer item count, not bytes; zero denotes an empty page while missing means page size was not reported.
Developer identifier: `users.appType`
App Type states app account subtype when `accountType` is app (service, agent, or unknown). It preserves the provider's current classification of this record.
* **Enables:** separate user records by the exact provider-reported app type value when describing their recorded state.
* **Interpretation:** The provider supplies `appType` per jira cloud user record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Cloud, app type is the work record's classification, not an individual-performance measure.
Developer identifier: `users.avatarUrls`
Avatar URLs records URLs for the user's avatar images in various sizes. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar urls on a jira cloud user record.
* **Interpretation:** The provider supplies `avatarUrls` as a URL or resource locator on each jira cloud user record. Availability still follows the provider's permissions and retention.
Developer identifier: `users.avatarUrls.16x16`
16x16 records URL for the 16x16 pixel avatar image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 16x16 on a avatar url record.
* **Interpretation:** The provider supplies `16x16` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `users.avatarUrls.24x24`
24x24 records URL for the 24x24 pixel avatar image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 24x24 on a avatar url record.
* **Interpretation:** The provider supplies `24x24` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `users.avatarUrls.32x32`
32x32 records URL for the 32x32 pixel avatar image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 32x32 on a avatar url record.
* **Interpretation:** The provider supplies `32x32` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `users.avatarUrls.48x48`
48x48 records URL for the 48x48 pixel avatar image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 48x48 on a avatar url record.
* **Interpretation:** The provider supplies `48x48` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention. A connector directive maps this field to the person's identity photo.
Developer identifier: `users.displayName`
Display Name records user's display name as shown in the Jira UI. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira cloud user record to the provider-reported person or account represented by display name.
* **Interpretation:** The provider supplies `displayName` as identity or attribution context on each jira cloud user record. In Jira Cloud, display name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `users.emailAddress`
Email Address records user's email address. May be absent if hidden by the user's privacy settings. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira cloud user record to the provider-reported person or account represented by email address.
* **Interpretation:** The provider supplies `emailAddress` as identity or attribution context on each jira cloud user record. In Jira Cloud, email address is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `users.expand`
Expand records comma-separated list of expanded properties included in this response. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact expand when validating the configuration or technical definition of a jira cloud user record.
* **Interpretation:** The provider supplies `expand` as configuration or technical metadata on `JiraCloudUser`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `users.groups`
Groups records groups the user belongs to. Only present when expanded. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each jira cloud user record with the specific provider container named by groups.
* **Interpretation:** The provider returns `groups` as a nested object or reference on `JiraCloudUser`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `users.groups.callback`
Callback records callback metadata. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact callback when validating the configuration or technical definition of a paginated group list record.
* **Interpretation:** The provider supplies `callback` as configuration or technical metadata on `PaginatedGroupList`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `users.groups.items`
Items captures the list of group items. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested items records contained by each paginated group list record.
* **Interpretation:** The provider returns `items` as a list on `PaginatedGroupList`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `users.groups.items.groupId`
Group ID captures the unique identifier of the group. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match user records to provider records that carry the same group ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `groupId` as a record-level identifier on `GroupItem`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `users.groups.items.name`
Name captures the name of the group. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each group item record.
* **Interpretation:** The provider supplies `name` at group item granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `users.groups.items.self`
Self records REST API URL for this group resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a group item record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each group item record. Availability still follows the provider's permissions and retention.
Developer identifier: `users.groups.max-results`
Max Results reports maximum number of results per page. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported max results for each paginated group list record.
* **Interpretation:** The provider supplies `max-results` at paginated group list granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `users.groups.pagingCallback`
Paging Callback records paging callback metadata. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact paging callback when validating the configuration or technical definition of a paginated group list record.
* **Interpretation:** The provider supplies `pagingCallback` as configuration or technical metadata on `PaginatedGroupList`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `users.groups.size`
Size reports the number of groups returned in the current page. It records page occupancy for the paginated collection.
* **Enables:** verify page boundaries and distinguish a short or empty group page from the configured maximum.
* **Interpretation:** The provider supplies `size` as an integer item count, not bytes; zero denotes an empty page while missing means page size was not reported.
Developer identifier: `users.locale`
Locale records user's locale setting as a BCP 47 language tag (e.g., `en_US`). It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for users using the recorded locale.
* **Interpretation:** The provider supplies `locale` as location or localization context per jira cloud user record; it does not establish a person's real-time physical location.
Developer identifier: `users.self`
Self records REST API URL for this user resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a jira cloud user record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each jira cloud user record. Availability still follows the provider's permissions and retention.
Developer identifier: `users.timeZone`
Time Zone records user's configured IANA timezone (e.g., America/`New_York`). It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for users using the recorded time zone.
* **Interpretation:** The provider supplies `timeZone` as location or localization context per jira cloud user record; it does not establish a person's real-time physical location.
* [Jira Cloud REST API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/)
* [Atlassian service account OAuth credentials](https://support.atlassian.com/user-management/docs/create-oauth-2-0-credential-for-service-accounts/)
* [Jira OAuth scopes](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/)
# Jira Data Center
Source: https://docs.parable.work/plugins/provider-plugins/jiradatacenter
Sync issues, projects, and users from Jira Data Center (self-hosted). Issue changelogs are embedded via expand=changelog on the issues tap.
Sync issues, projects, and users from Jira Data Center (self-hosted). Issue changelogs are embedded via expand=changelog on the issues tap.
Connect Parable to Jira Server or Data Center using Personal Access Tokens (PATs) for secure API access without exposing passwords.
| Feature | Jira Server | Jira Cloud |
| - | - | - |
| API Version | v2 | v2 and v3 |
| Auth | PAT or Basic | API Token + Basic |
| Base URL | Custom | `*.atlassian.net` |
| Audit Logs | Limited | Full |
> **Tip:** **Rate Limits:** Jira Server enforces rate limits of **varies by server configuration**.
>
> Parable handles rate limiting automatically with exponential backoff, but initial syncs of large datasets may take longer due to these limits.
## Data streams
This Provider Plugin defines 3 data streams.
| Stream | Description | Sync |
| - | - | - |
| `projects` | Jira Data Center projects | full |
| `users` | Jira Data Center users | full |
| `issues` | Jira Data Center issues via JQL search (v2 API, includes embedded changelogs) | incremental |
### Personal access token
#### What You'll Need
| Credential | What it is |
| - | - |
| **Username** | Jira account username |
| **Personal Access Token** | Generated from Jira profile |
| **Base URL** | Your Jira Server URL |
> **Info:** **Setup access in Jira Server.** These steps require **Administrator**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Jira Server administrator.
* **Jira Administrator** or user with Browse Projects permission
* Personal Access Tokens enabled on your instance (Jira 8.14+)
* Network access to your Jira Server
#### Step 1: Access Profile Settings
1. Log in to your Jira Server instance
2. Click your avatar → **Profile**
3. Navigate to **Personal Access Tokens**
> **Info:** PATs require Jira Server 8.14 or later. For older versions, use Basic Auth with username/password.
#### Step 2: Create Personal Access Token
1. Click **Create token**
2. Enter name: `Parable Integration`
3. Set expiration (optional)
4. Click **Create**
> **Warning:** **Copy your personal access token now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
#### Step 3: Note Your Base URL
Your Jira Server URL format:
```
https://jira.yourcompany.com
```
#### Step 4: Enter values in the form
1. Enter **Username**, **Personal Access Token**, and **Base URL** in the Provider form.
2. Click **Save & test connection**.
Developer identifier: `issues`
Issues contain Jira Data Center issues via JQL search (v2 API, includes embedded changelogs).
* **Enables:** report issue content, state, assignment, and embedded change history as work-record context.
* **Scope:** Reads provider changes through `POST /rest/api/2/search` using the declared incremental request boundary. Results contain only Jira records visible to the configured account; permission-hidden projects, issues, and comments are absent.
Provider-defined fields may also be returned for this data stream.
Developer identifier: `issues.changelog`
Changelog records change history for the issue (present when `expand=changelog`). It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested changelog records contained by each jira data center issue record.
* **Interpretation:** The provider returns `changelog` as a nested object or reference on `JiraDataCenterIssue`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.changelog.histories`
Histories records list of changelog history entries. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested histories records contained by each changelog record.
* **Interpretation:** The provider returns `histories` as a list on `Changelog`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.changelog.histories.author`
Author records user who made the change. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the change history record to the provider-reported actor represented by author.
* **Interpretation:** The provider supplies `author` as identity or attribution context on each change history record. In Jira Data Center, author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.changelog.histories.author.accountId`
Account ID is the unique account ID (Atlassian account ID, if applicable). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same account ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `accountId` as a record-level identifier on `User`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.changelog.histories.author.active`
Active indicates whether the user account is active. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per user record; false and missing are distinct when the field is optional. In Jira Data Center, active is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.changelog.histories.author.avatarUrls`
Avatar URLs records avatar image URLs at various sizes. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar urls on a user record.
* **Interpretation:** The provider supplies `avatarUrls` as a URL or resource locator on each user record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.changelog.histories.author.avatarUrls.16x16`
16x16 records 16x16 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 16x16 on a avatar url record.
* **Interpretation:** The provider supplies `16x16` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.changelog.histories.author.avatarUrls.24x24`
24x24 records 24x24 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 24x24 on a avatar url record.
* **Interpretation:** The provider supplies `24x24` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.changelog.histories.author.avatarUrls.32x32`
32x32 records 32x32 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 32x32 on a avatar url record.
* **Interpretation:** The provider supplies `32x32` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.changelog.histories.author.avatarUrls.48x48`
48x48 records 48x48 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 48x48 on a avatar url record.
* **Interpretation:** The provider supplies `48x48` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.changelog.histories.author.displayName`
Display Name records full display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by display name.
* **Interpretation:** The provider supplies `displayName` as identity or attribution context on each user record. In Jira Data Center, display name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.changelog.histories.author.emailAddress`
Email Address records email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by email address.
* **Interpretation:** The provider supplies `emailAddress` as identity or attribution context on each user record. In Jira Data Center, email address is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.changelog.histories.author.key`
Key identifies user key (unique identifier in Jira Data Center). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `User`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.changelog.histories.author.name`
Name records username / login name. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each user record.
* **Interpretation:** The provider supplies `name` at user granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.changelog.histories.author.self`
Self records REST API URL for this user. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a user record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each user record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.changelog.histories.author.timeZone`
Time Zone records user's configured timezone. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for issues using the recorded time zone.
* **Interpretation:** The provider supplies `timeZone` as location or localization context per user record; it does not establish a person's real-time physical location.
Developer identifier: `issues.changelog.histories.created`
Created records the timestamp when the change was made. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created` per change history record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.changelog.histories.id`
ID is the unique ID of the history entry. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ChangeHistory`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.changelog.histories.items`
Items records individual field changes in this history entry. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested items records contained by each change history record.
* **Interpretation:** The provider returns `items` as a list on `ChangeHistory`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.changelog.histories.items.field`
Field records human-readable name of the field that changed. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact field value attached to each change item record.
* **Interpretation:** The provider supplies `field` at change item granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.changelog.histories.items.fieldId`
Field ID identifies machine ID of the field (e.g., status, `customfield_10001`). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same field ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `fieldId` as a record-level identifier on `ChangeItem`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.changelog.histories.items.fieldtype`
Fieldtype records type of the field (jira, custom). It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret fieldtype according to the provider and Workspace configuration that produced each issue record.
* **Interpretation:** Keys and value shapes within `fieldtype` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `issues.changelog.histories.items.from`
From records previous value ID/key (for reference fields). It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded from with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `from` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `issues.changelog.histories.items.fromString`
From String records previous value as a display string. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded from string with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `fromString` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `issues.changelog.histories.items.to`
To records new value ID/key (for reference fields). It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded to with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `to` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `issues.changelog.histories.items.toString`
To String records new value as a display string. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded to string with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `toString` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `issues.changelog.maxResults`
Max Results reports maximum number of history entries returned. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported max results for each changelog record.
* **Interpretation:** The provider supplies `maxResults` at changelog granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.changelog.startAt`
Start At identifies the zero-based pagination offset of the first changelog entry returned in the embedded page. It locates that page within the issue's complete history.
* **Enables:** detect partial changelog pages and continue interpretation with `maxResults` and `total`.
* **Interpretation:** The provider supplies `startAt` as pagination metadata, not a history count or business measure; zero denotes the first page.
Developer identifier: `issues.changelog.total`
Total reports the total number of history entries. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported total for each changelog record.
* **Interpretation:** The provider supplies `total` at changelog granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.expand`
Expand records comma-separated list of expanded sections in this response. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact expand when validating the configuration or technical definition of a jira data center issue record.
* **Interpretation:** The provider supplies `expand` as configuration or technical metadata on `JiraDataCenterIssue`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `issues.fields`
Fields records all standard and custom fields on the issue. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret fields according to the provider and Workspace configuration that produced each issue record.
* **Interpretation:** Keys and value shapes within `fields` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `issues.fields.aggregateprogress`
Aggregateprogress groups time spent, the original estimate, and completion percentage for the issue and its subtasks. It keeps the rollup separate from issue-only progress.
* **Enables:** compare aggregate spent time with the estimate and identify issue trees that are incomplete or overrunning plan.
* **Interpretation:** The provider supplies `aggregateprogress` as a nested object whose time values are seconds and whose percent value expresses completion; absence means no rollup was reported.
Developer identifier: `issues.fields.aggregateprogress.percent`
Percent reports the issue's completion percentage. It summarizes the relationship between time spent and the original estimate.
* **Enables:** rank issue progress and distinguish not-started, partial, and complete work.
* **Interpretation:** The provider supplies `percent` as an integer percentage per progress object; zero and missing are not interchangeable.
Developer identifier: `issues.fields.aggregateprogress.progress`
Progress reports progress value (time spent in seconds). It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by progress across issue records.
* **Interpretation:** The provider supplies `progress` per progress record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.aggregateprogress.total`
Total reports the total value (original estimate in seconds). It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by total across issue records.
* **Interpretation:** The provider supplies `total` per progress record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.aggregatetimeestimate`
Aggregatetimeestimate reports aggregate remaining estimate including subtasks, in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by aggregatetimeestimate across issue records.
* **Interpretation:** The provider supplies `aggregatetimeestimate` per issue field record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.aggregatetimeoriginalestimate`
Aggregatetimeoriginalestimate reports aggregate original estimate including subtasks, in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by aggregatetimeoriginalestimate across issue records.
* **Interpretation:** The provider supplies `aggregatetimeoriginalestimate` per issue field record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.aggregatetimespent`
Aggregatetimespent reports aggregate time spent including subtasks, in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by aggregatetimespent across issue records.
* **Interpretation:** The provider supplies `aggregatetimespent` per issue field record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.assignee`
Assignee records user currently assigned to the issue. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the issue field record to the provider-reported actor represented by assignee.
* **Interpretation:** The provider supplies `assignee` as identity or attribution context on each issue field record. In Jira Data Center, assignee is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.attachment`
Attachment records file attachments on the issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested attachment records contained by each issue field record.
* **Interpretation:** The provider returns `attachment` as a list on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.attachment.author`
Author records user who uploaded the attachment. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the attachment record to the provider-reported actor represented by author.
* **Interpretation:** The provider supplies `author` as identity or attribution context on each attachment record. In Jira Data Center, author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.attachment.content`
Content records URL to download the attachment content. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact content value attached to each attachment record.
* **Interpretation:** The provider supplies `content` at attachment granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.attachment.created`
Created records the timestamp when the attachment was uploaded. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created` per attachment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.attachment.filename`
Filename records original filename of the attachment. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact filename value attached to each attachment record.
* **Interpretation:** The provider supplies `filename` at attachment granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.attachment.id`
ID is the unique ID of the attachment. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `Attachment`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.attachment.mimeType`
MIME Type states MIME type of the attachment. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported MIME type value when describing their recorded state.
* **Interpretation:** The provider supplies `mimeType` per attachment record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, MIME type is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.attachment.self`
Self records REST API URL for this attachment. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a attachment record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each attachment record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.attachment.size`
Size reports the attachment's file size in bytes. It preserves the payload footprint associated with the issue.
* **Enables:** identify large attachments and estimate storage or transfer requirements.
* **Interpretation:** The provider supplies `size` as an integer byte count per attachment; zero and missing are not interchangeable.
Developer identifier: `issues.fields.attachment.thumbnail`
Thumbnail records URL of the attachment thumbnail (if applicable). It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by thumbnail on a attachment record.
* **Interpretation:** The provider supplies `thumbnail` as a URL or resource locator on each attachment record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.closedSprints`
Closed Sprints records completed sprints the issue was part of. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by closed sprints and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `closedSprints` per issue field record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.closedSprints.completeDate`
Completion Date records completion date/time of the sprint. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by completion date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `completeDate` per sprint record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.closedSprints.endDate`
End Date records end date/time of the sprint. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by end date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `endDate` per sprint record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.closedSprints.goal`
Goal records sprint goal description. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact goal value attached to each sprint record.
* **Interpretation:** The provider supplies `goal` at sprint granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.closedSprints.id`
ID is the unique ID of the sprint. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `Sprint`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.closedSprints.name`
Name records display name of the sprint. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each sprint record.
* **Interpretation:** The provider supplies `name` at sprint granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.closedSprints.originBoardId`
Origin Board ID is the ID of the board the sprint originated from. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same origin board ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `originBoardId` as a record-level identifier on `Sprint`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.closedSprints.self`
Self records REST API URL for this sprint. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a sprint record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each sprint record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.closedSprints.startDate`
Start Date records start date/time of the sprint. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by start date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startDate` per sprint record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.closedSprints.state`
State states state of the sprint (future, active, closed). It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported state value when describing their recorded state.
* **Interpretation:** The provider supplies `state` per sprint record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, state is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.comment`
Comment records comments on the issue. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact comment value attached to each issue field record.
* **Interpretation:** The provider supplies `comment` at issue field granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.comment.comments`
Comments records list of comments. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact comments value attached to each comment container record.
* **Interpretation:** The provider supplies `comments` at comment container granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.comment.comments.author`
Author records user who authored the comment. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the comment record to the provider-reported actor represented by author.
* **Interpretation:** The provider supplies `author` as identity or attribution context on each comment record. In Jira Data Center, author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.comment.comments.body`
Body records comment body text. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact body value attached to each comment record.
* **Interpretation:** The provider supplies `body` at comment granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.comment.comments.created`
Created records the timestamp when the comment was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created` per comment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.comment.comments.id`
ID is the unique ID of the comment. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `Comment`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.comment.comments.self`
Self records REST API URL for this comment. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a comment record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each comment record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.comment.comments.updateAuthor`
Update Author records user who last updated the comment. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the comment record to the provider-reported actor represented by update author.
* **Interpretation:** The provider supplies `updateAuthor` as identity or attribution context on each comment record. In Jira Data Center, update author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.comment.comments.updated`
Updated records the timestamp when the comment was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by updated and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated` per comment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.comment.comments.visibility`
Visibility states visibility restriction on the comment. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported visibility attached to each comment record.
* **Interpretation:** The provider supplies `visibility` at comment granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `issues.fields.comment.comments.visibility.type`
Type states type of visibility restriction (group or role). It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported type attached to each visibility record.
* **Interpretation:** The provider supplies `type` at visibility granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Data Center, type is access or membership context, not an individual-performance measure.
Developer identifier: `issues.fields.comment.comments.visibility.value`
Value records name of the group or role. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded value with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `value` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `issues.fields.comment.maxResults`
Max Results reports maximum number of comments returned. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported max results for each comment container record.
* **Interpretation:** The provider supplies `maxResults` at comment container granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.fields.comment.startAt`
Start At identifies the zero-based pagination offset of the first comment returned in the embedded page. It locates that page within the issue's complete comment collection.
* **Enables:** detect partial comment pages and continue interpretation with `maxResults` and `total`.
* **Interpretation:** The provider supplies `startAt` as pagination metadata, not a comment count or business measure; zero denotes the first page.
Developer identifier: `issues.fields.comment.total`
Total reports the total number of comments on the issue. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported total for each comment container record.
* **Interpretation:** The provider supplies `total` at comment container granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.fields.components`
Components records components associated with the issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested components object into its declared child fields for each issue field record.
* **Interpretation:** The provider returns `components` as a list on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.components.assigneeType`
Assignee Type states default assignee type for the component. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported assignee type value when describing their recorded state.
* **Interpretation:** The provider supplies `assigneeType` per component record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, assignee type is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.components.description`
Description records description of the component. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each component record.
* **Interpretation:** The provider supplies `description` at component granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.components.id`
ID is the unique ID of the component. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `Component`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.components.lead`
Lead records component lead user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the component record to the provider-reported person or account represented by lead.
* **Interpretation:** The provider supplies `lead` as identity or attribution context on each component record. In Jira Data Center, lead is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.components.name`
Name records display name of the component. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each component record.
* **Interpretation:** The provider supplies `name` at component granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.components.self`
Self records REST API URL for this component. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a component record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each component record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.created`
Created records the timestamp when the issue was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created` per issue field record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.creator`
Creator records user who originally created the issue record. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the issue field record to the provider-reported actor represented by creator.
* **Interpretation:** The provider supplies `creator` as identity or attribution context on each issue field record. In Jira Data Center, creator is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.customFields`
Custom Fields records arbitrary custom fields (`customfield_NNNNN`) not explicitly modeled. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret custom fields according to the provider and Workspace configuration that produced each issue record.
* **Interpretation:** Keys and value shapes within `customFields` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `issues.fields.description`
Description records full description body of the issue (wiki markup or plain text). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each issue field record.
* **Interpretation:** The provider supplies `description` at issue field granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.duedate`
Duedate records due date for the issue. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by duedate and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `duedate` per issue field record as a calendar date without a time of day; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.environment`
Environment states environment information for the issue. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported environment value when describing their recorded state.
* **Interpretation:** The provider supplies `environment` per issue field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, environment is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.epic`
Epic records epic this issue belongs to (Jira Software). It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested epic object into its declared child fields for each issue field record.
* **Interpretation:** The provider returns `epic` as a nested object or reference on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.epic.color`
Color records color configuration of the epic. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied color for the represented design or board object.
* **Interpretation:** The provider supplies `color` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `issues.fields.epic.color.key`
Key identifies color key identifier (e.g., `color_1`, `color_2`). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `EpicColor`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.epic.done`
Done indicates whether the epic is marked as done. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports done as true or false.
* **Interpretation:** The provider supplies `done` as a boolean per epic reference record; false and missing are distinct when the field is optional. In Jira Data Center, done is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.fields.epic.id`
ID is the unique ID of the epic. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `EpicReference`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.epic.key`
Key identifies issue key of the epic. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `EpicReference`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.epic.name`
Name records name/summary of the epic. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each epic reference record.
* **Interpretation:** The provider supplies `name` at epic reference granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.epic.self`
Self records REST API URL for the epic. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a epic reference record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each epic reference record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.epic.summary`
Summary records summary of the epic issue. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact summary value attached to each epic reference record.
* **Interpretation:** The provider supplies `summary` at epic reference granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.fixVersions`
Fix Versions records fix versions associated with the issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested fix versions object into its declared child fields for each issue field record.
* **Interpretation:** The provider returns `fixVersions` as a list on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.fixVersions.archived`
Archived indicates whether the version is archived. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports archived as true or false.
* **Interpretation:** The provider supplies `archived` as a boolean per version record; false and missing are distinct when the field is optional. In Jira Data Center, archived is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.fields.fixVersions.description`
Description records description of the version. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each version record.
* **Interpretation:** The provider supplies `description` at version granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.fixVersions.id`
ID is the unique ID of the version. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `Version`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.fixVersions.name`
Name records display name of the version. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each version record.
* **Interpretation:** The provider supplies `name` at version granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.fixVersions.released`
Released indicates whether the version has been released. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports released as true or false.
* **Interpretation:** The provider supplies `released` as a boolean per version record; false and missing are distinct when the field is optional. In Jira Data Center, released is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.fields.fixVersions.releaseDate`
Release Date records release date of the version. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by release date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `releaseDate` per version record as a calendar date without a time of day; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.fixVersions.self`
Self records REST API URL for this version. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a version record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each version record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.fixVersions.startDate`
Start Date records start date of the version. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by start date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startDate` per version record as a calendar date without a time of day; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.flagged`
Flagged indicates whether the issue is flagged/impediment. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports flagged as true or false.
* **Interpretation:** The provider supplies `flagged` as a boolean per issue field record; false and missing are distinct when the field is optional. In Jira Data Center, flagged is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.fields.issuelinks`
Issuelinks records links to other issues. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested issuelinks object into its declared child fields for each issue field record.
* **Interpretation:** The provider returns `issuelinks` as a list on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.issuelinks.id`
ID is the unique ID of the issue link. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `IssueLink`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.issuelinks.inwardIssue`
Inward Issue captures the inward issue in the link relationship. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by inward issue on each issue link record.
* **Interpretation:** The provider returns `inwardIssue` as a nested object or reference on `IssueLink`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields`
Fields records summary fields of the referenced issue. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret fields according to the provider and Workspace configuration that produced each issue record.
* **Interpretation:** Keys and value shapes within `fields` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.issuetype`
Issuetype states issue type of the referenced issue. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported issuetype value when describing their recorded state.
* **Interpretation:** The provider supplies `issuetype` per issue reference summary field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, issuetype is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.issuetype.avatarId`
Avatar ID identifies avatar ID for the issue type. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same avatar ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `avatarId` as a record-level identifier on `IssueType`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.issuetype.description`
Description records description of the issue type. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each issue type record.
* **Interpretation:** The provider supplies `description` at issue type granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.issuetype.iconUrl`
Icon URL records URL of the issue type icon. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by icon URL on a issue type record.
* **Interpretation:** The provider supplies `iconUrl` as a URL or resource locator on each issue type record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.issuetype.id`
ID is the unique ID of the issue type. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `IssueType`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.issuetype.name`
Name states display name (e.g., Bug, Story, Task, Epic, Sub-task). It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Jira Data Center issue type name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per issue type record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, name is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.issuetype.self`
Self records REST API URL for this issue type. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a issue type record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each issue type record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.issuetype.subtask`
Subtask indicates whether this issue type represents a subtask. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports subtask as true or false.
* **Interpretation:** The provider supplies `subtask` as a boolean per issue type record; false and missing are distinct when the field is optional. In Jira Data Center, subtask is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.priority`
Priority states priority of the referenced issue. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported priority value when describing their recorded state.
* **Interpretation:** The provider supplies `priority` per issue reference summary field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, priority is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.priority.description`
Description records description of the priority level. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each priority record.
* **Interpretation:** The provider supplies `description` at priority granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.priority.iconUrl`
Icon URL records URL of the priority icon. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by icon URL on a priority record.
* **Interpretation:** The provider supplies `iconUrl` as a URL or resource locator on each priority record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.priority.id`
ID is the unique ID of the priority. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `Priority`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.priority.name`
Name states display name of the priority (e.g., Highest, High, Medium, Low, Lowest). It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Jira Data Center priority name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per priority record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, name is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.priority.self`
Self records REST API URL for this priority. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a priority record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each priority record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.status`
Status states status of the referenced issue. It preserves the provider's current classification of this record.
* **Enables:** filter issue records to a selected Jira status and group issue counts by that exact workflow classification.
* **Interpretation:** The provider supplies `status` per issue reference summary field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, status is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.status.description`
Description records description of the status. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each status record.
* **Interpretation:** The provider supplies `description` at status granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.status.iconUrl`
Icon URL records URL of the status icon. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by icon URL on a status record.
* **Interpretation:** The provider supplies `iconUrl` as a URL or resource locator on each status record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.status.id`
ID is the unique ID of the status. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `Status`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.status.name`
Name states display name of the status. It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Jira Data Center status name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per status record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, name is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.status.self`
Self records REST API URL for this status. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a status record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each status record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.status.statusCategory`
Status Category states high-level category of the status. It preserves the provider's current classification of this record.
* **Enables:** filter issue records to a selected Jira status category and group issue counts by that exact workflow classification.
* **Interpretation:** The provider supplies `statusCategory` per status record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, status category is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.status.statusCategory.colorName`
Color Name records color name associated with this category. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied color name for the represented design or board object.
* **Interpretation:** The provider supplies `colorName` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.status.statusCategory.id`
ID is the unique ID of the status category. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `StatusCategory`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.status.statusCategory.key`
Key is the key of the status category (e.g., new, indeterminate, done). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `StatusCategory`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.status.statusCategory.name`
Name states display name of the status category. It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Jira Data Center status category name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per status category record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, name is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.status.statusCategory.self`
Self records REST API URL for this status category. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a status category record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each status category record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.issuelinks.inwardIssue.fields.summary`
Summary records summary of the referenced issue. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact summary value attached to each issue reference summary field record.
* **Interpretation:** The provider supplies `summary` at issue reference summary field granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.issuelinks.inwardIssue.id`
ID is the unique numeric ID of the referenced issue. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `IssueReference`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.issuelinks.inwardIssue.key`
Key identifies human-readable issue key. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `IssueReference`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.issuelinks.inwardIssue.self`
Self records REST API URL for the referenced issue. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a issue reference record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each issue reference record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.issuelinks.outwardIssue`
Outward Issue captures the outward issue in the link relationship. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by outward issue on each issue link record.
* **Interpretation:** The provider returns `outwardIssue` as a nested object or reference on `IssueLink`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.issuelinks.self`
Self records REST API URL for this issue link. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a issue link record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each issue link record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.issuelinks.type`
Type states type of the link relationship. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per issue link record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, type is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.issuelinks.type.id`
ID is the unique ID of the link type. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `IssueLinkType`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.issuelinks.type.inward`
Inward records inward description (e.g., is blocked by). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact inward value attached to each issue link type record.
* **Interpretation:** The provider supplies `inward` at issue link type granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.issuelinks.type.name`
Name records name of the link type (e.g., Blocks, Cloners, Duplicate). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each issue link type record.
* **Interpretation:** The provider supplies `name` at issue link type granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.issuelinks.type.outward`
Outward records outward description (e.g., blocks). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact outward value attached to each issue link type record.
* **Interpretation:** The provider supplies `outward` at issue link type granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.issuelinks.type.self`
Self records REST API URL for this link type. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a issue link type record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each issue link type record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.issuetype`
Issuetype states type of issue (Bug, Story, Task, Epic, etc.). It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported issuetype value when describing their recorded state.
* **Interpretation:** The provider supplies `issuetype` per issue field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, issuetype is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.labels`
Labels records labels applied to the issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** apply the provider-defined labels classifications to each issue field record.
* **Interpretation:** The provider returns `labels` as a list on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.lastViewed`
Last Viewed records the timestamp when the current user last viewed this issue. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by last viewed and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastViewed` per issue field record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.parent`
Parent records parent issue reference (for subtasks or child issues). It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by parent on each issue field record.
* **Interpretation:** The provider returns `parent` as a nested object or reference on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.priority`
Priority states priority level of the issue. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported priority value when describing their recorded state.
* **Interpretation:** The provider supplies `priority` per issue field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, priority is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.progress`
Progress groups time spent, the original estimate, and completion percentage for the issue itself. It preserves time-tracking state without subtask rollups.
* **Enables:** compare spent time with the issue estimate and identify incomplete or overrunning work.
* **Interpretation:** The provider supplies `progress` as a nested object whose time values are seconds and whose percent value expresses completion; absence means no issue progress was reported.
Developer identifier: `issues.fields.project`
Project records project the issue belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each issue field record with the specific provider container named by project.
* **Interpretation:** The provider returns `project` as a nested object or reference on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.project.avatarUrls`
Avatar URLs records project avatar URLs. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar urls on a project record.
* **Interpretation:** The provider supplies `avatarUrls` as a URL or resource locator on each project record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.project.id`
ID is the unique ID of the project. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `Project`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.project.key`
Key identifies project key (e.g., PROJ). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `Project`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.project.name`
Name records display name of the project. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each project record.
* **Interpretation:** The provider supplies `name` at project granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.project.projectCategory`
Project Category states category the project belongs to. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported project category value when describing their recorded state.
* **Interpretation:** The provider supplies `projectCategory` per project record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, project category is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.project.projectCategory.description`
Description records description of the category. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each project category record.
* **Interpretation:** The provider supplies `description` at project category granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.project.projectCategory.id`
ID is the unique ID of the project category. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ProjectCategory`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.project.projectCategory.name`
Name states display name of the category. It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Jira Data Center project category name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per project category record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, name is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.project.projectCategory.self`
Self records REST API URL for this project category. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a project category record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each project category record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.project.projectTypeKey`
Project Type Key identifies project type key (e.g., software, business, `service_desk`). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same project type key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `projectTypeKey` as a record-level identifier on `Project`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.project.self`
Self records REST API URL for this project. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a project record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each project record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.reporter`
Reporter records user who created the issue. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the issue field record to the provider-reported person or account represented by reporter.
* **Interpretation:** The provider supplies `reporter` as identity or attribution context on each issue field record. In Jira Data Center, reporter is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.resolution`
Resolution states resolution of the issue if resolved. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported resolution value when describing their recorded state.
* **Interpretation:** The provider supplies `resolution` per issue field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, resolution is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.resolution.description`
Description records description of the resolution. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each resolution record.
* **Interpretation:** The provider supplies `description` at resolution granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.resolution.id`
ID is the unique ID of the resolution. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `Resolution`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.resolution.name`
Name states display name (e.g., Done, Won't Do, Duplicate, Cannot Reproduce). It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Jira Data Center resolution name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per resolution record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, name is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.resolution.self`
Self records REST API URL for this resolution. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a resolution record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each resolution record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.resolutiondate`
Resolutiondate records the timestamp when the issue was resolved. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by resolutiondate and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `resolutiondate` per issue field record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.security`
Security states security level of the issue. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported security value when describing their recorded state.
* **Interpretation:** The provider supplies `security` per issue field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, security is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.security.description`
Description records description of the security level. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each security level record.
* **Interpretation:** The provider supplies `description` at security level granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.security.id`
ID is the unique ID of the security level. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `SecurityLevel`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.security.name`
Name records display name of the security level. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each security level record.
* **Interpretation:** The provider supplies `name` at security level granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.security.self`
Self records REST API URL for this security level. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a security level record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each security level record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.sprint`
Sprint states active sprint the issue is in (Jira Software). It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported sprint value when describing their recorded state.
* **Interpretation:** The provider supplies `sprint` per issue field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, sprint is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.status`
Status states current workflow status of the issue. It preserves the provider's current classification of this record.
* **Enables:** filter issue records to a selected Jira status and group issue counts by that exact workflow classification.
* **Interpretation:** The provider supplies `status` per issue field record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, status is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.fields.statuscategorychangedate`
Statuscategorychangedate records the timestamp when the issue's status category most recently changed. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by statuscategorychangedate and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `statuscategorychangedate` per issue field record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.storyPoints`
Story Points records story point estimate (custom field, commonly mapped). It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret story points according to the provider and Workspace configuration that produced each issue record.
* **Interpretation:** Keys and value shapes within `storyPoints` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `issues.fields.subtasks`
Subtasks records subtasks of this issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by subtasks on each issue field record.
* **Interpretation:** The provider returns `subtasks` as a list on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.summary`
Summary records one-line summary/title of the issue. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact summary value attached to each issue field record.
* **Interpretation:** The provider supplies `summary` at issue field granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.timeestimate`
Timeestimate reports remaining time estimate in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by timeestimate across issue records.
* **Interpretation:** The provider supplies `timeestimate` per issue field record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.timeoriginalestimate`
Timeoriginalestimate reports original time estimate in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by timeoriginalestimate across issue records.
* **Interpretation:** The provider supplies `timeoriginalestimate` per issue field record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.timespent`
Timespent reports the total time spent in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by timespent across issue records.
* **Interpretation:** The provider supplies `timespent` per issue field record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.timetracking`
Timetracking records time tracking information. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested timetracking object into its declared child fields for each issue field record.
* **Interpretation:** The provider returns `timetracking` as a nested object or reference on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.timetracking.originalEstimate`
Original Estimate records the issue's original planned duration in Jira's human-readable format. It preserves the planning interval alongside its seconds representation.
* **Enables:** compare planned effort across issues and display the estimate in the provider's own duration syntax.
* **Interpretation:** The provider supplies `originalEstimate` as duration text such as `2d 4h`; consumers must use Jira's unit conventions rather than treat the string as an ordinal.
Developer identifier: `issues.fields.timetracking.originalEstimateSeconds`
Original Estimate Seconds reports original estimate in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by original estimate seconds across issue records.
* **Interpretation:** The provider supplies `originalEstimateSeconds` per time tracking record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.timetracking.remainingEstimate`
Remaining Estimate records the issue's remaining planned duration in Jira's human-readable format. It preserves the current forecast alongside its seconds representation.
* **Enables:** compare outstanding effort across issues and display the estimate in the provider's own duration syntax.
* **Interpretation:** The provider supplies `remainingEstimate` as provider-formatted duration text; consumers must use Jira's unit conventions rather than treat the string as an ordinal.
Developer identifier: `issues.fields.timetracking.remainingEstimateSeconds`
Remaining Estimate Seconds reports remaining estimate in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by remaining estimate seconds across issue records.
* **Interpretation:** The provider supplies `remainingEstimateSeconds` per time tracking record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.timetracking.timeSpent`
Time Spent reports human-readable time spent. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by time spent across issue records.
* **Interpretation:** The provider supplies `timeSpent` per time tracking record in the unit stated by the provider description; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.timetracking.timeSpentSeconds`
Time Spent Seconds reports time spent in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by time spent seconds across issue records.
* **Interpretation:** The provider supplies `timeSpentSeconds` per time tracking record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.updated`
Updated records the timestamp of the last modification to the issue. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by updated and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated` per issue field record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.versions`
Versions records affects versions associated with the issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested versions object into its declared child fields for each issue field record.
* **Interpretation:** The provider returns `versions` as a list on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.votes`
Votes records vote count and self-vote status. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by votes on a issue field record.
* **Interpretation:** The provider supplies `votes` as a URL or resource locator on each issue field record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.votes.hasVoted`
Has Voted indicates whether the current user has voted for this issue. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports has voted as true or false.
* **Interpretation:** The provider supplies `hasVoted` as a boolean per vote record; false and missing are distinct when the field is optional. In Jira Data Center, has voted is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.fields.votes.self`
Self records REST API URL for votes on this issue. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a vote record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each vote record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.votes.votes`
Votes reports the number of votes. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported votes for each vote record.
* **Interpretation:** The provider supplies `votes` at vote granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.fields.watches`
Watches records watch count and self-watch status. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by watches on a issue field record.
* **Interpretation:** The provider supplies `watches` as a URL or resource locator on each issue field record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.watches.isWatching`
Is Watching indicates whether the current user is watching the issue. It preserves the provider-reported yes-or-no condition for the watches record.
* **Enables:** separate issues the current user watches from those they do not.
* **Interpretation:** The provider supplies `isWatching` as a boolean per watches record; false and missing are distinct. It is a condition on the issue, not an individual-performance measure.
Developer identifier: `issues.fields.watches.self`
Self records the REST API URL for watches on the issue. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the watches resource referenced by each watcher summary.
* **Interpretation:** The provider supplies `self` as a URL on each watches record; availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.watches.watchCount`
Watch Count reports the number of users watching the issue. It preserves the audience count in the watcher summary.
* **Enables:** compare issue interest using the provider-reported watcher totals.
* **Interpretation:** The provider supplies `watchCount` as an integer count per watches record; zero and missing are not interchangeable.
Developer identifier: `issues.fields.worklog`
Worklog records worklogs recorded against the issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested worklog records contained by each issue field record.
* **Interpretation:** The provider returns `worklog` as a nested object or reference on `IssueFields`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.worklog.maxResults`
Max Results reports maximum number of worklogs returned. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported max results for each worklog container record.
* **Interpretation:** The provider supplies `maxResults` at worklog container granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.fields.worklog.startAt`
Start At identifies the zero-based pagination offset of the first worklog returned in the embedded page. It locates that page within the issue's complete worklog collection.
* **Enables:** detect partial worklog pages and continue interpretation with `maxResults` and `total`.
* **Interpretation:** The provider supplies `startAt` as pagination metadata, not a worklog count or business measure; zero denotes the first page.
Developer identifier: `issues.fields.worklog.total`
Total reports the total number of worklogs on the issue. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported total for each worklog container record.
* **Interpretation:** The provider supplies `total` at worklog container granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `issues.fields.worklog.worklogs`
Worklogs records list of worklogs. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested worklogs records contained by each worklog container record.
* **Interpretation:** The provider returns `worklogs` as a list on `WorklogContainer`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.fields.worklog.worklogs.author`
Author records user who logged the work. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the worklog record to the provider-reported actor represented by author.
* **Interpretation:** The provider supplies `author` as identity or attribution context on each worklog record. In Jira Data Center, author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.worklog.worklogs.comment`
Comment records comment on the worklog entry. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact comment value attached to each worklog record.
* **Interpretation:** The provider supplies `comment` at worklog granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.fields.worklog.worklogs.created`
Created records the timestamp when the worklog was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created` per worklog record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.worklog.worklogs.id`
ID is the unique ID of the worklog. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `Worklog`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.fields.worklog.worklogs.self`
Self records REST API URL for this worklog. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a worklog record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each worklog record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues.fields.worklog.worklogs.started`
Started records the timestamp when the work was started. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by started and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `started` per worklog record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.worklog.worklogs.timeSpent`
Time Spent reports human-readable time spent (e.g., 3h 20m). It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by time spent across issue records.
* **Interpretation:** The provider supplies `timeSpent` per worklog record in the unit stated by the provider description; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.worklog.worklogs.timeSpentSeconds`
Time Spent Seconds reports time spent in seconds. It preserves the elapsed interval reported for this record.
* **Enables:** compare the provider-recorded interval represented by time spent seconds across issue records.
* **Interpretation:** The provider supplies `timeSpentSeconds` per worklog record in seconds; it is an elapsed or recorded interval, not an outcome measure.
Developer identifier: `issues.fields.worklog.worklogs.updateAuthor`
Update Author records user who last updated the worklog. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the worklog record to the provider-reported actor represented by update author.
* **Interpretation:** The provider supplies `updateAuthor` as identity or attribution context on each worklog record. In Jira Data Center, update author is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.fields.worklog.worklogs.updated`
Updated records the timestamp when the worklog was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by updated and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated` per worklog record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.fields.worklog.worklogs.visibility`
Visibility states visibility restriction on the worklog. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported visibility attached to each worklog record.
* **Interpretation:** The provider supplies `visibility` at worklog granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `issues.fields.workratio`
Workratio reports the issue's work ratio as a percentage. It relates recorded work to the available estimate.
* **Enables:** identify issues consuming more or less effort than planned and separate issues for which the ratio does not apply.
* **Interpretation:** The provider supplies `workratio` as an integer percentage and uses `-1` when the ratio is not applicable; `-1`, zero, and missing have different meanings.
Developer identifier: `issues.id`
ID is the unique numeric ID of the issue. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same jira data center issue source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per jira data center issue record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `issues.key`
Key identifies human-readable issue key like PROJ-123. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `JiraDataCenterIssue`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.project_key`
Project Key identifies parent key injected by the ingestor from the projects to issues traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same project key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `project_key` as a record-level identifier on `JiraDataCenterIssue`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.self`
Self records REST API URL for this issue. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a jira data center issue record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each jira data center issue record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects`
Projects contain Jira Data Center projects.
* **Enables:** map Jira Data Center issues to their self-hosted project containers.
* **Scope:** Reads the declared collection through `GET /rest/api/2/project` as a full snapshot. Results contain only Jira records visible to the configured account; permission-hidden projects, issues, and comments are absent.
Developer identifier: `projects.archived`
Archived indicates whether the project is archived. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports archived as true or false.
* **Interpretation:** The provider supplies `archived` as a boolean per jira data center project record; false and missing are distinct when the field is optional. In Jira Data Center, archived is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.assigneeType`
Assignee Type states default assignee type for the project. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported assignee type value when describing their recorded state.
* **Interpretation:** The provider supplies `assigneeType` per jira data center project record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, assignee type is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.avatarUrls`
Avatar URLs records avatar image URLs at various sizes. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar urls on a jira data center project record.
* **Interpretation:** The provider supplies `avatarUrls` as a URL or resource locator on each jira data center project record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.avatarUrls.16x16`
16x16 records 16x16 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 16x16 on a jira avatar url record.
* **Interpretation:** The provider supplies `16x16` as a URL or resource locator on each jira avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.avatarUrls.24x24`
24x24 records 24x24 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 24x24 on a jira avatar url record.
* **Interpretation:** The provider supplies `24x24` as a URL or resource locator on each jira avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.avatarUrls.32x32`
32x32 records 32x32 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 32x32 on a jira avatar url record.
* **Interpretation:** The provider supplies `32x32` as a URL or resource locator on each jira avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.avatarUrls.48x48`
48x48 records 48x48 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 48x48 on a jira avatar url record.
* **Interpretation:** The provider supplies `48x48` as a URL or resource locator on each jira avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.components`
Components records list of components defined in this project. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each jira data center project record with the specific provider container named by components.
* **Interpretation:** The provider returns `components` as a list on `JiraDataCenterProject`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `projects.components.assignee`
Assignee records default assignee for the component. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira component record to the provider-reported actor represented by assignee.
* **Interpretation:** The provider supplies `assignee` as identity or attribution context on each jira component record. In Jira Data Center, assignee is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.components.assignee.active`
Active indicates whether the user account is active. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per jira user record; false and missing are distinct when the field is optional. In Jira Data Center, active is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.components.assignee.avatarUrls`
Avatar URLs records avatar image URLs at various sizes. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar urls on a jira user record.
* **Interpretation:** The provider supplies `avatarUrls` as a URL or resource locator on each jira user record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.components.assignee.displayName`
Display Name records full display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira user record to the provider-reported person or account represented by display name.
* **Interpretation:** The provider supplies `displayName` as identity or attribution context on each jira user record. In Jira Data Center, display name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.components.assignee.emailAddress`
Email Address records email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira user record to the provider-reported person or account represented by email address.
* **Interpretation:** The provider supplies `emailAddress` as identity or attribution context on each jira user record. In Jira Data Center, email address is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.components.assignee.key`
Key is the unique key identifying the user (often the username in Data Center). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `JiraUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.components.assignee.locale`
Locale records locale preference of the user. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for projects using the recorded locale.
* **Interpretation:** The provider supplies `locale` as location or localization context per jira user record; it does not establish a person's real-time physical location.
Developer identifier: `projects.components.assignee.name`
Name records username of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira user record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each jira user record. In Jira Data Center, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.components.assignee.self`
Self records REST API URL for this user resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a jira user record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each jira user record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.components.assignee.timeZone`
Time Zone records IANA timezone of the user. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for projects using the recorded time zone.
* **Interpretation:** The provider supplies `timeZone` as location or localization context per jira user record; it does not establish a person's real-time physical location.
Developer identifier: `projects.components.assigneeType`
Assignee Type states default assignee type for the component. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported assignee type value when describing their recorded state.
* **Interpretation:** The provider supplies `assigneeType` per jira component record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, assignee type is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.components.description`
Description records description of the component. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each jira component record.
* **Interpretation:** The provider supplies `description` at jira component granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects.components.id`
ID is the unique numeric ID of the component. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same jira component source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per jira component record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `projects.components.isAssigneeTypeValid`
Is Assignee Type Valid indicates whether the configured assignee type is valid. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports is assignee type valid as true or false.
* **Interpretation:** The provider supplies `isAssigneeTypeValid` as a boolean per jira component record; false and missing are distinct when the field is optional. In Jira Data Center, is assignee type valid is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.components.lead`
Lead records user designated as the component lead. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira component record to the provider-reported person or account represented by lead.
* **Interpretation:** The provider supplies `lead` as identity or attribution context on each jira component record. In Jira Data Center, lead is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.components.name`
Name records name of the component. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each jira component record.
* **Interpretation:** The provider supplies `name` at jira component granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects.components.project`
Project records project key this component belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each jira component record with the specific provider container named by project.
* **Interpretation:** The provider returns `project` as a nested object or reference on `JiraComponent`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `projects.components.projectId`
Project ID reports the numeric ID of the project this component belongs to. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same project ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `projectId` as a record-level identifier on `JiraComponent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.components.realAssignee`
Real Assignee records actual resolved assignee after applying project defaults. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira component record to the provider-reported actor represented by real assignee.
* **Interpretation:** The provider supplies `realAssignee` as identity or attribution context on each jira component record. In Jira Data Center, real assignee is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.components.realAssigneeType`
Real Assignee Type states actual resolved assignee type after applying project defaults. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported real assignee type value when describing their recorded state.
* **Interpretation:** The provider supplies `realAssigneeType` per jira component record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, real assignee type is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.components.self`
Self records REST API URL for this component resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a jira component record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each jira component record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.description`
Description records full description of the project, may contain wiki markup or HTML. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each jira data center project record.
* **Interpretation:** The provider supplies `description` at jira data center project granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects.email`
Email records email address associated with the project, if configured. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira data center project record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each jira data center project record. In Jira Data Center, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.entityId`
Entity ID identifies global entity ID for the project, used in cross-product integrations. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same entity ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `entityId` as a record-level identifier on `JiraDataCenterProject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.expand`
Expand records comma-separated list of expanded fields included in the response. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact expand when validating the configuration or technical definition of a jira data center project record.
* **Interpretation:** The provider supplies `expand` as configuration or technical metadata on `JiraDataCenterProject`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `projects.id`
ID is the unique numeric ID of the project. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `JiraDataCenterProject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.isPrivate`
Is Private indicates whether the project is private. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported is private attached to each jira data center project record.
* **Interpretation:** The provider supplies `isPrivate` at jira data center project granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `projects.issueTypes`
Issue Types records list of issue types available in this project. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each jira data center project record with the specific provider container named by issue types.
* **Interpretation:** The provider returns `issueTypes` as a list on `JiraDataCenterProject`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `projects.issueTypes.avatarId`
Avatar ID is the ID of the avatar associated with this issue type. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same avatar ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `avatarId` as a record-level identifier on `JiraIssueType`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.issueTypes.description`
Description records description of the issue type. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each jira issue type record.
* **Interpretation:** The provider supplies `description` at jira issue type granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects.issueTypes.iconUrl`
Icon URL records URL of the issue type icon. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by icon URL on a jira issue type record.
* **Interpretation:** The provider supplies `iconUrl` as a URL or resource locator on each jira issue type record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.issueTypes.id`
ID is the unique numeric ID of the issue type. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same jira issue type source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per jira issue type record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `projects.issueTypes.name`
Name states name of the issue type (e.g., Bug, Story, Task). It preserves the provider's current classification of this record.
* **Enables:** filter and group project records by the Jira Data Center jira issue type name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per jira issue type record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, name is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.issueTypes.self`
Self records REST API URL for this issue type resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a jira issue type record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each jira issue type record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.issueTypes.subtask`
Subtask indicates whether this issue type represents a subtask. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports subtask as true or false.
* **Interpretation:** The provider supplies `subtask` as a boolean per jira issue type record; false and missing are distinct when the field is optional. In Jira Data Center, subtask is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.key`
Key identifies short alphanumeric project key (e.g., PROJ) used in issue keys. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same jira data center project source row before constructing its represented state.
* **Interpretation:** The provider supplies `key` at one value per jira data center project record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `projects.lead`
Lead records user designated as the project lead. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira data center project record to the provider-reported person or account represented by lead.
* **Interpretation:** The provider supplies `lead` as identity or attribution context on each jira data center project record. In Jira Data Center, lead is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.name`
Name records display name of the project. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each jira data center project record.
* **Interpretation:** The provider supplies `name` at jira data center project granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects.projectCategory`
Project Category states administrative category grouping for the project. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported project category value when describing their recorded state.
* **Interpretation:** The provider supplies `projectCategory` per jira data center project record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, project category is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.projectCategory.description`
Description records description of the project category. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each jira project category record.
* **Interpretation:** The provider supplies `description` at jira project category granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects.projectCategory.id`
ID is the unique numeric ID of the project category. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `JiraProjectCategory`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.projectCategory.name`
Name states name of the project category. It preserves the provider's current classification of this record.
* **Enables:** filter and group project records by the Jira Data Center jira project category name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per jira project category record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, name is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.projectCategory.self`
Self records REST API URL for this project category resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a jira project category record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each jira project category record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.projectKeys`
Project Keys records all project keys associated with this project, including historical keys. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested project keys records contained by each jira data center project record.
* **Interpretation:** The provider returns `projectKeys` as a list on `JiraDataCenterProject`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `projects.projectTypeKey`
Project Type Key identifies type of project (software, business, `service_desk`). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same project type key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `projectTypeKey` as a record-level identifier on `JiraDataCenterProject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.properties`
Properties records arbitrary project properties as key-value pairs. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret properties according to the provider and Workspace configuration that produced each project record.
* **Interpretation:** Keys and value shapes within `properties` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `projects.roles`
Roles states map of project role names to their REST API URLs. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported roles attached to each jira data center project record.
* **Interpretation:** The provider supplies `roles` at jira data center project granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Data Center, roles is access or membership context, not an individual-performance measure.
Developer identifier: `projects.self`
Self records REST API URL for this project resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a jira data center project record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each jira data center project record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.simplified`
Simplified indicates whether this project uses the simplified project experience. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports simplified as true or false.
* **Interpretation:** The provider supplies `simplified` as a boolean per jira data center project record; false and missing are distinct when the field is optional. In Jira Data Center, simplified is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.style`
Style states project style indicator (classic or next-gen). It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported style value when describing their recorded state.
* **Interpretation:** The provider supplies `style` per jira data center project record using its own state vocabulary; unknown and missing values must remain distinct. In Jira Data Center, style is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.url`
URL records URL associated with the project (may be an external or internal link). It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a jira data center project record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each jira data center project record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.uuid`
UUID identifies UUID of the project if available. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same UUID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `uuid` as a record-level identifier on `JiraDataCenterProject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.versions`
Versions records list of versions (releases) defined in this project. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each jira data center project record with the specific provider container named by versions.
* **Interpretation:** The provider returns `versions` as a list on `JiraDataCenterProject`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `projects.versions.archived`
Archived indicates whether this version is archived. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports archived as true or false.
* **Interpretation:** The provider supplies `archived` as a boolean per jira version record; false and missing are distinct when the field is optional. In Jira Data Center, archived is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.versions.description`
Description records description of the version. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each jira version record.
* **Interpretation:** The provider supplies `description` at jira version granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects.versions.id`
ID is the unique numeric ID of the version. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same jira version source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per jira version record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `projects.versions.name`
Name records name of the version. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each jira version record.
* **Interpretation:** The provider supplies `name` at jira version granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects.versions.overdue`
Overdue indicates whether this version is past its release date without being released. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports overdue as true or false.
* **Interpretation:** The provider supplies `overdue` as a boolean per jira version record; false and missing are distinct when the field is optional. In Jira Data Center, overdue is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.versions.projectId`
Project ID reports the numeric ID of the project this version belongs to. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same project ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `projectId` as a record-level identifier on `JiraVersion`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.versions.released`
Released indicates whether this version has been released. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select project records for which the provider reports released as true or false.
* **Interpretation:** The provider supplies `released` as a boolean per jira version record; false and missing are distinct when the field is optional. In Jira Data Center, released is a condition on the work record, not an individual-performance measure.
Developer identifier: `projects.versions.releaseDate`
Release Date records planned or actual release date of the version. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project records on a timeline by release date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `releaseDate` per jira version record as a calendar date without a time of day; missing values mean the event or boundary was not reported.
Developer identifier: `projects.versions.self`
Self records REST API URL for this version resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a jira version record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each jira version record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.versions.startDate`
Start Date records planned start date of the version. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project records on a timeline by start date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startDate` per jira version record as a calendar date without a time of day; missing values mean the event or boundary was not reported.
Developer identifier: `projects.versions.userReleaseDate`
User Release Date records user-formatted release date string. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project records on a timeline by user release date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `userReleaseDate` per jira version record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `projects.versions.userStartDate`
User Start Date records user-formatted start date string. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project records on a timeline by user start date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `userStartDate` per jira version record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `users`
Users contain Jira Data Center users.
* **Enables:** resolve self-hosted Jira identities referenced by issue records.
* **Scope:** Reads the declared collection through `GET /rest/api/2/user/search` as a full snapshot. Results contain only Jira records visible to the configured account; permission-hidden projects, issues, and comments are absent.
Developer identifier: `users.active`
Active indicates whether the user account is active. Filters active vs deactivated users for license and adoption analysis. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select user records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per jira data center user record; false and missing are distinct when the field is optional. In Jira Data Center, active is a condition on the work record, not an individual-performance measure.
Developer identifier: `users.applicationRoles`
Application Roles states application roles assigned to the user (when expanded). It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported application roles attached to each jira data center user record.
* **Interpretation:** The provider supplies `applicationRoles` at jira data center user granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Data Center, application roles is access or membership context, not an individual-performance measure.
Developer identifier: `users.applicationRoles.items`
Items states array of application role objects. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported items attached to each application role list record.
* **Interpretation:** The provider supplies `items` at application role list granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Data Center, items is access or membership context, not an individual-performance measure.
Developer identifier: `users.applicationRoles.items.key`
Key captures the key identifier of the application role. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match user records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `ApplicationRole`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `users.applicationRoles.items.name`
Name captures the display name of the application role. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported name attached to each application role record.
* **Interpretation:** The provider supplies `name` at application role granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Jira Data Center, name is access or membership context, not an individual-performance measure.
Developer identifier: `users.applicationRoles.items.self`
Self captures the URL of the application role's REST API resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a application role record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each application role record. Availability still follows the provider's permissions and retention.
Developer identifier: `users.applicationRoles.size`
Size reports the number of application roles returned in the list. It records collection occupancy for the response.
* **Enables:** distinguish an empty role collection from one containing the provider-reported number of roles.
* **Interpretation:** The provider supplies `size` as an integer item count, not bytes; zero and missing are not interchangeable.
Developer identifier: `users.avatarUrls`
Avatar URLs records map of avatar image URLs at various sizes. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar urls on a jira data center user record.
* **Interpretation:** The provider supplies `avatarUrls` as a URL or resource locator on each jira data center user record. Availability still follows the provider's permissions and retention.
Developer identifier: `users.avatarUrls.16x16`
16x16 records 16x16 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 16x16 on a avatar url record.
* **Interpretation:** The provider supplies `16x16` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `users.avatarUrls.24x24`
24x24 records 24x24 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 24x24 on a avatar url record.
* **Interpretation:** The provider supplies `24x24` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `users.avatarUrls.32x32`
32x32 records 32x32 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 32x32 on a avatar url record.
* **Interpretation:** The provider supplies `32x32` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention.
Developer identifier: `users.avatarUrls.48x48`
48x48 records 48x48 pixel avatar URL. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by 48x48 on a avatar url record.
* **Interpretation:** The provider supplies `48x48` as a URL or resource locator on each avatar url record. Availability still follows the provider's permissions and retention. A connector directive maps this field to the person's identity photo.
Developer identifier: `users.deleted`
Deleted indicates whether the user account has been deleted. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select user records for which the provider reports deleted as true or false.
* **Interpretation:** The provider supplies `deleted` as a boolean per jira data center user record; false and missing are distinct when the field is optional. In Jira Data Center, deleted is a condition on the work record, not an individual-performance measure.
Developer identifier: `users.displayName`
Display Name records full display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira data center user record to the provider-reported person or account represented by display name.
* **Interpretation:** The provider supplies `displayName` as identity or attribution context on each jira data center user record. In Jira Data Center, display name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `users.emailAddress`
Email Address records email address of the user. Primary cross-connector identity matching key. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the jira data center user record to the provider-reported person or account represented by email address.
* **Interpretation:** The provider supplies `emailAddress` as identity or attribution context on each jira data center user record. In Jira Data Center, email address is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `users.expand`
Expand records comma-separated list of expanded properties included in the response. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact expand when validating the configuration or technical definition of a jira data center user record.
* **Interpretation:** The provider supplies `expand` as configuration or technical metadata on `JiraDataCenterUser`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `users.groups`
Groups records groups the user belongs to (when expanded). It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each jira data center user record with the specific provider container named by groups.
* **Interpretation:** The provider returns `groups` as a nested object or reference on `JiraDataCenterUser`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `users.groups.items`
Items records array of group objects. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested items records contained by each group list record.
* **Interpretation:** The provider returns `items` as a list on `GroupList`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `users.groups.items.name`
Name captures the name of the group. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each group record.
* **Interpretation:** The provider supplies `name` at group granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `users.groups.items.self`
Self captures the URL of the group's REST API resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a group record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each group record. Availability still follows the provider's permissions and retention.
Developer identifier: `users.groups.size`
Size reports the number of groups returned in the list. It records collection occupancy for the response.
* **Enables:** distinguish an empty group collection from one containing the provider-reported number of groups.
* **Interpretation:** The provider supplies `size` as an integer item count, not bytes; zero and missing are not interchangeable.
Developer identifier: `users.key`
Key is the unique user key in Jira Data Center. Primary key for joining users to issues, worklogs, and changelogs. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same jira data center user source row before constructing its represented state.
* **Interpretation:** The provider supplies `key` at one value per jira data center user record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `users.locale`
Locale records user's configured locale (e.g., `en_US`). It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for users using the recorded locale.
* **Interpretation:** The provider supplies `locale` as location or localization context per jira data center user record; it does not establish a person's real-time physical location.
Developer identifier: `users.name`
Name identifies username / login name of the user. Login identifier for cross-system identity resolution. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match user records to provider records that carry the same name, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `name` as a record-level identifier on `JiraDataCenterUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `users.self`
Self captures the URL of the user's REST API resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a jira data center user record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each jira data center user record. Availability still follows the provider's permissions and retention.
Developer identifier: `users.timeZone`
Time Zone records user's configured timezone. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for users using the recorded time zone.
* **Interpretation:** The provider supplies `timeZone` as location or localization context per jira data center user record; it does not establish a person's real-time physical location.
| Error | Meaning | Solution |
| - | - | - |
| `401 Unauthorized` | Invalid credentials | Verify username and token/password |
| `403 Forbidden` | No permission | Check user has required permissions |
| `Connection refused` | Network issue | Verify server URL and network access |
#### Common Issues
#### PATs not available
Personal Access Tokens require Jira 8.14+. For older versions, use Basic Authentication.
#### SSL certificate errors
Self-signed certificates may cause issues. Ensure proper certificate configuration.
**[Jira Server REST API](https://docs.atlassian.com/software/jira/docs/api/REST/latest/)** — Official API documentation
# Lattice
Source: https://docs.parable.work/plugins/provider-plugins/lattice
Sync employee and performance data from Lattice
Sync employee and performance data from Lattice.
Connect Parable to Lattice for people performance and management data.
#### People
Employee profiles, org structure
#### Performance
Goals, reviews, feedback
## Data streams
This Provider Plugin defines 8 data streams.
| Stream | Description | Sync |
| - | - | - |
| `goals` | Goals tracked in Lattice | full |
| `updates` | Goal updates and check-ins | incremental |
| `feedbacks` | Feedback entries in Lattice | incremental |
| `users` | Users in Lattice | full |
| `tasks` | Tasks assigned to users in Lattice | full |
| `direct_reports` | Direct reports for each user in Lattice | full |
| `review_cycles` | Performance review cycles in Lattice | full |
| `reviews` | Individual reviews within a review cycle | incremental |
### API token
#### What You'll Need
| Credential | What it is |
| - | - |
| **API Token** | API token from Lattice admin settings |
> **Info:** **Setup access in Lattice.** These steps require **Administrator**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Lattice administrator.
* **Admin** role in Lattice
* API access enabled for your account
#### Step 1: Access Admin Settings
1. Log in to Lattice as admin
2. Go to **Admin** → **Platform** → **API Keys**
#### Step 2: Generate API Key
1. Click **Generate API key**
2. Name: `Parable Integration`
3. Select permissions as needed
4. Click **Create**
> **Warning:** **Copy your API key now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
#### Step 3: Enter values in the form
1. **API Key**: Paste your Lattice API key.
2. Click **Save & test connection**.
Developer identifier: `direct_reports`
**Direct Reports.** Direct reports for each user in Lattice.
* **Enables:** Reconstruct provider-reported manager-to-direct-report relationships using the parent manager and returned user identifiers.
* **Scope:** Reads the records selected by Lattice's `/v1/user/{user_id}/directReports` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the Lattice API key's organization access and the provider's privacy controls. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `direct_reports.birthDate`
**Birth Date.** User birth date. It anchors the direct report on the provider's reported timeline.
* **Enables:** Order Direct Reports by birth date in `direct_reports.birthDate` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports birth date as a calendar date on each direct report; its grain is one day and no time of day should be inferred.
Developer identifier: `direct_reports.createdAt`
**Created At.** Unix timestamp when the user was created. It anchors the direct report on the provider's reported timeline.
* **Enables:** Order Direct Reports by created at in `direct_reports.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports created at as a Unix timestamp in a unit not declared by this field on each direct report; derive timezone display separately and do not guess an undeclared unit.
Developer identifier: `direct_reports.department`
**Department.** User department. It preserves the nested context needed to interpret the parent direct report.
* **Enables:** Attribute department in `direct_reports.department` to the parent direct report; identify parent records where that nested department object is absent.
* **Interpretation:** Lattice reports department as a nested object on each direct report; optional children may be absent from a valid response.
Developer identifier: `direct_reports.department.id`
**ID.** Department ID. It provides the reference needed to connect the direct report to the corresponding provider object.
* **Enables:** Connect each Lattice direct report department in Direct Reports to the referenced Lattice direct report department through `direct_reports.LatticeDirectReportDepartment.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports ID as an identifier in its Lattice direct report department namespace; it is not a universal identity outside Lattice.
Developer identifier: `direct_reports.email`
**Email.** User email address. It supplies the provider-reported address or location facet for the direct report, not a residency determination.
* **Enables:** Attribute each direct report to a person or account by the exact email in `direct_reports.email`; identify addresses that do not match the Lattice directory.
* **Interpretation:** Lattice reports email as an address on each direct report; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `direct_reports.externalUserId`
**External User ID.** External identity provider user ID for this Lattice user. It provides the reference needed to connect the direct report to the corresponding provider object.
* **Enables:** Connect each direct report in Direct Reports to the referenced external user through `direct_reports.externalUserId`; flag external user ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports external user ID as an identifier in its external user namespace; it is not a universal identity outside Lattice.
Developer identifier: `direct_reports.gender`
**Gender.** User gender. It supplies the gender profile facet used to reconcile or attribute the direct report.
* **Enables:** Reconcile the direct report's gender in `direct_reports.gender` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Lattice reports gender as a mutable profile or directory attribute on each direct report; it may be absent, shared, or non-unique.
Developer identifier: `direct_reports.id`
**ID.** Unique user identifier. It provides the reference needed to connect the direct report to the corresponding provider object.
* **Enables:** Match repeated direct report entries on ID in `direct_reports.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Lattice reports ID as an identifier in its direct report namespace; it is not a universal identity outside Lattice. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `direct_reports.isAdmin`
**Is Admin.** Whether the user is a Lattice admin. It distinguishes the provider-defined is admin state or classification for the direct report.
* **Enables:** Filter Direct Reports by whether the user is a Lattice admin in `direct_reports.isAdmin`; count true, false, and missing results separately.
* **Interpretation:** Lattice reports the user is a Lattice admin as a boolean on each direct report; a missing field is unknown, not false.
Developer identifier: `direct_reports.jobTitle`
**Job Title.** User job title. It supplies the job title profile facet used to reconcile or attribute the direct report.
* **Enables:** Label each direct report with job title from `direct_reports.jobTitle`; distinguish records that share that display name but have different Lattice identifiers.
* **Interpretation:** Lattice reports job title as display text for each direct report; names are mutable and are not stable identities.
Developer identifier: `direct_reports.manager`
**Manager.** User's manager. It preserves the nested context needed to interpret the parent direct report.
* **Enables:** Attribute manager in `direct_reports.manager` to the parent direct report; identify parent records where that nested manager object is absent.
* **Interpretation:** Lattice reports manager as a nested object on each direct report; optional children may be absent from a valid response.
Developer identifier: `direct_reports.manager.id`
**ID.** Manager user ID. It provides the reference needed to connect the direct report to the corresponding provider object.
* **Enables:** Connect each Lattice direct report manager in Direct Reports to the referenced Lattice direct report manager through `direct_reports.LatticeDirectReportManager.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports ID as an identifier in its Lattice direct report manager namespace; it is not a universal identity outside Lattice.
Developer identifier: `direct_reports.manager_id`
**Manager ID.** Parent manager reference copied into each direct report because the child operation does not return that relationship. It provides the reference needed to connect the direct report to the corresponding provider object.
* **Enables:** Connect each direct report in Direct Reports to the referenced manager through `direct_reports.manager_id`; flag manager ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies manager ID from the parent traversal record into each direct report; the child Lattice operation does not return it.
Developer identifier: `direct_reports.name`
**Name.** User display name. It gives the direct report a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each direct report with name from `direct_reports.name`; distinguish records that share that display name but have different Lattice identifiers.
* **Interpretation:** Lattice reports name as display text for each direct report; names are mutable and are not stable identities.
Developer identifier: `direct_reports.preferredName`
**Preferred Name.** User preferred display name. It gives the direct report a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each direct report with preferred name from `direct_reports.preferredName`; distinguish records that share that display name but have different Lattice identifiers.
* **Interpretation:** Lattice reports preferred name as display text for each direct report; names are mutable and are not stable identities.
Developer identifier: `direct_reports.startDate`
**Start Date.** User start date. It anchors the direct report on the provider's reported timeline.
* **Enables:** Filter Direct Reports by start date in `direct_reports.startDate`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** Lattice reports start date as a calendar date on each direct report; its grain is one day and no time of day should be inferred.
Developer identifier: `direct_reports.status`
**Status.** User account status. It distinguishes the provider-defined status state or classification for the direct report.
* **Enables:** Segment direct report entries in Direct Reports by status in `direct_reports.status`; compare counts only within the same Lattice taxonomy.
* **Interpretation:** Lattice reports status as a label from its own taxonomy on each direct report; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `direct_reports.timezone`
**Timezone.** User timezone setting. It is needed to interpret companion dates and times for the direct report in the provider's intended zone.
* **Enables:** Apply the zone in `direct_reports.timezone` when converting the direct report's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** Lattice reports timezone as a timezone identifier for each direct report; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `direct_reports.title`
**Title.** User job title. It gives the direct report a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each direct report with title from `direct_reports.title`; distinguish records that share that display name but have different Lattice identifiers.
* **Interpretation:** Lattice reports title as display text for each direct report; names are mutable and are not stable identities.
Developer identifier: `direct_reports.updatedAt`
**Updated At.** Unix timestamp when the user was last updated. It anchors the direct report on the provider's reported timeline.
* **Enables:** Order Direct Reports by updated at in `direct_reports.updatedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports updated at as a Unix timestamp in seconds on each direct report; derive timezone display separately and do not guess an undeclared unit. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `direct_reports.user_id`
**User ID.** Parent user reference copied into each direct report because the child operation does not return that relationship. It provides the reference needed to connect the direct report to the corresponding provider object.
* **Enables:** Connect each direct report in Direct Reports to the referenced user through `direct_reports.user_id`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies user ID from the parent traversal record into each direct report; the child Lattice operation does not return it.
Developer identifier: `feedbacks`
**Feedbacks.** Feedback entries in Lattice.
* **Enables:** Match feedback entries to their authors, recipients, requests, visibility, and provider-recorded timestamps.
* **Scope:** Reads the records selected by Lattice's `/v1/feedbacks` operation as a changelog stream using incremental synchronization. This stream is opt-in. Visibility follows the Lattice API key's organization access and the provider's privacy controls. Provider-authored ratings, feedback, and classifications must remain in their review context and are not Parable performance judgments. This stream supplies no reliable deletion signal.
Developer identifier: `feedbacks.associatedValues`
**Associated Values.** Associated company values list envelope. It preserves the nested context needed to interpret the parent feedback.
* **Enables:** Attribute associated values in `feedbacks.associatedValues` to the parent feedback; identify parent records where that nested associated values object is absent.
* **Interpretation:** Lattice reports associated values as a nested object on each feedback; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.associatedValues.data`
**Data.** Envelope data items. It preserves the nested context needed to interpret the parent feedback.
* **Enables:** Attribute every returned Lattice object reference in `feedbacks.LatticeTargetsList.data` to its parent feedback; keep each relationship distinct and distinguish an absent array from an explicitly empty one.
* **Interpretation:** Lattice returns data as an array of Lattice object reference entries on each Lattice target-list page; missing, empty, and permission-redacted arrays are not equivalent. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.associatedValues.data.id`
**ID.** Referenced object ID. It provides the reference needed to connect the feedback to the corresponding provider object.
* **Enables:** Connect each Lattice object reference in Feedbacks to the referenced Lattice object reference through `feedbacks.LatticeObjectReference.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports ID as an identifier in its Lattice object reference namespace; it is not a universal identity outside Lattice. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.associatedValues.data.object`
**Object.** Referenced object type. It identifies the related provider object that gives the Lattice object reference its parent, owner, or container context.
* **Enables:** Connect each Lattice object reference to the related object in `feedbacks.LatticeObjectReference.object` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** Lattice reports object as relationship context on each Lattice object reference; resolve it in the named provider namespace rather than by display text alone. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.associatedValues.data.url`
**URL.** Referenced object URL. It locates the provider resource or path associated with the Lattice object reference.
* **Enables:** Associate each Lattice object reference with the resource identified by URL in `feedbacks.LatticeObjectReference.url`; verify the link resolves to the expected Lattice object.
* **Interpretation:** Lattice reports URL as a resource locator for each Lattice object reference; access still depends on viewer permissions and the URL may expire or change. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.associatedValues.endingCursor`
**Ending Cursor.** Cursor for the next page. It is needed to continue the provider result set without skipping or repeating a page.
* **Enables:** Resume Lattice pagination from `feedbacks.LatticeTargetsList.endingCursor` and verify that every page boundary advances before requesting the next result set.
* **Interpretation:** Lattice returns ending cursor as opaque pagination state; it has no business meaning and must be replayed exactly when requesting the next page. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.associatedValues.hasMore`
**Has More.** Whether more pages exist. It is needed to continue the provider result set without skipping or repeating a page.
* **Enables:** Filter Feedbacks by whether more pages exist in `feedbacks.LatticeTargetsList.hasMore`; count true, false, and missing results separately.
* **Interpretation:** Lattice reports more pages exist as a boolean on each Lattice target-list page; a missing field is unknown, not false. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.associatedValues.object`
**Object.** Envelope object type. It distinguishes the provider-defined object state or classification for the Lattice targets list.
* **Enables:** Filter Feedbacks by the exact Lattice-defined object in `feedbacks.LatticeTargetsList.object` and preserve unknown values as distinct categories.
* **Interpretation:** Lattice supplies object from its own taxonomy on each Lattice targets list; preserve unknown and newly introduced labels. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.author`
**Author.** Author ObjectReference for this feedback. It preserves the nested context needed to interpret the parent feedback.
* **Enables:** Attribute author in `feedbacks.author` to the parent feedback; identify parent records where that nested author object is absent.
* **Interpretation:** Lattice reports author as a nested object on each feedback; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.body`
**Body.** Feedback body text. It defines the content surface available for this feedback.
* **Enables:** Locate feedback records by body in `feedbacks.body`; attribute each text match to its parent feedback and, when present, its reported author.
* **Interpretation:** Lattice supplies body as text on each feedback; referenced files or media are not implied unless explicitly represented. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.competency`
**Competency.** Competency associated with this feedback. It identifies the related provider object that gives the feedback its parent, owner, or container context.
* **Enables:** Connect each feedback to the related competency in `feedbacks.competency` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** Lattice reports competency as relationship context on each feedback; resolve it in the named provider namespace rather than by display text alone. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.createdAt`
**Created At.** Unix timestamp when the feedback was created. It anchors the feedback on the provider's reported timeline.
* **Enables:** Order Feedbacks by created at in `feedbacks.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports created at as a Unix timestamp in seconds on each feedback; derive timezone display separately and do not guess an undeclared unit. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.feedbackRequest`
**Feedback Request.** Feedback request this entry fulfills. It preserves the nested context needed to interpret the parent feedback.
* **Enables:** Attribute feedback request in `feedbacks.feedbackRequest` to the parent feedback; identify parent records where that nested feedback request object is absent.
* **Interpretation:** Lattice reports feedback request as a nested object on each feedback; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.feedbackRequest.author`
**Author.** User who authored the feedback request. It preserves the nested context needed to interpret the parent feedback.
* **Enables:** Attribute author in `feedbacks.LatticeFeedbackRequest.author` to the parent feedback; identify parent records where that nested author object is absent.
* **Interpretation:** Lattice reports author as a nested object on each Lattice feedback request; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.feedbackRequest.body`
**Body.** Feedback request body. It defines the content surface available for this feedback.
* **Enables:** Locate Lattice feedback request records by body in `feedbacks.LatticeFeedbackRequest.body`; attribute each text match to its parent feedback and, when present, its reported author.
* **Interpretation:** Lattice supplies body as text on each Lattice feedback request; referenced files or media are not implied unless explicitly represented. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.feedbackRequest.competency`
**Competency.** Competency associated with the feedback request. It identifies the related provider object that gives the Lattice feedback request its parent, owner, or container context.
* **Enables:** Connect each Lattice feedback request to the related competency in `feedbacks.LatticeFeedbackRequest.competency` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** Lattice reports competency as relationship context on each Lattice feedback request; resolve it in the named provider namespace rather than by display text alone. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.feedbackRequest.createdAt`
**Created At.** Unix timestamp when the feedback request was created. It anchors the feedback on the provider's reported timeline.
* **Enables:** Order Feedbacks by created at in `feedbacks.LatticeFeedbackRequest.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports created at as a Unix timestamp in a unit not declared by this field on each Lattice feedback request; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.feedbackRequest.fulfilledAt`
**Fulfilled At.** Unix timestamp when the feedback request was fulfilled. It anchors the feedback on the provider's reported timeline.
* **Enables:** Order Feedbacks by fulfilled at in `feedbacks.LatticeFeedbackRequest.fulfilledAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports fulfilled at as a Unix timestamp in a unit not declared by this field on each Lattice feedback request; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.feedbackRequest.subject`
**Subject.** Subject of the feedback request. It preserves the nested context needed to interpret the parent feedback.
* **Enables:** Attribute subject in `feedbacks.LatticeFeedbackRequest.subject` to the parent feedback; identify parent records where that nested subject object is absent.
* **Interpretation:** Lattice reports subject as a nested object on each Lattice feedback request; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.feedbackRequest.target`
**Target.** User targeted by the feedback request. It preserves the nested context needed to interpret the parent feedback.
* **Enables:** Attribute target in `feedbacks.LatticeFeedbackRequest.target` to the parent feedback; identify parent records where that nested target object is absent.
* **Interpretation:** Lattice reports target as a nested object on each Lattice feedback request; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.id`
**ID.** Unique feedback identifier. It provides the reference needed to connect the feedback to the corresponding provider object.
* **Enables:** Match repeated feedback entries on ID in `feedbacks.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Lattice reports ID as an identifier in its feedback namespace; it is not a universal identity outside Lattice. The connector explicitly marks this field as a transform deduplication key. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.isPublic`
**Is Public.** Whether the feedback is publicly visible. It distinguishes the provider-defined is public state or classification for the feedback.
* **Enables:** Filter Feedbacks by whether the feedback is publicly visible in `feedbacks.isPublic`; count true, false, and missing results separately.
* **Interpretation:** Lattice reports the feedback is publicly visible as a boolean on each feedback; a missing field is unknown, not false. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.targets`
**Targets.** Targets list envelope of ObjectReference items. It preserves the nested context needed to interpret the parent feedback.
* **Enables:** Attribute targets in `feedbacks.targets` to the parent feedback; identify parent records where that nested targets object is absent.
* **Interpretation:** Lattice reports targets as a nested object on each feedback; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.updatedAt`
**Updated At.** Unix timestamp when the feedback was last updated. It anchors the feedback on the provider's reported timeline.
* **Enables:** Order Feedbacks by updated at in `feedbacks.updatedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports updated at as a Unix timestamp in a unit not declared by this field on each feedback; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `feedbacks.visibility`
**Visibility.** Visibility level of the feedback. It distinguishes the provider-defined visibility state or classification for the feedback.
* **Enables:** Segment feedback entries in Feedbacks by visibility in `feedbacks.visibility`; compare counts only within the same Lattice taxonomy.
* **Interpretation:** Lattice reports visibility as a label from its own taxonomy on each feedback; preserve unknown labels rather than mapping them by assumption. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals`
**Goals.** Goals tracked in Lattice.
* **Enables:** Track provider-recorded goal ownership, dates, status, progress amounts, and parent-child relationships without converting them into a Parable performance score.
* **Scope:** Reads the records selected by Lattice's `/v1/goals` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the Lattice API key's organization access and the provider's privacy controls. Provider-authored ratings, feedback, and classifications must remain in their review context and are not Parable performance judgments. This stream supplies no reliable deletion signal.
Developer identifier: `goals.amountType`
**Amount Type.** Measurement type for goal amounts. It supplies the amount type measure for the goal at the provider's declared unit and grain.
* **Enables:** Segment goal entries in Goals by amount type in `goals.amountType`; compare counts only within the same Lattice taxonomy.
* **Interpretation:** Lattice reports amount type as a label from its own taxonomy on each goal; preserve unknown labels rather than mapping them by assumption. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.archivedAt`
**Archived At.** Unix timestamp when the goal was archived. It anchors the goal on the provider's reported timeline.
* **Enables:** Order Goals by archived at in `goals.archivedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports archived at as a Unix timestamp in a unit not declared by this field on each goal; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.childGoals`
**Child Goals.** Child goals list envelope. It preserves the nested context needed to interpret the parent goal.
* **Enables:** Attribute child goals in `goals.childGoals` to the parent goal; identify parent records where that nested child goals object is absent.
* **Interpretation:** Lattice reports child goals as a nested object on each goal; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.childGoals.data`
**Data.** Envelope data items. It preserves the nested context needed to interpret the parent goal.
* **Enables:** Attribute every returned Lattice object reference in `goals.LatticeOwnersList.data` to its parent goal; keep each relationship distinct and distinguish an absent array from an explicitly empty one.
* **Interpretation:** Lattice returns data as an array of Lattice object reference entries on each Lattice owner-list page; missing, empty, and permission-redacted arrays are not equivalent. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.childGoals.data.id`
**ID.** Referenced object ID. It provides the reference needed to connect the goal to the corresponding provider object.
* **Enables:** Connect each Lattice object reference in Goals to the referenced Lattice object reference through `goals.LatticeObjectReference.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports ID as an identifier in its Lattice object reference namespace; it is not a universal identity outside Lattice. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.childGoals.data.object`
**Object.** Referenced object type. It identifies the related provider object that gives the Lattice object reference its parent, owner, or container context.
* **Enables:** Connect each Lattice object reference to the related object in `goals.LatticeObjectReference.object` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** Lattice reports object as relationship context on each Lattice object reference; resolve it in the named provider namespace rather than by display text alone. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.childGoals.data.url`
**URL.** Referenced object URL. It locates the provider resource or path associated with the Lattice object reference.
* **Enables:** Associate each Lattice object reference with the resource identified by URL in `goals.LatticeObjectReference.url`; verify the link resolves to the expected Lattice object.
* **Interpretation:** Lattice reports URL as a resource locator for each Lattice object reference; access still depends on viewer permissions and the URL may expire or change. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.childGoals.endingCursor`
**Ending Cursor.** Cursor for the next page. It is needed to continue the provider result set without skipping or repeating a page.
* **Enables:** Resume Lattice pagination from `goals.LatticeOwnersList.endingCursor` and verify that every page boundary advances before requesting the next result set.
* **Interpretation:** Lattice returns ending cursor as opaque pagination state; it has no business meaning and must be replayed exactly when requesting the next page. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.childGoals.hasMore`
**Has More.** Whether more pages exist. It is needed to continue the provider result set without skipping or repeating a page.
* **Enables:** Filter Goals by whether more pages exist in `goals.LatticeOwnersList.hasMore`; count true, false, and missing results separately.
* **Interpretation:** Lattice reports more pages exist as a boolean on each Lattice owner-list page; a missing field is unknown, not false. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.childGoals.object`
**Object.** Envelope object type. It distinguishes the provider-defined object state or classification for the Lattice owners list.
* **Enables:** Filter Goals by the exact Lattice-defined object in `goals.LatticeOwnersList.object` and preserve unknown values as distinct categories.
* **Interpretation:** Lattice supplies object from its own taxonomy on each Lattice owners list; preserve unknown and newly introduced labels. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.completedAt`
**Completed At.** Unix timestamp when the goal was completed. It anchors the goal on the provider's reported timeline.
* **Enables:** Filter Goals by completed at in `goals.completedAt`; pair that boundary with the corresponding start before measuring elapsed time.
* **Interpretation:** Lattice reports completed at as a Unix timestamp in a unit not declared by this field on each goal; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.createdAt`
**Created At.** Unix timestamp when the goal was created. It anchors the goal on the provider's reported timeline.
* **Enables:** Order Goals by created at in `goals.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports created at as a Unix timestamp in a unit not declared by this field on each goal; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.currentAmount`
**Current Amount.** Current amount for the goal metric. It supplies the current amount measure for the goal at the provider's declared unit and grain.
* **Enables:** Measure current amount through `goals.currentAmount` for each goal and compare only values with the same unit and record grain.
* **Interpretation:** Lattice reports current amount as a measure on each goal; compare only records with the same unit and aggregation grain. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.department`
**Department.** Department associated with this goal. It preserves the nested context needed to interpret the parent goal.
* **Enables:** Attribute department in `goals.department` to the parent goal; identify parent records where that nested department object is absent.
* **Interpretation:** Lattice reports department as a nested object on each goal; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.description`
**Description.** Goal description. It defines the content surface available for this goal.
* **Enables:** Locate goal records by description in `goals.description`; attribute each text match to its parent goal and, when present, its reported author.
* **Interpretation:** Lattice supplies description as text on each goal; referenced files or media are not implied unless explicitly represented. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.dueDate`
**Due Date.** Goal due date. It anchors the goal on the provider's reported timeline.
* **Enables:** Order Goals by due date in `goals.dueDate` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports due date as a calendar date on each goal; its grain is one day and no time of day should be inferred. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.endingAmount`
**Ending Amount.** Target ending amount for the goal metric. It supplies the ending amount measure for the goal at the provider's declared unit and grain.
* **Enables:** Measure ending amount through `goals.endingAmount` for each goal and compare only values with the same unit and record grain.
* **Interpretation:** Lattice reports ending amount as a measure on each goal; compare only records with the same unit and aggregation grain. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.goalType`
**Goal Type.** Lattice goal type. It distinguishes the provider-defined goal type state or classification for the goal.
* **Enables:** Segment goal entries in Goals by goal type in `goals.goalType`; compare counts only within the same Lattice taxonomy.
* **Interpretation:** Lattice reports goal type as a label from its own taxonomy on each goal; preserve unknown labels rather than mapping them by assumption. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.id`
**ID.** Unique goal identifier. It provides the reference needed to connect the goal to the corresponding provider object.
* **Enables:** Match repeated goal entries on ID in `goals.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Lattice reports ID as an identifier in its goal namespace; it is not a universal identity outside Lattice. The connector explicitly marks this field as a transform deduplication key. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.isPrivate`
**Is Private.** Whether the goal is private. It distinguishes the provider-defined is private state or classification for the goal.
* **Enables:** Filter Goals by whether the goal is private in `goals.isPrivate`; count true, false, and missing results separately.
* **Interpretation:** Lattice reports the goal is private as a boolean on each goal; a missing field is unknown, not false. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.lastUpdatedAt`
**Last Updated At.** Unix timestamp when the goal was last updated by Lattice. It anchors the goal on the provider's reported timeline.
* **Enables:** Order Goals by last updated at in `goals.lastUpdatedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports last updated at as a Unix timestamp in seconds on each goal; derive timezone display separately and do not guess an undeclared unit. A connector directive uses this field to order records for latest-state or incremental processing. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.name`
**Name.** Goal display name. It gives the goal a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each goal with name from `goals.name`; distinguish records that share that display name but have different Lattice identifiers.
* **Interpretation:** Lattice reports name as display text for each goal; names are mutable and are not stable identities. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.owners`
**Owners.** Owners list envelope for this goal. It preserves the nested context needed to interpret the parent goal.
* **Enables:** Attribute owners in `goals.owners` to the parent goal; identify parent records where that nested owners object is absent.
* **Interpretation:** Lattice reports owners as a nested object on each goal; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.parentGoal`
**Parent Goal.** Parent goal reference, if any. It preserves the nested context needed to interpret the parent goal.
* **Enables:** Attribute parent goal in `goals.parentGoal` to the parent goal; identify parent records where that nested parent goal object is absent.
* **Interpretation:** Lattice reports parent goal as a nested object on each goal; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.priority`
**Priority.** Priority assigned to the goal. It supplies the priority measure for the goal at the provider's declared unit and grain.
* **Enables:** Segment goal entries in Goals by priority in `goals.priority`; compare counts only within the same Lattice taxonomy.
* **Interpretation:** Lattice reports priority as a label from its own taxonomy on each goal; preserve unknown labels rather than mapping them by assumption. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.publishedAt`
**Published At.** Unix timestamp when the goal was published. It anchors the goal on the provider's reported timeline.
* **Enables:** Order Goals by published at in `goals.publishedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports published at as a Unix timestamp in a unit not declared by this field on each goal; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.startDate`
**Start Date.** Goal start date. It anchors the goal on the provider's reported timeline.
* **Enables:** Filter Goals by start date in `goals.startDate`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** Lattice reports start date as a calendar date on each goal; its grain is one day and no time of day should be inferred. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.startingAmount`
**Starting Amount.** Starting amount for the goal metric. It supplies the starting amount measure for the goal at the provider's declared unit and grain.
* **Enables:** Measure starting amount through `goals.startingAmount` for each goal and compare only values with the same unit and record grain.
* **Interpretation:** Lattice reports starting amount as a measure on each goal; compare only records with the same unit and aggregation grain. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.state`
**State.** Current lifecycle state of the goal. It distinguishes the provider-defined state state or classification for the goal.
* **Enables:** Segment goal entries in Goals by state in `goals.state`; compare counts only within the same Lattice taxonomy.
* **Interpretation:** Lattice reports state as a label from its own taxonomy on each goal; preserve unknown labels rather than mapping them by assumption. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.status`
**Status.** Current goal status. It distinguishes the provider-defined status state or classification for the goal.
* **Enables:** Segment goal entries in Goals by status in `goals.status`; compare counts only within the same Lattice taxonomy.
* **Interpretation:** Lattice reports status as a label from its own taxonomy on each goal; preserve unknown labels rather than mapping them by assumption. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.tags`
**Tags.** Tags list envelope. It preserves the nested context needed to interpret the parent goal.
* **Enables:** Attribute tags in `goals.tags` to the parent goal; identify parent records where that nested tags object is absent.
* **Interpretation:** Lattice reports tags as a nested object on each goal; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.updatedAt`
**Updated At.** Unix timestamp when the goal was last updated. It anchors the goal on the provider's reported timeline.
* **Enables:** Order Goals by updated at in `goals.updatedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports updated at as a Unix timestamp in a unit not declared by this field on each goal; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `goals.url`
**URL.** URL for the goal in Lattice. It locates the provider resource or path associated with the goal.
* **Enables:** Associate each goal with the resource identified by URL in `goals.url`; verify the link resolves to the expected Lattice object.
* **Interpretation:** Lattice reports URL as a resource locator for each goal; access still depends on viewer permissions and the URL may expire or change. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `review_cycles`
**Review Cycles.** Performance review cycles in Lattice.
* **Enables:** Track review-cycle scheduling, stage, and completion without treating provider ratings as Parable performance judgments.
* **Scope:** Reads the records selected by Lattice's `/v1/reviewCycles` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the Lattice API key's organization access and the provider's privacy controls. Provider-authored ratings, feedback, and classifications must remain in their review context and are not Parable performance judgments. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `review_cycles.autocalculatedWeightedScoresEnabled`
**Autocalculated Weighted Scores Enabled.** Whether auto-calculated weighted scores are enabled. It distinguishes the provider-defined autocalculated weighted scores enabled state or classification for the review cycle.
* **Enables:** Filter Review Cycles by whether auto-calculated weighted scores are enabled in `review_cycles.autocalculatedWeightedScoresEnabled`; count true, false, and missing results separately.
* **Interpretation:** Lattice reports auto-calculated weighted scores are enabled as a boolean on each review cycle; a missing field is unknown, not false. This is provider-authored review context, not an independent Parable assessment of employee performance. The provider's scale can vary by question or cycle, so values must not be compared across unlike review contexts.
Developer identifier: `review_cycles.createdAt`
**Created At.** Unix timestamp when the review cycle was created. It anchors the review cycle on the provider's reported timeline.
* **Enables:** Order Review Cycles by created at in `review_cycles.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports created at as a Unix timestamp in a unit not declared by this field on each review cycle; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `review_cycles.creator`
**Creator.** User who created this review cycle. It preserves the nested context needed to interpret the parent review cycle.
* **Enables:** Attribute creator in `review_cycles.creator` to the parent review cycle; identify parent records where that nested creator object is absent.
* **Interpretation:** Lattice reports creator as a nested object on each review cycle; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `review_cycles.creator.id`
**ID.** Creator user ID. It provides the reference needed to connect the review cycle to the corresponding provider object.
* **Enables:** Connect each Lattice review cycle creator in Review Cycles to the referenced Lattice review cycle creator through `review_cycles.LatticeReviewCycleCreator.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports ID as an identifier in its Lattice review cycle creator namespace; it is not a universal identity outside Lattice. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `review_cycles.endDate`
**End Date.** Review cycle end date. It anchors the review cycle on the provider's reported timeline.
* **Enables:** Filter Review Cycles by end date in `review_cycles.endDate`; pair that boundary with the corresponding start before measuring elapsed time.
* **Interpretation:** Lattice reports end date as a calendar date on each review cycle; its grain is one day and no time of day should be inferred. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `review_cycles.id`
**ID.** Unique review cycle identifier. It provides the reference needed to connect the review cycle to the corresponding provider object.
* **Enables:** Match repeated review cycle entries on ID in `review_cycles.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Lattice reports ID as an identifier in its review cycle namespace; it is not a universal identity outside Lattice. The connector explicitly marks this field as a transform deduplication key. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `review_cycles.name`
**Name.** Review cycle name. It gives the review cycle a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each review cycle with name from `review_cycles.name`; distinguish records that share that display name but have different Lattice identifiers.
* **Interpretation:** Lattice reports name as display text for each review cycle; names are mutable and are not stable identities. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `review_cycles.peerSelectionStartedAt`
**Peer Selection Started At.** Unix timestamp when peer selection started. It anchors the review cycle on the provider's reported timeline.
* **Enables:** Order Review Cycles by peer selection started at in `review_cycles.peerSelectionStartedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports peer selection started at as a Unix timestamp in a unit not declared by this field on each review cycle; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `review_cycles.reviewsEndedAt`
**Reviews Ended At.** Unix timestamp when reviews ended. It anchors the review cycle on the provider's reported timeline.
* **Enables:** Order Review Cycles by reviews ended at in `review_cycles.reviewsEndedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports reviews ended at as a Unix timestamp in a unit not declared by this field on each review cycle; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `review_cycles.reviewsStartedAt`
**Reviews Started At.** Unix timestamp when reviews started. It anchors the review cycle on the provider's reported timeline.
* **Enables:** Order Review Cycles by reviews started at in `review_cycles.reviewsStartedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports reviews started at as a Unix timestamp in a unit not declared by this field on each review cycle; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `review_cycles.reviewType`
**Review Type.** Type of review cycle. It distinguishes the provider-defined review type state or classification for the review cycle.
* **Enables:** Segment review cycle entries in Review Cycles by review type in `review_cycles.reviewType`; compare counts only within the same Lattice taxonomy.
* **Interpretation:** Lattice reports review type as a label from its own taxonomy on each review cycle; preserve unknown labels rather than mapping them by assumption. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `review_cycles.stage`
**Stage.** Current stage of the review cycle. It distinguishes the provider-defined stage state or classification for the review cycle.
* **Enables:** Filter Review Cycles by the exact Lattice-defined stage in `review_cycles.stage` and preserve unknown values as distinct categories.
* **Interpretation:** Lattice supplies stage from its own taxonomy on each review cycle; preserve unknown and newly introduced labels. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `review_cycles.startDate`
**Start Date.** Review cycle start date. It anchors the review cycle on the provider's reported timeline.
* **Enables:** Filter Review Cycles by start date in `review_cycles.startDate`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** Lattice reports start date as a calendar date on each review cycle; its grain is one day and no time of day should be inferred. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `review_cycles.status`
**Status.** Review cycle status. It distinguishes the provider-defined status state or classification for the review cycle.
* **Enables:** Segment review cycle entries in Review Cycles by status in `review_cycles.status`; compare counts only within the same Lattice taxonomy.
* **Interpretation:** Lattice reports status as a label from its own taxonomy on each review cycle; preserve unknown labels rather than mapping them by assumption. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `review_cycles.updatedAt`
**Updated At.** Unix timestamp when the review cycle was last updated. It anchors the review cycle on the provider's reported timeline.
* **Enables:** Order Review Cycles by updated at in `review_cycles.updatedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports updated at as a Unix timestamp in seconds on each review cycle; derive timezone display separately and do not guess an undeclared unit. A connector directive uses this field to order records for latest-state or incremental processing. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews`
**Reviews.** Individual reviews within a review cycle.
* **Enables:** Match each submitted review response to its cycle, question, reviewer, and reviewee for workflow completeness checks.
* **Scope:** Reads the records selected by Lattice's `/v1/reviewCycle/{review_cycle_id}/reviews` operation as a snapshot stream using incremental synchronization. This stream is opt-in. Visibility follows the Lattice API key's organization access and the provider's privacy controls. Provider-authored ratings, feedback, and classifications must remain in their review context and are not Parable performance judgments. This stream supplies no reliable deletion signal.
Developer identifier: `reviews.calibratedResponse`
**Calibrated Response.** Calibrated response provided for this review question. It preserves the nested context needed to interpret the parent review.
* **Enables:** Attribute calibrated response in `reviews.calibratedResponse` to the parent review; identify parent records where that nested calibrated response object is absent.
* **Interpretation:** Lattice reports calibrated response as a nested object on each review; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.calibratedResponse.choices`
**Choices.** Selected choice strings for multi-choice/select questions; null otherwise. It preserves the nested context needed to interpret the parent review.
* **Enables:** Compare the exact Lattice-configured choices set in `reviews.LatticeReviewResponse.choices` for each Lattice review response; preserve provider labels and unknown entries.
* **Interpretation:** Lattice returns choices as an array of choice value entries on each Lattice review response; missing, empty, and permission-redacted arrays are not equivalent. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.calibratedResponse.comment`
**Comment.** Free-form review comment. It defines the content surface available for this review.
* **Enables:** Locate Lattice review response records by comment in `reviews.LatticeReviewResponse.comment`; attribute each text match to its parent review and, when present, its reported author.
* **Interpretation:** Lattice supplies comment as text on each Lattice review response; referenced files or media are not implied unless explicitly represented. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.calibratedResponse.commentSentiment`
**Comment Sentiment.** Sentiment score for the review comment. It defines the content surface available for this review.
* **Enables:** Locate Lattice review response records by comment sentiment in `reviews.LatticeReviewResponse.commentSentiment`; attribute each text match to its parent review and, when present, its reported author.
* **Interpretation:** Lattice supplies comment sentiment as text on each Lattice review response; referenced files or media are not implied unless explicitly represented. This is provider-authored review context, not an independent Parable assessment of employee performance. The provider's scale can vary by question or cycle, so values must not be compared across unlike review contexts.
Developer identifier: `reviews.calibratedResponse.createdAt`
**Created At.** Unix timestamp when the response was created. It anchors the review on the provider's reported timeline.
* **Enables:** Order Reviews by created at in `reviews.LatticeReviewResponse.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports created at as a Unix timestamp in a unit not declared by this field on each Lattice review response; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.calibratedResponse.rating`
**Rating.** Numeric rating for the review question. It supplies the returned rating text needed to understand the Lattice review response in context.
* **Enables:** Search the returned rating text in `reviews.LatticeReviewResponse.rating` and attribute each match to its parent review and reported author when available.
* **Interpretation:** Lattice supplies rating as returned text on each Lattice review response; truncation, formatting, and access boundaries can limit completeness. This is provider-authored review context, not an independent Parable assessment of employee performance. The provider's scale can vary by question or cycle, so values must not be compared across unlike review contexts.
Developer identifier: `reviews.calibratedResponse.ratingString`
**Rating String.** Numeric rating as a display string. It supplies the rating string measure for the Lattice review response at the provider's declared unit and grain.
* **Enables:** Measure rating string through `reviews.LatticeReviewResponse.ratingString` for each Lattice review response and compare only values with the same unit and record grain.
* **Interpretation:** Lattice reports rating string as a measure on each Lattice review response; compare only records with the same unit and aggregation grain. This is provider-authored review context, not an independent Parable assessment of employee performance. The provider's scale can vary by question or cycle, so values must not be compared across unlike review contexts.
Developer identifier: `reviews.calibratedResponse.updatedAt`
**Updated At.** Unix timestamp when the response was last updated. It anchors the review on the provider's reported timeline.
* **Enables:** Order Reviews by updated at in `reviews.LatticeReviewResponse.updatedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports updated at as a Unix timestamp in a unit not declared by this field on each Lattice review response; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.calibrationEnded`
**Calibration Ended.** Whether the calibration phase has ended. It distinguishes the provider-defined calibration ended state or classification for the review.
* **Enables:** Filter Reviews by whether the calibration phase has ended in `reviews.calibrationEnded`; count true, false, and missing results separately.
* **Interpretation:** Lattice reports the calibration phase has ended as a boolean on each review; a missing field is unknown, not false. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.competency`
**Competency.** Competency referenced by this review question. It preserves the nested context needed to interpret the parent review.
* **Enables:** Attribute competency in `reviews.competency` to the parent review; identify parent records where that nested competency object is absent.
* **Interpretation:** Lattice reports competency as a nested object on each review; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.competency.id`
**ID.** Referenced object ID. It provides the reference needed to connect the review to the corresponding provider object.
* **Enables:** Connect each Lattice review object reference in Reviews to the referenced Lattice review object reference through `reviews.LatticeReviewObjectReference.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports ID as an identifier in its Lattice review object reference namespace; it is not a universal identity outside Lattice. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.competency.object`
**Object.** Referenced object type. It identifies the related provider object that gives the Lattice review object reference its parent, owner, or container context.
* **Enables:** Connect each Lattice review object reference to the related object in `reviews.LatticeReviewObjectReference.object` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** Lattice reports object as relationship context on each Lattice review object reference; resolve it in the named provider namespace rather than by display text alone. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.competency.url`
**URL.** Referenced object URL. It locates the provider resource or path associated with the Lattice review object reference.
* **Enables:** Associate each Lattice review object reference with the resource identified by URL in `reviews.LatticeReviewObjectReference.url`; verify the link resolves to the expected Lattice object.
* **Interpretation:** Lattice reports URL as a resource locator for each Lattice review object reference; access still depends on viewer permissions and the URL may expire or change. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.createdAt`
**Created At.** Unix timestamp when the review was created. It anchors the review on the provider's reported timeline.
* **Enables:** Order Reviews by created at in `reviews.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports created at as a Unix timestamp in a unit not declared by this field on each review; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.declinedAt`
**Declined At.** Unix timestamp when the reviewer declined the review. It anchors the review on the provider's reported timeline.
* **Enables:** Order Reviews by declined at in `reviews.declinedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports declined at as a Unix timestamp in a unit not declared by this field on each review; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.goal`
**Goal.** Goal referenced by this review question. It preserves the nested context needed to interpret the parent review.
* **Enables:** Attribute goal in `reviews.goal` to the parent review; identify parent records where that nested goal object is absent.
* **Interpretation:** Lattice reports goal as a nested object on each review; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.id`
**ID.** Unique review identifier. It provides the reference needed to connect the review to the corresponding provider object.
* **Enables:** Match repeated review entries on ID in `reviews.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Lattice reports ID as an identifier in its review namespace; it is not a universal identity outside Lattice. The connector explicitly marks this field as a transform deduplication key. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.isMostRecentDownwardReview`
**Is Most Recent Downward Review.** Whether this is the most recent downward review for the reviewee in this cycle. It distinguishes the provider-defined is most recent downward review state or classification for the review.
* **Enables:** Filter Reviews by whether this is the most recent downward review for the reviewee in this cycle in `reviews.isMostRecentDownwardReview`; count true, false, and missing results separately.
* **Interpretation:** Lattice reports this is the most recent downward review for the reviewee in this cycle as a boolean on each review; a missing field is unknown, not false. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.overall`
**Overall.** Overall rating and comment. It preserves the nested context needed to interpret the parent review.
* **Enables:** Attribute overall in `reviews.overall` to the parent review; identify parent records where that nested overall object is absent.
* **Interpretation:** Lattice reports overall as a nested object on each review; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance. The provider's scale can vary by question or cycle, so values must not be compared across unlike review contexts.
Developer identifier: `reviews.overall.comment`
**Comment.** Overall review comment. It defines the content surface available for this review.
* **Enables:** Locate Lattice review overall records by comment in `reviews.LatticeReviewOverall.comment`; attribute each text match to its parent review and, when present, its reported author.
* **Interpretation:** Lattice supplies comment as text on each Lattice review overall; referenced files or media are not implied unless explicitly represented. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.overall.rating`
**Rating.** Overall rating value. It supplies the rating measure for the Lattice review overall at the provider's declared unit and grain.
* **Enables:** Measure rating through `reviews.LatticeReviewOverall.rating` for each Lattice review overall and compare only values with the same unit and record grain.
* **Interpretation:** Lattice reports rating as a measure on each Lattice review overall; compare only records with the same unit and aggregation grain. This is provider-authored review context, not an independent Parable assessment of employee performance. The provider's scale can vary by question or cycle, so values must not be compared across unlike review contexts.
Developer identifier: `reviews.question`
**Question.** Base question being answered. It preserves the nested context needed to interpret the parent review.
* **Enables:** Attribute question in `reviews.question` to the parent review; identify parent records where that nested question object is absent.
* **Interpretation:** Lattice reports question as a nested object on each review; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.questionRevision`
**Question Revision.** Specific question revision being answered. It preserves the nested context needed to interpret the parent review.
* **Enables:** Attribute question revision in `reviews.questionRevision` to the parent review; identify parent records where that nested question revision object is absent.
* **Interpretation:** Lattice reports question revision as a nested object on each review; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.response`
**Response.** Response provided by the reviewer. It preserves the nested context needed to interpret the parent review.
* **Enables:** Attribute response in `reviews.response` to the parent review; identify parent records where that nested response object is absent.
* **Interpretation:** Lattice reports response as a nested object on each review; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.review_cycle_id`
**Review Cycle ID.** Parent review cycle reference copied into each review because the child operation does not return that relationship. It provides the reference needed to connect the review to the corresponding provider object.
* **Enables:** Connect each review in Reviews to the referenced review cycle through `reviews.review_cycle_id`; flag review cycle ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies review cycle ID from the parent traversal record into each review; the child Lattice operation does not return it. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.reviewCycleId`
**Review Cycle ID.** ID of the review cycle this review belongs to. It provides the reference needed to connect the review to the corresponding provider object.
* **Enables:** Connect each review in Reviews to the referenced review cycle through `reviews.reviewCycleId`; flag review cycle ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports review cycle ID as an identifier in its review cycle namespace; it is not a universal identity outside Lattice. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.reviewee`
**Reviewee.** User being reviewed. It preserves the nested context needed to interpret the parent review.
* **Enables:** Attribute reviewee in `reviews.reviewee` to the parent review; identify parent records where that nested reviewee object is absent.
* **Interpretation:** Lattice reports reviewee as a nested object on each review; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.revieweeId`
**Reviewee ID.** ID of the user being reviewed. It provides the reference needed to connect the review to the corresponding provider object.
* **Enables:** Connect each review in Reviews to the referenced reviewee through `reviews.revieweeId`; flag reviewee ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports reviewee ID as an identifier in its reviewee namespace; it is not a universal identity outside Lattice. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.reviewer`
**Reviewer.** User writing the review. It preserves the nested context needed to interpret the parent review.
* **Enables:** Attribute reviewer in `reviews.reviewer` to the parent review; identify parent records where that nested reviewer object is absent.
* **Interpretation:** Lattice reports reviewer as a nested object on each review; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.reviewerId`
**Reviewer ID.** ID of the user performing the review. It provides the reference needed to connect the review to the corresponding provider object.
* **Enables:** Connect each review in Reviews to the referenced reviewer through `reviews.reviewerId`; flag reviewer ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports reviewer ID as an identifier in its reviewer namespace; it is not a universal identity outside Lattice. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.reviewType`
**Review Type.** Review direction or type. It distinguishes the provider-defined review type state or classification for the review.
* **Enables:** Segment review entries in Reviews by review type in `reviews.reviewType`; compare counts only within the same Lattice taxonomy.
* **Interpretation:** Lattice reports review type as a label from its own taxonomy on each review; preserve unknown labels rather than mapping them by assumption. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.status`
**Status.** Review status. It distinguishes the provider-defined status state or classification for the review.
* **Enables:** Segment review entries in Reviews by status in `reviews.status`; compare counts only within the same Lattice taxonomy.
* **Interpretation:** Lattice reports status as a label from its own taxonomy on each review; preserve unknown labels rather than mapping them by assumption. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.submittedAt`
**Submitted At.** Unix timestamp when the review was submitted. It anchors the review on the provider's reported timeline.
* **Enables:** Order Reviews by submitted at in `reviews.submittedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports submitted at as a Unix timestamp in a unit not declared by this field on each review; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `reviews.updatedAt`
**Updated At.** Unix timestamp when the review was last updated. It anchors the review on the provider's reported timeline.
* **Enables:** Order Reviews by updated at in `reviews.updatedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports updated at as a Unix timestamp in seconds on each review; derive timezone display separately and do not guess an undeclared unit. A connector directive uses this field to order records for latest-state or incremental processing. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks`
**Tasks.** Tasks assigned to users in Lattice.
* **Enables:** Match assigned tasks to the user, review cycle or feedback request, status, and due date that created the work item.
* **Scope:** Reads the records selected by Lattice's `/v1/user/{user_id}/tasks` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the Lattice API key's organization access and the provider's privacy controls. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `tasks.assignee`
**Assignee.** User assigned to this task. It preserves the nested context needed to interpret the parent task.
* **Enables:** Attribute assignee in `tasks.assignee` to the parent task; identify parent records where that nested assignee object is absent.
* **Interpretation:** Lattice reports assignee as a nested object on each task; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.assignee.email`
**Email.** Assignee email address. It supplies the provider-reported address or location facet for the Lattice task assignee, not a residency determination.
* **Enables:** Attribute each Lattice task assignee to a person or account by the exact email in `tasks.LatticeTaskAssignee.email`; identify addresses that do not match the Lattice directory.
* **Interpretation:** Lattice reports email as an address on each Lattice task assignee; aliases, casing, and unverified addresses can prevent a one-to-one person match. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.assignee.id`
**ID.** Assignee user ID. It provides the reference needed to connect the task to the corresponding provider object.
* **Enables:** Connect each Lattice task assignee in Tasks to the referenced Lattice task assignee through `tasks.LatticeTaskAssignee.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports ID as an identifier in its Lattice task assignee namespace; it is not a universal identity outside Lattice. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.assignee.name`
**Name.** Assignee display name. It gives the Lattice task assignee a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each Lattice task assignee with name from `tasks.LatticeTaskAssignee.name`; distinguish records that share that display name but have different Lattice identifiers.
* **Interpretation:** Lattice reports name as display text for each Lattice task assignee; names are mutable and are not stable identities. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.body`
**Body.** Task body text. It defines the content surface available for this task.
* **Enables:** Locate task records by body in `tasks.body`; attribute each text match to its parent task and, when present, its reported author.
* **Interpretation:** Lattice supplies body as text on each task; referenced files or media are not implied unless explicitly represented. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.completedAt`
**Completed At.** Unix timestamp when the task was completed. It anchors the task on the provider's reported timeline.
* **Enables:** Filter Tasks by completed at in `tasks.completedAt`; pair that boundary with the corresponding start before measuring elapsed time.
* **Interpretation:** Lattice reports completed at as a Unix timestamp in a unit not declared by this field on each task; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.completeRequestsCount`
**Completion Requests Count.** Number of completed requests represented by the task. It supplies the completion requests count measure for the task at the provider's declared unit and grain.
* **Enables:** Measure completion requests count through `tasks.completeRequestsCount` for each task and compare only values with the same unit and record grain.
* **Interpretation:** Lattice reports completion requests count as a measure on each task; compare only records with the same unit and aggregation grain. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.createdAt`
**Created At.** Unix timestamp when the task was created. It anchors the task on the provider's reported timeline.
* **Enables:** Order Tasks by created at in `tasks.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports created at as a Unix timestamp in a unit not declared by this field on each task; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.dueAt`
**Due At.** Timestamp when the task is due. It anchors the task on the provider's reported timeline.
* **Enables:** Order Tasks by due at in `tasks.dueAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports due at as a timestamp on each task; timezone and precision follow this API field, and absence is not an inferred event time. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.dueDate`
**Due Date.** Task due date. It anchors the task on the provider's reported timeline.
* **Enables:** Order Tasks by due date in `tasks.dueDate` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports due date as a calendar date on each task; its grain is one day and no time of day should be inferred. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.feedbackRequest`
**Feedback Request.** Feedback request associated with this task. It preserves the nested context needed to interpret the parent task.
* **Enables:** Attribute feedback request in `tasks.feedbackRequest` to the parent task; identify parent records where that nested feedback request object is absent.
* **Interpretation:** Lattice reports feedback request as a nested object on each task; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.feedbackRequest.author`
**Author.** Author of the feedback request. It preserves the nested context needed to interpret the parent task.
* **Enables:** Attribute author in `tasks.LatticeTaskFeedbackRequest.author` to the parent task; identify parent records where that nested author object is absent.
* **Interpretation:** Lattice reports author as a nested object on each Lattice task feedback request; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.feedbackRequest.createdAt`
**Created At.** Unix timestamp when the feedback request was created. It anchors the task on the provider's reported timeline.
* **Enables:** Order Tasks by created at in `tasks.LatticeTaskFeedbackRequest.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports created at as a Unix timestamp in a unit not declared by this field on each Lattice task feedback request; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.feedbackRequest.fulfilledAt`
**Fulfilled At.** Unix timestamp when the feedback request was fulfilled. It anchors the task on the provider's reported timeline.
* **Enables:** Order Tasks by fulfilled at in `tasks.LatticeTaskFeedbackRequest.fulfilledAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports fulfilled at as a Unix timestamp in a unit not declared by this field on each Lattice task feedback request; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.feedbackRequest.subject`
**Subject.** Subject of the feedback request. It preserves the nested context needed to interpret the parent task.
* **Enables:** Attribute subject in `tasks.LatticeTaskFeedbackRequest.subject` to the parent task; identify parent records where that nested subject object is absent.
* **Interpretation:** Lattice reports subject as a nested object on each Lattice task feedback request; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.feedbackRequest.target`
**Target.** Target of the feedback request. It preserves the nested context needed to interpret the parent task.
* **Enables:** Attribute target in `tasks.LatticeTaskFeedbackRequest.target` to the parent task; identify parent records where that nested target object is absent.
* **Interpretation:** Lattice reports target as a nested object on each Lattice task feedback request; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.id`
**ID.** Unique task identifier. It provides the reference needed to connect the task to the corresponding provider object.
* **Enables:** Match repeated task entries on ID in `tasks.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Lattice reports ID as an identifier in its task namespace; it is not a universal identity outside Lattice. The connector explicitly marks this field as a transform deduplication key. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.reviewCycle`
**Review Cycle.** Review cycle associated with this task. It preserves the nested context needed to interpret the parent task.
* **Enables:** Attribute review cycle in `tasks.reviewCycle` to the parent task; identify parent records where that nested review cycle object is absent.
* **Interpretation:** Lattice reports review cycle as a nested object on each task; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.reviewCycle.createdAt`
**Created At.** Unix timestamp when the review cycle was created. It anchors the task on the provider's reported timeline.
* **Enables:** Order Tasks by created at in `tasks.LatticeTaskReviewCycle.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports created at as a Unix timestamp in a unit not declared by this field on each Lattice task review cycle; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.reviewCycle.creator`
**Creator.** User who created the review cycle. It preserves the nested context needed to interpret the parent task.
* **Enables:** Attribute creator in `tasks.LatticeTaskReviewCycle.creator` to the parent task; identify parent records where that nested creator object is absent.
* **Interpretation:** Lattice reports creator as a nested object on each Lattice task review cycle; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.reviewCycle.id`
**ID.** Review cycle ID. It provides the reference needed to connect the task to the corresponding provider object.
* **Enables:** Connect each Lattice task review cycle in Tasks to the referenced Lattice task review cycle through `tasks.LatticeTaskReviewCycle.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports ID as an identifier in its Lattice task review cycle namespace; it is not a universal identity outside Lattice. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.reviewCycle.name`
**Name.** Review cycle name. It gives the Lattice task review cycle a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each Lattice task review cycle with name from `tasks.LatticeTaskReviewCycle.name`; distinguish records that share that display name but have different Lattice identifiers.
* **Interpretation:** Lattice reports name as display text for each Lattice task review cycle; names are mutable and are not stable identities. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.reviewCycle.stage`
**Stage.** Review cycle stage. It distinguishes the provider-defined stage state or classification for the Lattice task review cycle.
* **Enables:** Filter Tasks by the exact Lattice-defined stage in `tasks.LatticeTaskReviewCycle.stage` and preserve unknown values as distinct categories.
* **Interpretation:** Lattice supplies stage from its own taxonomy on each Lattice task review cycle; preserve unknown and newly introduced labels. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.reviewCycle.updatedAt`
**Updated At.** Unix timestamp when the review cycle was last updated. It anchors the task on the provider's reported timeline.
* **Enables:** Order Tasks by updated at in `tasks.LatticeTaskReviewCycle.updatedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports updated at as a Unix timestamp in a unit not declared by this field on each Lattice task review cycle; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.status`
**Status.** Task status. It distinguishes the provider-defined status state or classification for the task.
* **Enables:** Segment task entries in Tasks by status in `tasks.status`; compare counts only within the same Lattice taxonomy.
* **Interpretation:** Lattice reports status as a label from its own taxonomy on each task; preserve unknown labels rather than mapping them by assumption. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.title`
**Title.** Task title. It gives the task a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each task with title from `tasks.title`; distinguish records that share that display name but have different Lattice identifiers.
* **Interpretation:** Lattice reports title as display text for each task; names are mutable and are not stable identities. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.totalRequestsCount`
**Total Requests Count.** Total number of requests represented by the task. It supplies the total requests count measure for the task at the provider's declared unit and grain.
* **Enables:** Measure total requests count through `tasks.totalRequestsCount` for each task and compare only values with the same unit and record grain.
* **Interpretation:** Lattice reports total requests count as a measure on each task; compare only records with the same unit and aggregation grain. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.type`
**Type.** Lattice task type. It distinguishes the provider-defined type state or classification for the task.
* **Enables:** Segment task entries in Tasks by type in `tasks.type`; compare counts only within the same Lattice taxonomy.
* **Interpretation:** Lattice reports type as a label from its own taxonomy on each task; preserve unknown labels rather than mapping them by assumption. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.updatedAt`
**Updated At.** Unix timestamp when the task was last updated. It anchors the task on the provider's reported timeline.
* **Enables:** Order Tasks by updated at in `tasks.updatedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports updated at as a Unix timestamp in seconds on each task; derive timezone display separately and do not guess an undeclared unit. A connector directive uses this field to order records for latest-state or incremental processing. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `tasks.user_id`
**User ID.** Parent user reference copied into each task because the child operation does not return that relationship. It provides the reference needed to connect the task to the corresponding provider object.
* **Enables:** Connect each task in Tasks to the referenced user through `tasks.user_id`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies user ID from the parent traversal record into each task; the child Lattice operation does not return it. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates`
**Updates.** Goal updates and check-ins.
* **Enables:** Match check-in responses and provider-recorded sentiment fields to the relevant update and author.
* **Scope:** Reads the records selected by Lattice's `/v1/updates` operation as a changelog stream using incremental synchronization. This stream is opt-in. Visibility follows the Lattice API key's organization access and the provider's privacy controls. Provider-authored ratings, feedback, and classifications must remain in their review context and are not Parable performance judgments. This stream supplies no reliable deletion signal.
Developer identifier: `updates.author`
**Author.** Author ObjectReference for this update. It preserves the nested context needed to interpret the parent update.
* **Enables:** Attribute author in `updates.author` to the parent update; identify parent records where that nested author object is absent.
* **Interpretation:** Lattice reports author as a nested object on each update; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.author.id`
**ID.** Referenced object ID. It provides the reference needed to connect the update to the corresponding provider object.
* **Enables:** Connect each Lattice object reference in Updates to the referenced Lattice object reference through `updates.LatticeObjectReference.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports ID as an identifier in its Lattice object reference namespace; it is not a universal identity outside Lattice. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.author.object`
**Object.** Referenced object type. It identifies the related provider object that gives the Lattice object reference its parent, owner, or container context.
* **Enables:** Connect each Lattice object reference to the related object in `updates.LatticeObjectReference.object` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** Lattice reports object as relationship context on each Lattice object reference; resolve it in the named provider namespace rather than by display text alone. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.author.url`
**URL.** Referenced object URL. It locates the provider resource or path associated with the Lattice object reference.
* **Enables:** Associate each Lattice object reference with the resource identified by URL in `updates.LatticeObjectReference.url`; verify the link resolves to the expected Lattice object.
* **Interpretation:** Lattice reports URL as a resource locator for each Lattice object reference; access still depends on viewer permissions and the URL may expire or change. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.createdAt`
**Created At.** Unix timestamp when the update was created. It anchors the update on the provider's reported timeline.
* **Enables:** Order Updates by created at in `updates.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports created at as a Unix timestamp in a unit not declared by this field on each update; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.id`
**ID.** Unique update identifier. It provides the reference needed to connect the update to the corresponding provider object.
* **Enables:** Match repeated update entries on ID in `updates.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Lattice reports ID as an identifier in its update namespace; it is not a universal identity outside Lattice. The connector explicitly marks this field as a transform deduplication key. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.isPublic`
**Is Public.** Whether the update is publicly visible. It distinguishes the provider-defined is public state or classification for the update.
* **Enables:** Filter Updates by whether the update is publicly visible in `updates.isPublic`; count true, false, and missing results separately.
* **Interpretation:** Lattice reports the update is publicly visible as a boolean on each update; a missing field is unknown, not false. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.manager`
**Manager.** Manager ObjectReference for this update. It preserves the nested context needed to interpret the parent update.
* **Enables:** Attribute manager in `updates.manager` to the parent update; identify parent records where that nested manager object is absent.
* **Interpretation:** Lattice reports manager as a nested object on each update; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.publishedAt`
**Published At.** Unix timestamp when the update was published. It anchors the update on the provider's reported timeline.
* **Enables:** Order Updates by published at in `updates.publishedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports published at as a Unix timestamp in seconds on each update; derive timezone display separately and do not guess an undeclared unit. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.responses`
**Responses.** Check-in question/answer responses envelope. It preserves the nested context needed to interpret the parent update.
* **Enables:** Attribute responses in `updates.responses` to the parent update; identify parent records where that nested responses object is absent.
* **Interpretation:** Lattice reports responses as a nested object on each update; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.responses.data`
**Data.** Envelope data items. It preserves the nested context needed to interpret the parent update.
* **Enables:** Attribute every returned Lattice update response item in `updates.LatticeUpdateResponsesList.data` to its parent update; keep each relationship distinct and distinguish an absent array from an explicitly empty one.
* **Interpretation:** Lattice returns data as an array of Lattice update response item entries on each Lattice response-list page; missing, empty, and permission-redacted arrays are not equivalent. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.responses.data.answer`
**Answer.** Answer text. It defines the content surface available for this update.
* **Enables:** Locate Lattice update response item records by answer in `updates.LatticeUpdateResponseItem.answer`; attribute each text match to its parent update and, when present, its reported author.
* **Interpretation:** Lattice supplies answer as text on each Lattice update response item; referenced files or media are not implied unless explicitly represented. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.responses.data.id`
**ID.** Response item ID. It provides the reference needed to connect the update to the corresponding provider object.
* **Enables:** Connect each Lattice update response item in Updates to the referenced Lattice update response item through `updates.LatticeUpdateResponseItem.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports ID as an identifier in its Lattice update response item namespace; it is not a universal identity outside Lattice. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.responses.data.object`
**Object.** Object type. It distinguishes the provider-defined object state or classification for the Lattice update response item.
* **Enables:** Filter Updates by the exact Lattice-defined object in `updates.LatticeUpdateResponseItem.object` and preserve unknown values as distinct categories.
* **Interpretation:** Lattice supplies object from its own taxonomy on each Lattice update response item; preserve unknown and newly introduced labels. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.responses.data.question`
**Question.** Question text. It defines the content surface available for this update.
* **Enables:** Locate Lattice update response item records by question in `updates.LatticeUpdateResponseItem.question`; attribute each text match to its parent update and, when present, its reported author.
* **Interpretation:** Lattice supplies question as text on each Lattice update response item; referenced files or media are not implied unless explicitly represented. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.responses.endingCursor`
**Ending Cursor.** Cursor for the next page. It is needed to continue the provider result set without skipping or repeating a page.
* **Enables:** Resume Lattice pagination from `updates.LatticeUpdateResponsesList.endingCursor` and verify that every page boundary advances before requesting the next result set.
* **Interpretation:** Lattice returns ending cursor as opaque pagination state; it has no business meaning and must be replayed exactly when requesting the next page. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.responses.hasMore`
**Has More.** Whether more pages exist. It is needed to continue the provider result set without skipping or repeating a page.
* **Enables:** Filter Updates by whether more pages exist in `updates.LatticeUpdateResponsesList.hasMore`; count true, false, and missing results separately.
* **Interpretation:** Lattice reports more pages exist as a boolean on each Lattice response-list page; a missing field is unknown, not false. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.responses.object`
**Object.** Envelope object type. It distinguishes the provider-defined object state or classification for the Lattice update responses list.
* **Enables:** Filter Updates by the exact Lattice-defined object in `updates.LatticeUpdateResponsesList.object` and preserve unknown values as distinct categories.
* **Interpretation:** Lattice supplies object from its own taxonomy on each Lattice update responses list; preserve unknown and newly introduced labels. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.reviewedAt`
**Reviewed At.** Unix timestamp when the update was reviewed. It anchors the update on the provider's reported timeline.
* **Enables:** Order Updates by reviewed at in `updates.reviewedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports reviewed at as a Unix timestamp in a unit not declared by this field on each update; derive timezone display separately and do not guess an undeclared unit. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.sentiment`
**Sentiment.** Sentiment object for this update. It preserves the nested context needed to interpret the parent update.
* **Enables:** Attribute sentiment in `updates.sentiment` to the parent update; identify parent records where that nested sentiment object is absent.
* **Interpretation:** Lattice reports sentiment as a nested object on each update; optional children may be absent from a valid response. This is provider-authored review context, not an independent Parable assessment of employee performance. The provider's scale can vary by question or cycle, so values must not be compared across unlike review contexts.
Developer identifier: `updates.sentiment.id`
**ID.** Sentiment ID. It provides the reference needed to connect the update to the corresponding provider object.
* **Enables:** Connect each Lattice update sentiment in Updates to the referenced Lattice update sentiment through `updates.LatticeUpdateSentiment.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports ID as an identifier in its Lattice update sentiment namespace; it is not a universal identity outside Lattice. This is provider-authored review context, not an independent Parable assessment of employee performance. The provider's scale can vary by question or cycle, so values must not be compared across unlike review contexts.
Developer identifier: `updates.sentiment.object`
**Object.** Object type. It distinguishes the provider-defined object state or classification for the Lattice update sentiment.
* **Enables:** Filter Updates by the exact Lattice-defined object in `updates.LatticeUpdateSentiment.object` and preserve unknown values as distinct categories.
* **Interpretation:** Lattice supplies object from its own taxonomy on each Lattice update sentiment; preserve unknown and newly introduced labels. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `updates.sentiment.rating`
**Rating.** Sentiment rating. It supplies the rating measure for the Lattice update sentiment at the provider's declared unit and grain.
* **Enables:** Measure rating through `updates.LatticeUpdateSentiment.rating` for each Lattice update sentiment and compare only values with the same unit and record grain.
* **Interpretation:** Lattice reports rating as a measure on each Lattice update sentiment; compare only records with the same unit and aggregation grain. This is provider-authored review context, not an independent Parable assessment of employee performance. The provider's scale can vary by question or cycle, so values must not be compared across unlike review contexts.
Developer identifier: `updates.url`
**URL.** URL for the update in Lattice. It locates the provider resource or path associated with the update.
* **Enables:** Associate each update with the resource identified by URL in `updates.url`; verify the link resolves to the expected Lattice object.
* **Interpretation:** Lattice reports URL as a resource locator for each update; access still depends on viewer permissions and the URL may expire or change. This is provider-authored review context, not an independent Parable assessment of employee performance.
Developer identifier: `users`
**Users.** Users in Lattice.
* **Enables:** Match Lattice user identifiers and email addresses to account status, role, department, manager, and hire-date records.
* **Scope:** Reads the records selected by Lattice's `/v1/users` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility follows the Lattice API key's organization access and the provider's privacy controls. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `users.birthDate`
**Birth Date.** User birth date. It anchors the user on the provider's reported timeline.
* **Enables:** Order Users by birth date in `users.birthDate` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports birth date as a calendar date on each user; its grain is one day and no time of day should be inferred.
Developer identifier: `users.createdAt`
**Created At.** Unix timestamp when the user was created. It anchors the user on the provider's reported timeline.
* **Enables:** Order Users by created at in `users.createdAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports created at as a Unix timestamp in a unit not declared by this field on each user; derive timezone display separately and do not guess an undeclared unit.
Developer identifier: `users.department`
**Department.** User department. It preserves the nested context needed to interpret the parent user.
* **Enables:** Attribute department in `users.department` to the parent user; identify parent records where that nested department object is absent.
* **Interpretation:** Lattice reports department as a nested object on each user; optional children may be absent from a valid response.
Developer identifier: `users.department.id`
**ID.** Department ID. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Connect each Lattice user department in Users to the referenced Lattice user department through `users.LatticeUserDepartment.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports ID as an identifier in its Lattice user department namespace; it is not a universal identity outside Lattice.
Developer identifier: `users.email`
**Email.** User email address. It supplies the provider-reported address or location facet for the user, not a residency determination.
* **Enables:** Attribute each user to a person or account by the exact email in `users.email`; identify addresses that do not match the Lattice directory.
* **Interpretation:** Lattice reports email as an address on each user; aliases, casing, and unverified addresses can prevent a one-to-one person match. A connector directive maps this field to a person's email identity.
Developer identifier: `users.externalUserId`
**External User ID.** External identity provider user ID for this Lattice user. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Connect each user in Users to the referenced external user through `users.externalUserId`; flag external user ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports external user ID as an identifier in its external user namespace; it is not a universal identity outside Lattice.
Developer identifier: `users.gender`
**Gender.** User gender. It supplies the gender profile facet used to reconcile or attribute the user.
* **Enables:** Reconcile the user's gender in `users.gender` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Lattice reports gender as a mutable profile or directory attribute on each user; it may be absent, shared, or non-unique.
Developer identifier: `users.id`
**ID.** Unique user identifier. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Match repeated user entries on ID in `users.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Lattice reports ID as an identifier in its user namespace; it is not a universal identity outside Lattice. The connector explicitly marks this field as a transform deduplication key. A connector directive maps this field to account identity.
Developer identifier: `users.isAdmin`
**Is Admin.** Whether the user is a Lattice admin. It distinguishes the provider-defined is admin state or classification for the user.
* **Enables:** Filter Users by whether the user is a Lattice admin in `users.isAdmin`; count true, false, and missing results separately.
* **Interpretation:** Lattice reports the user is a Lattice admin as a boolean on each user; a missing field is unknown, not false.
Developer identifier: `users.jobTitle`
**Job Title.** User job title. It supplies the job title profile facet used to reconcile or attribute the user.
* **Enables:** Label each user with job title from `users.jobTitle`; distinguish records that share that display name but have different Lattice identifiers.
* **Interpretation:** Lattice reports job title as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.manager`
**Manager.** User's manager. It preserves the nested context needed to interpret the parent user.
* **Enables:** Attribute manager in `users.manager` to the parent user; identify parent records where that nested manager object is absent.
* **Interpretation:** Lattice reports manager as a nested object on each user; optional children may be absent from a valid response.
Developer identifier: `users.manager.id`
**ID.** Manager user ID. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Connect each Lattice user manager in Users to the referenced Lattice user manager through `users.LatticeUserManager.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports ID as an identifier in its Lattice user manager namespace; it is not a universal identity outside Lattice.
Developer identifier: `users.managerId`
**Manager ID.** ID of the user's manager. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Connect each user in Users to the referenced manager through `users.managerId`; flag manager ID values that do not resolve in that provider namespace.
* **Interpretation:** Lattice reports manager ID as an identifier in its manager namespace; it is not a universal identity outside Lattice.
Developer identifier: `users.name`
**Name.** User display name. It gives the user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each user with name from `users.name`; distinguish records that share that display name but have different Lattice identifiers.
* **Interpretation:** Lattice reports name as display text for each user; names are mutable and are not stable identities. A connector directive maps this field to a person's display name.
Developer identifier: `users.preferredName`
**Preferred Name.** User preferred display name. It gives the user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each user with preferred name from `users.preferredName`; distinguish records that share that display name but have different Lattice identifiers.
* **Interpretation:** Lattice reports preferred name as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.startDate`
**Start Date.** User start date. It anchors the user on the provider's reported timeline.
* **Enables:** Filter Users by start date in `users.startDate`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** Lattice reports start date as a calendar date on each user; its grain is one day and no time of day should be inferred.
Developer identifier: `users.status`
**Status.** User account status. It distinguishes the provider-defined status state or classification for the user.
* **Enables:** Segment user entries in Users by status in `users.status`; compare counts only within the same Lattice taxonomy.
* **Interpretation:** Lattice reports status as a label from its own taxonomy on each user; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `users.timezone`
**Timezone.** User timezone setting. It is needed to interpret companion dates and times for the user in the provider's intended zone.
* **Enables:** Apply the zone in `users.timezone` when converting the user's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** Lattice reports timezone as a timezone identifier for each user; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `users.title`
**Title.** User job title. It gives the user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each user with title from `users.title`; distinguish records that share that display name but have different Lattice identifiers.
* **Interpretation:** Lattice reports title as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.updatedAt`
**Updated At.** Unix timestamp when the user was last updated. It anchors the user on the provider's reported timeline.
* **Enables:** Order Users by updated at in `users.updatedAt` and isolate records inside an exact provider reporting window.
* **Interpretation:** Lattice reports updated at as a Unix timestamp in seconds on each user; derive timezone display separately and do not guess an undeclared unit. A connector directive uses this field to order records for latest-state or incremental processing.
| Error | Meaning | Solution |
| - | - | - |
| `401 Unauthorized` | Invalid API key | Verify key is correct |
| `403 Forbidden` | Insufficient permissions | Check API key permissions |
**[Lattice API](https://developers.lattice.com/)** — Official API documentation
# Linear
Source: https://docs.parable.work/plugins/provider-plugins/linear
Linear is a project management and issue tracking tool for software teams, offering a GraphQL API for accessing issues, teams, projects, cycles, users, roadmaps, initiatives, and customers.
Linear is a project management and issue tracking tool for software teams, offering a GraphQL API for accessing issues, teams, projects, cycles, users, roadmaps, initiatives, and customers.
Connect Parable to Linear for issues, projects, and teams using the GraphQL API.
#### Issues & Projects
Issues, projects, cycles, milestones
#### Teams & Users
Team structure, user assignments
## Data streams
This Provider Plugin defines 16 data streams.
| Stream | Description | Sync |
| - | - | - |
| `issues` | Extracts all issues (tasks/tickets) from Linear, including title, description, priority, state, assignee, labels, and relationships. | incremental |
| `teams` | Extracts all teams within the Linear organization, including name, key, and settings. | full |
| `projects` | Extracts all projects from Linear, including name, status, progress, and milestone relationships. | full |
| `active_cycles` | Extracts all cycles (sprints) from Linear, including name, number, start/end dates, and team relationships. | full |
| `users` | Extracts all members of the Linear organization, including profile information and roles. | full |
| `roadmaps` | Extracts all roadmaps from Linear providing a high-level view of projects and initiatives over time. | full |
| `initiatives` | Extracts all initiatives (strategic goals) from Linear that group related projects at a higher level. | full |
| `customers` | Extracts all customer records from Linear used for tracking customer-related issues and requests. | full |
| `comments` | Extracts all comments posted on Linear issues, including body text, author, and timestamps. | full |
| `labels` | Extracts all issue labels from Linear used to categorize and filter issues. | full |
| `workflow_states` | Extracts all workflow states from Linear defining lifecycle stages for issues within teams. | full |
| `attachments` | Extracts all file and link attachments associated with Linear issues. | full |
| `project_milestones` | Extracts all project milestones from Linear marking significant progress points within projects. | full |
| `notifications` | Extracts notifications for the authenticated user about issue updates, mentions, and other activity. | full |
| `custom_views` | Extracts custom saved views from Linear with filters and display settings created by users. | full |
| `project_updates` | Extracts project status updates from Linear. These are periodic updates posted by team members on projects, including health status, body text, and associated project metadata. | incremental |
### API token
#### What You'll Need
| Credential | What it is |
| - | - |
| **API Key** | Personal API key from Linear settings |
> **Info:** **Setup access in Linear.** These steps require **Administrator**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Linear administrator.
* **Admin** role in Linear workspace (for full data access)
* API keys are tied to your user account and its permissions
#### Step 1: Access Linear Settings
1. Go to linear.app
2. Click your avatar → **Settings**
3. Navigate to **Account** → **Security & Access**
#### Step 2: Create API Key
1. Scroll to **Personal API keys** and click **New API key**
2. Enter label: `Parable Integration`
3. Choose permissions (full access or restricted) and click **Create**
> **Warning:** **Copy your API key now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
#### Step 3: Note Permissions
The API key inherits your account's permissions:
* **Admin users** have access to all workspace data
* **Member users** have access based on team membership
> **Tip:** For comprehensive data access, create the key with an admin account.
#### Step 4: Enter values in the form
1. **API Key**: Paste your Linear personal API key.
2. Click **Save & test connection**.
Developer identifier: `active_cycles`
Active Cycles contain all cycles (sprints) from Linear, including name, number, start/end dates, and team relationships.
* **Enables:** place issues in their current planning cycles and compare cycle dates and recorded scope.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `active_cycles.archivedAt`
Archived At captures the time at which the cycle was archived, if applicable. It preserves the provider's current classification of this record.
* **Enables:** separate active cycle records by the exact provider-reported archived at value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedAt` per linear active cycle record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `active_cycles.completedAt`
Completed At captures the time at which the cycle was marked as completed. It preserves the provider's current classification of this record.
* **Enables:** separate active cycle records by the exact provider-reported completed at value when describing their recorded state.
* **Interpretation:** The provider supplies `completedAt` per linear active cycle record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, completed at is the work record's classification, not an individual-performance measure.
Developer identifier: `active_cycles.completedIssueCountHistory`
Completed Issue Count History states historical snapshot of the completed issue count over the cycle's duration. It preserves the provider's current classification of this record.
* **Enables:** separate active cycle records by the exact provider-reported completed issue count history value when describing their recorded state.
* **Interpretation:** The provider supplies `completedIssueCountHistory` per linear active cycle record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, completed issue count history is the work record's classification, not an individual-performance measure.
Developer identifier: `active_cycles.completedScopeHistory`
Completed Scope History states historical snapshot of the completed scope (number of points or issues) over the cycle's duration. It preserves the provider's current classification of this record.
* **Enables:** separate active cycle records by the exact provider-reported completed scope history value when describing their recorded state.
* **Interpretation:** The provider supplies `completedScopeHistory` per linear active cycle record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, completed scope history is the work record's classification, not an individual-performance measure.
Developer identifier: `active_cycles.createdAt`
Created At captures the time at which the cycle was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place active cycle records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear active cycle record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `active_cycles.description`
Description contains a description of the cycle, often in markdown. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each linear active cycle record.
* **Interpretation:** The provider supplies `description` at linear active cycle granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `active_cycles.endsAt`
Ends At records end date of the cycle. It anchors the named event or boundary on the record's timeline.
* **Enables:** place active cycle records on a timeline by ends at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `endsAt` per linear active cycle record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `active_cycles.id`
ID is the unique identifier for the cycle. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear active cycle source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear active cycle record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `active_cycles.issueCountHistory`
Issue Count History records the ordered series of issue-count snapshots captured during the cycle. It preserves how the number of in-scope issues changed over time.
* **Enables:** analyze issues added or removed during a sprint and compare scope churn between cycles.
* **Interpretation:** The provider supplies `issueCountHistory` as an array of issue-count samples, not an elapsed interval; an empty series and a missing series are distinct.
Developer identifier: `active_cycles.name`
Name captures the name of the cycle. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear active cycle record.
* **Interpretation:** The provider supplies `name` at linear active cycle granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `active_cycles.number`
Number identifies the active cycle's auto-incrementing sequence within its team. It anchors sprint history to team-local chronology.
* **Enables:** order cycles for velocity trends and compare consecutive sprints within the same team.
* **Interpretation:** The provider scopes `number` to a team; it is a cycle sequence, not a cycle count or cross-team measure.
Developer identifier: `active_cycles.progress`
Progress reports cycle completion as a decimal ratio from 0 to 1. It captures the provider's current sprint progress.
* **Enables:** compare cycle advancement and support sprint progress or burndown analysis.
* **Interpretation:** The provider supplies `progress` as a ratio where `0` means no reported completion and `1` means complete; missing remains unknown.
Developer identifier: `active_cycles.scopeHistory`
Scope History records the ordered series of total-scope snapshots captured during the cycle. It preserves how planned points or issue scope changed over time.
* **Enables:** analyze scope growth or reduction during a sprint and compare the shape of scope change between cycles.
* **Interpretation:** The provider supplies `scopeHistory` as an array of scope samples, not an elapsed interval; interpret each value using the team's point or issue-count convention.
Developer identifier: `active_cycles.startsAt`
Starts At records start date of the cycle. It anchors the named event or boundary on the record's timeline.
* **Enables:** place active cycle records on a timeline by starts at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startsAt` per linear active cycle record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `active_cycles.team`
Team captures the team that owns this cycle. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each linear active cycle record with the specific provider container named by team.
* **Interpretation:** The provider returns `team` as a nested object or reference on `LinearActiveCycle`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `active_cycles.team.id`
ID is the unique identifier for the team. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match active cycle records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearCycleTeam`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `active_cycles.team.key`
Key captures the short key identifier for the team, used as a prefix for issue identifiers. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match active cycle records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `LinearCycleTeam`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `active_cycles.team.name`
Name captures the name of the team. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear cycle team record.
* **Interpretation:** The provider supplies `name` at linear cycle team granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `active_cycles.updatedAt`
Updated At captures the last time at which the cycle was meaningfully updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place active cycle records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear active cycle record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `attachments`
Attachments contain all file and link attachments associated with Linear issues.
* **Enables:** trace files and external links attached to issues.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `attachments.archivedAt`
Archived At records the timestamp when the attachment was archived, or null if not archived. It preserves the provider's current classification of this record.
* **Enables:** separate attachment records by the exact provider-reported archived at value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedAt` per linear attachment record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `attachments.createdAt`
Created At records the timestamp when the attachment was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place attachment records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear attachment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `attachments.creator`
Creator captures the user who created the attachment. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear attachment record to the provider-reported actor represented by creator.
* **Interpretation:** The provider supplies `creator` as identity or attribution context on each linear attachment record. In Linear, creator is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `attachments.creator.email`
Email records email address of the creator. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the attachment creator record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each attachment creator record. In Linear, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `attachments.creator.id`
ID is the unique identifier of the creator user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match attachment records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `AttachmentCreator`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `attachments.creator.name`
Name records display name of the creator. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the attachment creator record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each attachment creator record. In Linear, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `attachments.groupBySource`
Group By Source indicates whether attachments from this source should be grouped together in the UI. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select attachment records for which the provider reports group by source as true or false.
* **Interpretation:** The provider supplies `groupBySource` as a boolean per linear attachment record; false and missing are distinct when the field is optional. In Linear, group by source is a condition on the work record, not an individual-performance measure.
Developer identifier: `attachments.id`
ID is the unique identifier for the attachment. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear attachment source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear attachment record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `attachments.issue`
Issue captures the issue this attachment is linked to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested issue records contained by each linear attachment record.
* **Interpretation:** The provider returns `issue` as a nested object or reference on `LinearAttachment`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `attachments.issue.id`
ID is the unique identifier of the linked issue. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match attachment records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `AttachmentIssue`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `attachments.issue.identifier`
Identifier identifies human-readable issue identifier (e.g., ENG-123). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match attachment records to provider records that carry the same identifier, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `identifier` as a record-level identifier on `AttachmentIssue`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `attachments.metadata`
Metadata records arbitrary metadata associated with the attachment, typically populated by integrations. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret metadata according to the provider and Workspace configuration that produced each attachment record.
* **Interpretation:** Keys and value shapes within `metadata` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `attachments.source`
Source records source of the attachment as a JSON object (e.g. `{type, `imageUrl`}`) describing the integration that created it. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact source when validating the configuration or technical definition of a linear attachment record.
* **Interpretation:** The provider supplies `source` as configuration or technical metadata on `LinearAttachment`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `attachments.sourceType`
Source Type states type of the source resource within the source service (e.g., `pull_request`, commit, comment, file). It preserves the provider's current classification of this record.
* **Enables:** separate attachment records by the exact provider-reported source type value when describing their recorded state.
* **Interpretation:** The provider supplies `sourceType` per linear attachment record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, source type is the work record's classification, not an individual-performance measure.
Developer identifier: `attachments.subtitle`
Subtitle records subtitle or secondary description of the attachment. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact subtitle value attached to each linear attachment record.
* **Interpretation:** The provider supplies `subtitle` at linear attachment granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `attachments.title`
Title records title of the attachment. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact title value attached to each linear attachment record.
* **Interpretation:** The provider supplies `title` at linear attachment granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `attachments.updatedAt`
Updated At records the timestamp when the attachment was last meaningfully updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place attachment records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear attachment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `attachments.url`
URL records URL of the attachment resource (e.g., link to a GitHub PR, Figma file, or uploaded document). It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a linear attachment record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each linear attachment record. Availability still follows the provider's permissions and retention.
Developer identifier: `comments`
Comments contain all comments posted on Linear issues, including body text, author, and timestamps.
* **Enables:** inspect issue discussion text with its author and timestamps.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `comments.archivedAt`
Archived At captures the time at which the comment was archived, if applicable. It preserves the provider's current classification of this record.
* **Enables:** separate comment records by the exact provider-reported archived at value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedAt` per linear comment record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `comments.body`
Body captures the text content of the comment in Markdown format. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact body value attached to each linear comment record.
* **Interpretation:** The provider supplies `body` at linear comment granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `comments.bodyData`
Body Data captures the rich text body data of the comment as a JSON document (ProseMirror format). It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact body data when validating the configuration or technical definition of a linear comment record.
* **Interpretation:** The provider supplies `bodyData` as configuration or technical metadata on `LinearComment`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `comments.createdAt`
Created At captures the time at which the comment was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place comment records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear comment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `comments.editedAt`
Edited At captures the time at which the comment was edited by the user, if applicable. It anchors the named event or boundary on the record's timeline.
* **Enables:** place comment records on a timeline by edited at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `editedAt` per linear comment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `comments.id`
ID is the unique identifier for the comment. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear comment source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear comment record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `comments.issue`
Issue captures the issue this comment belongs to. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact issue value attached to each linear comment record.
* **Interpretation:** The provider supplies `issue` at linear comment granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `comments.issue.id`
ID is the unique identifier for the issue. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match comment records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearCommentIssue`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `comments.issue.identifier`
Identifier captures the human-readable identifier of the issue (e.g., ENG-123). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match comment records to provider records that carry the same identifier, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `identifier` as a record-level identifier on `LinearCommentIssue`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `comments.parent`
Parent captures the parent comment in a threaded discussion, if this is a reply. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact parent value attached to each linear comment record.
* **Interpretation:** The provider supplies `parent` at linear comment granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `comments.parent.id`
ID is the unique identifier of the parent comment. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match comment records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearCommentParent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `comments.resolvedAt`
Resolved At captures the time at which the comment was resolved, if applicable. It anchors the named event or boundary on the record's timeline.
* **Enables:** place comment records on a timeline by resolved at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `resolvedAt` per linear comment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `comments.updatedAt`
Updated At captures the last time at which the comment was meaningfully updated. Used as incremental sync cursor. It anchors the named event or boundary on the record's timeline.
* **Enables:** place comment records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear comment record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `comments.user`
User captures the user who authored the comment. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear comment record to the provider-reported actor represented by user.
* **Interpretation:** The provider supplies `user` as identity or attribution context on each linear comment record. In Linear, user is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `comments.user.email`
Email captures the email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear comment user record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each linear comment user record. In Linear, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `comments.user.id`
ID is the unique identifier for the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match comment records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearCommentUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `comments.user.name`
Name captures the display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear comment user record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each linear comment user record. In Linear, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `custom_views`
Custom Views contain custom saved views from Linear with filters and display settings created by users.
* **Enables:** reproduce the saved filters and display settings of Linear custom views.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `custom_views.archivedAt`
Archived At records the timestamp when the custom view was archived, if applicable. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret archived at according to the provider and Workspace configuration that produced each custom view record.
* **Interpretation:** Keys and value shapes within `archivedAt` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `custom_views.color`
Color records color value associated with the custom view for display purposes. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret color according to the provider and Workspace configuration that produced each custom view record.
* **Interpretation:** Keys and value shapes within `color` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `custom_views.createdAt`
Created At records the timestamp when the custom view was created. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret created at according to the provider and Workspace configuration that produced each custom view record.
* **Interpretation:** Keys and value shapes within `createdAt` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `custom_views.creator`
Creator captures the user who created this custom view. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret creator according to the provider and Workspace configuration that produced each custom view record.
* **Interpretation:** Keys and value shapes within `creator` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `custom_views.creator.email`
Email records email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each linear user record. In Linear, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `custom_views.creator.id`
ID is the unique identifier for the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match custom view records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `custom_views.creator.name`
Name records display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each linear user record. In Linear, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `custom_views.description`
Description records description of the custom view explaining its purpose or contents. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret description according to the provider and Workspace configuration that produced each custom view record.
* **Interpretation:** Keys and value shapes within `description` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `custom_views.filterData`
Filter Data records JSON object containing the filter configuration and criteria for this custom view. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret filter data according to the provider and Workspace configuration that produced each custom view record.
* **Interpretation:** Keys and value shapes within `filterData` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `custom_views.icon`
Icon records icon identifier associated with the custom view. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret icon according to the provider and Workspace configuration that produced each custom view record.
* **Interpretation:** Keys and value shapes within `icon` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `custom_views.id`
ID is the unique identifier for the custom view. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear custom view source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear custom view record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `custom_views.name`
Name records name of the custom view. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret name according to the provider and Workspace configuration that produced each custom view record.
* **Interpretation:** Keys and value shapes within `name` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `custom_views.shared`
Shared indicates whether the view is shared with the team or is a personal/private view. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select custom view records for which the provider reports shared as true or false.
* **Interpretation:** The provider supplies `shared` as a boolean per linear custom view record; false and missing are distinct when the field is optional. In Linear, shared is a condition on the work record, not an individual-performance measure.
Developer identifier: `custom_views.team`
Team captures the team this custom view is associated with, if any. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret team according to the provider and Workspace configuration that produced each custom view record.
* **Interpretation:** Keys and value shapes within `team` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `custom_views.team.id`
ID is the unique identifier for the team. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match custom view records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearTeam`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `custom_views.team.key`
Key identifies short unique key/prefix used for the team's issue identifiers. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match custom view records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `LinearTeam`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `custom_views.team.name`
Name records name of the team. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear team record.
* **Interpretation:** The provider supplies `name` at linear team granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `custom_views.updatedAt`
Updated At records the timestamp when the custom view was last meaningfully updated. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret updated at according to the provider and Workspace configuration that produced each custom view record.
* **Interpretation:** Keys and value shapes within `updatedAt` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `customers`
Customers contain all customer records from Linear used for tracking customer-related issues and requests.
* **Enables:** associate customer-request records with the Linear issues that reference them.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `customers.archivedAt`
Archived At captures the time at which the customer was archived, if applicable. It preserves the provider's current classification of this record.
* **Enables:** separate customer records by the exact provider-reported archived at value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedAt` per linear customer record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `customers.createdAt`
Created At captures the time at which the customer was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place customer records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear customer record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `customers.domains`
Domains records domain names associated with the customer. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each linear customer record with the specific provider container named by domains.
* **Interpretation:** The provider returns `domains` as a list on `LinearCustomer`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `customers.externalIds`
External IDs identifies external identifiers associated with the customer from integrated systems. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match customer records to provider records that carry the same external ids, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `externalIds` as a record-level identifier on `LinearCustomer`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `customers.id`
ID is the unique identifier for the customer. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear customer source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear customer record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `customers.logoUrl`
Logo URL records URL of the customer's logo image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by logo URL on a linear customer record.
* **Interpretation:** The provider supplies `logoUrl` as a URL or resource locator on each linear customer record. Availability still follows the provider's permissions and retention.
Developer identifier: `customers.name`
Name records name of the customer. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear customer record.
* **Interpretation:** The provider supplies `name` at linear customer granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `customers.revenue`
Revenue reports revenue associated with the customer. It preserves the source-domain financial amount at this record's granularity.
* **Enables:** compare the revenue recorded in the source business process across customer records using the accompanying currency when one is supplied.
* **Interpretation:** The source supplies `revenue` as a financial value in its actual business domain; no currency conversion is implied, and currency is unknown unless a companion field states it.
Developer identifier: `customers.size`
Size records Linear's stated size for the customer organization. It preserves the organization-scale attribute without assuming a storage interpretation.
* **Enables:** segment customer records by the provider-reported organization size.
* **Interpretation:** The provider supplies `size` as an integer organization attribute whose unit is not declared by this schema; do not interpret it as bytes or headcount without provider context.
Developer identifier: `customers.updatedAt`
Updated At captures the last time at which the customer was meaningfully updated. Used as incremental sync cursor. It anchors the named event or boundary on the record's timeline.
* **Enables:** place customer records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear customer record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `initiatives`
Initiatives contain all initiatives (strategic goals) from Linear that group related projects at a higher level.
* **Enables:** trace strategic initiative records to their related projects.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `initiatives.archivedAt`
Archived At records the timestamp when the initiative was archived, if applicable. It preserves the provider's current classification of this record.
* **Enables:** separate initiative records by the exact provider-reported archived at value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedAt` per linear initiative record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `initiatives.color`
Color records display color for the initiative in the UI. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied color for the represented design or board object.
* **Interpretation:** The provider supplies `color` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `initiatives.createdAt`
Created At records the timestamp when the initiative was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place initiative records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear initiative record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `initiatives.creator`
Creator captures the user who created this initiative. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear initiative record to the provider-reported actor represented by creator.
* **Interpretation:** The provider supplies `creator` as identity or attribution context on each linear initiative record. In Linear, creator is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `initiatives.creator.displayName`
Display Name records preferred display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user summary record to the provider-reported person or account represented by display name.
* **Interpretation:** The provider supplies `displayName` as identity or attribution context on each linear user summary record. In Linear, display name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `initiatives.creator.email`
Email records email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user summary record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each linear user summary record. In Linear, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `initiatives.creator.id`
ID is the unique identifier for the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match initiative records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearUserSummary`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `initiatives.creator.name`
Name records display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user summary record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each linear user summary record. In Linear, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `initiatives.description`
Description records detailed description of the initiative, typically in markdown format. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each linear initiative record.
* **Interpretation:** The provider supplies `description` at linear initiative granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `initiatives.icon`
Icon records icon identifier associated with the initiative. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by icon on a linear initiative record.
* **Interpretation:** The provider supplies `icon` as a URL or resource locator on each linear initiative record. Availability still follows the provider's permissions and retention.
Developer identifier: `initiatives.id`
ID is the unique identifier for the initiative. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear initiative source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear initiative record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `initiatives.name`
Name records name of the initiative. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear initiative record.
* **Interpretation:** The provider supplies `name` at linear initiative granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `initiatives.owner`
Owner captures the user who owns this initiative. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear initiative record to the provider-reported actor represented by owner.
* **Interpretation:** The provider supplies `owner` as identity or attribution context on each linear initiative record. In Linear, owner is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `initiatives.projects`
Projects records projects associated with this initiative. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each linear initiative record with the specific provider container named by projects.
* **Interpretation:** The provider returns `projects` as a nested object or reference on `LinearInitiative`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `initiatives.projects.nodes`
Nodes records project nodes in the connection. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each linear project connection record with the specific provider container named by nodes.
* **Interpretation:** The provider returns `nodes` as a list on `LinearProjectConnection`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `initiatives.projects.nodes.id`
ID is the unique identifier for the project. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match initiative records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearProjectSummary`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `initiatives.projects.nodes.name`
Name records name of the project. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear project summary record.
* **Interpretation:** The provider supplies `name` at linear project summary granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `initiatives.slugId`
Slug ID identifies URL-friendly slug identifier for the initiative. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match initiative records to provider records that carry the same slug ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `slugId` as a record-level identifier on `LinearInitiative`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `initiatives.sortOrder`
Sort Order reports sort order value used for ordering initiatives in the UI. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify initiative records using the provider-defined sort order value.
* **Interpretation:** The provider supplies `sortOrder` at linear initiative granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `initiatives.status`
Status states current status of the initiative. It preserves the provider's current classification of this record.
* **Enables:** separate initiative records by the exact provider-reported status value when describing their recorded state.
* **Interpretation:** The provider supplies `status` per linear initiative record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, status is the work record's classification, not an individual-performance measure.
Developer identifier: `initiatives.targetDate`
Target Date records target completion date for the initiative. It anchors the named event or boundary on the record's timeline.
* **Enables:** place initiative records on a timeline by target date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `targetDate` per linear initiative record as a calendar date without a time of day; missing values mean the event or boundary was not reported.
Developer identifier: `initiatives.updatedAt`
Updated At records the timestamp when the initiative was last meaningfully updated. Used as incremental sync cursor. It anchors the named event or boundary on the record's timeline.
* **Enables:** place initiative records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear initiative record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `initiatives.url`
URL records URL to view the initiative in Linear. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a linear initiative record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each linear initiative record. Availability still follows the provider's permissions and retention.
Developer identifier: `issues`
Issues contain all issues (tasks/tickets) from Linear, including title, description, priority, state, assignee, labels, and relationships.
* **Enables:** report issue scope, workflow state, assignment, and relationships as work-record context.
* **Scope:** Reads provider changes through the declared GraphQL operation using the declared incremental request boundary. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `issues.addedToCycleAt`
Added To Cycle At records when the issue was added to its cycle. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by added to cycle at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `addedToCycleAt` per linear issue record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.addedToProjectAt`
Added To Project At records when the issue was added to its project. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by added to project at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `addedToProjectAt` per linear issue record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.addedToTeamAt`
Added To Team At records when the issue was added to its team. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by added to team at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `addedToTeamAt` per linear issue record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.archivedAt`
Archived At records when the issue was archived. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported archived at value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedAt` per linear issue record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.assignee`
Assignee records user currently assigned to this issue. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear issue record to the provider-reported actor represented by assignee.
* **Interpretation:** The provider supplies `assignee` as identity or attribution context on each linear issue record. In Linear, assignee is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.assignee.email`
Email records email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user ref record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each linear user ref record. In Linear, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.assignee.id`
ID is the unique identifier for the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearUserRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.assignee.name`
Name records display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user ref record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each linear user ref record. In Linear, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.autoArchivedAt`
Auto Archived At records when the issue was automatically archived. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported auto archived at value when describing their recorded state.
* **Interpretation:** The provider supplies `autoArchivedAt` per linear issue record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, auto archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.autoClosedAt`
Auto Closed At records when the issue was automatically closed by the system. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by auto closed at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `autoClosedAt` per linear issue record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.boardOrder`
Board Order reports position of the issue on the board view. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify issue records using the provider-defined board order value.
* **Interpretation:** The provider supplies `boardOrder` at linear issue granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `issues.branchName`
Branch Name records suggested branch name for the issue. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact branch name when validating the configuration or technical definition of a linear issue record.
* **Interpretation:** The provider supplies `branchName` as configuration or technical metadata on `LinearIssue`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `issues.canceledAt`
Canceled At records when the issue was cancelled. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by canceled at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `canceledAt` per linear issue record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.completedAt`
Completed At records when the issue was marked as complete. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported completed at value when describing their recorded state.
* **Interpretation:** The provider supplies `completedAt` per linear issue record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, completed at is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.createdAt`
Created At records when the issue was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear issue record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.creator`
Creator records user who created this issue. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear issue record to the provider-reported actor represented by creator.
* **Interpretation:** The provider supplies `creator` as identity or attribution context on each linear issue record. In Linear, creator is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `issues.cycle`
Cycle records cycle (sprint) this issue is assigned to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each linear issue record with the specific provider container named by cycle.
* **Interpretation:** The provider returns `cycle` as a nested object or reference on `LinearIssue`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.cycle.id`
ID is the unique identifier for the cycle. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearCycleRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.cycle.name`
Name records optional name of the cycle. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear cycle ref record.
* **Interpretation:** The provider supplies `name` at linear cycle ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.cycle.number`
Number identifies the cycle's auto-incrementing sequence within its team. It keeps an issue's cycle reference tied to the team's sprint chronology.
* **Enables:** resolve and order referenced cycles within the same team.
* **Interpretation:** The provider scopes `number` to a team; it is a cycle sequence, not a cycle count or cross-team measure.
Developer identifier: `issues.description`
Description records full description of the issue in markdown format. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each linear issue record.
* **Interpretation:** The provider supplies `description` at linear issue granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.dueDate`
Due Date records due date for the issue in YYYY-MM-DD format. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by due date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `dueDate` per linear issue record as a calendar date without a time of day; missing values mean the event or boundary was not reported.
Developer identifier: `issues.estimate`
Estimate reports point estimate for the issue used in velocity calculations. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify issue records using the provider-defined estimate value.
* **Interpretation:** The provider supplies `estimate` at linear issue granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `issues.id`
ID is the unique identifier for the issue. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear issue source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear issue record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `issues.identifier`
Identifier identifies human-readable issue identifier like TEAM-123. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same identifier, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `identifier` as a record-level identifier on `LinearIssue`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.labels`
Labels records labels applied to this issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** apply the provider-defined labels classifications to each linear issue record.
* **Interpretation:** The provider returns `labels` as a nested object or reference on `LinearIssue`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.labels.nodes`
Nodes records list of labels applied to the issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** apply the provider-defined nodes classifications to each linear label connection record.
* **Interpretation:** The provider returns `nodes` as a list on `LinearLabelConnection`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.labels.nodes.id`
ID is the unique identifier for the label. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearLabelRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.labels.nodes.name`
Name records name of the label. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear label ref record.
* **Interpretation:** The provider supplies `name` at linear label ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.number`
Number identifies the issue's auto-incrementing sequence within its team. It supplies the numeric portion used to reference the issue in team context.
* **Enables:** locate issues by team and number and order issue creation within the same team sequence.
* **Interpretation:** The provider scopes `number` to a team; it is a reference sequence, not a quantity comparable across teams.
Developer identifier: `issues.parent`
Parent records parent issue if this is a sub-issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by parent on each linear issue record.
* **Interpretation:** The provider returns `parent` as a nested object or reference on `LinearIssue`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.parent.id`
ID is the unique identifier of the parent issue. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearIssueParentRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.parent.identifier`
Identifier identifies human-readable identifier of the parent issue. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same identifier, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `identifier` as a record-level identifier on `LinearIssueParentRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.priority`
Priority reports the numeric priority level (0=none, 1=urgent, 2=high, 3=medium, 4=low). It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported priority value when describing their recorded state.
* **Interpretation:** The provider supplies `priority` per linear issue record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, priority is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.priorityLabel`
Priority Label states human-readable label for the priority level (e.g., Urgent, High, Medium, Low, No priority). It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported priority label value when describing their recorded state.
* **Interpretation:** The provider supplies `priorityLabel` per linear issue record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, priority label is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.project`
Project records project this issue belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each linear issue record with the specific provider container named by project.
* **Interpretation:** The provider returns `project` as a nested object or reference on `LinearIssue`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.project.id`
ID is the unique identifier for the project. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearProjectRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.project.name`
Name records name of the project. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear project ref record.
* **Interpretation:** The provider supplies `name` at linear project ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.project.status`
Status states project status for this issue's project. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported status value when describing their recorded state.
* **Interpretation:** The provider supplies `status` per linear project ref record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, status is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.project.status.id`
ID is the unique identifier for the project status. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearProjectStatusRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.project.status.name`
Name states name of the project status. It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Linear linear project status ref name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per linear project status ref record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, name is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.project.status.type`
Type states lifecycle type of the project status. It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Linear linear project status ref type exposed by the nested object.
* **Interpretation:** The provider supplies `type` per linear project status ref record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, type is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.snoozedUntilAt`
Snoozed Until At records when the issue snooze period ends and it becomes active again. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by snoozed until at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `snoozedUntilAt` per linear issue record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.sortOrder`
Sort Order reports position of the issue when ordered in a list. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify issue records using the provider-defined sort order value.
* **Interpretation:** The provider supplies `sortOrder` at linear issue granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `issues.startedAt`
Started At records when work on the issue was started (transitioned to a started state). It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by started at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startedAt` per linear issue record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.state`
State states current workflow state of the issue. It preserves the provider's current classification of this record.
* **Enables:** separate issue records by the exact provider-reported state value when describing their recorded state.
* **Interpretation:** The provider supplies `state` per linear issue record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, state is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.state.id`
ID is the unique identifier for the workflow state. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearWorkflowState`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.state.name`
Name states name of the workflow state (e.g., Todo, In Progress, Done). It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Linear linear workflow state name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per linear workflow state record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, name is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.state.type`
Type states category type of the workflow state. It preserves the provider's current classification of this record.
* **Enables:** filter and group issue records by the Linear linear workflow state type exposed by the nested object.
* **Interpretation:** The provider supplies `type` per linear workflow state record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, type is the work record's classification, not an individual-performance measure.
Developer identifier: `issues.team`
Team records team that owns this issue. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each linear issue record with the specific provider container named by team.
* **Interpretation:** The provider returns `team` as a nested object or reference on `LinearIssue`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `issues.team.id`
ID is the unique identifier for the team. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearTeamRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.team.key`
Key identifies short key/prefix used in issue identifiers (e.g., ENG, DES). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match issue records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `LinearTeamRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `issues.team.name`
Name records name of the team. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear team ref record.
* **Interpretation:** The provider supplies `name` at linear team ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.title`
Title records title of the issue. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact title value attached to each linear issue record.
* **Interpretation:** The provider supplies `title` at linear issue granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `issues.trashed`
Trashed indicates whether the issue has been trashed. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select issue records for which the provider reports trashed as true or false.
* **Interpretation:** The provider supplies `trashed` as a boolean per linear issue record; false and missing are distinct when the field is optional. In Linear, trashed is a condition on the work record, not an individual-performance measure.
Developer identifier: `issues.triagedAt`
Triaged At records when the issue was triaged. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by triaged at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `triagedAt` per linear issue record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.updatedAt`
Updated At records when the issue was last meaningfully updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place issue records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear issue record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `issues.url`
URL records URL to view the issue in Linear. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a linear issue record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each linear issue record. Availability still follows the provider's permissions and retention.
Developer identifier: `labels`
Labels contain all issue labels from Linear used to categorize and filter issues.
* **Enables:** categorize issues using the labels defined in Linear.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `labels.archivedAt`
Archived At captures the time at which the label was archived, or null if not archived. It preserves the provider's current classification of this record.
* **Enables:** separate label records by the exact provider-reported archived at value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedAt` per linear label record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `labels.color`
Color records color of the label for visual identification, typically a hex color string. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied color for the represented design or board object.
* **Interpretation:** The provider supplies `color` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `labels.createdAt`
Created At captures the time at which the label was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place label records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear label record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `labels.creator`
Creator records user who created the label. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear label record to the provider-reported actor represented by creator.
* **Interpretation:** The provider supplies `creator` as identity or attribution context on each linear label record. In Linear, creator is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `labels.creator.email`
Email carries the source person or account value named Email for each linear label row. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear label record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each linear label record. In Linear, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `labels.creator.id`
ID carries the source identifier named ID for each linear label row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match label records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearLabel`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `labels.creator.name`
Name carries the source-authored value named Name for each linear label row. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear label record.
* **Interpretation:** The provider supplies `name` at linear label granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `labels.description`
Description records description of the label explaining its intended use. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each linear label record.
* **Interpretation:** The provider supplies `description` at linear label granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `labels.id`
ID is the unique identifier for the label. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear label source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear label record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `labels.isGroup`
Is Group indicates whether this label is a group (parent) label that can contain child labels. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select label records for which the provider reports is group as true or false.
* **Interpretation:** The provider supplies `isGroup` as a boolean per linear label record; false and missing are distinct when the field is optional. In Linear, is group is a condition on the work record, not an individual-performance measure.
Developer identifier: `labels.name`
Name records name of the label. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear label record.
* **Interpretation:** The provider supplies `name` at linear label granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `labels.parent`
Parent captures the parent label if this label is part of a group hierarchy. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact parent value attached to each linear label record.
* **Interpretation:** The provider supplies `parent` at linear label granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `labels.parent.id`
ID is the unique identifier for the parent label. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match label records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearLabelParent`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `labels.parent.name`
Name captures the name of the parent label. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear label parent record.
* **Interpretation:** The provider supplies `name` at linear label parent granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `labels.team`
Team captures the team this label belongs to. Null for workspace-level labels. It preserves the provider's current classification of this record.
* **Enables:** separate label records by the exact provider-reported team value when describing their recorded state.
* **Interpretation:** The provider supplies `team` per linear label record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, team is the work record's classification, not an individual-performance measure.
Developer identifier: `labels.team.id`
ID is the unique identifier for the team. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match label records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearLabelTeam`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `labels.team.key`
Key captures the short key identifier for the team, used as a prefix for issue identifiers. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match label records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `LinearLabelTeam`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `labels.team.name`
Name captures the name of the team. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear label team record.
* **Interpretation:** The provider supplies `name` at linear label team granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `labels.updatedAt`
Updated At captures the last time at which the label was meaningfully updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place label records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear label record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `notifications`
Notifications contain notifications for the authenticated user about issue updates, mentions, and other activity.
* **Enables:** review notifications returned for the authenticated account and the records they reference.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `notifications.actor`
Actor captures the user who triggered the notification. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear notification record to the provider-reported actor represented by actor.
* **Interpretation:** The provider supplies `actor` as identity or attribution context on each linear notification record. In Linear, actor is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `notifications.actor.email`
Email captures the email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the notification user record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each notification user record. In Linear, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `notifications.actor.id`
ID is the unique identifier for the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match notification records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `NotificationUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `notifications.actor.name`
Name captures the display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the notification user record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each notification user record. In Linear, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `notifications.archivedAt`
Archived At captures the time at which the notification was archived. It preserves the provider's current classification of this record.
* **Enables:** separate notification records by the exact provider-reported archived at value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedAt` per linear notification record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `notifications.createdAt`
Created At captures the time at which the notification was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place notification records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear notification record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `notifications.emailedAt`
Emailed At captures the time at which the notification was emailed to the user. It anchors the named event or boundary on the record's timeline.
* **Enables:** place notification records on a timeline by emailed at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `emailedAt` per linear notification record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `notifications.id`
ID is the unique identifier for the notification. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear notification source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear notification record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `notifications.readAt`
Read At captures the time at which the notification was read by the user. It anchors the named event or boundary on the record's timeline.
* **Enables:** place notification records on a timeline by read at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `readAt` per linear notification record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `notifications.snoozedUntilAt`
Snoozed Until At captures the time until which the notification is snoozed. It anchors the named event or boundary on the record's timeline.
* **Enables:** place notification records on a timeline by snoozed until at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `snoozedUntilAt` per linear notification record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `notifications.type`
Type states type of notification (e.g., `issueAssignment`, `issueMention`, `issueStatusChanged`). It preserves the provider's current classification of this record.
* **Enables:** separate notification records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per linear notification record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, type is the work record's classification, not an individual-performance measure.
Developer identifier: `notifications.unsnoozedAt`
Unsnoozed At captures the time at which the notification was unsnoozed. It anchors the named event or boundary on the record's timeline.
* **Enables:** place notification records on a timeline by unsnoozed at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `unsnoozedAt` per linear notification record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `notifications.updatedAt`
Updated At captures the last time at which the notification was meaningfully updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place notification records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear notification record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `notifications.user`
User captures the user who received the notification. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear notification record to the provider-reported actor represented by user.
* **Interpretation:** The provider supplies `user` as identity or attribution context on each linear notification record. In Linear, user is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `project_milestones`
Project Milestones contain all project milestones from Linear marking significant progress points within projects.
* **Enables:** place project work against named milestone records and target dates.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `project_milestones.archivedAt`
Archived At captures the time at which the milestone was archived, if applicable. It preserves the provider's current classification of this record.
* **Enables:** separate project milestone records by the exact provider-reported archived at value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedAt` per linear project milestone record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `project_milestones.createdAt`
Created At captures the time at which the milestone was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project milestone records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear project milestone record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `project_milestones.description`
Description records description of the milestone providing additional context or details. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each linear project milestone record.
* **Interpretation:** The provider supplies `description` at linear project milestone granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `project_milestones.id`
ID is the unique identifier for the milestone. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear project milestone source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear project milestone record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `project_milestones.name`
Name records name of the milestone. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear project milestone record.
* **Interpretation:** The provider supplies `name` at linear project milestone granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `project_milestones.project`
Project captures the project this milestone belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each linear project milestone record with the specific provider container named by project.
* **Interpretation:** The provider returns `project` as a nested object or reference on `LinearProjectMilestone`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `project_milestones.project.id`
ID is the unique identifier of the parent project. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project milestone records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearProjectMilestoneProject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `project_milestones.project.name`
Name records name of the parent project. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear project milestone project record.
* **Interpretation:** The provider supplies `name` at linear project milestone project granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `project_milestones.sortOrder`
Sort Order captures the sort order of the milestone within the project, used for display ordering. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify project milestone records using the provider-defined sort order value.
* **Interpretation:** The provider supplies `sortOrder` at linear project milestone granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `project_milestones.targetDate`
Target Date records target date for the milestone completion in YYYY-MM-DD format. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project milestone records on a timeline by target date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `targetDate` per linear project milestone record as a calendar date without a time of day; missing values mean the event or boundary was not reported.
Developer identifier: `project_milestones.updatedAt`
Updated At captures the last time at which the milestone was meaningfully updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project milestone records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear project milestone record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `project_updates`
Project Updates contain project status updates from Linear. These are periodic updates posted by team members on projects, including health status, body text, and associated project metadata.
* **Enables:** review periodic project-update text, health state, author, and publication time.
* **Scope:** Reads provider changes through the declared GraphQL operation using the declared incremental request boundary. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `project_updates.body`
Body records update content in markdown format. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact body value attached to each linear project update record.
* **Interpretation:** The provider supplies `body` at linear project update granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `project_updates.createdAt`
Created At records when the update was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project update records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear project update record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `project_updates.editedAt`
Edited At records when the update body was last edited. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project update records on a timeline by edited at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `editedAt` per linear project update record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `project_updates.health`
Health states project health status at time of update. It preserves the provider's current classification of this record.
* **Enables:** separate project update records by the exact provider-reported health value when describing their recorded state.
* **Interpretation:** The provider supplies `health` per linear project update record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, health is the work record's classification, not an individual-performance measure.
Developer identifier: `project_updates.id`
ID is the unique identifier for the project update. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear project update source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear project update record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `project_updates.project`
Project records project this update belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each linear project update record with the specific provider container named by project.
* **Interpretation:** The provider returns `project` as a nested object or reference on `LinearProjectUpdate`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `project_updates.project.id`
ID carries the source identifier named ID for each linear project row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project update records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearProject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `project_updates.project.name`
Name carries the source-authored value named Name for each linear project row. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear project record.
* **Interpretation:** The provider supplies `name` at linear project granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `project_updates.updatedAt`
Updated At records when the update was last modified. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project update records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear project update record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `project_updates.user`
User records user who posted the update. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear project update record to the provider-reported actor represented by user.
* **Interpretation:** The provider supplies `user` as identity or attribution context on each linear project update record. In Linear, user is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `project_updates.user.email`
Email carries the source person or account value named Email for each linear user row. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each linear user record. In Linear, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `project_updates.user.id`
ID carries the source identifier named ID for each linear user row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project update records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `project_updates.user.name`
Name carries the source-authored value named Name for each linear user row. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear user record.
* **Interpretation:** The provider supplies `name` at linear user granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects`
Projects contain all projects from Linear, including name, status, progress, and milestone relationships.
* **Enables:** review project scope, milestones, health updates, and recorded progress.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `projects.archivedAt`
Archived At records the timestamp when the project was archived, if applicable. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported archived at value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedAt` per linear project record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.canceledAt`
Canceled At records the timestamp when the project was canceled. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project records on a timeline by canceled at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `canceledAt` per linear project record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `projects.color`
Color records color associated with the project for UI display. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied color for the represented design or board object.
* **Interpretation:** The provider supplies `color` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `projects.completedAt`
Completed At records the timestamp when the project was completed. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported completed at value when describing their recorded state.
* **Interpretation:** The provider supplies `completedAt` per linear project record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, completed at is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.createdAt`
Created At records the timestamp when the project was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear project record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `projects.description`
Description records long-form description of the project, typically in markdown. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each linear project record.
* **Interpretation:** The provider supplies `description` at linear project granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects.health`
Health states current health status of the project. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported health value when describing their recorded state.
* **Interpretation:** The provider supplies `health` per linear project record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, health is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.icon`
Icon records icon emoji or identifier associated with the project. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by icon on a linear project record.
* **Interpretation:** The provider supplies `icon` as a URL or resource locator on each linear project record. Availability still follows the provider's permissions and retention.
Developer identifier: `projects.id`
ID is the unique identifier for the project. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear project source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear project record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `projects.lead`
Lead records user who is the lead of this project. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear project record to the provider-reported person or account represented by lead.
* **Interpretation:** The provider supplies `lead` as identity or attribution context on each linear project record. In Linear, lead is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.lead.email`
Email records email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each linear user record. In Linear, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.lead.id`
ID is the unique identifier for the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.lead.name`
Name records display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each linear user record. In Linear, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `projects.name`
Name records name of the project. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear project record.
* **Interpretation:** The provider supplies `name` at linear project granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `projects.priority`
Priority states priority level of the project (lower number is higher priority). It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported priority value when describing their recorded state.
* **Interpretation:** The provider supplies `priority` per linear project record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, priority is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.progress`
Progress reports project completion as a decimal ratio from 0 to 1. It captures the provider's current completion state.
* **Enables:** compare project advancement and identify work that is not started, partial, or complete.
* **Interpretation:** The provider supplies `progress` as a ratio where `0` means no reported completion and `1` means complete; missing remains unknown.
Developer identifier: `projects.scope`
Scope reports the total scope (points) of the project. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported scope for each linear project record.
* **Interpretation:** The provider supplies `scope` at linear project granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `projects.slugId`
Slug ID identifies URL-friendly slug identifier for the project. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match project records to provider records that carry the same slug ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `slugId` as a record-level identifier on `LinearProject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `projects.sortOrder`
Sort Order reports sort order value used for manual ordering of projects. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify project records using the provider-defined sort order value.
* **Interpretation:** The provider supplies `sortOrder` at linear project granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `projects.startDate`
Start Date records planned start date of the project. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project records on a timeline by start date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startDate` per linear project record as a calendar date without a time of day; missing values mean the event or boundary was not reported.
Developer identifier: `projects.startedAt`
Started At records the timestamp when the project was actually started. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project records on a timeline by started at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `startedAt` per linear project record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `projects.state`
State states current lifecycle state of the project. It preserves the provider's current classification of this record.
* **Enables:** separate project records by the exact provider-reported state value when describing their recorded state.
* **Interpretation:** The provider supplies `state` per linear project record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, state is the work record's classification, not an individual-performance measure.
Developer identifier: `projects.targetDate`
Target Date records target completion date of the project. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project records on a timeline by target date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `targetDate` per linear project record as a calendar date without a time of day; missing values mean the event or boundary was not reported.
Developer identifier: `projects.updatedAt`
Updated At records the timestamp when the project was last meaningfully updated. Used as incremental sync cursor. It anchors the named event or boundary on the record's timeline.
* **Enables:** place project records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear project record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `roadmaps`
Roadmaps contain all roadmaps from Linear providing a high-level view of projects and initiatives over time.
* **Enables:** organize projects and initiatives using Linear's roadmap records.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `roadmaps.archivedAt`
Archived At records the timestamp when the roadmap was archived, if applicable. It preserves the provider's current classification of this record.
* **Enables:** separate roadmap records by the exact provider-reported archived at value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedAt` per linear roadmap record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `roadmaps.color`
Color records color of the roadmap. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied color for the represented design or board object.
* **Interpretation:** The provider supplies `color` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `roadmaps.createdAt`
Created At records the timestamp when the roadmap was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place roadmap records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear roadmap record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `roadmaps.creator`
Creator captures the user who created this roadmap. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear roadmap record to the provider-reported actor represented by creator.
* **Interpretation:** The provider supplies `creator` as identity or attribution context on each linear roadmap record. In Linear, creator is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `roadmaps.creator.email`
Email records email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each linear user record. In Linear, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `roadmaps.creator.id`
ID is the unique identifier for the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match roadmap records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearUser`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `roadmaps.creator.name`
Name records display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each linear user record. In Linear, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `roadmaps.description`
Description records description of the roadmap, providing context about its strategic purpose. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each linear roadmap record.
* **Interpretation:** The provider supplies `description` at linear roadmap granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `roadmaps.id`
ID is the unique identifier for the roadmap. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear roadmap source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear roadmap record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `roadmaps.name`
Name records name of the roadmap. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear roadmap record.
* **Interpretation:** The provider supplies `name` at linear roadmap granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `roadmaps.slugId`
Slug ID identifies URL-friendly slug identifier for the roadmap. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match roadmap records to provider records that carry the same slug ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `slugId` as a record-level identifier on `LinearRoadmap`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `roadmaps.sortOrder`
Sort Order captures the sort order of the roadmap relative to other roadmaps. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify roadmap records using the provider-defined sort order value.
* **Interpretation:** The provider supplies `sortOrder` at linear roadmap granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `roadmaps.updatedAt`
Updated At records the timestamp when the roadmap was last meaningfully updated. Used as incremental sync cursor. It anchors the named event or boundary on the record's timeline.
* **Enables:** place roadmap records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear roadmap record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `teams`
Teams contain all teams within the Linear organization, including name, key, and settings.
* **Enables:** map issues, cycles, and projects to the Linear teams that contain them.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `teams.activeCycle`
Active Cycle states current active cycle for the team. It preserves the provider's current classification of this record.
* **Enables:** separate team records by the exact provider-reported active cycle value when describing their recorded state.
* **Interpretation:** The provider supplies `activeCycle` per linear team record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, active cycle is the work record's classification, not an individual-performance measure.
Developer identifier: `teams.activeCycle.id`
ID is the unique identifier for the cycle. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearCycleRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `teams.activeCycle.name`
Name records optional cycle name. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear cycle ref record.
* **Interpretation:** The provider supplies `name` at linear cycle ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `teams.activeCycle.number`
Number identifies the cycle's sequence within its team. It preserves sprint chronology on the cycle reference.
* **Enables:** resolve and order cycles within the same team when following team relationships.
* **Interpretation:** The provider scopes `number` to a team; it is a cycle sequence, not a cycle count or cross-team measure.
Developer identifier: `teams.archivedAt`
Archived At records when the team was archived, if applicable. It preserves the provider's current classification of this record.
* **Enables:** separate team records by the exact provider-reported archived at value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedAt` per linear team record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `teams.children`
Children records child teams nested under this team. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by children on each linear team record.
* **Interpretation:** The provider returns `children` as a list on `LinearTeam`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `teams.children.id`
ID is the unique identifier for the team. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear team ref source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear team ref record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `teams.children.key`
Key identifies short team key used in issue identifiers. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `LinearTeamRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `teams.children.name`
Name records name of the team. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear team ref record.
* **Interpretation:** The provider supplies `name` at linear team ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `teams.color`
Color records team color used in the Linear UI. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied color for the represented design or board object.
* **Interpretation:** The provider supplies `color` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `teams.createdAt`
Created At records when the team was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place team records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear team record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `teams.description`
Description records description of the team's purpose or scope. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each linear team record.
* **Interpretation:** The provider supplies `description` at linear team granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `teams.displayName`
Display Name records team name including parent team name when applicable. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact display name value attached to each linear team record.
* **Interpretation:** The provider supplies `displayName` at linear team granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `teams.icon`
Icon records icon identifier or emoji for the team. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by icon on a linear team record.
* **Interpretation:** The provider supplies `icon` as a URL or resource locator on each linear team record. Availability still follows the provider's permissions and retention.
Developer identifier: `teams.id`
ID is the unique identifier for the team. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear team source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear team record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `teams.issueCount`
Issue Count reports the number of issues in the team. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported issue count for each linear team record.
* **Interpretation:** The provider supplies `issueCount` at linear team granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `teams.key`
Key identifies short key/prefix used in issue identifiers (e.g., ENG, DES). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `LinearTeam`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `teams.name`
Name records display name of the team. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear team record.
* **Interpretation:** The provider supplies `name` at linear team granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `teams.organization`
Organization records Linear organization associated with the team. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each linear team record with the specific provider container named by organization.
* **Interpretation:** The provider returns `organization` as a nested object or reference on `LinearTeam`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `teams.organization.id`
ID is the unique identifier for the organization. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearOrganizationRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `teams.organization.name`
Name records name of the organization. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear organization ref record.
* **Interpretation:** The provider supplies `name` at linear organization ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `teams.parent`
Parent records parent team, if this is a child team. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by parent on each linear team record.
* **Interpretation:** The provider returns `parent` as a nested object or reference on `LinearTeam`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `teams.private`
Private indicates whether the team is private. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported private attached to each linear team record.
* **Interpretation:** The provider supplies `private` at linear team granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `teams.timezone`
Timezone records IANA timezone identifier for the team. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for teams using the recorded timezone.
* **Interpretation:** The provider supplies `timezone` as location or localization context per linear team record; it does not establish a person's real-time physical location.
Developer identifier: `teams.updatedAt`
Updated At records when the team was last updated. Used as incremental sync cursor. It anchors the named event or boundary on the record's timeline.
* **Enables:** place team records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear team record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `users`
Users contain all members of the Linear organization, including profile information and roles.
* **Enables:** resolve Linear member identities and organization roles for attribution and membership context.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `users.active`
Active indicates whether the user account is currently active in the workspace. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select user records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per linear user record; false and missing are distinct when the field is optional. In Linear, active is a condition on the work record, not an individual-performance measure.
Developer identifier: `users.admin`
Admin indicates whether the user has admin privileges in the workspace. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported admin attached to each linear user record.
* **Interpretation:** The provider supplies `admin` at linear user granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Linear, admin is access or membership context, not an individual-performance measure.
Developer identifier: `users.archivedAt`
Archived At states ISO8601 datetime when the user was archived, if applicable. It preserves the provider's current classification of this record.
* **Enables:** separate user records by the exact provider-reported archived at value when describing their recorded state.
* **Interpretation:** The provider supplies `archivedAt` per linear user record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `users.avatarUrl`
Avatar URL records URL of the user's avatar image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by avatar URL on a linear user record.
* **Interpretation:** The provider supplies `avatarUrl` as a URL or resource locator on each linear user record. Availability still follows the provider's permissions and retention. A connector directive maps this field to the person's identity photo.
Developer identifier: `users.createdAt`
Created At records ISO8601 datetime when the user record was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place user records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear user record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `users.createdIssueCount`
Created Issue Count reports the number of issues created by the user. It anchors the named event or boundary on the record's timeline.
* **Enables:** place user records on a timeline by created issue count and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdIssueCount` per linear user record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `users.description`
Description records user-provided bio or description text. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each linear user record.
* **Interpretation:** The provider supplies `description` at linear user granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `users.disableReason`
Disable Reason records reason the user account was disabled, if applicable. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user record to the provider-reported person or account represented by disable reason.
* **Interpretation:** The provider supplies `disableReason` as identity or attribution context on each linear user record. In Linear, disable reason is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `users.displayName`
Display Name records display name of the user, typically their preferred name shown in the UI. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user record to the provider-reported person or account represented by display name.
* **Interpretation:** The provider supplies `displayName` as identity or attribution context on each linear user record. In Linear, display name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `users.email`
Email records email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each linear user record. In Linear, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `users.guest`
Guest indicates whether the user is a guest (external collaborator) rather than a full member. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported guest attached to each linear user record.
* **Interpretation:** The provider supplies `guest` at linear user granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Linear, guest is access or membership context, not an individual-performance measure.
Developer identifier: `users.id`
ID is the unique identifier for the user. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear user source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear user record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `users.initials`
Initials records initials displayed for the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user record to the provider-reported person or account represented by initials.
* **Interpretation:** The provider supplies `initials` as identity or attribution context on each linear user record. In Linear, initials is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `users.lastSeen`
Last Seen records ISO8601 datetime of when the user was last seen active in Linear. It anchors the named event or boundary on the record's timeline.
* **Enables:** place user records on a timeline by last seen and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastSeen` per linear user record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `users.name`
Name records full name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the linear user record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each linear user record. In Linear, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `users.organization`
Organization records organization the user belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each linear user record with the specific provider container named by organization.
* **Interpretation:** The provider returns `organization` as a nested object or reference on `LinearUser`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `users.organization.id`
ID is the unique identifier for the organization. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match user records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearOrganizationRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `users.organization.name`
Name records name of the organization. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear organization ref record.
* **Interpretation:** The provider supplies `name` at linear organization ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `users.statusEmoji`
Status Emoji states emoji representing the user's current status. It preserves the provider's current classification of this record.
* **Enables:** separate user records by the exact provider-reported status emoji value when describing their recorded state.
* **Interpretation:** The provider supplies `statusEmoji` per linear user record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, status emoji is the work record's classification, not an individual-performance measure.
Developer identifier: `users.statusLabel`
Status Label states text label for the user's current status. It preserves the provider's current classification of this record.
* **Enables:** separate user records by the exact provider-reported status label value when describing their recorded state.
* **Interpretation:** The provider supplies `statusLabel` per linear user record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, status label is the work record's classification, not an individual-performance measure.
Developer identifier: `users.statusUntilAt`
Status Until At states ISO8601 datetime indicating when the user's current status expires. It preserves the provider's current classification of this record.
* **Enables:** separate user records by the exact provider-reported status until at value when describing their recorded state.
* **Interpretation:** The provider supplies `statusUntilAt` per linear user record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, status until at is the work record's classification, not an individual-performance measure.
Developer identifier: `users.teams`
Teams records teams the user belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each linear user record with the specific provider container named by teams.
* **Interpretation:** The provider returns `teams` as a nested object or reference on `LinearUser`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `users.teams.nodes`
Nodes records team nodes in the connection. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each linear team connection record with the specific provider container named by nodes.
* **Interpretation:** The provider returns `nodes` as a list on `LinearTeamConnection`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `users.teams.nodes.id`
ID is the unique identifier for the team. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match user records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearTeamRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `users.teams.nodes.key`
Key identifies short team key used in issue identifiers. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match user records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `LinearTeamRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `users.teams.nodes.name`
Name records name of the team. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each linear team ref record.
* **Interpretation:** The provider supplies `name` at linear team ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `users.timezone`
Timezone records user's configured timezone (IANA timezone identifier). It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for users using the recorded timezone.
* **Interpretation:** The provider supplies `timezone` as location or localization context per linear user record; it does not establish a person's real-time physical location.
Developer identifier: `users.updatedAt`
Updated At records ISO8601 datetime when the user record was last meaningfully updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place user records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear user record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `users.url`
URL records URL to the user's profile page in Linear. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a linear user record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each linear user record. Availability still follows the provider's permissions and retention.
Developer identifier: `workflow_states`
Workflow States contain all workflow states from Linear defining lifecycle stages for issues within teams.
* **Enables:** interpret issue state using each team's configured workflow stages.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects visible to the configured API key or OAuth grant; private or restricted records not returned by Linear are absent.
Developer identifier: `workflow_states.archivedAt`
Archived At records the timestamp when the workflow state was archived, null if not archived. It preserves the provider's current classification of this record.
* **Enables:** filter and group workflow state records by the Linear linear workflow state archived at exposed by the nested object.
* **Interpretation:** The provider supplies `archivedAt` per linear workflow state record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, archived at is the work record's classification, not an individual-performance measure.
Developer identifier: `workflow_states.color`
Color records color of the workflow state displayed in the UI, typically a hex color code. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied color for the represented design or board object.
* **Interpretation:** The provider supplies `color` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `workflow_states.createdAt`
Created At records the timestamp when the workflow state was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place workflow state records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per linear workflow state record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `workflow_states.description`
Description records description of the workflow state explaining its purpose or usage. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each linear workflow state record.
* **Interpretation:** The provider supplies `description` at linear workflow state granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `workflow_states.id`
ID is the unique identifier for the workflow state. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same linear workflow state source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per linear workflow state record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `workflow_states.name`
Name states name of the workflow state (e.g., Todo, In Progress, Done). It preserves the provider's current classification of this record.
* **Enables:** filter and group workflow state records by the Linear linear workflow state name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per linear workflow state record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, name is the work record's classification, not an individual-performance measure.
Developer identifier: `workflow_states.position`
Position reports sort position of the state within the team's workflow, used for ordering. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify workflow state records using the provider-defined position value.
* **Interpretation:** The provider supplies `position` at linear workflow state granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `workflow_states.team`
Team captures the team this workflow state belongs to. It preserves the provider's current classification of this record.
* **Enables:** filter and group workflow state records by the Linear linear workflow state team exposed by the nested object.
* **Interpretation:** The provider supplies `team` per linear workflow state record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, team is the work record's classification, not an individual-performance measure.
Developer identifier: `workflow_states.team.id`
ID is the unique identifier of the team. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match workflow state records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `LinearWorkflowStateTeam`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `workflow_states.team.key`
Key identifies short key or abbreviation for the team, used as a prefix in issue identifiers. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match workflow state records to provider records that carry the same key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `key` as a record-level identifier on `LinearWorkflowStateTeam`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `workflow_states.team.name`
Name states name of the team. It preserves the provider's current classification of this record.
* **Enables:** filter and group workflow state records by the Linear linear workflow state team name exposed by the nested object.
* **Interpretation:** The provider supplies `name` per linear workflow state team record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, name is the work record's classification, not an individual-performance measure.
Developer identifier: `workflow_states.type`
Type states category type classifying the workflow state into a standardized lifecycle stage. It preserves the provider's current classification of this record.
* **Enables:** filter and group workflow state records by the Linear linear workflow state type exposed by the nested object.
* **Interpretation:** The provider supplies `type` per linear workflow state record using its own state vocabulary; unknown and missing values must remain distinct. In Linear, type is the work record's classification, not an individual-performance measure.
Developer identifier: `workflow_states.updatedAt`
Updated At records the timestamp when the workflow state was last meaningfully updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place workflow state records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updatedAt` per linear workflow state record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
| Error | Meaning | Solution |
| - | - | - |
| `Authentication required` | Missing or invalid token | Verify API key in header |
| `Forbidden` | Insufficient permissions | Use admin account or check team access |
| `Rate limit exceeded` | Too many requests | If this occurs during setup, wait briefly, then click **Save & test connection** again. If this occurs during syncing, Parable retries automatically for a limited time. If the sync still fails, review the connection error before retrying. |
#### Common Issues
#### Can't see certain teams
API keys inherit user permissions. If you can't see certain teams, verify the user account has access.
**[Linear API](https://developers.linear.app/docs)** — Official API documentation
**[GraphQL Schema](https://developers.linear.app/docs/graphql/working-with-the-graphql-api)** — GraphQL reference
# Microsoft 365
Source: https://docs.parable.work/plugins/provider-plugins/microsoft
Sync data from Microsoft 365 (Teams, SharePoint, etc.)
Sync data from Microsoft 365 (Teams, SharePoint, etc.).
Create an Azure AD app registration to connect Parable to Microsoft 365 using OAuth 2.0 client credentials. This enables secure, automated access without user sign-in.
## Data streams
This Provider Plugin defines 15 data streams.
| Stream | Description | Sync |
| - | - | - |
| `users` | Microsoft Entra ID users | full |
| `calendar_events` | Calendar events by user | incremental |
| `messages` | Mailbox messages by user | incremental |
| `teams` | Microsoft Teams represented as groups | full |
| `team_details` | Detailed settings for each team | full |
| `team_calendar_events` | Team calendar events by group | incremental |
| `sign_in_logs` | Microsoft Entra sign-in logs | incremental |
| `audit_logs` | Microsoft Purview audit log records via the /beta async create-poll-fetch pattern. Uses recordTypeFilters \[sharePointFileOperation, oneDrive] matching the legacy ingestion-service default. | incremental |
| `copilot_interactions` | Microsoft 365 Copilot user interaction audit records via the Purview /beta async create-poll-fetch pattern. Filters recordTypeFilters to CopilotInteraction (who/when/AppHost/AccessedResources). Does not include prompt or response text. Opt-in; requires AuditLogsQuery.Read.All. | incremental |
| `user_calendar_events` | DEPRECATED expansion tap. Duplicates the calendar\_events tap with a narrower \$select. The legacy ingestion-service only defines a single user-calendar tap (calendar\_events). Disabled by default; retained for backward compatibility. | incremental |
| `channels` | Channels within each Microsoft Team | full |
| `channel_messages` | All channel messages across a team (including thread replies) via Teams export API | incremental |
| `channel_members` | Members of each Teams channel | full |
| `organization` | Entra organization (tenant) metadata | full |
| `groups` | Microsoft Entra groups (all group types, including non-Teams). Overlaps with the teams tap for groups that have resourceProvisioningOptions Team; teams remains the filtered source for Teams child fan-out. | full |
### App registration
#### What You'll Need
| Credential | What it is |
| - | - |
| **Tenant ID** | Azure AD tenant identifier |
| **Client ID** | Application (client) ID |
| **Client Secret** | Generated client secret |
> **Info:** **Setup access in Azure.** These steps require **Administrator**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Azure administrator.
* **Global Administrator** or **Application Administrator** role in Azure AD
* Permission to grant admin consent for API permissions
#### Step 1: Access Azure Portal
1. Navigate to Azure Portal
2. Go to **Azure Active Directory** → **App registrations**
3. Click **New registration**
#### Step 2: Register Application
| Field | Value |
| - | - |
| Name | `Parable Integration` |
| Supported account types | Accounts in this organizational directory only |
| Redirect URI | Leave blank (not needed for client credentials) |
Click **Register**
#### Step 3: Note Application Details
From the **Overview** page, copy:
* **Application (client) ID**
* **Directory (tenant) ID**
#### Step 4: Create Client Secret
1. Go to **Certificates & secrets**
2. Click **New client secret**
3. Add description: `Parable Integration Secret`
4. Select expiration (recommend: 24 months)
5. Click **Add**
> **Warning:** Copy the secret **Value** immediately - it won't be shown again!
#### Step 5: Configure API Permissions
1. Go to **API permissions**
2. Click **Add a permission** → **Microsoft Graph**
3. Select **Application permissions**
4. Add these permissions:
| Permission | Purpose |
| - | - |
| `User.Read.All` | Read all user profiles |
| `Directory.Read.All` | Read directory data (also covers org metadata and channel list when present) |
| `Team.ReadBasic.All` | Read Microsoft Teams details |
| `Channel.ReadBasic.All` | List Teams channels (required if Directory.Read.All is not granted) |
| `ChannelMessage.Read.All` | Read Teams channel messages via the Teams export API |
| `ChannelMember.Read.All` | Read Teams channel membership |
| `AuditLog.Read.All` | Read sign-in and directory audit logs |
| `AuditLogsQuery.Read.All` | Read Microsoft Purview audit log queries |
| `Mail.Read` | Read mail (if needed) |
| `Calendars.Read` | Read calendars (if needed) |
> **Optional: Restrict mailbox access**
>
> By default, Microsoft Graph application permissions can cover every user in the
> directory. Use Microsoft's
> [mailbox access guidance](https://learn.microsoft.com/en-us/graph/auth-limit-mailbox-access)
> when your organization needs to restrict the app to an approved population.
> **Warning:** `ChannelMessage.Read.All` is a protected Teams export permission. Admin
> consent alone is not enough: Microsoft must also approve protected-API
> access for your app, and your tenant needs Teams message export
> eligibility. See Microsoft's
> [Export content with the Microsoft Teams export APIs](https://learn.microsoft.com/en-us/microsoftteams/export-teams-content)
> guide. Until that is in place, leave the Parable `channel_messages` tap
> disabled (it ships opt-in).
#### Step 6: Grant Admin Consent
1. Click **Grant admin consent for \[Your Org]**
2. Confirm the consent dialog
> **Info:** All permissions should show a green checkmark indicating consent was granted.
> Channel / message taps that ship disabled stay off until you enable them
> in Parable after consent and protected-API approval succeed.
#### Step 7: Enter values in the form
1. **Tenant ID**, **Client ID**, and **Client Secret**: Paste the Directory (tenant) ID, Application (client) ID, and client secret value.
2. Click **Save & test connection**.
### App registration
| Permission | Data Accessed |
| - | - |
| `User.Read.All` | User profiles, managers, photos |
| `Directory.Read.All` | Groups, org hierarchy, devices; sufficient for listing channels when granted |
| `Team.ReadBasic.All` | Microsoft Teams names, settings, and membership counts |
| `Channel.ReadBasic.All` | Channel list (standard / private / shared) when Directory.Read.All is not used |
| `ChannelMessage.Read.All` | Channel message content via Teams export APIs (protected API; Global cloud only - not US Gov L4/L5 or China 21Vianet) |
| `ChannelMember.Read.All` | Teams channel member lists |
| `AuditLog.Read.All` | Sign-in logs, directory audits |
| `AuditLogsQuery.Read.All` | Purview audit log records (SharePoint/OneDrive file operations) |
| `Mail.Read` | Email metadata and content |
| `Calendars.Read` | Calendar events and availability |
> **Info:** Channel message export covers public and private channels. Shared-channel
> coverage follows Microsoft Graph's getAllMessages behavior and may omit
> some shared-channel traffic. 1:1 and group chats are not included in this
> Provider version.
> **Tip:** **Rate Limits:** Microsoft Graph enforces rate limits of **10,000 requests per 10 minutes per app; throttling returns 429 with Retry-After header**.
>
> Parable handles rate limiting automatically with exponential backoff, but initial syncs of large datasets may take longer due to these limits.
Developer identifier: `audit_logs`
**Audit Logs.** Microsoft Purview audit log records via the /beta async create-poll-fetch pattern. Uses recordTypeFilters \[sharePointFileOperation, oneDrive] matching the legacy ingestion-service default.
* **Enables:** Trace SharePoint and OneDrive audit operations to the reported user, resource, operation, and event time.
* **Scope:** Reads the records selected by Microsoft 365's `/beta/security/auditLog/queries` operation as an event stream using incremental synchronization. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. The query is restricted to SharePoint file operations and OneDrive record types rather than the tenant's complete Purview audit corpus. This stream supplies no reliable deletion signal.
Developer identifier: `audit_logs.administrativeUnits`
**Administrative Units.** Administrative units associated with the record. It preserves the nested context needed to interpret the parent audit log.
* **Enables:** Attribute every returned administrative unit value in `audit_logs.administrativeUnits` to its parent audit log; keep each relationship distinct and distinguish an absent array from an explicitly empty one.
* **Interpretation:** Microsoft 365 returns administrative units as an array of administrative unit value entries on each audit log; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `audit_logs.auditData`
**Audit Data.** Raw service-specific audit payload as a JSON object. It preserves the nested context needed to interpret the parent audit log.
* **Enables:** Attribute audit data in `audit_logs.auditData` to the parent audit log; identify parent records where that nested audit data object is absent.
* **Interpretation:** Microsoft 365 reports audit data as a nested object on each audit log; optional children may be absent from a valid response.
Developer identifier: `audit_logs.auditLogRecordType`
**Audit Log Record Type.** Audit log record type (e.g. SharePointFileOperation, OneDrive). It distinguishes the provider-defined audit log record type state or classification for the audit log.
* **Enables:** Segment audit log entries in Audit Logs by audit log record type in `audit_logs.auditLogRecordType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports audit log record type as a label from its own taxonomy on each audit log; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `audit_logs.clientIp`
**Client IP.** Client IP address from which the operation was performed. It supplies the provider-reported address or location facet for the audit log, not a residency determination.
* **Enables:** Correlate audit log records that report the same network address in `audit_logs.clientIp` during an authorized investigation; account for shared, proxied, or translated addresses.
* **Interpretation:** Microsoft 365 reports this as an IP network address on each audit log. It is not verified geolocation, does not identify a person by itself, and does not establish data residency.
Developer identifier: `audit_logs.createdDateTime`
**Created Date Time.** Timestamp when the audited operation occurred. It anchors the audit log on the provider's reported timeline.
* **Enables:** Order Audit Logs by created date time in `audit_logs.createdDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports created date time as a timestamp on each audit log; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `audit_logs.id`
**ID.** Unique identifier of the audit log record. It provides the reference needed to connect the audit log to the corresponding provider object.
* **Enables:** Match repeated audit log entries on ID in `audit_logs.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its audit log namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `audit_logs.objectId`
**Object ID.** Identifier of the object the operation acted on (e.g. file URL). It provides the reference needed to connect the audit log to the corresponding provider object.
* **Enables:** Connect each audit log in Audit Logs to the referenced object through `audit_logs.objectId`; flag object ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports object ID as an identifier in its object namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `audit_logs.operation`
**Operation.** Operation name (e.g. FileAccessed, FileModified). It distinguishes the provider-defined operation state or classification for the audit log.
* **Enables:** Filter Audit Logs by the exact Microsoft 365-defined operation in `audit_logs.operation` and preserve unknown values as distinct categories.
* **Interpretation:** Microsoft 365 supplies operation from its own taxonomy on each audit log; preserve unknown and newly introduced labels.
Developer identifier: `audit_logs.organizationId`
**Organization ID.** Microsoft tenant identifier. It provides the reference needed to connect the audit log to the corresponding provider object.
* **Enables:** Connect each audit log in Audit Logs to the referenced organization through `audit_logs.organizationId`; flag organization ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports organization ID as an identifier in its organization namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `audit_logs.service`
**Service.** Microsoft 365 service that produced the record (e.g. SharePoint, OneDrive). It distinguishes the provider-defined service state or classification for the audit log.
* **Enables:** Filter Audit Logs by the exact Microsoft 365-defined service in `audit_logs.service` and preserve unknown values as distinct categories.
* **Interpretation:** Microsoft 365 supplies service from its own taxonomy on each audit log; preserve unknown and newly introduced labels.
Developer identifier: `audit_logs.userId`
**User ID.** Object ID of the user that performed the operation. It provides the reference needed to connect the audit log to the corresponding provider object.
* **Enables:** Connect each audit log in Audit Logs to the referenced user through `audit_logs.userId`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports user ID as an identifier in its user namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `audit_logs.userPrincipalName`
**User Principal Name.** UPN of the user that performed the operation. It gives the audit log a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each audit log with user principal name from `audit_logs.userPrincipalName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports user principal name as display text for each audit log; names are mutable and are not stable identities.
Developer identifier: `audit_logs.userType`
**User Type.** Type of user that performed the operation. It supplies the user type profile facet used to reconcile or attribute the audit log.
* **Enables:** Segment audit log entries in Audit Logs by user type in `audit_logs.userType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports user type as a label from its own taxonomy on each audit log; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calendar_events`
**Calendar Events.** Calendar events by user.
* **Enables:** Attribute user calendar events to organizers, attendees, calendars, time intervals, recurrence, and response state.
* **Scope:** Reads the records selected by Microsoft 365's `/v1.0/users/{id}/calendarView` operation as an event stream using incremental synchronization. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. The selected fields include `bodyPreview` plus event and recurrence metadata, not the complete event body or attachment bytes. This stream supplies no reliable deletion signal.
Developer identifier: `calendar_events.attendees`
**Attendees.** List of attendees with email, name, and response status. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute each returned attendee in `calendar_events.attendees` to the parent calendar event; preserve whether the field represents an attendee, To, Cc, or Bcc relationship.
* **Interpretation:** Microsoft 365 returns attendees as an array of attendee entries on each calendar event; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calendar_events.attendees.emailAddress`
**Email Address.** Email address and display name of the attendee. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Match repeated attendee entries on email address in `calendar_events.Attendee.emailAddress`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Microsoft 365 reports email address as a nested object on each attendee; optional children may be absent from a valid response.
Developer identifier: `calendar_events.attendees.emailAddress.address`
**Address.** Email/contact address returned for this recipient or account; needed to attribute it to the corresponding Microsoft 365 identity.
* **Enables:** Attribute each email address to a person or account by the exact address in `calendar_events.EmailAddress.address`; identify addresses that do not match the Microsoft 365 directory.
* **Interpretation:** Microsoft 365 reports address as an address on each email address; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `calendar_events.attendees.emailAddress.name`
**Name.** Display name of the person or entity. It gives the email address a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each email address with name from `calendar_events.EmailAddress.name`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports name as display text for each email address; names are mutable and are not stable identities.
Developer identifier: `calendar_events.attendees.proposedNewTime`
**Proposed New Time.** An alternate date/time proposed by the attendee. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute proposed new time in `calendar_events.Attendee.proposedNewTime` to the parent calendar event; identify parent records where that nested proposed new time object is absent.
* **Interpretation:** Microsoft 365 reports proposed new time as a nested object on each attendee; optional children may be absent from a valid response.
Developer identifier: `calendar_events.attendees.proposedNewTime.end`
**End.** End of the time slot. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute end in `calendar_events.TimeSlot.end` to the parent calendar event; identify parent records where that nested end object is absent.
* **Interpretation:** Microsoft 365 reports end as a nested object on each time slot; optional children may be absent from a valid response.
Developer identifier: `calendar_events.attendees.proposedNewTime.end.dateTime`
**Date Time.** Date and time in ISO 8601 format without timezone offset (e.g. 2024-01-15T09:00:00.0000000). It anchors the calendar event on the provider's reported timeline.
* **Enables:** Order Calendar Events by date time in `calendar_events.DateTimeTimeZone.dateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports date time as a timestamp on each date time time zone; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `calendar_events.attendees.proposedNewTime.end.timeZone`
**Time Zone.** IANA or Windows time zone identifier (e.g. Pacific Standard Time, America/New\_York). It is needed to interpret companion dates and times for the date time time zone in the provider's intended zone.
* **Enables:** Apply the zone in `calendar_events.DateTimeTimeZone.timeZone` when converting the calendar event's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** Microsoft 365 reports time zone as a timezone identifier for each date time time zone; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `calendar_events.attendees.proposedNewTime.start`
**Start.** Start of the time slot. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute start in `calendar_events.TimeSlot.start` to the parent calendar event; identify parent records where that nested start object is absent.
* **Interpretation:** Microsoft 365 reports start as a nested object on each time slot; optional children may be absent from a valid response.
Developer identifier: `calendar_events.attendees.status`
**Status.** The attendee's response status for the event. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute status in `calendar_events.Attendee.status` to the parent calendar event; identify parent records where that nested status object is absent.
* **Interpretation:** Microsoft 365 reports status as a nested object on each attendee; optional children may be absent from a valid response.
Developer identifier: `calendar_events.attendees.status.response`
**Response.** The response type. It distinguishes the provider-defined response state or classification for the response status.
* **Enables:** Segment response status entries in Calendar Events by response in `calendar_events.ResponseStatus.response`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports response as a label from its own taxonomy on each response status; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calendar_events.attendees.status.time`
**Time.** Date and time the response was submitted. It anchors the calendar event on the provider's reported timeline.
* **Enables:** Order Calendar Events by time in `calendar_events.ResponseStatus.time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports time as a timestamp on each response status; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `calendar_events.attendees.type`
**Type.** Attendee type: required, optional, or resource. It distinguishes the provider-defined type state or classification for the attendee.
* **Enables:** Segment attendee entries in Calendar Events by type in `calendar_events.Attendee.type`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports type as a label from its own taxonomy on each attendee; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calendar_events.bodyPreview`
**Body Preview.** Short text preview of the event body content. It defines the content surface available for this calendar event.
* **Enables:** Locate calendar event records whose body preview in `calendar_events.bodyPreview` contains the search term; open the Microsoft 365 record when the excerpt lacks needed context.
* **Interpretation:** This is an excerpt supplied by the provider, not the complete body or an attachment.
Developer identifier: `calendar_events.calendar`
**Calendar.** The calendar navigation property or calendar ID associated with the event. It identifies the related provider object that gives the calendar event its parent, owner, or container context.
* **Enables:** Connect each calendar event to the related calendar in `calendar_events.calendar` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** Microsoft 365 reports calendar as relationship context on each calendar event; resolve it in the named provider namespace rather than by display text alone.
Developer identifier: `calendar_events.categories`
**Categories.** User-assigned categories/labels on the event. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Compare the exact Microsoft 365-configured categories set in `calendar_events.categories` for each calendar event; preserve provider labels and unknown entries.
* **Interpretation:** Microsoft 365 returns categories as an array of category value entries on each calendar event; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calendar_events.changeKey`
**Change Key.** Version identifier of the event; changes each time the event is modified. It provides the reference needed to connect the calendar event to the corresponding provider object.
* **Enables:** Connect each calendar event in Calendar Events to the referenced change through `calendar_events.changeKey`; flag change key values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports change key as an identifier in its change namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `calendar_events.createdDateTime`
**Created Date Time.** Date and time the event was created in ISO 8601 format. It anchors the calendar event on the provider's reported timeline.
* **Enables:** Order Calendar Events by created date time in `calendar_events.createdDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports created date time as a timestamp on each calendar event; timezone and precision follow this API field, and absence is not an inferred event time. The schema designates this field as the event timestamp.
Developer identifier: `calendar_events.end`
**End.** End date/time and timezone of the event. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute end in `calendar_events.end` to the parent calendar event; identify parent records where that nested end object is absent.
* **Interpretation:** Microsoft 365 reports end as a nested object on each calendar event; optional children may be absent from a valid response.
Developer identifier: `calendar_events.iCalUId`
**I Cal U ID.** Unique identifier for the event across calendars. Stable when the event moves between calendars, unlike ID. It provides the reference needed to connect the calendar event to the corresponding provider object.
* **Enables:** Connect each calendar event in Calendar Events to the referenced i cal u through `calendar_events.iCalUId`; flag i cal u ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports i cal u ID as an identifier in its i cal u namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `calendar_events.id`
**ID.** Unique identifier for the event. It provides the reference needed to connect the calendar event to the corresponding provider object.
* **Enables:** Match repeated calendar event entries on ID in `calendar_events.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its calendar event namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `calendar_events.importance`
**Importance.** Importance level of the event. It distinguishes the provider-defined importance state or classification for the calendar event.
* **Enables:** Segment calendar event entries in Calendar Events by importance in `calendar_events.importance`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports importance as a label from its own taxonomy on each calendar event; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calendar_events.isAllDay`
**Is All Day.** Whether the event lasts all day. It distinguishes the provider-defined is all day state or classification for the calendar event.
* **Enables:** Filter Calendar Events by whether the event lasts all day in `calendar_events.isAllDay`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the event lasts all day as a boolean on each calendar event; a missing field is unknown, not false.
Developer identifier: `calendar_events.isCancelled`
**Is Cancelled.** Whether the event has been cancelled. It distinguishes the provider-defined is cancelled state or classification for the calendar event.
* **Enables:** Filter Calendar Events by whether the event has been cancelled in `calendar_events.isCancelled`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the event has been cancelled as a boolean on each calendar event; a missing field is unknown, not false.
Developer identifier: `calendar_events.isOnlineMeeting`
**Is Online Meeting.** Whether the event is an online meeting. It distinguishes the provider-defined is online meeting state or classification for the calendar event.
* **Enables:** Filter Calendar Events by whether the event is an online meeting in `calendar_events.isOnlineMeeting`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the event is an online meeting as a boolean on each calendar event; a missing field is unknown, not false.
Developer identifier: `calendar_events.lastModifiedDateTime`
**Last Modified Date Time.** Date and time the event was last modified in ISO 8601 format. Used as incremental sync cursor. It anchors the calendar event on the provider's reported timeline.
* **Enables:** Order Calendar Events by last modified date time in `calendar_events.lastModifiedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports last modified date time as a timestamp on each calendar event; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `calendar_events.location`
**Location.** Location of the event. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute location in `calendar_events.location` to the parent calendar event; identify parent records where that nested location object is absent.
* **Interpretation:** Microsoft 365 reports location as a nested object on each calendar event; optional children may be absent from a valid response. This nested location attribute does not establish where data is stored or processed and is not a residency signal.
Developer identifier: `calendar_events.location.address`
**Address.** Physical street address of the location. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute address in `calendar_events.Location.address` to the parent calendar event; identify parent records where that nested address object is absent.
* **Interpretation:** Microsoft 365 reports address as a nested object on each location; optional children may be absent from a valid response.
Developer identifier: `calendar_events.location.address.city`
**City.** City. It supplies the provider-reported address or location facet for the physical address, not a residency determination.
* **Enables:** Group Calendar Events by city in `calendar_events.PhysicalAddress.city` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports city as a user, device, request, or resource location attribute on each physical address; it does not establish where data is stored or processed.
Developer identifier: `calendar_events.location.address.countryOrRegion`
**Country Or Region.** Country or region. It supplies the provider-reported address or location facet for the physical address, not a residency determination.
* **Enables:** Group Calendar Events by country or region in `calendar_events.PhysicalAddress.countryOrRegion` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports country or region as a user, device, request, or resource location attribute on each physical address; it does not establish where data is stored or processed.
Developer identifier: `calendar_events.location.address.postalCode`
**Postal Code.** Postal/ZIP code. It supplies the provider-reported address or location facet for the physical address, not a residency determination.
* **Enables:** Group Calendar Events by the exact postal code in `calendar_events.PhysicalAddress.postalCode` while keeping that address or location separate from geolocation and residency claims.
* **Interpretation:** Microsoft 365 reports postal code as an address or location facet on each physical address; it does not establish verified geolocation or data residency.
Developer identifier: `calendar_events.location.address.state`
**State.** State or province. It distinguishes the provider-defined state state or classification for the physical address.
* **Enables:** Group Calendar Events by state in `calendar_events.PhysicalAddress.state` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports state as a user, device, request, or resource location attribute on each physical address; it does not establish where data is stored or processed.
Developer identifier: `calendar_events.location.address.street`
**Street.** Street address. It supplies the provider-reported address or location facet for the physical address, not a residency determination.
* **Enables:** Group Calendar Events by the exact street in `calendar_events.PhysicalAddress.street` while keeping that address or location separate from geolocation and residency claims.
* **Interpretation:** Microsoft 365 reports street as an address or location facet on each physical address; it does not establish verified geolocation or data residency.
Developer identifier: `calendar_events.location.coordinates`
**Coordinates.** Geographic coordinates and elevation of the location. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute coordinates in `calendar_events.Location.coordinates` to the parent calendar event; identify parent records where that nested coordinates object is absent.
* **Interpretation:** Microsoft 365 reports coordinates as a nested object on each location; optional children may be absent from a valid response.
Developer identifier: `calendar_events.location.coordinates.accuracy`
**Accuracy.** Accuracy of the coordinates in meters. It supplies the accuracy measure for the geo coordinate at the provider's declared unit and grain.
* **Enables:** Measure accuracy through `calendar_events.GeoCoordinates.accuracy` for each geo coordinate and compare only values with the same unit and record grain.
* **Interpretation:** Microsoft 365 reports accuracy as a measure on each geo coordinate; compare only records with the same unit and aggregation grain.
Developer identifier: `calendar_events.location.coordinates.altitude`
**Altitude.** Altitude of the location. It supplies the provider-reported address or location facet for the geo coordinate, not a residency determination.
* **Enables:** Group Calendar Events by the exact altitude in `calendar_events.GeoCoordinates.altitude` while keeping that address or location separate from geolocation and residency claims.
* **Interpretation:** Microsoft 365 reports altitude as an address or location facet on each geo coordinate; it does not establish verified geolocation or data residency.
Developer identifier: `calendar_events.location.coordinates.altitudeAccuracy`
**Altitude Accuracy.** Accuracy of the altitude in meters. It supplies the altitude accuracy measure for the geo coordinate at the provider's declared unit and grain.
* **Enables:** Measure altitude accuracy through `calendar_events.GeoCoordinates.altitudeAccuracy` for each geo coordinate and compare only values with the same unit and record grain.
* **Interpretation:** Microsoft 365 reports altitude accuracy as a measure on each geo coordinate; compare only records with the same unit and aggregation grain.
Developer identifier: `calendar_events.location.coordinates.latitude`
**Latitude.** Latitude of the location. It supplies the provider-reported address or location facet for the geo coordinate, not a residency determination.
* **Enables:** Group Calendar Events by latitude in `calendar_events.GeoCoordinates.latitude` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports latitude as a user, device, request, or resource location attribute on each geo coordinate; it does not establish where data is stored or processed.
Developer identifier: `calendar_events.location.coordinates.longitude`
**Longitude.** Longitude of the location. It supplies the provider-reported address or location facet for the geo coordinate, not a residency determination.
* **Enables:** Group Calendar Events by longitude in `calendar_events.GeoCoordinates.longitude` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports longitude as a user, device, request, or resource location attribute on each geo coordinate; it does not establish where data is stored or processed.
Developer identifier: `calendar_events.location.displayName`
**Display Name.** Display name of the location. It distinguishes the provider-defined display name state or classification for the location.
* **Enables:** Label each location with display name from `calendar_events.Location.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each location; names are mutable and are not stable identities.
Developer identifier: `calendar_events.location.locationEmailAddress`
**Location Email Address.** Email address associated with the location (e.g. a conference room). It supplies the provider-reported address or location facet for the location, not a residency determination.
* **Enables:** Attribute each location to a person or account by the exact location email address in `calendar_events.Location.locationEmailAddress`; identify addresses that do not match the Microsoft 365 directory.
* **Interpretation:** Microsoft 365 reports location email address as an address on each location; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `calendar_events.location.locationType`
**Location Type.** Type of location. It distinguishes the provider-defined location type state or classification for the location.
* **Enables:** Segment location entries in Calendar Events by location type in `calendar_events.Location.locationType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports location type as a label from its own taxonomy on each location; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calendar_events.location.locationUri`
**Location URI.** URI representing the location. It supplies the provider-reported address or location facet for the location, not a residency determination.
* **Enables:** Associate each location with the resource identified by location URI in `calendar_events.Location.locationUri`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports location URI as a resource locator for each location; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `calendar_events.location.uniqueId`
**Unique ID.** Unique identifier of the location, if available. It provides the reference needed to connect the calendar event to the corresponding provider object.
* **Enables:** Connect each location in Calendar Events to the referenced unique through `calendar_events.Location.uniqueId`; flag unique ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports unique ID as an identifier in its unique namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `calendar_events.location.uniqueIdType`
**Unique ID Type.** Type of the unique ID for the location. It distinguishes the provider-defined unique ID type state or classification for the location.
* **Enables:** Segment location entries in Calendar Events by unique ID type in `calendar_events.Location.uniqueIdType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports unique ID type as a label from its own taxonomy on each location; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calendar_events.onlineMeeting`
**Online Meeting.** Details for joining an online meeting, including join URL and conference ID. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute online meeting in `calendar_events.onlineMeeting` to the parent calendar event; identify parent records where that nested online meeting object is absent.
* **Interpretation:** Microsoft 365 reports online meeting as a nested object on each calendar event; optional children may be absent from a valid response.
Developer identifier: `calendar_events.onlineMeeting.conferenceId`
**Conference ID.** Conference ID for dial-in access. It provides the reference needed to connect the calendar event to the corresponding provider object.
* **Enables:** Connect each online meeting info in Calendar Events to the referenced conference through `calendar_events.OnlineMeetingInfo.conferenceId`; flag conference ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports conference ID as an identifier in its conference namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `calendar_events.onlineMeeting.dialinUrl`
**Dialin URL.** URL with dial-in information. It locates the provider resource or path associated with the online meeting info.
* **Enables:** Associate each online meeting info with the resource identified by dialin URL in `calendar_events.OnlineMeetingInfo.dialinUrl`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports dialin URL as a resource locator for each online meeting info; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `calendar_events.onlineMeeting.joinUrl`
**Join URL.** URL to join the online meeting. It locates the provider resource or path associated with the online meeting info.
* **Enables:** Associate each online meeting info with the resource identified by join URL in `calendar_events.OnlineMeetingInfo.joinUrl`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports join URL as a resource locator for each online meeting info; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `calendar_events.onlineMeeting.phones`
**Phones.** Phone numbers associated with the online meeting. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Reconcile each returned online meeting phone in `calendar_events.OnlineMeetingInfo.phones` with the parent calendar event's provider profile; preserve distinct aliases, contact points, and organization attributes.
* **Interpretation:** Microsoft 365 returns phones as an array of online meeting phone entries on each online meeting info; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calendar_events.onlineMeeting.phones.number`
**Number.** The phone number. It supplies the number measure for the online meeting phone at the provider's declared unit and grain.
* **Enables:** Measure number through `calendar_events.OnlineMeetingPhone.number` for each online meeting phone and compare only values with the same unit and record grain.
* **Interpretation:** Microsoft 365 reports number as a measure on each online meeting phone; compare only records with the same unit and aggregation grain.
Developer identifier: `calendar_events.onlineMeeting.phones.type`
**Type.** Type of phone number (e.g. toll, tollFree). It distinguishes the provider-defined type state or classification for the online meeting phone.
* **Enables:** Segment online meeting phone entries in Calendar Events by type in `calendar_events.OnlineMeetingPhone.type`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports type as a label from its own taxonomy on each online meeting phone; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calendar_events.onlineMeeting.quickDial`
**Quick Dial.** Quick dial code for the meeting. It supplies the sensitive provider access code needed to join the online meeting info, not a stable record identifier.
* **Enables:** Reconcile `calendar_events.OnlineMeetingInfo.quickDial` with the same conference entry point or meeting instructions when validating join access; handle it as sensitive access metadata.
* **Interpretation:** Microsoft 365 returns quick dial as meeting or conference access metadata on each online meeting info; it can rotate and does not identify the meeting by itself.
Developer identifier: `calendar_events.onlineMeeting.tollFreeNumbers`
**Toll Free Numbers.** List of toll-free phone numbers for dial-in. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Reconcile each returned toll free number value in `calendar_events.OnlineMeetingInfo.tollFreeNumbers` with the parent calendar event's provider profile; preserve distinct aliases, contact points, and organization attributes.
* **Interpretation:** Microsoft 365 returns toll free numbers as an array of toll free number value entries on each online meeting info; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calendar_events.onlineMeeting.tollNumber`
**Toll Number.** Toll phone number for dial-in. It supplies the toll number measure for the online meeting info at the provider's declared unit and grain.
* **Enables:** Measure toll number through `calendar_events.OnlineMeetingInfo.tollNumber` for each online meeting info and compare only values with the same unit and record grain.
* **Interpretation:** Microsoft 365 reports toll number as a measure on each online meeting info; compare only records with the same unit and aggregation grain.
Developer identifier: `calendar_events.onlineMeetingUrl`
**Online Meeting URL.** URL for joining the online meeting (legacy property). It locates the provider resource or path associated with the calendar event.
* **Enables:** Associate each calendar event with the resource identified by online meeting URL in `calendar_events.onlineMeetingUrl`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports online meeting URL as a resource locator for each calendar event; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `calendar_events.organizer`
**Organizer.** Organizer of the event with email and name. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute organizer in `calendar_events.organizer` to the parent calendar event; identify parent records where that nested organizer object is absent.
* **Interpretation:** Microsoft 365 reports organizer as a nested object on each calendar event; optional children may be absent from a valid response.
Developer identifier: `calendar_events.organizer.emailAddress`
**Email Address.** Email address and display name of the recipient. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute email address in `calendar_events.Recipient.emailAddress` to the parent calendar event; identify parent records where that nested email address object is absent.
* **Interpretation:** Microsoft 365 reports email address as a nested object on each recipient; optional children may be absent from a valid response.
Developer identifier: `calendar_events.originalEndTimeZone`
**Original End Time Zone.** End time zone the event was created in (IANA or Windows identifier). It is needed to interpret companion dates and times for the calendar event in the provider's intended zone.
* **Enables:** Apply the zone in `calendar_events.originalEndTimeZone` when converting the calendar event's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** Microsoft 365 reports original end time zone as a timezone identifier for each calendar event; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `calendar_events.originalStartTimeZone`
**Original Start Time Zone.** Start time zone the event was created in (IANA or Windows identifier). It is needed to interpret companion dates and times for the calendar event in the provider's intended zone.
* **Enables:** Apply the zone in `calendar_events.originalStartTimeZone` when converting the calendar event's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** Microsoft 365 reports original start time zone as a timezone identifier for each calendar event; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `calendar_events.recurrence`
**Recurrence.** Recurrence pattern and range for recurring events. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute recurrence in `calendar_events.recurrence` to the parent calendar event; identify parent records where that nested recurrence object is absent.
* **Interpretation:** Microsoft 365 reports recurrence as a nested object on each calendar event; optional children may be absent from a valid response.
Developer identifier: `calendar_events.recurrence.pattern`
**Pattern.** The frequency and rules of the recurrence. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute pattern in `calendar_events.PatternedRecurrence.pattern` to the parent calendar event; identify parent records where that nested pattern object is absent.
* **Interpretation:** Microsoft 365 reports pattern as a nested object on each patterned recurrence; optional children may be absent from a valid response.
Developer identifier: `calendar_events.recurrence.pattern.dayOfMonth`
**Day Of Month.** Day of the month for absoluteMonthly/absoluteYearly patterns. It supplies the day of month measure for the recurrence pattern at the provider's declared unit and grain.
* **Enables:** Measure day of month through `calendar_events.RecurrencePattern.dayOfMonth` for each recurrence pattern and compare only values with the same unit and record grain.
* **Interpretation:** Microsoft 365 reports day of month as a measure on each recurrence pattern; compare only records with the same unit and aggregation grain.
Developer identifier: `calendar_events.recurrence.pattern.daysOfWeek`
**Days Of Week.** Days of the week the event occurs on. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Compare the exact Microsoft 365-configured days of week set in `calendar_events.RecurrencePattern.daysOfWeek` for each recurrence pattern; preserve provider labels and unknown entries.
* **Interpretation:** Microsoft 365 returns days of week as an array of recurrence pattern day of week enum entries on each recurrence pattern; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `calendar_events.recurrence.pattern.firstDayOfWeek`
**First Day Of Week.** First day of the week for weekly patterns. It distinguishes the provider-defined first day of week state or classification for the recurrence pattern.
* **Enables:** Segment recurrence pattern entries in Calendar Events by first day of week in `calendar_events.RecurrencePattern.firstDayOfWeek`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports first day of week as a label from its own taxonomy on each recurrence pattern; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calendar_events.recurrence.pattern.index`
**Index.** Week index for relativeMonthly/relativeYearly patterns. It distinguishes the provider-defined index state or classification for the recurrence pattern.
* **Enables:** Segment recurrence pattern entries in Calendar Events by index in `calendar_events.RecurrencePattern.index`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports index as a label from its own taxonomy on each recurrence pattern; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calendar_events.recurrence.pattern.interval`
**Interval.** Number of units between occurrences (e.g. every 2 weeks). It supplies the interval boundary, band, or unit needed to interpret the companion measure.
* **Enables:** Interpret `calendar_events.RecurrencePattern.interval` with its companion minimum, maximum, interval, or unit before comparing the interval across like-for-like records.
* **Interpretation:** Microsoft 365 reports interval as a boundary, band, interval, or unit on each recurrence pattern; it is meaningful only with its companion measure and provider scale.
Developer identifier: `calendar_events.recurrence.pattern.month`
**Month.** Month in which the event occurs (1-12), for yearly patterns. It supplies the month measure for the recurrence pattern at the provider's declared unit and grain.
* **Enables:** Measure month through `calendar_events.RecurrencePattern.month` for each recurrence pattern and compare only values with the same unit and record grain.
* **Interpretation:** Microsoft 365 reports month as a measure on each recurrence pattern; compare only records with the same unit and aggregation grain.
Developer identifier: `calendar_events.recurrence.pattern.type`
**Type.** The recurrence pattern type. It distinguishes the provider-defined type state or classification for the recurrence pattern.
* **Enables:** Segment recurrence pattern entries in Calendar Events by type in `calendar_events.RecurrencePattern.type`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports type as a label from its own taxonomy on each recurrence pattern; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calendar_events.recurrence.range`
**Range.** The duration/bounds of the recurrence. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute range in `calendar_events.PatternedRecurrence.range` to the parent calendar event; identify parent records where that nested range object is absent.
* **Interpretation:** Microsoft 365 reports range as a nested object on each patterned recurrence; optional children may be absent from a valid response.
Developer identifier: `calendar_events.recurrence.range.endDate`
**End Date.** End date of the recurrence range (YYYY-MM-DD). Used when type is endDate. It anchors the calendar event on the provider's reported timeline.
* **Enables:** Filter Calendar Events by end date in `calendar_events.RecurrenceRange.endDate`; pair that boundary with the corresponding start before measuring elapsed time.
* **Interpretation:** Microsoft 365 reports end date as a calendar date on each recurrence range; its grain is one day and no time of day should be inferred.
Developer identifier: `calendar_events.recurrence.range.numberOfOccurrences`
**Number Of Occurrences.** Number of occurrences. Used when type is numbered. It supplies the number of occurrences measure for the recurrence range at the provider's declared unit and grain.
* **Enables:** Measure number of occurrences through `calendar_events.RecurrenceRange.numberOfOccurrences` for each recurrence range and compare only values with the same unit and record grain.
* **Interpretation:** Microsoft 365 reports number of occurrences as a measure on each recurrence range; compare only records with the same unit and aggregation grain.
Developer identifier: `calendar_events.recurrence.range.recurrenceTimeZone`
**Recurrence Time Zone.** Time zone for the start and end dates. It is needed to interpret companion dates and times for the recurrence range in the provider's intended zone.
* **Enables:** Apply the zone in `calendar_events.RecurrenceRange.recurrenceTimeZone` when converting the calendar event's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** Microsoft 365 reports recurrence time zone as a timezone identifier for each recurrence range; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `calendar_events.recurrence.range.startDate`
**Start Date.** Start date of the recurrence range (YYYY-MM-DD). It anchors the calendar event on the provider's reported timeline.
* **Enables:** Filter Calendar Events by start date in `calendar_events.RecurrenceRange.startDate`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** Microsoft 365 reports start date as a calendar date on each recurrence range; its grain is one day and no time of day should be inferred.
Developer identifier: `calendar_events.recurrence.range.type`
**Type.** The recurrence range type. It distinguishes the provider-defined type state or classification for the recurrence range.
* **Enables:** Segment recurrence range entries in Calendar Events by type in `calendar_events.RecurrenceRange.type`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports type as a label from its own taxonomy on each recurrence range; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calendar_events.responseStatus`
**Response Status.** The response status and time of the current user for this event. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute response status in `calendar_events.responseStatus` to the parent calendar event; identify parent records where that nested response status object is absent.
* **Interpretation:** Microsoft 365 reports response status as a nested object on each calendar event; optional children may be absent from a valid response.
Developer identifier: `calendar_events.sensitivity`
**Sensitivity.** Sensitivity level of the event. It distinguishes the provider-defined sensitivity state or classification for the calendar event.
* **Enables:** Segment calendar event entries in Calendar Events by sensitivity in `calendar_events.sensitivity`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports sensitivity as a label from its own taxonomy on each calendar event; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calendar_events.seriesMasterId`
**Series Master ID.** The ID of the recurring series master event, if this event is part of a recurring series. It provides the reference needed to connect the calendar event to the corresponding provider object.
* **Enables:** Connect each calendar event in Calendar Events to the referenced series master through `calendar_events.seriesMasterId`; flag series master ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports series master ID as an identifier in its series master namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `calendar_events.showAs`
**Show As.** Free/busy status shown during the event. It distinguishes the provider-defined show as state or classification for the calendar event.
* **Enables:** Segment calendar event entries in Calendar Events by show as in `calendar_events.showAs`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports show as as a label from its own taxonomy on each calendar event; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calendar_events.start`
**Start.** Start date/time and timezone of the event. It preserves the nested context needed to interpret the parent calendar event.
* **Enables:** Attribute start in `calendar_events.start` to the parent calendar event; identify parent records where that nested start object is absent.
* **Interpretation:** Microsoft 365 reports start as a nested object on each calendar event; optional children may be absent from a valid response.
Developer identifier: `calendar_events.subject`
**Subject.** Subject/title of the calendar event. It defines the content surface available for this calendar event.
* **Enables:** Locate calendar event records by subject in `calendar_events.subject`; attribute each text match to its parent calendar event and, when present, its reported author.
* **Interpretation:** Microsoft 365 supplies subject as text on each calendar event; referenced files or media are not implied unless explicitly represented.
Developer identifier: `calendar_events.type`
**Type.** The event type: singleInstance, occurrence, exception, or seriesMaster. It distinguishes the provider-defined type state or classification for the calendar event.
* **Enables:** Segment calendar event entries in Calendar Events by type in `calendar_events.type`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports type as a label from its own taxonomy on each calendar event; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `calendar_events.user_id`
**User ID.** Parent user reference copied into each calendar event because the child operation does not return that relationship. It provides the reference needed to connect the calendar event to the corresponding provider object.
* **Enables:** Connect each calendar event in Calendar Events to the referenced user through `calendar_events.user_id`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies user ID from the parent traversal record into each calendar event; the child Microsoft 365 operation does not return it.
Developer identifier: `calendar_events.webLink`
**Web Link.** URL to open the event in Outlook on the web. It locates the provider resource or path associated with the calendar event.
* **Enables:** Associate each calendar event with the resource identified by web link in `calendar_events.webLink`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports web link as a resource locator for each calendar event; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `channel_members`
**Channel Members.** Members of each Teams channel.
* **Enables:** Match each Teams channel membership to the channel, user, roles, and provider membership identifier.
* **Scope:** Reads the records selected by Microsoft 365's `/v1.0/teams/{team_id}/channels/{id}/members` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `channel_members.channel_id`
**Channel ID.** Parent channel reference copied into each channel member because the child operation does not return that relationship. It provides the reference needed to connect the channel member to the corresponding provider object.
* **Enables:** Connect each channel member in Channel Members to the referenced channel through `channel_members.channel_id`; flag channel ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies channel ID from the parent traversal record into each channel member; the child Microsoft 365 operation does not return it.
Developer identifier: `channel_members.displayName`
**Display Name.** Display name of the member. It distinguishes the provider-defined display name state or classification for the channel member.
* **Enables:** Label each channel member with display name from `channel_members.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each channel member; names are mutable and are not stable identities.
Developer identifier: `channel_members.email`
**Email.** Email address of the member when present. It supplies the provider-reported address or location facet for the channel member, not a residency determination.
* **Enables:** Attribute each channel member to a person or account by the exact email in `channel_members.email`; identify addresses that do not match the Microsoft 365 directory.
* **Interpretation:** Microsoft 365 reports email as an address on each channel member; aliases, casing, and unverified addresses can prevent a one-to-one person match. A connector directive maps this field to a person's email identity.
Developer identifier: `channel_members.id`
**ID.** Opaque membership ID. It provides the reference needed to connect the channel member to the corresponding provider object.
* **Enables:** Connect each channel member in Channel Members to the referenced channel member through `channel_members.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its channel member namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_members.membership_key`
**Membership Key.** Synthetic primary key hashing injected channel\_id and wire membership ID. Graph membership IDs are opaque and can collide across channels for the same user. It provides the reference needed to connect the channel member to the corresponding provider object.
* **Enables:** Match repeated channel member entries on membership key in `channel_members.membership_key`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports membership key as an identifier in its membership namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `channel_members.roles`
**Roles.** Roles of the member in the channel (e.g. owner, guest). It preserves the nested context needed to interpret the parent channel member.
* **Enables:** Compare the exact Microsoft 365-configured roles set in `channel_members.roles` for each channel member; preserve provider labels and unknown entries.
* **Interpretation:** Microsoft 365 returns roles as an array of role value entries on each channel member; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `channel_members.team_id`
**Team ID.** Parent team reference copied into each channel member because the child operation does not return that relationship. It provides the reference needed to connect the channel member to the corresponding provider object.
* **Enables:** Connect each channel member in Channel Members to the referenced team through `channel_members.team_id`; flag team ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies team ID from the parent traversal record into each channel member; the child Microsoft 365 operation does not return it.
Developer identifier: `channel_members.tenantId`
**Tenant ID.** Tenant ID of the member. It provides the reference needed to connect the channel member to the corresponding provider object.
* **Enables:** Connect each channel member in Channel Members to the referenced tenant through `channel_members.tenantId`; flag tenant ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports tenant ID as an identifier in its tenant namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_members.userId`
**User ID.** Entra user ID of the member. It provides the reference needed to connect the channel member to the corresponding provider object.
* **Enables:** Connect each channel member in Channel Members to the referenced user through `channel_members.userId`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports user ID as an identifier in its user namespace; it is not a universal identity outside Microsoft 365. A connector directive maps this field to account identity.
Developer identifier: `channel_members.visibleHistoryStartDateTime`
**Visible History Start Date Time.** Earliest message history visible to this member, when set. It anchors the channel member on the provider's reported timeline.
* **Enables:** Filter Channel Members by visible history start date time in `channel_members.visibleHistoryStartDateTime`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** Microsoft 365 reports visible history start date time as a timestamp on each channel member; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `channel_messages`
**Channel Messages.** All channel messages across a team (including thread replies) via Teams export API.
* **Enables:** Attribute Teams channel posts and thread replies to their channel, author, mentions, and timestamps.
* **Scope:** Reads the records selected by Microsoft 365's `/v1.0/teams/{id}/channels/getAllMessages` operation as an event stream using incremental synchronization. This stream is opt-in. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. Message bodies and message-level attachment or mention metadata may be present, but binary attachment content is not fetched. This stream supplies no reliable deletion signal.
Developer identifier: `channel_messages.attachments`
**Attachments.** Attachments on the message. It preserves the nested context needed to interpret the parent channel message.
* **Enables:** Associate each returned chat message attachment metadata entry in `channel_messages.attachments` with the parent channel message; inventory the reference without assuming file, recording, or attachment bytes are present.
* **Interpretation:** Microsoft 365 returns attachments as file, recording, or attachment metadata on each channel message; the array does not imply that binary content was collected. This field is metadata or a reference for the file or attachment; it does not by itself include binary content.
Developer identifier: `channel_messages.attachments.content`
**Content.** The provider-reported content for each chat message attachment in Channel Messages. It defines the content surface available for this channel message.
* **Enables:** Locate chat message attachment records by content in `channel_messages.ChatMessageAttachment.content`; attribute each text match to its parent channel message and, when present, its reported author.
* **Interpretation:** This is attachment or file metadata; it does not by itself include the referenced file bytes. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `channel_messages.attachments.contentType`
**Content Type.** The provider-reported content type for each chat message attachment in Channel Messages. It supplies the returned content type text needed to understand the chat message attachment in context.
* **Enables:** Segment chat message attachment entries in Channel Messages by content type in `channel_messages.ChatMessageAttachment.contentType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports content type as a label from its own taxonomy on each chat message attachment; preserve unknown labels rather than mapping them by assumption. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `channel_messages.attachments.contentUrl`
**Content URL.** ContentUrl for the attachment. It locates the provider resource or path associated with the chat message attachment.
* **Enables:** Associate each chat message attachment with the resource identified by content URL in `channel_messages.ChatMessageAttachment.contentUrl`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports content URL as a resource locator for each chat message attachment; access still depends on viewer permissions and the URL may expire or change. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `channel_messages.attachments.id`
**ID.** The provider-reported ID for each chat message attachment in Channel Messages. It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Match repeated chat message attachment entries on ID in `channel_messages.ChatMessageAttachment.id`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its chat message attachment namespace; it is not a universal identity outside Microsoft 365. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `channel_messages.attachments.name`
**Name.** The provider-reported name for each chat message attachment in Channel Messages. It gives the chat message attachment a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each chat message attachment with name from `channel_messages.ChatMessageAttachment.name`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports name as display text for each chat message attachment; names are mutable and are not stable identities. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `channel_messages.attachments.thumbnailUrl`
**Thumbnail URL.** ThumbnailUrl for the attachment. It locates the provider resource or path associated with the chat message attachment.
* **Enables:** Associate each chat message attachment with the resource identified by thumbnail URL in `channel_messages.ChatMessageAttachment.thumbnailUrl`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports thumbnail URL as a resource locator for each chat message attachment; access still depends on viewer permissions and the URL may expire or change. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `channel_messages.body`
**Body.** Message body content. It preserves the nested context needed to interpret the parent channel message.
* **Enables:** Attribute body in `channel_messages.body` to the parent channel message; identify parent records where that nested body object is absent.
* **Interpretation:** Microsoft 365 reports body as a nested object on each channel message; optional children may be absent from a valid response.
Developer identifier: `channel_messages.body.content`
**Content.** Body content. It defines the content surface available for this channel message.
* **Enables:** Locate chat message body records by content in `channel_messages.ChatMessageBody.content`; attribute each text match to its parent channel message and, when present, its reported author.
* **Interpretation:** Microsoft 365 supplies content as text on each chat message body; referenced files or media are not implied unless explicitly represented.
Developer identifier: `channel_messages.body.contentType`
**Content Type.** Content type: text or html. It supplies the returned content type text needed to understand the chat message body in context.
* **Enables:** Segment chat message body entries in Channel Messages by content type in `channel_messages.ChatMessageBody.contentType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports content type as a label from its own taxonomy on each chat message body; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `channel_messages.channelIdentity`
**Channel Identity.** Team and channel identity for this message. It preserves the nested context needed to interpret the parent channel message.
* **Enables:** Attribute channel identity in `channel_messages.channelIdentity` to the parent channel message; identify parent records where that nested channel identity object is absent.
* **Interpretation:** Microsoft 365 reports channel identity as a nested object on each channel message; optional children may be absent from a valid response.
Developer identifier: `channel_messages.channelIdentity.channelId`
**Channel ID.** Channel ID (opaque thread ID). It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Connect each channel identity in Channel Messages to the referenced channel through `channel_messages.ChannelIdentity.channelId`; flag channel ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports channel ID as an identifier in its channel namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_messages.channelIdentity.teamId`
**Team ID.** Team ID. It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Connect each channel identity in Channel Messages to the referenced team through `channel_messages.ChannelIdentity.teamId`; flag team ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports team ID as an identifier in its team namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_messages.chatId`
**Chat ID.** Chat ID when the message belongs to a chat rather than a channel; null for channel messages. It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Connect each channel message in Channel Messages to the referenced chat through `channel_messages.chatId`; flag chat ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports chat ID as an identifier in its chat namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_messages.createdDateTime`
**Created Date Time.** When the message was created. It anchors the channel message on the provider's reported timeline.
* **Enables:** Order Channel Messages by created date time in `channel_messages.createdDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports created date time as a timestamp on each channel message; timezone and precision follow this API field, and absence is not an inferred event time. The schema designates this field as the event timestamp.
Developer identifier: `channel_messages.deletedDateTime`
**Deleted Date Time.** When the message was soft-deleted, if ever. It anchors the channel message on the provider's reported timeline.
* **Enables:** Order Channel Messages by deleted date time in `channel_messages.deletedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports deleted date time as a timestamp on each channel message; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `channel_messages.etag`
**ETag.** Version stamp for the message. It is needed for conditional reads and provider-version checks, not as a stable business identifier.
* **Enables:** Use `channel_messages.etag` for conditional provider reads and revision checks; pair the ETag with the channel message ID rather than joining on it.
* **Interpretation:** Microsoft 365 returns this ETag as an opaque revision token for each channel message; it can change when the resource changes and is not a universal identifier.
Developer identifier: `channel_messages.from`
**From.** Identity of the sender. It preserves the nested context needed to interpret the parent channel message.
* **Enables:** Attribute from in `channel_messages.from` to the parent channel message; identify parent records where that nested from object is absent.
* **Interpretation:** Microsoft 365 reports from as a nested object on each channel message; optional children may be absent from a valid response.
Developer identifier: `channel_messages.from.application`
**Application.** Application identity when the sender is an app. It preserves the nested context needed to interpret the parent channel message.
* **Enables:** Attribute application in `channel_messages.ChatMessageFrom.application` to the parent channel message; identify parent records where that nested application object is absent.
* **Interpretation:** Microsoft 365 reports application as a nested object on each chat message from; optional children may be absent from a valid response.
Developer identifier: `channel_messages.from.application.applicationIdentityType`
**Application Identity Type.** The provider-reported application identity type for each application in Channel Messages. It distinguishes the provider-defined application identity type state or classification for the application.
* **Enables:** Segment application entries in Channel Messages by application identity type in `channel_messages.ChatMessageFrom.application.applicationIdentityType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports application identity type as a label from its own taxonomy on each application; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `channel_messages.from.application.displayName`
**Display Name.** The provider-reported display name for each application in Channel Messages. It distinguishes the provider-defined display name state or classification for the application.
* **Enables:** Label each application with display name from `channel_messages.ChatMessageFrom.application.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each application; names are mutable and are not stable identities.
Developer identifier: `channel_messages.from.application.id`
**ID.** The provider-reported ID for each application in Channel Messages. It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Connect each application in Channel Messages to the referenced application through `channel_messages.ChatMessageFrom.application.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its application namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_messages.from.device`
**Device.** Device identity when the sender is a device. It preserves the nested context needed to interpret the parent channel message.
* **Enables:** Attribute device in `channel_messages.ChatMessageFrom.device` to the parent channel message; identify parent records where that nested device object is absent.
* **Interpretation:** Microsoft 365 reports device as a nested object on each chat message from; optional children may be absent from a valid response.
Developer identifier: `channel_messages.from.device.displayName`
**Display Name.** The provider-reported display name for each device in Channel Messages. It distinguishes the provider-defined display name state or classification for the device.
* **Enables:** Label each device with display name from `channel_messages.ChatMessageFrom.device.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each device; names are mutable and are not stable identities.
Developer identifier: `channel_messages.from.device.id`
**ID.** The provider-reported ID for each device in Channel Messages. It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Connect each device in Channel Messages to the referenced device through `channel_messages.ChatMessageFrom.device.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its device namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_messages.from.user`
**User.** User identity when the sender is a user. It preserves the nested context needed to interpret the parent channel message.
* **Enables:** Attribute user in `channel_messages.ChatMessageFrom.user` to the parent channel message; identify parent records where that nested user object is absent.
* **Interpretation:** Microsoft 365 reports user as a nested object on each chat message from; optional children may be absent from a valid response.
Developer identifier: `channel_messages.from.user.displayName`
**Display Name.** Display name of the sender. It distinguishes the provider-defined display name state or classification for the user.
* **Enables:** Label each user with display name from `channel_messages.ChatMessageFrom.user.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each user; names are mutable and are not stable identities.
Developer identifier: `channel_messages.from.user.id`
**ID.** Entra user ID of the sender. It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Connect each user in Channel Messages to the referenced user through `channel_messages.ChatMessageFrom.user.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its user namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_messages.from.user.tenantId`
**Tenant ID.** Tenant ID of the sender when present. It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Connect each user in Channel Messages to the referenced tenant through `channel_messages.ChatMessageFrom.user.tenantId`; flag tenant ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports tenant ID as an identifier in its tenant namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_messages.from.user.userIdentityType`
**User Identity Type.** User identity type (e.g. aadUser). It supplies the user identity type profile facet used to reconcile or attribute the user.
* **Enables:** Segment user entries in Channel Messages by user identity type in `channel_messages.ChatMessageFrom.user.userIdentityType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports user identity type as a label from its own taxonomy on each user; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `channel_messages.id`
**ID.** Wire chatMessage ID (unique within its channel). It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Connect each channel message in Channel Messages to the referenced channel message through `channel_messages.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its channel message namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_messages.importance`
**Importance.** Message importance: normal, high, urgent, or unknownFutureValue. It supplies the returned importance text needed to understand the channel message in context.
* **Enables:** Search the returned importance text in `channel_messages.importance` and attribute each match to its parent channel message and reported author when available.
* **Interpretation:** Microsoft 365 supplies importance as returned text on each channel message; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `channel_messages.lastEditedDateTime`
**Last Edited Date Time.** When the message body was last edited, if ever. It anchors the channel message on the provider's reported timeline.
* **Enables:** Order Channel Messages by last edited date time in `channel_messages.lastEditedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports last edited date time as a timestamp on each channel message; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `channel_messages.lastModifiedDateTime`
**Last Modified Date Time.** When the message was last modified. Used as incremental sync cursor. It anchors the channel message on the provider's reported timeline.
* **Enables:** Order Channel Messages by last modified date time in `channel_messages.lastModifiedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports last modified date time as a timestamp on each channel message; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `channel_messages.locale`
**Locale.** Locale of the message body. It supplies the returned locale text needed to understand the channel message in context.
* **Enables:** Search the returned locale text in `channel_messages.locale` and attribute each match to its parent channel message and reported author when available.
* **Interpretation:** Microsoft 365 supplies locale as returned text on each channel message; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `channel_messages.mentions`
**Mentions.** Mentions in the message. It preserves the nested context needed to interpret the parent channel message.
* **Enables:** Attribute each returned chat message mention in `channel_messages.mentions` to the parent channel message and reconcile the reacting or mentioned users and provider symbol.
* **Interpretation:** Microsoft 365 returns mentions as an array of chat message mention entries on each channel message; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `channel_messages.mentions.id`
**ID.** Mention index within the message. It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Match repeated chat message mention entries on ID in `channel_messages.ChatMessageMention.id`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its chat message mention namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_messages.mentions.mentioned`
**Mentioned.** Identity that was mentioned. It preserves the nested context needed to interpret the parent channel message.
* **Enables:** Attribute mentioned in `channel_messages.ChatMessageMention.mentioned` to the parent channel message; identify parent records where that nested mentioned object is absent.
* **Interpretation:** Microsoft 365 reports mentioned as a nested object on each chat message mention; optional children may be absent from a valid response.
Developer identifier: `channel_messages.mentions.mentioned.application`
**Application.** The structured application details attached to each mentioned in Channel Messages. It preserves the nested context needed to interpret the parent channel message.
* **Enables:** Attribute application in `channel_messages.ChatMessageMention.mentioned.application` to the parent channel message; identify parent records where that nested application object is absent.
* **Interpretation:** Microsoft 365 reports application as a nested object on each mentioned; optional children may be absent from a valid response.
Developer identifier: `channel_messages.mentions.mentioned.application.applicationIdentityType`
**Application Identity Type.** The provider-reported application identity type for each application in Channel Messages. It distinguishes the provider-defined application identity type state or classification for the application.
* **Enables:** Segment application entries in Channel Messages by application identity type in `channel_messages.ChatMessageMention.mentioned.application.applicationIdentityType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports application identity type as a label from its own taxonomy on each application; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `channel_messages.mentions.mentioned.application.displayName`
**Display Name.** The provider-reported display name for each application in Channel Messages. It distinguishes the provider-defined display name state or classification for the application.
* **Enables:** Label each application with display name from `channel_messages.ChatMessageMention.mentioned.application.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each application; names are mutable and are not stable identities.
Developer identifier: `channel_messages.mentions.mentioned.application.id`
**ID.** The provider-reported ID for each application in Channel Messages. It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Connect each application in Channel Messages to the referenced application through `channel_messages.ChatMessageMention.mentioned.application.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its application namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_messages.mentions.mentioned.conversation`
**Conversation.** The structured conversation details attached to each mentioned in Channel Messages. It preserves the nested context needed to interpret the parent channel message.
* **Enables:** Attribute conversation in `channel_messages.ChatMessageMention.mentioned.conversation` to the parent channel message; identify parent records where that nested conversation object is absent.
* **Interpretation:** Microsoft 365 reports conversation as a nested object on each mentioned; optional children may be absent from a valid response.
Developer identifier: `channel_messages.mentions.mentioned.conversation.conversationIdentityType`
**Conversation Identity Type.** The provider-reported conversation identity type for each conversation in Channel Messages. It distinguishes the provider-defined conversation identity type state or classification for the conversation.
* **Enables:** Segment conversation entries in Channel Messages by conversation identity type in `channel_messages.ChatMessageMention.mentioned.conversation.conversationIdentityType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports conversation identity type as a label from its own taxonomy on each conversation; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `channel_messages.mentions.mentioned.conversation.displayName`
**Display Name.** The provider-reported display name for each conversation in Channel Messages. It distinguishes the provider-defined display name state or classification for the conversation.
* **Enables:** Label each conversation with display name from `channel_messages.ChatMessageMention.mentioned.conversation.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each conversation; names are mutable and are not stable identities.
Developer identifier: `channel_messages.mentions.mentioned.conversation.id`
**ID.** The provider-reported ID for each conversation in Channel Messages. It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Connect each conversation in Channel Messages to the referenced conversation through `channel_messages.ChatMessageMention.mentioned.conversation.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its conversation namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_messages.mentions.mentioned.user`
**User.** The structured user details attached to each mentioned in Channel Messages. It preserves the nested context needed to interpret the parent channel message.
* **Enables:** Attribute user in `channel_messages.ChatMessageMention.mentioned.user` to the parent channel message; identify parent records where that nested user object is absent.
* **Interpretation:** Microsoft 365 reports user as a nested object on each mentioned; optional children may be absent from a valid response.
Developer identifier: `channel_messages.mentions.mentioned.user.displayName`
**Display Name.** The provider-reported display name for each user in Channel Messages. It distinguishes the provider-defined display name state or classification for the user.
* **Enables:** Label each user with display name from `channel_messages.ChatMessageMention.mentioned.user.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each user; names are mutable and are not stable identities.
Developer identifier: `channel_messages.mentions.mentioned.user.id`
**ID.** The provider-reported ID for each user in Channel Messages. It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Connect each user in Channel Messages to the referenced user through `channel_messages.ChatMessageMention.mentioned.user.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its user namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_messages.mentions.mentioned.user.userIdentityType`
**User Identity Type.** The provider-reported user identity type for each user in Channel Messages. It supplies the user identity type profile facet used to reconcile or attribute the user.
* **Enables:** Segment user entries in Channel Messages by user identity type in `channel_messages.ChatMessageMention.mentioned.user.userIdentityType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports user identity type as a label from its own taxonomy on each user; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `channel_messages.mentions.mentionText`
**Mention Text.** Display text of the mention. It defines the content surface available for this channel message.
* **Enables:** Locate chat message mention records by mention text in `channel_messages.ChatMessageMention.mentionText`; attribute each text match to its parent channel message and, when present, its reported author.
* **Interpretation:** Microsoft 365 supplies mention text as text on each chat message mention; referenced files or media are not implied unless explicitly represented.
Developer identifier: `channel_messages.message_key`
**Message Key.** Synthetic primary key hashing channelIdentity.channelId and wire ID. Graph message IDs are unique within a channel, not across channels. It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Match repeated channel message entries on message key in `channel_messages.message_key`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports message key as an identifier in its message namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `channel_messages.messageType`
**Message Type.** Message type (message, chatEvent, typing, unknownFutureValue, systemEventMessage). It supplies the returned message type text needed to understand the channel message in context.
* **Enables:** Segment channel message entries in Channel Messages by message type in `channel_messages.messageType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports message type as a label from its own taxonomy on each channel message; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `channel_messages.reactions`
**Reactions.** Reactions on the message. Stored as Generic.JSON because Graph emits one object per (user, emoji); a typed child table keyed only on reactionType would silently collapse multi-user reactions. It preserves the nested context needed to interpret the parent channel message.
* **Enables:** Attribute each returned reaction in `channel_messages.reactions` to the parent channel message and reconcile the reacting or mentioned users and provider symbol.
* **Interpretation:** Microsoft 365 returns reactions as an array of reaction entries on each channel message; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `channel_messages.replyToId`
**Reply To ID.** ID of the parent root message when this record is a thread reply. It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Connect each channel message in Channel Messages to the referenced reply to through `channel_messages.replyToId`; flag reply to ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports reply to ID as an identifier in its reply to namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channel_messages.subject`
**Subject.** Plaintext subject of the message. It defines the content surface available for this channel message.
* **Enables:** Locate channel message records by subject in `channel_messages.subject`; attribute each text match to its parent channel message and, when present, its reported author.
* **Interpretation:** Microsoft 365 supplies subject as text on each channel message; referenced files or media are not implied unless explicitly represented.
Developer identifier: `channel_messages.summary`
**Summary.** Summary text for notifications or fallback views. It defines the content surface available for this channel message.
* **Enables:** Locate channel message records by summary in `channel_messages.summary`; attribute each text match to its parent channel message and, when present, its reported author.
* **Interpretation:** Microsoft 365 supplies summary as text on each channel message; referenced files or media are not implied unless explicitly represented. Microsoft 365 generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `channel_messages.team_id`
**Team ID.** Parent team reference copied into each channel message because the child operation does not return that relationship. It provides the reference needed to connect the channel message to the corresponding provider object.
* **Enables:** Connect each channel message in Channel Messages to the referenced team through `channel_messages.team_id`; flag team ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies team ID from the parent traversal record into each channel message; the child Microsoft 365 operation does not return it.
Developer identifier: `channel_messages.webUrl`
**Web URL.** Deep link URL to the message in Microsoft Teams. It locates the provider resource or path associated with the channel message.
* **Enables:** Associate each channel message with the resource identified by web URL in `channel_messages.webUrl`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports web URL as a resource locator for each channel message; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `channels`
**Channels.** Channels within each Microsoft Team.
* **Enables:** Match channels to their parent Team and compare channel name, description, type, membership mode, and lifecycle state.
* **Scope:** Reads the records selected by Microsoft 365's `/v1.0/teams/{id}/channels` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `channels.createdDateTime`
**Created Date Time.** When the channel was created. It anchors the channel on the provider's reported timeline.
* **Enables:** Order Channels by created date time in `channels.createdDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports created date time as a timestamp on each channel; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `channels.description`
**Description.** Optional channel description. It defines the content surface available for this channel.
* **Enables:** Locate channel records by description in `channels.description`; attribute each text match to its parent channel and, when present, its reported author.
* **Interpretation:** Microsoft 365 supplies description as text on each channel; referenced files or media are not implied unless explicitly represented.
Developer identifier: `channels.displayName`
**Display Name.** Display name of the channel. It distinguishes the provider-defined display name state or classification for the channel.
* **Enables:** Label each channel with display name from `channels.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each channel; names are mutable and are not stable identities.
Developer identifier: `channels.id`
**ID.** Channel ID (opaque thread ID, e.g. 19:...\@thread.tacv2). Not an RFC UUID. It provides the reference needed to connect the channel to the corresponding provider object.
* **Enables:** Match repeated channel entries on ID in `channels.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its channel namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `channels.isArchived`
**Is Archived.** Whether the channel is archived. It distinguishes the provider-defined is archived state or classification for the channel.
* **Enables:** Filter Channels by whether the channel is archived in `channels.isArchived`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the channel is archived as a boolean on each channel; a missing field is unknown, not false.
Developer identifier: `channels.isFavoriteByDefault`
**Is Favorite By Default.** Whether the channel is favorited by default for team members. It distinguishes the provider-defined is favorite by default state or classification for the channel.
* **Enables:** Filter Channels by whether the channel is favorited by default for team members in `channels.isFavoriteByDefault`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the channel is favorited by default for team members as a boolean on each channel; a missing field is unknown, not false.
Developer identifier: `channels.membershipType`
**Membership Type.** Channel membership type: standard, private, shared, or unknownFutureValue. It identifies the related provider object that gives the channel its parent, owner, or container context.
* **Enables:** Segment channel entries in Channels by membership type in `channels.membershipType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports membership type as a label from its own taxonomy on each channel; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `channels.team_id`
**Team ID.** Parent team reference copied into each channel because the child operation does not return that relationship. It provides the reference needed to connect the channel to the corresponding provider object.
* **Enables:** Connect each channel in Channels to the referenced team through `channels.team_id`; flag team ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies team ID from the parent traversal record into each channel; the child Microsoft 365 operation does not return it.
Developer identifier: `channels.tenantId`
**Tenant ID.** Entra tenant ID that owns the channel. It provides the reference needed to connect the channel to the corresponding provider object.
* **Enables:** Connect each channel in Channels to the referenced tenant through `channels.tenantId`; flag tenant ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports tenant ID as an identifier in its tenant namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `channels.webUrl`
**Web URL.** Deep link URL to the channel in Microsoft Teams. It locates the provider resource or path associated with the channel.
* **Enables:** Associate each channel with the resource identified by web URL in `channels.webUrl`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports web URL as a resource locator for each channel; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `copilot_interactions`
**Copilot Interactions.** Microsoft 365 Copilot user interaction audit records via the Purview /beta async create-poll-fetch pattern. Filters recordTypeFilters to CopilotInteraction (who/when/AppHost/AccessedResources). Does not include prompt or response text. Opt-in; requires AuditLogsQuery.Read.All.
* **Enables:** Attribute Microsoft-reported Copilot interaction events to users, host applications, accessed resources, and timestamps.
* **Scope:** Reads the records selected by Microsoft 365's `/beta/security/auditLog/queries` operation as an event stream using incremental synchronization. This stream is opt-in. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. The filtered Purview records include who, when, host application, and accessed-resource metadata; prompt and response text are excluded. This stream supplies no reliable deletion signal.
Developer identifier: `copilot_interactions.administrativeUnits`
**Administrative Units.** Administrative units associated with the record. It preserves the nested context needed to interpret the parent copilot interaction.
* **Enables:** Attribute every returned administrative unit value in `copilot_interactions.administrativeUnits` to its parent copilot interaction; keep each relationship distinct and distinguish an absent array from an explicitly empty one.
* **Interpretation:** Microsoft 365 returns administrative units as an array of administrative unit value entries on each copilot interaction; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `copilot_interactions.auditData`
**Audit Data.** Raw Copilot audit payload as a JSON object, including CopilotEventData (AppHost, Contexts, AccessedResources, Messages, ThreadId). Does not contain prompt or response text. It preserves the nested context needed to interpret the parent copilot interaction.
* **Enables:** Attribute audit data in `copilot_interactions.auditData` to the parent copilot interaction; identify parent records where that nested audit data object is absent.
* **Interpretation:** Microsoft 365 reports audit data as a nested object on each copilot interaction; optional children may be absent from a valid response.
Developer identifier: `copilot_interactions.auditLogRecordType`
**Audit Log Record Type.** Audit log record type (CopilotInteraction for this tap). It distinguishes the provider-defined audit log record type state or classification for the copilot interaction.
* **Enables:** Segment copilot interaction entries in Copilot Interactions by audit log record type in `copilot_interactions.auditLogRecordType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports audit log record type as a label from its own taxonomy on each copilot interaction; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `copilot_interactions.clientIp`
**Client IP.** Client IP address from which the operation was performed. It supplies the provider-reported address or location facet for the copilot interaction, not a residency determination.
* **Enables:** Correlate copilot interaction records that report the same network address in `copilot_interactions.clientIp` during an authorized investigation; account for shared, proxied, or translated addresses.
* **Interpretation:** Microsoft 365 reports this as an IP network address on each copilot interaction. It is not verified geolocation, does not identify a person by itself, and does not establish data residency.
Developer identifier: `copilot_interactions.createdDateTime`
**Created Date Time.** Timestamp when the Copilot interaction occurred. It anchors the copilot interaction on the provider's reported timeline.
* **Enables:** Order Copilot Interactions by created date time in `copilot_interactions.createdDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports created date time as a timestamp on each copilot interaction; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `copilot_interactions.id`
**ID.** Unique identifier of the audit log record. It provides the reference needed to connect the copilot interaction to the corresponding provider object.
* **Enables:** Match repeated copilot interaction entries on ID in `copilot_interactions.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its copilot interaction namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `copilot_interactions.objectId`
**Object ID.** Identifier of the object the operation acted on, when present. It provides the reference needed to connect the copilot interaction to the corresponding provider object.
* **Enables:** Connect each copilot interaction in Copilot Interactions to the referenced object through `copilot_interactions.objectId`; flag object ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports object ID as an identifier in its object namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `copilot_interactions.operation`
**Operation.** Operation name (typically CopilotInteraction). It distinguishes the provider-defined operation state or classification for the copilot interaction.
* **Enables:** Filter Copilot Interactions by the exact Microsoft 365-defined operation in `copilot_interactions.operation` and preserve unknown values as distinct categories.
* **Interpretation:** Microsoft 365 supplies operation from its own taxonomy on each copilot interaction; preserve unknown and newly introduced labels.
Developer identifier: `copilot_interactions.organizationId`
**Organization ID.** Microsoft tenant identifier. It provides the reference needed to connect the copilot interaction to the corresponding provider object.
* **Enables:** Connect each copilot interaction in Copilot Interactions to the referenced organization through `copilot_interactions.organizationId`; flag organization ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports organization ID as an identifier in its organization namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `copilot_interactions.service`
**Service.** Microsoft 365 service that produced the record (typically Copilot). It distinguishes the provider-defined service state or classification for the copilot interaction.
* **Enables:** Filter Copilot Interactions by the exact Microsoft 365-defined service in `copilot_interactions.service` and preserve unknown values as distinct categories.
* **Interpretation:** Microsoft 365 supplies service from its own taxonomy on each copilot interaction; preserve unknown and newly introduced labels.
Developer identifier: `copilot_interactions.userId`
**User ID.** Object ID of the user that performed the Copilot interaction. It provides the reference needed to connect the copilot interaction to the corresponding provider object.
* **Enables:** Connect each copilot interaction in Copilot Interactions to the referenced user through `copilot_interactions.userId`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports user ID as an identifier in its user namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `copilot_interactions.userPrincipalName`
**User Principal Name.** UPN of the user that performed the Copilot interaction. It gives the copilot interaction a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each copilot interaction with user principal name from `copilot_interactions.userPrincipalName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports user principal name as display text for each copilot interaction; names are mutable and are not stable identities.
Developer identifier: `copilot_interactions.userType`
**User Type.** Type of user that performed the operation. It supplies the user type profile facet used to reconcile or attribute the copilot interaction.
* **Enables:** Segment copilot interaction entries in Copilot Interactions by user type in `copilot_interactions.userType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports user type as a label from its own taxonomy on each copilot interaction; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `groups`
**Groups.** Microsoft Entra groups (all group types, including non-Teams). Overlaps with the teams tap for groups that have resourceProvisioningOptions Team; teams remains the filtered source for Teams child fan-out.
* **Enables:** Inventory all Entra group types and distinguish Teams-enabled groups from groups not used for Teams child traversal.
* **Scope:** Reads the records selected by Microsoft 365's `/v1.0/groups` operation as a snapshot stream using full synchronization. This stream is opt-in. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `groups.classification`
**Classification.** Classification of the group (e.g. Low, Medium, High) when classifications are configured for the organization. It distinguishes the provider-defined classification state or classification for the group.
* **Enables:** Segment group entries in Groups by classification in `groups.classification`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports classification as a label from its own taxonomy on each group; preserve unknown labels rather than mapping them by assumption. Microsoft 365 generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `groups.createdDateTime`
**Created Date Time.** When the group was created. It anchors the group on the provider's reported timeline.
* **Enables:** Order Groups by created date time in `groups.createdDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports created date time as a timestamp on each group; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `groups.deletedDateTime`
**Deleted Date Time.** When the group was soft-deleted, if it is in the deleted items. It anchors the group on the provider's reported timeline.
* **Enables:** Order Groups by deleted date time in `groups.deletedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports deleted date time as a timestamp on each group; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `groups.description`
**Description.** Description of the group. It defines the content surface available for this group.
* **Enables:** Locate group records by description in `groups.description`; attribute each text match to its parent group and, when present, its reported author.
* **Interpretation:** Microsoft 365 supplies description as text on each group; referenced files or media are not implied unless explicitly represented.
Developer identifier: `groups.displayName`
**Display Name.** Display name of the group. It distinguishes the provider-defined display name state or classification for the group.
* **Enables:** Label each group with display name from `groups.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each group; names are mutable and are not stable identities.
Developer identifier: `groups.expirationDateTime`
**Expiration Date Time.** When the group is set to expire under the group lifecycle policy. It anchors the group on the provider's reported timeline.
* **Enables:** Order Groups by expiration date time in `groups.expirationDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports expiration date time as a timestamp on each group; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `groups.groupTypes`
**Group Types.** Group type markers (e.g. Unified for M365 groups, DynamicMembership). It preserves the nested context needed to interpret the parent group.
* **Enables:** Compare the exact Microsoft 365-configured group types set in `groups.groupTypes` for each group; preserve provider labels and unknown entries.
* **Interpretation:** Microsoft 365 returns group types as an array of group type value entries on each group; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `groups.id`
**ID.** Unique identifier for the group. It provides the reference needed to connect the group to the corresponding provider object.
* **Enables:** Match repeated group entries on ID in `groups.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its group namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `groups.mail`
**Mail.** SMTP address for the group. It supplies the provider-reported address or location facet for the group, not a residency determination.
* **Enables:** Group Groups by the exact mail in `groups.mail` while keeping that address or location separate from geolocation and residency claims.
* **Interpretation:** Microsoft 365 reports mail as an address or location facet on each group; it does not establish verified geolocation or data residency.
Developer identifier: `groups.mailEnabled`
**Mail Enabled.** Whether the group is mail-enabled. It distinguishes the provider-defined mail enabled state or classification for the group.
* **Enables:** Filter Groups by whether the group is mail-enabled in `groups.mailEnabled`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the group is mail-enabled as a boolean on each group; a missing field is unknown, not false.
Developer identifier: `groups.mailNickname`
**Mail Nickname.** Mail alias for the group. It supplies the mail nickname profile facet used to reconcile or attribute the group.
* **Enables:** Reconcile the group's mail nickname in `groups.mailNickname` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Microsoft 365 reports mail nickname as a mutable profile or directory attribute on each group; it may be absent, shared, or non-unique.
Developer identifier: `groups.renewedDateTime`
**Renewed Date Time.** When the group was last renewed under the group lifecycle policy. It anchors the group on the provider's reported timeline.
* **Enables:** Order Groups by renewed date time in `groups.renewedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports renewed date time as a timestamp on each group; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `groups.resourceProvisioningOptions`
**Resource Provisioning Options.** Provisioned resources for the group (e.g. Team). It preserves the nested context needed to interpret the parent group.
* **Enables:** Compare the exact Microsoft 365-configured resource provisioning options set in `groups.resourceProvisioningOptions` for each group; preserve provider labels and unknown entries.
* **Interpretation:** Microsoft 365 returns resource provisioning options as an array of resource provisioning option value entries on each group; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `groups.securityEnabled`
**Security Enabled.** Whether the group is a security group. It distinguishes the provider-defined security enabled state or classification for the group.
* **Enables:** Filter Groups by whether the group is a security group in `groups.securityEnabled`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the group is a security group as a boolean on each group; a missing field is unknown, not false.
Developer identifier: `groups.visibility`
**Visibility.** Group visibility: Public, Private, or HiddenMembership. It distinguishes the provider-defined visibility state or classification for the group.
* **Enables:** Segment group entries in Groups by visibility in `groups.visibility`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports visibility as a label from its own taxonomy on each group; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `messages`
**Messages.** Mailbox messages by user.
* **Enables:** Attribute mailbox message metadata, recipient headers, and body previews to the owning user and conversation.
* **Scope:** Reads the records selected by Microsoft 365's `/v1.0/users/{id}/messages` operation as an event stream using incremental synchronization. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. The selected fields include `bodyPreview`, not the full message body; expanded attachments provide metadata only unless the response explicitly contains content bytes. This stream supplies no reliable deletion signal.
Developer identifier: `messages.bccRecipients`
**Bcc Recipients.** Recipients on the Bcc line of the message. It preserves the nested context needed to interpret the parent message.
* **Enables:** Attribute each returned recipient in `messages.bccRecipients` to the parent message; preserve whether the field represents an attendee, To, Cc, or Bcc relationship.
* **Interpretation:** Microsoft 365 returns bcc recipients as an array of recipient entries on each message; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `messages.bccRecipients.emailAddress`
**Email Address.** Email address and display name of the recipient. It preserves the nested context needed to interpret the parent message.
* **Enables:** Match repeated recipient entries on email address in `messages.Recipient.emailAddress`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Microsoft 365 reports email address as a nested object on each recipient; optional children may be absent from a valid response.
Developer identifier: `messages.bccRecipients.emailAddress.address`
**Address.** Email/contact address returned for this recipient or account; needed to attribute it to the corresponding Microsoft 365 identity.
* **Enables:** Match repeated email address entries on address in `messages.EmailAddress.address`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Microsoft 365 reports address as an address on each email address; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `messages.bccRecipients.emailAddress.name`
**Name.** Display name of the person or entity. It gives the email address a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each email address with name from `messages.EmailAddress.name`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports name as display text for each email address; names are mutable and are not stable identities.
Developer identifier: `messages.bodyPreview`
**Body Preview.** Short text preview of the message body. It defines the content surface available for this message.
* **Enables:** Locate message records whose body preview in `messages.bodyPreview` contains the search term; open the Microsoft 365 record when the excerpt lacks needed context.
* **Interpretation:** This is an excerpt supplied by the provider, not the complete body or an attachment.
Developer identifier: `messages.ccRecipients`
**Cc Recipients.** Recipients on the Cc line of the message. It preserves the nested context needed to interpret the parent message.
* **Enables:** Attribute each returned recipient in `messages.ccRecipients` to the parent message; preserve whether the field represents an attendee, To, Cc, or Bcc relationship.
* **Interpretation:** Microsoft 365 returns cc recipients as an array of recipient entries on each message; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `messages.conversationId`
**Conversation ID.** ID of the conversation the message belongs to. It provides the reference needed to connect the message to the corresponding provider object.
* **Enables:** Connect each message in Messages to the referenced conversation through `messages.conversationId`; flag conversation ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports conversation ID as an identifier in its conversation namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `messages.createdDateTime`
**Created Date Time.** Date and time the message was created in ISO 8601 format. It anchors the message on the provider's reported timeline.
* **Enables:** Order Messages by created date time in `messages.createdDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports created date time as a timestamp on each message; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `messages.from`
**From.** Mailbox owner and sender of the message (the From header). It preserves the nested context needed to interpret the parent message.
* **Enables:** Attribute from in `messages.from` to the parent message; identify parent records where that nested from object is absent.
* **Interpretation:** Microsoft 365 reports from as a nested object on each message; optional children may be absent from a valid response.
Developer identifier: `messages.hasAttachments`
**Has Attachments.** Whether the message has file attachments (excludes inline attachments). It distinguishes the provider-defined has attachments state or classification for the message.
* **Enables:** Filter Messages by whether the message has file attachments (excludes inline attachments) in `messages.hasAttachments`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the message has file attachments (excludes inline attachments) as a boolean on each message; a missing field is unknown, not false. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `messages.id`
**ID.** Unique identifier for the message. It provides the reference needed to connect the message to the corresponding provider object.
* **Enables:** Match repeated message entries on ID in `messages.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its message namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `messages.importance`
**Importance.** Importance of the message: low, normal, or high. It distinguishes the provider-defined importance state or classification for the message.
* **Enables:** Segment message entries in Messages by importance in `messages.importance`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports importance as a label from its own taxonomy on each message; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `messages.internetMessageId`
**Internet Message ID.** RFC 2822 Internet message ID of the message (Message-ID header). It provides the reference needed to connect the message to the corresponding provider object.
* **Enables:** Connect each message in Messages to the referenced internet message through `messages.internetMessageId`; flag internet message ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports internet message ID as an identifier in its internet message namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `messages.isDraft`
**Is Draft.** Whether the message is a draft that has not yet been sent. It distinguishes the provider-defined is draft state or classification for the message.
* **Enables:** Filter Messages by whether the message is a draft that has not yet been sent in `messages.isDraft`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the message is a draft that has not yet been sent as a boolean on each message; a missing field is unknown, not false.
Developer identifier: `messages.isRead`
**Is Read.** Whether the message has been read. It distinguishes the provider-defined is read state or classification for the message.
* **Enables:** Filter Messages by whether the message has been read in `messages.isRead`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the message has been read as a boolean on each message; a missing field is unknown, not false.
Developer identifier: `messages.lastModifiedDateTime`
**Last Modified Date Time.** Date and time the message was last modified in ISO 8601 format. It anchors the message on the provider's reported timeline.
* **Enables:** Order Messages by last modified date time in `messages.lastModifiedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports last modified date time as a timestamp on each message; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `messages.parentFolderId`
**Parent Folder ID.** Unique identifier for the mailbox folder that contains the message. It provides the reference needed to connect the message to the corresponding provider object.
* **Enables:** Connect each message in Messages to the referenced parent folder through `messages.parentFolderId`; flag parent folder ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports parent folder ID as an identifier in its parent folder namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `messages.receivedDateTime`
**Received Date Time.** Date and time the message was received in ISO 8601 format. Used as incremental sync cursor. It anchors the message on the provider's reported timeline.
* **Enables:** Order Messages by received date time in `messages.receivedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports received date time as a timestamp on each message; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `messages.sender`
**Sender.** Account actually used to generate the message. Differs from from when sending on behalf of another mailbox. It preserves the nested context needed to interpret the parent message.
* **Enables:** Attribute sender in `messages.sender` to the parent message; identify parent records where that nested sender object is absent.
* **Interpretation:** Microsoft 365 reports sender as a nested object on each message; optional children may be absent from a valid response.
Developer identifier: `messages.sentDateTime`
**Sent Date Time.** Date and time the message was sent in ISO 8601 format. It anchors the message on the provider's reported timeline.
* **Enables:** Order Messages by sent date time in `messages.sentDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports sent date time as a timestamp on each message; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `messages.subject`
**Subject.** Subject line of the message. It defines the content surface available for this message.
* **Enables:** Locate message records by subject in `messages.subject`; attribute each text match to its parent message and, when present, its reported author.
* **Interpretation:** Microsoft 365 supplies subject as text on each message; referenced files or media are not implied unless explicitly represented.
Developer identifier: `messages.toRecipients`
**To Recipients.** Recipients on the To line of the message. It preserves the nested context needed to interpret the parent message.
* **Enables:** Attribute each returned recipient in `messages.toRecipients` to the parent message; preserve whether the field represents an attendee, To, Cc, or Bcc relationship.
* **Interpretation:** Microsoft 365 returns to recipients as an array of recipient entries on each message; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `messages.user_id`
**User ID.** Parent user reference copied into each message because the child operation does not return that relationship. It provides the reference needed to connect the message to the corresponding provider object.
* **Enables:** Connect each message in Messages to the referenced user through `messages.user_id`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies user ID from the parent traversal record into each message; the child Microsoft 365 operation does not return it.
Developer identifier: `organization`
**Organization.** Entra organization (tenant) metadata.
* **Enables:** Inventory the Entra organization's identity, verified domains, directory settings, and synchronization metadata.
* **Scope:** Reads the records selected by Microsoft 365's `/v1.0/organization` operation as a snapshot stream using full synchronization. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `organization.countryLetterCode`
**Country Letter Code.** Country letter code. It supplies the provider-reported address or location facet for the organization, not a residency determination.
* **Enables:** Group Organization by country letter code in `organization.countryLetterCode` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports country letter code as a user, device, request, or resource location attribute on each organization; it does not establish where data is stored or processed.
Developer identifier: `organization.createdDateTime`
**Created Date Time.** When the organization was created. It anchors the organization on the provider's reported timeline.
* **Enables:** Order Organization by created date time in `organization.createdDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports created date time as a timestamp on each organization; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `organization.deletedDateTime`
**Deleted Date Time.** When the organization was soft-deleted, if ever. It anchors the organization on the provider's reported timeline.
* **Enables:** Order Organization by deleted date time in `organization.deletedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports deleted date time as a timestamp on each organization; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `organization.displayName`
**Display Name.** Display name of the organization. It distinguishes the provider-defined display name state or classification for the organization.
* **Enables:** Label each organization with display name from `organization.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each organization; names are mutable and are not stable identities.
Developer identifier: `organization.id`
**ID.** Tenant ID. It provides the reference needed to connect the organization to the corresponding provider object.
* **Enables:** Match repeated organization entries on ID in `organization.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its organization namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `organization.preferredLanguage`
**Preferred Language.** Preferred language for the organization. It supplies the preferred language profile facet used to reconcile or attribute the organization.
* **Enables:** Reconcile the organization's preferred language in `organization.preferredLanguage` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Microsoft 365 reports preferred language as a mutable profile or directory attribute on each organization; it may be absent, shared, or non-unique.
Developer identifier: `organization.tenantType`
**Tenant Type.** Tenant type. It distinguishes the provider-defined tenant type state or classification for the organization.
* **Enables:** Segment organization entries in Organization by tenant type in `organization.tenantType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports tenant type as a label from its own taxonomy on each organization; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `organization.verifiedDomains`
**Verified Domains.** Verified domains for the organization. It preserves the nested context needed to interpret the parent organization.
* **Enables:** Reconcile each returned verified domain in `organization.verifiedDomains` with the parent organization's provider profile; preserve distinct aliases, contact points, and organization attributes.
* **Interpretation:** Microsoft 365 returns verified domains as an array of verified domain entries on each organization; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `organization.verifiedDomains.capabilities`
**Capabilities.** The provider-reported capabilities for each verified domain in Organization. It distinguishes the provider-defined capabilities state or classification for the verified domain.
* **Enables:** Filter Organization by the exact Microsoft 365-defined capabilities in `organization.VerifiedDomain.capabilities` and preserve unknown values as distinct categories.
* **Interpretation:** Microsoft 365 supplies capabilities from its own taxonomy on each verified domain; preserve unknown and newly introduced labels.
Developer identifier: `organization.verifiedDomains.isDefault`
**Is Default.** The provider-reported is default for each verified domain in Organization. It distinguishes the provider-defined is default state or classification for the verified domain.
* **Enables:** Filter Organization by whether is default in `organization.VerifiedDomain.isDefault`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports is default as a boolean on each verified domain; a missing field is unknown, not false.
Developer identifier: `organization.verifiedDomains.isInitial`
**Is Initial.** The provider-reported is initial for each verified domain in Organization. It distinguishes the provider-defined is initial state or classification for the verified domain.
* **Enables:** Filter Organization by whether is initial in `organization.VerifiedDomain.isInitial`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports is initial as a boolean on each verified domain; a missing field is unknown, not false.
Developer identifier: `organization.verifiedDomains.name`
**Name.** Verified domain name. It gives the verified domain a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Match repeated verified domain entries on name in `organization.VerifiedDomain.name`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Microsoft 365 reports name as display text for each verified domain; names are mutable and are not stable identities.
Developer identifier: `organization.verifiedDomains.type`
**Type.** The provider-reported type for each verified domain in Organization. It distinguishes the provider-defined type state or classification for the verified domain.
* **Enables:** Segment verified domain entries in Organization by type in `organization.VerifiedDomain.type`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports type as a label from its own taxonomy on each verified domain; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `sign_in_logs`
**Sign In Logs.** Microsoft Entra sign-in logs.
* **Enables:** Trace Microsoft Entra sign-in attempts to users, applications, devices, network attributes, and provider outcomes.
* **Scope:** Reads the records selected by Microsoft 365's `/v1.0/auditLogs/signIns` operation as an event stream using incremental synchronization. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. This stream supplies no reliable deletion signal.
Developer identifier: `sign_in_logs.appDisplayName`
**App Display Name.** Name of the application the user signed into. It distinguishes the provider-defined app display name state or classification for the sign in log.
* **Enables:** Label each sign in log with app display name from `sign_in_logs.appDisplayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports app display name as display text for each sign in log; names are mutable and are not stable identities.
Developer identifier: `sign_in_logs.appId`
**App ID.** Application ID of the app signed into. It provides the reference needed to connect the sign in log to the corresponding provider object.
* **Enables:** Connect each sign in log in Sign In Logs to the referenced app through `sign_in_logs.appId`; flag app ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports app ID as an identifier in its app namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `sign_in_logs.clientAppUsed`
**Client App Used.** Client app used for sign-in (e.g., Browser, Mobile Apps). It distinguishes the provider-defined client app used state or classification for the sign in log.
* **Enables:** Filter Sign In Logs by the exact Microsoft 365-defined client app used in `sign_in_logs.clientAppUsed` and preserve unknown values as distinct categories.
* **Interpretation:** Microsoft 365 supplies client app used from its own taxonomy on each sign in log; preserve unknown and newly introduced labels.
Developer identifier: `sign_in_logs.conditionalAccessStatus`
**Conditional Access Status.** Status of conditional access policies applied. It distinguishes the provider-defined conditional access status state or classification for the sign in log.
* **Enables:** Segment sign in log entries in Sign In Logs by conditional access status in `sign_in_logs.conditionalAccessStatus`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports conditional access status as a label from its own taxonomy on each sign in log; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `sign_in_logs.correlationId`
**Correlation ID.** Identifier that correlates all sign-in activity for a single sign-in flow. It provides the reference needed to connect the sign in log to the corresponding provider object.
* **Enables:** Connect each sign in log in Sign In Logs to the referenced correlation through `sign_in_logs.correlationId`; flag correlation ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports correlation ID as an identifier in its correlation namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `sign_in_logs.createdDateTime`
**Created Date Time.** When the sign-in occurred. It anchors the sign in log on the provider's reported timeline.
* **Enables:** Order Sign In Logs by created date time in `sign_in_logs.createdDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports created date time as a timestamp on each sign in log; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing. The schema designates this field as the event timestamp.
Developer identifier: `sign_in_logs.deviceDetail`
**Device Detail.** Device information including device ID, OS, browser, and management state. It preserves the nested context needed to interpret the parent sign in log.
* **Enables:** Attribute device detail in `sign_in_logs.deviceDetail` to the parent sign in log; identify parent records where that nested device detail object is absent.
* **Interpretation:** Microsoft 365 reports device detail as a nested object on each sign in log; optional children may be absent from a valid response.
Developer identifier: `sign_in_logs.deviceDetail.browser`
**Browser.** Browser used for the sign-in. It distinguishes the provider-defined browser state or classification for the device detail.
* **Enables:** Filter Sign In Logs by the exact Microsoft 365-defined browser in `sign_in_logs.DeviceDetail.browser` and preserve unknown values as distinct categories.
* **Interpretation:** Microsoft 365 supplies browser from its own taxonomy on each device detail; preserve unknown and newly introduced labels.
Developer identifier: `sign_in_logs.deviceDetail.deviceId`
**Device ID.** Identifier of the device used for the sign-in. It provides the reference needed to connect the sign in log to the corresponding provider object.
* **Enables:** Connect each device detail in Sign In Logs to the referenced device through `sign_in_logs.DeviceDetail.deviceId`; flag device ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports device ID as an identifier in its device namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `sign_in_logs.deviceDetail.displayName`
**Display Name.** Display name of the device. It distinguishes the provider-defined display name state or classification for the device detail.
* **Enables:** Label each device detail with display name from `sign_in_logs.DeviceDetail.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each device detail; names are mutable and are not stable identities.
Developer identifier: `sign_in_logs.deviceDetail.isCompliant`
**Is Compliant.** Whether the device is compliant with organization policy. It distinguishes the provider-defined is compliant state or classification for the device detail.
* **Enables:** Filter Sign In Logs by whether the device is compliant with organization policy in `sign_in_logs.DeviceDetail.isCompliant`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the device is compliant with organization policy as a boolean on each device detail; a missing field is unknown, not false.
Developer identifier: `sign_in_logs.deviceDetail.isManaged`
**Is Managed.** Whether the device is managed by the organization. It distinguishes the provider-defined is managed state or classification for the device detail.
* **Enables:** Filter Sign In Logs by whether the device is managed by the organization in `sign_in_logs.DeviceDetail.isManaged`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the device is managed by the organization as a boolean on each device detail; a missing field is unknown, not false.
Developer identifier: `sign_in_logs.deviceDetail.operatingSystem`
**Operating System.** Operating system name and version of the device. It distinguishes the provider-defined operating system state or classification for the device detail.
* **Enables:** Filter Sign In Logs by the exact Microsoft 365-defined operating system in `sign_in_logs.DeviceDetail.operatingSystem` and preserve unknown values as distinct categories.
* **Interpretation:** Microsoft 365 supplies operating system from its own taxonomy on each device detail; preserve unknown and newly introduced labels.
Developer identifier: `sign_in_logs.deviceDetail.trustType`
**Trust Type.** Trust type of the device (e.g. AzureAd, ServerAd, Workplace). It distinguishes the provider-defined trust type state or classification for the device detail.
* **Enables:** Segment device detail entries in Sign In Logs by trust type in `sign_in_logs.DeviceDetail.trustType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports trust type as a label from its own taxonomy on each device detail; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `sign_in_logs.id`
**ID.** Unique identifier for the sign-in event. It provides the reference needed to connect the sign in log to the corresponding provider object.
* **Enables:** Match repeated sign in log entries on ID in `sign_in_logs.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its sign in log namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `sign_in_logs.ipAddress`
**IP Address.** IP address of the client used for sign-in. It supplies the provider-reported address or location facet for the sign in log, not a residency determination.
* **Enables:** Correlate sign in log records that report the same network address in `sign_in_logs.ipAddress` during an authorized investigation; account for shared, proxied, or translated addresses.
* **Interpretation:** Microsoft 365 reports this as an IP network address on each sign in log. It is not verified geolocation, does not identify a person by itself, and does not establish data residency.
Developer identifier: `sign_in_logs.isInteractive`
**Is Interactive.** Whether the sign-in was interactive or non-interactive. It distinguishes the provider-defined is interactive state or classification for the sign in log.
* **Enables:** Filter Sign In Logs by whether the sign-in was interactive or non-interactive in `sign_in_logs.isInteractive`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the sign-in was interactive or non-interactive as a boolean on each sign in log; a missing field is unknown, not false.
Developer identifier: `sign_in_logs.location`
**Location.** City, state, country, and geo-coordinates from which the sign-in occurred. It preserves the nested context needed to interpret the parent sign in log.
* **Enables:** Attribute location in `sign_in_logs.location` to the parent sign in log; identify parent records where that nested location object is absent.
* **Interpretation:** Microsoft 365 reports location as a nested object on each sign in log; optional children may be absent from a valid response. This nested location attribute does not establish where data is stored or processed and is not a residency signal.
Developer identifier: `sign_in_logs.location.city`
**City.** City the sign-in originated from. It supplies the provider-reported address or location facet for the sign in location, not a residency determination.
* **Enables:** Group Sign In Logs by city in `sign_in_logs.SignInLocation.city` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports city as a user, device, request, or resource location attribute on each sign in location; it does not establish where data is stored or processed.
Developer identifier: `sign_in_logs.location.countryOrRegion`
**Country Or Region.** Country or region code the sign-in originated from. It supplies the provider-reported address or location facet for the sign in location, not a residency determination.
* **Enables:** Group Sign In Logs by country or region in `sign_in_logs.SignInLocation.countryOrRegion` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports country or region as a user, device, request, or resource location attribute on each sign in location; it does not establish where data is stored or processed.
Developer identifier: `sign_in_logs.location.geoCoordinates`
**Geo Coordinates.** Latitude, longitude, and altitude of the sign-in location. It preserves the nested context needed to interpret the parent sign in log.
* **Enables:** Attribute geo coordinates in `sign_in_logs.SignInLocation.geoCoordinates` to the parent sign in log; identify parent records where that nested geo coordinates object is absent.
* **Interpretation:** Microsoft 365 reports geo coordinates as a nested object on each sign in location; optional children may be absent from a valid response. This nested location attribute does not establish where data is stored or processed and is not a residency signal.
Developer identifier: `sign_in_logs.location.geoCoordinates.altitude`
**Altitude.** Altitude of the location, in meters. It supplies the provider-reported address or location facet for the geo coordinate, not a residency determination.
* **Enables:** Group Sign In Logs by the exact altitude in `sign_in_logs.GeoCoordinates.altitude` while keeping that address or location separate from geolocation and residency claims.
* **Interpretation:** Microsoft 365 reports altitude as an address or location facet on each geo coordinate; it does not establish verified geolocation or data residency.
Developer identifier: `sign_in_logs.location.geoCoordinates.latitude`
**Latitude.** Latitude of the location. It supplies the provider-reported address or location facet for the geo coordinate, not a residency determination.
* **Enables:** Group Sign In Logs by latitude in `sign_in_logs.GeoCoordinates.latitude` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports latitude as a user, device, request, or resource location attribute on each geo coordinate; it does not establish where data is stored or processed.
Developer identifier: `sign_in_logs.location.geoCoordinates.longitude`
**Longitude.** Longitude of the location. It supplies the provider-reported address or location facet for the geo coordinate, not a residency determination.
* **Enables:** Group Sign In Logs by longitude in `sign_in_logs.GeoCoordinates.longitude` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports longitude as a user, device, request, or resource location attribute on each geo coordinate; it does not establish where data is stored or processed.
Developer identifier: `sign_in_logs.location.state`
**State.** State or province the sign-in originated from. It distinguishes the provider-defined state state or classification for the sign in location.
* **Enables:** Group Sign In Logs by state in `sign_in_logs.SignInLocation.state` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports state as a user, device, request, or resource location attribute on each sign in location; it does not establish where data is stored or processed.
Developer identifier: `sign_in_logs.resourceDisplayName`
**Resource Display Name.** Display name of the resource the user signed into. It distinguishes the provider-defined resource display name state or classification for the sign in log.
* **Enables:** Label each sign in log with resource display name from `sign_in_logs.resourceDisplayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports resource display name as display text for each sign in log; names are mutable and are not stable identities.
Developer identifier: `sign_in_logs.resourceId`
**Resource ID.** Identifier of the resource the user signed into. It provides the reference needed to connect the sign in log to the corresponding provider object.
* **Enables:** Connect each sign in log in Sign In Logs to the referenced resource through `sign_in_logs.resourceId`; flag resource ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports resource ID as an identifier in its resource namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `sign_in_logs.riskDetail`
**Risk Detail.** Reason behind the sign-in risk state (evolvable enum, e.g. none, hidden, adminConfirmedSigninSafe). Stored as string because Microsoft may add values. It supplies the returned risk detail text needed to understand the sign in log in context.
* **Enables:** Search the returned risk detail text in `sign_in_logs.riskDetail` and attribute each match to its parent sign in log and reported author when available.
* **Interpretation:** Microsoft 365 supplies risk detail as returned text on each sign in log; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `sign_in_logs.riskEventTypes_v2`
**Risk Event Types V2.** Risk event types associated with the sign-in. It preserves the nested context needed to interpret the parent sign in log.
* **Enables:** Compare the exact Microsoft 365-configured risk event types v2 set in `sign_in_logs.riskEventTypes_v2` for each sign in log; preserve provider labels and unknown entries.
* **Interpretation:** Microsoft 365 returns risk event types v2 as an array of risk event types v2 value entries on each sign in log; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `sign_in_logs.riskLevelAggregated`
**Risk Level Aggregated.** Aggregated risk level of the sign-in (evolvable enum: none, low, medium, high, hidden). Stored as string because Microsoft may add values. It distinguishes the provider-defined risk level aggregated state or classification for the sign in log.
* **Enables:** Filter Sign In Logs by the exact Microsoft 365-defined risk level aggregated in `sign_in_logs.riskLevelAggregated` and preserve unknown values as distinct categories.
* **Interpretation:** Microsoft 365 supplies risk level aggregated from its own taxonomy on each sign in log; preserve unknown and newly introduced labels.
Developer identifier: `sign_in_logs.riskLevelDuringSignIn`
**Risk Level During Sign In.** Risk level during the sign-in (evolvable enum: none, low, medium, high, hidden). Stored as string because Microsoft may add values. It distinguishes the provider-defined risk level during sign in state or classification for the sign in log.
* **Enables:** Filter Sign In Logs by the exact Microsoft 365-defined risk level during sign in in `sign_in_logs.riskLevelDuringSignIn` and preserve unknown values as distinct categories.
* **Interpretation:** Microsoft 365 supplies risk level during sign in from its own taxonomy on each sign in log; preserve unknown and newly introduced labels.
Developer identifier: `sign_in_logs.riskState`
**Risk State.** Risk state of the sign-in (evolvable enum: none, confirmedSafe, remediated, dismissed, atRisk, confirmedCompromised). Stored as string because Microsoft may add values. It distinguishes the provider-defined risk state state or classification for the sign in log.
* **Enables:** Segment sign in log entries in Sign In Logs by risk state in `sign_in_logs.riskState`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports risk state as a label from its own taxonomy on each sign in log; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `sign_in_logs.status`
**Status.** Sign-in status including error code, failure reason, and additional details. It preserves the nested context needed to interpret the parent sign in log.
* **Enables:** Attribute status in `sign_in_logs.status` to the parent sign in log; identify parent records where that nested status object is absent.
* **Interpretation:** Microsoft 365 reports status as a nested object on each sign in log; optional children may be absent from a valid response.
Developer identifier: `sign_in_logs.status.additionalDetails`
**Additional Details.** Additional details about the sign-in status. It supplies the returned additional details text needed to understand the sign in status in context.
* **Enables:** Search the returned additional details text in `sign_in_logs.SignInStatus.additionalDetails` and attribute each match to its parent sign in log and reported author when available.
* **Interpretation:** Microsoft 365 supplies additional details as returned text on each sign in status; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `sign_in_logs.status.errorCode`
**Error Code.** Sign-in error code. 0 indicates success. It distinguishes the provider-defined error code state or classification for the sign in status.
* **Enables:** Filter Sign In Logs by the exact Microsoft 365-defined error code in `sign_in_logs.SignInStatus.errorCode` and preserve unknown values as distinct categories.
* **Interpretation:** Microsoft 365 supplies error code from its own taxonomy on each sign in status; preserve unknown and newly introduced labels.
Developer identifier: `sign_in_logs.status.failureReason`
**Failure Reason.** Human-readable failure reason when the sign-in did not succeed. It supplies the returned failure reason text needed to understand the sign in status in context.
* **Enables:** Search the returned failure reason text in `sign_in_logs.SignInStatus.failureReason` and attribute each match to its parent sign in log and reported author when available.
* **Interpretation:** Microsoft 365 supplies failure reason as returned text on each sign in status; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `sign_in_logs.userDisplayName`
**User Display Name.** Display name of the user who signed in. It distinguishes the provider-defined user display name state or classification for the sign in log.
* **Enables:** Label each sign in log with user display name from `sign_in_logs.userDisplayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports user display name as display text for each sign in log; names are mutable and are not stable identities.
Developer identifier: `sign_in_logs.userId`
**User ID.** Entra ID object ID of the user. It provides the reference needed to connect the sign in log to the corresponding provider object.
* **Enables:** Connect each sign in log in Sign In Logs to the referenced user through `sign_in_logs.userId`; flag user ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports user ID as an identifier in its user namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `sign_in_logs.userPrincipalName`
**User Principal Name.** UPN of the user who signed in. It gives the sign in log a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each sign in log with user principal name from `sign_in_logs.userPrincipalName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports user principal name as display text for each sign in log; names are mutable and are not stable identities.
Developer identifier: `team_calendar_events`
**Team Calendar Events.** Team calendar events by group.
* **Enables:** Attribute group calendar events to the parent Team, organizer, attendees, recurrence, and time interval.
* **Scope:** Reads the records selected by Microsoft 365's `/v1.0/groups/{id}/calendar/calendarView` operation as an event stream using incremental synchronization. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. The selected fields are event, organizer, attendee, and time metadata; full body and attachment bytes are not fetched. This stream supplies no reliable deletion signal.
Developer identifier: `team_calendar_events.attendees`
**Attendees.** List of attendees with email, name, and response status. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute each returned attendee in `team_calendar_events.attendees` to the parent team calendar event; preserve whether the field represents an attendee, To, Cc, or Bcc relationship.
* **Interpretation:** Microsoft 365 returns attendees as an array of attendee entries on each team calendar event; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `team_calendar_events.attendees.emailAddress`
**Email Address.** Email address and display name of the attendee. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Match repeated attendee entries on email address in `team_calendar_events.Attendee.emailAddress`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Microsoft 365 reports email address as a nested object on each attendee; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.attendees.emailAddress.address`
**Address.** Email/contact address returned for this recipient or account; needed to attribute it to the corresponding Microsoft 365 identity.
* **Enables:** Attribute each email address to a person or account by the exact address in `team_calendar_events.EmailAddress.address`; identify addresses that do not match the Microsoft 365 directory.
* **Interpretation:** Microsoft 365 reports address as an address on each email address; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `team_calendar_events.attendees.emailAddress.name`
**Name.** Display name of the person or entity. It gives the email address a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each email address with name from `team_calendar_events.EmailAddress.name`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports name as display text for each email address; names are mutable and are not stable identities.
Developer identifier: `team_calendar_events.attendees.proposedNewTime`
**Proposed New Time.** An alternate date/time proposed by the attendee. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute proposed new time in `team_calendar_events.Attendee.proposedNewTime` to the parent team calendar event; identify parent records where that nested proposed new time object is absent.
* **Interpretation:** Microsoft 365 reports proposed new time as a nested object on each attendee; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.attendees.proposedNewTime.end`
**End.** End of the time slot. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute end in `team_calendar_events.TimeSlot.end` to the parent team calendar event; identify parent records where that nested end object is absent.
* **Interpretation:** Microsoft 365 reports end as a nested object on each time slot; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.attendees.proposedNewTime.end.dateTime`
**Date Time.** Date and time in ISO 8601 format without timezone offset (e.g. 2024-01-15T09:00:00.0000000). It anchors the team calendar event on the provider's reported timeline.
* **Enables:** Order Team Calendar Events by date time in `team_calendar_events.DateTimeTimeZone.dateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports date time as a timestamp on each date time time zone; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `team_calendar_events.attendees.proposedNewTime.end.timeZone`
**Time Zone.** IANA or Windows time zone identifier (e.g. Pacific Standard Time, America/New\_York). It is needed to interpret companion dates and times for the date time time zone in the provider's intended zone.
* **Enables:** Apply the zone in `team_calendar_events.DateTimeTimeZone.timeZone` when converting the team calendar event's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** Microsoft 365 reports time zone as a timezone identifier for each date time time zone; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `team_calendar_events.attendees.proposedNewTime.start`
**Start.** Start of the time slot. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute start in `team_calendar_events.TimeSlot.start` to the parent team calendar event; identify parent records where that nested start object is absent.
* **Interpretation:** Microsoft 365 reports start as a nested object on each time slot; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.attendees.status`
**Status.** The attendee's response status for the event. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute status in `team_calendar_events.Attendee.status` to the parent team calendar event; identify parent records where that nested status object is absent.
* **Interpretation:** Microsoft 365 reports status as a nested object on each attendee; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.attendees.status.response`
**Response.** The response type. It distinguishes the provider-defined response state or classification for the response status.
* **Enables:** Segment response status entries in Team Calendar Events by response in `team_calendar_events.ResponseStatus.response`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports response as a label from its own taxonomy on each response status; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_calendar_events.attendees.status.time`
**Time.** Date and time the response was submitted. It anchors the team calendar event on the provider's reported timeline.
* **Enables:** Order Team Calendar Events by time in `team_calendar_events.ResponseStatus.time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports time as a timestamp on each response status; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `team_calendar_events.attendees.type`
**Type.** Attendee type: required, optional, or resource. It distinguishes the provider-defined type state or classification for the attendee.
* **Enables:** Segment attendee entries in Team Calendar Events by type in `team_calendar_events.Attendee.type`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports type as a label from its own taxonomy on each attendee; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_calendar_events.bodyPreview`
**Body Preview.** Short text preview of the event body content. It defines the content surface available for this team calendar event.
* **Enables:** Locate team calendar event records whose body preview in `team_calendar_events.bodyPreview` contains the search term; open the Microsoft 365 record when the excerpt lacks needed context.
* **Interpretation:** This is an excerpt supplied by the provider, not the complete body or an attachment.
Developer identifier: `team_calendar_events.calendar`
**Calendar.** The calendar navigation property or calendar ID associated with the event. It identifies the related provider object that gives the team calendar event its parent, owner, or container context.
* **Enables:** Connect each team calendar event to the related calendar in `team_calendar_events.calendar` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** Microsoft 365 reports calendar as relationship context on each team calendar event; resolve it in the named provider namespace rather than by display text alone.
Developer identifier: `team_calendar_events.categories`
**Categories.** User-assigned categories/labels on the event. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Compare the exact Microsoft 365-configured categories set in `team_calendar_events.categories` for each team calendar event; preserve provider labels and unknown entries.
* **Interpretation:** Microsoft 365 returns categories as an array of category value entries on each team calendar event; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `team_calendar_events.changeKey`
**Change Key.** Version identifier of the event; changes each time the event is modified. It provides the reference needed to connect the team calendar event to the corresponding provider object.
* **Enables:** Connect each team calendar event in Team Calendar Events to the referenced change through `team_calendar_events.changeKey`; flag change key values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports change key as an identifier in its change namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `team_calendar_events.createdDateTime`
**Created Date Time.** Date and time the event was created in ISO 8601 format. It anchors the team calendar event on the provider's reported timeline.
* **Enables:** Order Team Calendar Events by created date time in `team_calendar_events.createdDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports created date time as a timestamp on each team calendar event; timezone and precision follow this API field, and absence is not an inferred event time. The schema designates this field as the event timestamp.
Developer identifier: `team_calendar_events.end`
**End.** End date/time and timezone of the event. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute end in `team_calendar_events.end` to the parent team calendar event; identify parent records where that nested end object is absent.
* **Interpretation:** Microsoft 365 reports end as a nested object on each team calendar event; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.iCalUId`
**I Cal U ID.** Unique identifier for the event across calendars. Stable when the event moves between calendars, unlike ID. It provides the reference needed to connect the team calendar event to the corresponding provider object.
* **Enables:** Connect each team calendar event in Team Calendar Events to the referenced i cal u through `team_calendar_events.iCalUId`; flag i cal u ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports i cal u ID as an identifier in its i cal u namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `team_calendar_events.id`
**ID.** Unique identifier for the event. It provides the reference needed to connect the team calendar event to the corresponding provider object.
* **Enables:** Match repeated team calendar event entries on ID in `team_calendar_events.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its team calendar event namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `team_calendar_events.importance`
**Importance.** Importance level of the event. It distinguishes the provider-defined importance state or classification for the team calendar event.
* **Enables:** Segment team calendar event entries in Team Calendar Events by importance in `team_calendar_events.importance`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports importance as a label from its own taxonomy on each team calendar event; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_calendar_events.isAllDay`
**Is All Day.** Whether the event lasts all day. It distinguishes the provider-defined is all day state or classification for the team calendar event.
* **Enables:** Filter Team Calendar Events by whether the event lasts all day in `team_calendar_events.isAllDay`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the event lasts all day as a boolean on each team calendar event; a missing field is unknown, not false.
Developer identifier: `team_calendar_events.isCancelled`
**Is Cancelled.** Whether the event has been cancelled. It distinguishes the provider-defined is cancelled state or classification for the team calendar event.
* **Enables:** Filter Team Calendar Events by whether the event has been cancelled in `team_calendar_events.isCancelled`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the event has been cancelled as a boolean on each team calendar event; a missing field is unknown, not false.
Developer identifier: `team_calendar_events.isOnlineMeeting`
**Is Online Meeting.** Whether the event is an online meeting. It distinguishes the provider-defined is online meeting state or classification for the team calendar event.
* **Enables:** Filter Team Calendar Events by whether the event is an online meeting in `team_calendar_events.isOnlineMeeting`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the event is an online meeting as a boolean on each team calendar event; a missing field is unknown, not false.
Developer identifier: `team_calendar_events.lastModifiedDateTime`
**Last Modified Date Time.** Date and time the event was last modified in ISO 8601 format. Used as incremental sync cursor. It anchors the team calendar event on the provider's reported timeline.
* **Enables:** Order Team Calendar Events by last modified date time in `team_calendar_events.lastModifiedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports last modified date time as a timestamp on each team calendar event; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `team_calendar_events.location`
**Location.** Location of the event. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute location in `team_calendar_events.location` to the parent team calendar event; identify parent records where that nested location object is absent.
* **Interpretation:** Microsoft 365 reports location as a nested object on each team calendar event; optional children may be absent from a valid response. This nested location attribute does not establish where data is stored or processed and is not a residency signal.
Developer identifier: `team_calendar_events.location.address`
**Address.** Physical street address of the location. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute address in `team_calendar_events.Location.address` to the parent team calendar event; identify parent records where that nested address object is absent.
* **Interpretation:** Microsoft 365 reports address as a nested object on each location; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.location.address.city`
**City.** City. It supplies the provider-reported address or location facet for the physical address, not a residency determination.
* **Enables:** Group Team Calendar Events by city in `team_calendar_events.PhysicalAddress.city` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports city as a user, device, request, or resource location attribute on each physical address; it does not establish where data is stored or processed.
Developer identifier: `team_calendar_events.location.address.countryOrRegion`
**Country Or Region.** Country or region. It supplies the provider-reported address or location facet for the physical address, not a residency determination.
* **Enables:** Group Team Calendar Events by country or region in `team_calendar_events.PhysicalAddress.countryOrRegion` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports country or region as a user, device, request, or resource location attribute on each physical address; it does not establish where data is stored or processed.
Developer identifier: `team_calendar_events.location.address.postalCode`
**Postal Code.** Postal/ZIP code. It supplies the provider-reported address or location facet for the physical address, not a residency determination.
* **Enables:** Group Team Calendar Events by the exact postal code in `team_calendar_events.PhysicalAddress.postalCode` while keeping that address or location separate from geolocation and residency claims.
* **Interpretation:** Microsoft 365 reports postal code as an address or location facet on each physical address; it does not establish verified geolocation or data residency.
Developer identifier: `team_calendar_events.location.address.state`
**State.** State or province. It distinguishes the provider-defined state state or classification for the physical address.
* **Enables:** Group Team Calendar Events by state in `team_calendar_events.PhysicalAddress.state` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports state as a user, device, request, or resource location attribute on each physical address; it does not establish where data is stored or processed.
Developer identifier: `team_calendar_events.location.address.street`
**Street.** Street address. It supplies the provider-reported address or location facet for the physical address, not a residency determination.
* **Enables:** Group Team Calendar Events by the exact street in `team_calendar_events.PhysicalAddress.street` while keeping that address or location separate from geolocation and residency claims.
* **Interpretation:** Microsoft 365 reports street as an address or location facet on each physical address; it does not establish verified geolocation or data residency.
Developer identifier: `team_calendar_events.location.coordinates`
**Coordinates.** Geographic coordinates and elevation of the location. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute coordinates in `team_calendar_events.Location.coordinates` to the parent team calendar event; identify parent records where that nested coordinates object is absent.
* **Interpretation:** Microsoft 365 reports coordinates as a nested object on each location; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.location.coordinates.accuracy`
**Accuracy.** Accuracy of the coordinates in meters. It supplies the accuracy measure for the geo coordinate at the provider's declared unit and grain.
* **Enables:** Measure accuracy through `team_calendar_events.GeoCoordinates.accuracy` for each geo coordinate and compare only values with the same unit and record grain.
* **Interpretation:** Microsoft 365 reports accuracy as a measure on each geo coordinate; compare only records with the same unit and aggregation grain.
Developer identifier: `team_calendar_events.location.coordinates.altitude`
**Altitude.** Altitude of the location. It supplies the provider-reported address or location facet for the geo coordinate, not a residency determination.
* **Enables:** Group Team Calendar Events by the exact altitude in `team_calendar_events.GeoCoordinates.altitude` while keeping that address or location separate from geolocation and residency claims.
* **Interpretation:** Microsoft 365 reports altitude as an address or location facet on each geo coordinate; it does not establish verified geolocation or data residency.
Developer identifier: `team_calendar_events.location.coordinates.altitudeAccuracy`
**Altitude Accuracy.** Accuracy of the altitude in meters. It supplies the altitude accuracy measure for the geo coordinate at the provider's declared unit and grain.
* **Enables:** Measure altitude accuracy through `team_calendar_events.GeoCoordinates.altitudeAccuracy` for each geo coordinate and compare only values with the same unit and record grain.
* **Interpretation:** Microsoft 365 reports altitude accuracy as a measure on each geo coordinate; compare only records with the same unit and aggregation grain.
Developer identifier: `team_calendar_events.location.coordinates.latitude`
**Latitude.** Latitude of the location. It supplies the provider-reported address or location facet for the geo coordinate, not a residency determination.
* **Enables:** Group Team Calendar Events by latitude in `team_calendar_events.GeoCoordinates.latitude` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports latitude as a user, device, request, or resource location attribute on each geo coordinate; it does not establish where data is stored or processed.
Developer identifier: `team_calendar_events.location.coordinates.longitude`
**Longitude.** Longitude of the location. It supplies the provider-reported address or location facet for the geo coordinate, not a residency determination.
* **Enables:** Group Team Calendar Events by longitude in `team_calendar_events.GeoCoordinates.longitude` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports longitude as a user, device, request, or resource location attribute on each geo coordinate; it does not establish where data is stored or processed.
Developer identifier: `team_calendar_events.location.displayName`
**Display Name.** Display name of the location. It distinguishes the provider-defined display name state or classification for the location.
* **Enables:** Label each location with display name from `team_calendar_events.Location.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each location; names are mutable and are not stable identities.
Developer identifier: `team_calendar_events.location.locationEmailAddress`
**Location Email Address.** Email address associated with the location (e.g. a conference room). It supplies the provider-reported address or location facet for the location, not a residency determination.
* **Enables:** Attribute each location to a person or account by the exact location email address in `team_calendar_events.Location.locationEmailAddress`; identify addresses that do not match the Microsoft 365 directory.
* **Interpretation:** Microsoft 365 reports location email address as an address on each location; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `team_calendar_events.location.locationType`
**Location Type.** Type of location. It distinguishes the provider-defined location type state or classification for the location.
* **Enables:** Segment location entries in Team Calendar Events by location type in `team_calendar_events.Location.locationType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports location type as a label from its own taxonomy on each location; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_calendar_events.location.locationUri`
**Location URI.** URI representing the location. It supplies the provider-reported address or location facet for the location, not a residency determination.
* **Enables:** Associate each location with the resource identified by location URI in `team_calendar_events.Location.locationUri`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports location URI as a resource locator for each location; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `team_calendar_events.location.uniqueId`
**Unique ID.** Unique identifier of the location, if available. It provides the reference needed to connect the team calendar event to the corresponding provider object.
* **Enables:** Connect each location in Team Calendar Events to the referenced unique through `team_calendar_events.Location.uniqueId`; flag unique ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports unique ID as an identifier in its unique namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `team_calendar_events.location.uniqueIdType`
**Unique ID Type.** Type of the unique ID for the location. It distinguishes the provider-defined unique ID type state or classification for the location.
* **Enables:** Segment location entries in Team Calendar Events by unique ID type in `team_calendar_events.Location.uniqueIdType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports unique ID type as a label from its own taxonomy on each location; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_calendar_events.onlineMeeting`
**Online Meeting.** Details for joining an online meeting, including join URL and conference ID. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute online meeting in `team_calendar_events.onlineMeeting` to the parent team calendar event; identify parent records where that nested online meeting object is absent.
* **Interpretation:** Microsoft 365 reports online meeting as a nested object on each team calendar event; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.onlineMeeting.conferenceId`
**Conference ID.** Conference ID for dial-in access. It provides the reference needed to connect the team calendar event to the corresponding provider object.
* **Enables:** Connect each online meeting info in Team Calendar Events to the referenced conference through `team_calendar_events.OnlineMeetingInfo.conferenceId`; flag conference ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports conference ID as an identifier in its conference namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `team_calendar_events.onlineMeeting.dialinUrl`
**Dialin URL.** URL with dial-in information. It locates the provider resource or path associated with the online meeting info.
* **Enables:** Associate each online meeting info with the resource identified by dialin URL in `team_calendar_events.OnlineMeetingInfo.dialinUrl`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports dialin URL as a resource locator for each online meeting info; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `team_calendar_events.onlineMeeting.joinUrl`
**Join URL.** URL to join the online meeting. It locates the provider resource or path associated with the online meeting info.
* **Enables:** Associate each online meeting info with the resource identified by join URL in `team_calendar_events.OnlineMeetingInfo.joinUrl`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports join URL as a resource locator for each online meeting info; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `team_calendar_events.onlineMeeting.phones`
**Phones.** Phone numbers associated with the online meeting. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Reconcile each returned online meeting phone in `team_calendar_events.OnlineMeetingInfo.phones` with the parent team calendar event's provider profile; preserve distinct aliases, contact points, and organization attributes.
* **Interpretation:** Microsoft 365 returns phones as an array of online meeting phone entries on each online meeting info; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `team_calendar_events.onlineMeeting.phones.number`
**Number.** The phone number. It supplies the number measure for the online meeting phone at the provider's declared unit and grain.
* **Enables:** Measure number through `team_calendar_events.OnlineMeetingPhone.number` for each online meeting phone and compare only values with the same unit and record grain.
* **Interpretation:** Microsoft 365 reports number as a measure on each online meeting phone; compare only records with the same unit and aggregation grain.
Developer identifier: `team_calendar_events.onlineMeeting.phones.type`
**Type.** Type of phone number (e.g. toll, tollFree). It distinguishes the provider-defined type state or classification for the online meeting phone.
* **Enables:** Segment online meeting phone entries in Team Calendar Events by type in `team_calendar_events.OnlineMeetingPhone.type`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports type as a label from its own taxonomy on each online meeting phone; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_calendar_events.onlineMeeting.quickDial`
**Quick Dial.** Quick dial code for the meeting. It supplies the sensitive provider access code needed to join the online meeting info, not a stable record identifier.
* **Enables:** Reconcile `team_calendar_events.OnlineMeetingInfo.quickDial` with the same conference entry point or meeting instructions when validating join access; handle it as sensitive access metadata.
* **Interpretation:** Microsoft 365 returns quick dial as meeting or conference access metadata on each online meeting info; it can rotate and does not identify the meeting by itself.
Developer identifier: `team_calendar_events.onlineMeeting.tollFreeNumbers`
**Toll Free Numbers.** List of toll-free phone numbers for dial-in. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Reconcile each returned toll free number value in `team_calendar_events.OnlineMeetingInfo.tollFreeNumbers` with the parent team calendar event's provider profile; preserve distinct aliases, contact points, and organization attributes.
* **Interpretation:** Microsoft 365 returns toll free numbers as an array of toll free number value entries on each online meeting info; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `team_calendar_events.onlineMeeting.tollNumber`
**Toll Number.** Toll phone number for dial-in. It supplies the toll number measure for the online meeting info at the provider's declared unit and grain.
* **Enables:** Measure toll number through `team_calendar_events.OnlineMeetingInfo.tollNumber` for each online meeting info and compare only values with the same unit and record grain.
* **Interpretation:** Microsoft 365 reports toll number as a measure on each online meeting info; compare only records with the same unit and aggregation grain.
Developer identifier: `team_calendar_events.onlineMeetingUrl`
**Online Meeting URL.** URL for joining the online meeting (legacy property). It locates the provider resource or path associated with the team calendar event.
* **Enables:** Associate each team calendar event with the resource identified by online meeting URL in `team_calendar_events.onlineMeetingUrl`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports online meeting URL as a resource locator for each team calendar event; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `team_calendar_events.organizer`
**Organizer.** Organizer of the event with email and name. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute organizer in `team_calendar_events.organizer` to the parent team calendar event; identify parent records where that nested organizer object is absent.
* **Interpretation:** Microsoft 365 reports organizer as a nested object on each team calendar event; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.organizer.emailAddress`
**Email Address.** Email address and display name of the recipient. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute email address in `team_calendar_events.Recipient.emailAddress` to the parent team calendar event; identify parent records where that nested email address object is absent.
* **Interpretation:** Microsoft 365 reports email address as a nested object on each recipient; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.originalEndTimeZone`
**Original End Time Zone.** End time zone the event was created in (IANA or Windows identifier). It is needed to interpret companion dates and times for the team calendar event in the provider's intended zone.
* **Enables:** Apply the zone in `team_calendar_events.originalEndTimeZone` when converting the team calendar event's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** Microsoft 365 reports original end time zone as a timezone identifier for each team calendar event; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `team_calendar_events.originalStartTimeZone`
**Original Start Time Zone.** Start time zone the event was created in (IANA or Windows identifier). It is needed to interpret companion dates and times for the team calendar event in the provider's intended zone.
* **Enables:** Apply the zone in `team_calendar_events.originalStartTimeZone` when converting the team calendar event's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** Microsoft 365 reports original start time zone as a timezone identifier for each team calendar event; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `team_calendar_events.recurrence`
**Recurrence.** Recurrence pattern and range for recurring events. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute recurrence in `team_calendar_events.recurrence` to the parent team calendar event; identify parent records where that nested recurrence object is absent.
* **Interpretation:** Microsoft 365 reports recurrence as a nested object on each team calendar event; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.recurrence.pattern`
**Pattern.** The frequency and rules of the recurrence. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute pattern in `team_calendar_events.PatternedRecurrence.pattern` to the parent team calendar event; identify parent records where that nested pattern object is absent.
* **Interpretation:** Microsoft 365 reports pattern as a nested object on each patterned recurrence; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.recurrence.pattern.dayOfMonth`
**Day Of Month.** Day of the month for absoluteMonthly/absoluteYearly patterns. It supplies the day of month measure for the recurrence pattern at the provider's declared unit and grain.
* **Enables:** Measure day of month through `team_calendar_events.RecurrencePattern.dayOfMonth` for each recurrence pattern and compare only values with the same unit and record grain.
* **Interpretation:** Microsoft 365 reports day of month as a measure on each recurrence pattern; compare only records with the same unit and aggregation grain.
Developer identifier: `team_calendar_events.recurrence.pattern.daysOfWeek`
**Days Of Week.** Days of the week the event occurs on. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Compare the exact Microsoft 365-configured days of week set in `team_calendar_events.RecurrencePattern.daysOfWeek` for each recurrence pattern; preserve provider labels and unknown entries.
* **Interpretation:** Microsoft 365 returns days of week as an array of recurrence pattern day of week enum entries on each recurrence pattern; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `team_calendar_events.recurrence.pattern.firstDayOfWeek`
**First Day Of Week.** First day of the week for weekly patterns. It distinguishes the provider-defined first day of week state or classification for the recurrence pattern.
* **Enables:** Segment recurrence pattern entries in Team Calendar Events by first day of week in `team_calendar_events.RecurrencePattern.firstDayOfWeek`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports first day of week as a label from its own taxonomy on each recurrence pattern; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_calendar_events.recurrence.pattern.index`
**Index.** Week index for relativeMonthly/relativeYearly patterns. It distinguishes the provider-defined index state or classification for the recurrence pattern.
* **Enables:** Segment recurrence pattern entries in Team Calendar Events by index in `team_calendar_events.RecurrencePattern.index`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports index as a label from its own taxonomy on each recurrence pattern; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_calendar_events.recurrence.pattern.interval`
**Interval.** Number of units between occurrences (e.g. every 2 weeks). It supplies the interval boundary, band, or unit needed to interpret the companion measure.
* **Enables:** Interpret `team_calendar_events.RecurrencePattern.interval` with its companion minimum, maximum, interval, or unit before comparing the interval across like-for-like records.
* **Interpretation:** Microsoft 365 reports interval as a boundary, band, interval, or unit on each recurrence pattern; it is meaningful only with its companion measure and provider scale.
Developer identifier: `team_calendar_events.recurrence.pattern.month`
**Month.** Month in which the event occurs (1-12), for yearly patterns. It supplies the month measure for the recurrence pattern at the provider's declared unit and grain.
* **Enables:** Measure month through `team_calendar_events.RecurrencePattern.month` for each recurrence pattern and compare only values with the same unit and record grain.
* **Interpretation:** Microsoft 365 reports month as a measure on each recurrence pattern; compare only records with the same unit and aggregation grain.
Developer identifier: `team_calendar_events.recurrence.pattern.type`
**Type.** The recurrence pattern type. It distinguishes the provider-defined type state or classification for the recurrence pattern.
* **Enables:** Segment recurrence pattern entries in Team Calendar Events by type in `team_calendar_events.RecurrencePattern.type`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports type as a label from its own taxonomy on each recurrence pattern; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_calendar_events.recurrence.range`
**Range.** The duration/bounds of the recurrence. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute range in `team_calendar_events.PatternedRecurrence.range` to the parent team calendar event; identify parent records where that nested range object is absent.
* **Interpretation:** Microsoft 365 reports range as a nested object on each patterned recurrence; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.recurrence.range.endDate`
**End Date.** End date of the recurrence range (YYYY-MM-DD). Used when type is endDate. It anchors the team calendar event on the provider's reported timeline.
* **Enables:** Filter Team Calendar Events by end date in `team_calendar_events.RecurrenceRange.endDate`; pair that boundary with the corresponding start before measuring elapsed time.
* **Interpretation:** Microsoft 365 reports end date as a calendar date on each recurrence range; its grain is one day and no time of day should be inferred.
Developer identifier: `team_calendar_events.recurrence.range.numberOfOccurrences`
**Number Of Occurrences.** Number of occurrences. Used when type is numbered. It supplies the number of occurrences measure for the recurrence range at the provider's declared unit and grain.
* **Enables:** Measure number of occurrences through `team_calendar_events.RecurrenceRange.numberOfOccurrences` for each recurrence range and compare only values with the same unit and record grain.
* **Interpretation:** Microsoft 365 reports number of occurrences as a measure on each recurrence range; compare only records with the same unit and aggregation grain.
Developer identifier: `team_calendar_events.recurrence.range.recurrenceTimeZone`
**Recurrence Time Zone.** Time zone for the start and end dates. It is needed to interpret companion dates and times for the recurrence range in the provider's intended zone.
* **Enables:** Apply the zone in `team_calendar_events.RecurrenceRange.recurrenceTimeZone` when converting the team calendar event's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** Microsoft 365 reports recurrence time zone as a timezone identifier for each recurrence range; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `team_calendar_events.recurrence.range.startDate`
**Start Date.** Start date of the recurrence range (YYYY-MM-DD). It anchors the team calendar event on the provider's reported timeline.
* **Enables:** Filter Team Calendar Events by start date in `team_calendar_events.RecurrenceRange.startDate`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** Microsoft 365 reports start date as a calendar date on each recurrence range; its grain is one day and no time of day should be inferred.
Developer identifier: `team_calendar_events.recurrence.range.type`
**Type.** The recurrence range type. It distinguishes the provider-defined type state or classification for the recurrence range.
* **Enables:** Segment recurrence range entries in Team Calendar Events by type in `team_calendar_events.RecurrenceRange.type`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports type as a label from its own taxonomy on each recurrence range; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_calendar_events.responseStatus`
**Response Status.** The response status and time of the current user for this event. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute response status in `team_calendar_events.responseStatus` to the parent team calendar event; identify parent records where that nested response status object is absent.
* **Interpretation:** Microsoft 365 reports response status as a nested object on each team calendar event; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.sensitivity`
**Sensitivity.** Sensitivity level of the event. It distinguishes the provider-defined sensitivity state or classification for the team calendar event.
* **Enables:** Segment team calendar event entries in Team Calendar Events by sensitivity in `team_calendar_events.sensitivity`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports sensitivity as a label from its own taxonomy on each team calendar event; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_calendar_events.seriesMasterId`
**Series Master ID.** The ID of the recurring series master event, if this event is part of a recurring series. It provides the reference needed to connect the team calendar event to the corresponding provider object.
* **Enables:** Connect each team calendar event in Team Calendar Events to the referenced series master through `team_calendar_events.seriesMasterId`; flag series master ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports series master ID as an identifier in its series master namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `team_calendar_events.showAs`
**Show As.** Free/busy status shown during the event. It distinguishes the provider-defined show as state or classification for the team calendar event.
* **Enables:** Segment team calendar event entries in Team Calendar Events by show as in `team_calendar_events.showAs`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports show as as a label from its own taxonomy on each team calendar event; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_calendar_events.start`
**Start.** Start date/time and timezone of the event. It preserves the nested context needed to interpret the parent team calendar event.
* **Enables:** Attribute start in `team_calendar_events.start` to the parent team calendar event; identify parent records where that nested start object is absent.
* **Interpretation:** Microsoft 365 reports start as a nested object on each team calendar event; optional children may be absent from a valid response.
Developer identifier: `team_calendar_events.subject`
**Subject.** Subject/title of the calendar event. It defines the content surface available for this team calendar event.
* **Enables:** Locate team calendar event records by subject in `team_calendar_events.subject`; attribute each text match to its parent team calendar event and, when present, its reported author.
* **Interpretation:** Microsoft 365 supplies subject as text on each team calendar event; referenced files or media are not implied unless explicitly represented.
Developer identifier: `team_calendar_events.team_id`
**Team ID.** Parent team reference copied into each team calendar event because the child operation does not return that relationship. It provides the reference needed to connect the team calendar event to the corresponding provider object.
* **Enables:** Connect each team calendar event in Team Calendar Events to the referenced team through `team_calendar_events.team_id`; flag team ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies team ID from the parent traversal record into each team calendar event; the child Microsoft 365 operation does not return it.
Developer identifier: `team_calendar_events.type`
**Type.** The event type: singleInstance, occurrence, exception, or seriesMaster. It distinguishes the provider-defined type state or classification for the team calendar event.
* **Enables:** Segment team calendar event entries in Team Calendar Events by type in `team_calendar_events.type`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports type as a label from its own taxonomy on each team calendar event; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_calendar_events.webLink`
**Web Link.** URL to open the event in Outlook on the web. It locates the provider resource or path associated with the team calendar event.
* **Enables:** Associate each team calendar event with the resource identified by web link in `team_calendar_events.webLink`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports web link as a resource locator for each team calendar event; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `team_details`
**Team Details.** Detailed settings for each team.
* **Enables:** Match each Team to its detailed messaging, member, guest, discovery, and archival settings.
* **Scope:** Reads the records selected by Microsoft 365's `/v1.0/teams/{id}` operation as a snapshot stream using full synchronization. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `team_details.classification`
**Classification.** Classification of the team (e.g. low, medium, high business impact) when classifications are configured for the organization. It identifies the related provider object that gives the team detail its parent, owner, or container context.
* **Enables:** Segment team detail entries in Team Details by classification in `team_details.classification`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports classification as a label from its own taxonomy on each team detail; preserve unknown labels rather than mapping them by assumption. Microsoft 365 generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `team_details.createdDateTime`
**Created Date Time.** When the team was created. It anchors the team detail on the provider's reported timeline.
* **Enables:** Order Team Details by created date time in `team_details.createdDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports created date time as a timestamp on each team detail; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `team_details.description`
**Description.** Optional description of the team. It defines the content surface available for this team detail.
* **Enables:** Locate team detail records by description in `team_details.description`; attribute each text match to its parent team detail and, when present, its reported author.
* **Interpretation:** Microsoft 365 supplies description as text on each team detail; referenced files or media are not implied unless explicitly represented.
Developer identifier: `team_details.displayName`
**Display Name.** Name of the team as displayed to users. It distinguishes the provider-defined display name state or classification for the team detail.
* **Enables:** Label each team detail with display name from `team_details.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each team detail; names are mutable and are not stable identities.
Developer identifier: `team_details.funSettings`
**Fun Settings.** Settings that control fun content (giphy, stickers, memes) in the team. It preserves the nested context needed to interpret the parent team detail.
* **Enables:** Attribute fun settings in `team_details.funSettings` to the parent team detail; identify parent records where that nested fun settings object is absent.
* **Interpretation:** Microsoft 365 reports fun settings as a nested object on each team detail; optional children may be absent from a valid response.
Developer identifier: `team_details.funSettings.allowCustomMemes`
**Allow Custom Memes.** Whether custom memes can be used in the team. It distinguishes the provider-defined allow custom memes state or classification for the team fun setting.
* **Enables:** Filter Team Details by whether custom memes can be used in the team in `team_details.TeamFunSettings.allowCustomMemes`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports custom memes can be used in the team as a boolean on each team fun setting; a missing field is unknown, not false.
Developer identifier: `team_details.funSettings.allowGiphy`
**Allow Giphy.** Whether Giphy can be used in the team. It distinguishes the provider-defined allow giphy state or classification for the team fun setting.
* **Enables:** Filter Team Details by whether giphy can be used in the team in `team_details.TeamFunSettings.allowGiphy`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports giphy can be used in the team as a boolean on each team fun setting; a missing field is unknown, not false.
Developer identifier: `team_details.funSettings.allowStickersAndMemes`
**Allow Stickers And Memes.** Whether stickers and memes can be used in the team. It distinguishes the provider-defined allow stickers and memes state or classification for the team fun setting.
* **Enables:** Filter Team Details by whether stickers and memes can be used in the team in `team_details.TeamFunSettings.allowStickersAndMemes`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports stickers and memes can be used in the team as a boolean on each team fun setting; a missing field is unknown, not false.
Developer identifier: `team_details.funSettings.giphyContentRating`
**Giphy Content Rating.** Giphy content rating: moderate or strict. It distinguishes the provider-defined giphy content rating state or classification for the team fun setting.
* **Enables:** Segment team fun setting entries in Team Details by giphy content rating in `team_details.TeamFunSettings.giphyContentRating`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports giphy content rating as a label from its own taxonomy on each team fun setting; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_details.guestSettings`
**Guest Settings.** Settings that control what guests can do in the team. It preserves the nested context needed to interpret the parent team detail.
* **Enables:** Attribute guest settings in `team_details.guestSettings` to the parent team detail; identify parent records where that nested guest settings object is absent.
* **Interpretation:** Microsoft 365 reports guest settings as a nested object on each team detail; optional children may be absent from a valid response.
Developer identifier: `team_details.guestSettings.allowCreateUpdateChannels`
**Allow Create Update Channels.** Whether guests can add and update channels. It distinguishes the provider-defined allow create update channels state or classification for the team guest setting.
* **Enables:** Filter Team Details by whether guests can add and update channels in `team_details.TeamGuestSettings.allowCreateUpdateChannels`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports guests can add and update channels as a boolean on each team guest setting; a missing field is unknown, not false.
Developer identifier: `team_details.guestSettings.allowDeleteChannels`
**Allow Delete Channels.** Whether guests can delete channels. It distinguishes the provider-defined allow delete channels state or classification for the team guest setting.
* **Enables:** Filter Team Details by whether guests can delete channels in `team_details.TeamGuestSettings.allowDeleteChannels`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports guests can delete channels as a boolean on each team guest setting; a missing field is unknown, not false.
Developer identifier: `team_details.id`
**ID.** Unique identifier for the team. It provides the reference needed to connect the team detail to the corresponding provider object.
* **Enables:** Match repeated team detail entries on ID in `team_details.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its team detail namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `team_details.internalId`
**Internal ID.** Unique identifier used by Teams telemetry (not the same as ID). It provides the reference needed to connect the team detail to the corresponding provider object.
* **Enables:** Connect each team detail in Team Details to the referenced internal through `team_details.internalId`; flag internal ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports internal ID as an identifier in its internal namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `team_details.isArchived`
**Is Archived.** Whether the team is currently archived (read-only). It distinguishes the provider-defined is archived state or classification for the team detail.
* **Enables:** Filter Team Details by whether the team is currently archived (read-only) in `team_details.isArchived`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the team is currently archived (read-only) as a boolean on each team detail; a missing field is unknown, not false.
Developer identifier: `team_details.memberSettings`
**Member Settings.** Settings that control what members can do in the team. It preserves the nested context needed to interpret the parent team detail.
* **Enables:** Attribute member settings in `team_details.memberSettings` to the parent team detail; identify parent records where that nested member settings object is absent.
* **Interpretation:** Microsoft 365 reports member settings as a nested object on each team detail; optional children may be absent from a valid response.
Developer identifier: `team_details.memberSettings.allowAddRemoveApps`
**Allow Add Remove Apps.** Whether members can add or remove apps. It distinguishes the provider-defined allow add remove apps state or classification for the team member setting.
* **Enables:** Filter Team Details by whether members can add or remove apps in `team_details.TeamMemberSettings.allowAddRemoveApps`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports members can add or remove apps as a boolean on each team member setting; a missing field is unknown, not false.
Developer identifier: `team_details.memberSettings.allowCreatePrivateChannels`
**Allow Create Private Channels.** Whether members can add private channels. It distinguishes the provider-defined allow create private channels state or classification for the team member setting.
* **Enables:** Filter Team Details by whether members can add private channels in `team_details.TeamMemberSettings.allowCreatePrivateChannels`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports members can add private channels as a boolean on each team member setting; a missing field is unknown, not false.
Developer identifier: `team_details.memberSettings.allowCreateUpdateChannels`
**Allow Create Update Channels.** Whether members can add and update channels. It distinguishes the provider-defined allow create update channels state or classification for the team member setting.
* **Enables:** Filter Team Details by whether members can add and update channels in `team_details.TeamMemberSettings.allowCreateUpdateChannels`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports members can add and update channels as a boolean on each team member setting; a missing field is unknown, not false.
Developer identifier: `team_details.memberSettings.allowCreateUpdateRemoveConnectors`
**Allow Create Update Remove Connectors.** Whether members can add, update, and remove connectors. It distinguishes the provider-defined allow create update remove connectors state or classification for the team member setting.
* **Enables:** Filter Team Details by whether members can add, update, and remove connectors in `team_details.TeamMemberSettings.allowCreateUpdateRemoveConnectors`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports members can add, update, and remove connectors as a boolean on each team member setting; a missing field is unknown, not false.
Developer identifier: `team_details.memberSettings.allowCreateUpdateRemoveTabs`
**Allow Create Update Remove Tabs.** Whether members can add, update, and remove tabs. It distinguishes the provider-defined allow create update remove tabs state or classification for the team member setting.
* **Enables:** Filter Team Details by whether members can add, update, and remove tabs in `team_details.TeamMemberSettings.allowCreateUpdateRemoveTabs`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports members can add, update, and remove tabs as a boolean on each team member setting; a missing field is unknown, not false.
Developer identifier: `team_details.memberSettings.allowDeleteChannels`
**Allow Delete Channels.** Whether members can delete channels. It distinguishes the provider-defined allow delete channels state or classification for the team member setting.
* **Enables:** Filter Team Details by whether members can delete channels in `team_details.TeamMemberSettings.allowDeleteChannels`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports members can delete channels as a boolean on each team member setting; a missing field is unknown, not false.
Developer identifier: `team_details.messagingSettings`
**Messaging Settings.** Settings that control messaging and mentions in the team. It preserves the nested context needed to interpret the parent team detail.
* **Enables:** Attribute messaging settings in `team_details.messagingSettings` to the parent team detail; identify parent records where that nested messaging settings object is absent.
* **Interpretation:** Microsoft 365 reports messaging settings as a nested object on each team detail; optional children may be absent from a valid response.
Developer identifier: `team_details.messagingSettings.allowChannelMentions`
**Allow Channel Mentions.** Whether @channel mentions are allowed. It distinguishes the provider-defined allow channel mentions state or classification for the team messaging setting.
* **Enables:** Filter Team Details by whether @channel mentions are allowed in `team_details.TeamMessagingSettings.allowChannelMentions`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports @channel mentions are allowed as a boolean on each team messaging setting; a missing field is unknown, not false.
Developer identifier: `team_details.messagingSettings.allowOwnerDeleteMessages`
**Allow Owner Delete Messages.** Whether owners can delete any message. It distinguishes the provider-defined allow owner delete messages state or classification for the team messaging setting.
* **Enables:** Filter Team Details by whether owners can delete any message in `team_details.TeamMessagingSettings.allowOwnerDeleteMessages`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports owners can delete any message as a boolean on each team messaging setting; a missing field is unknown, not false.
Developer identifier: `team_details.messagingSettings.allowTeamMentions`
**Allow Team Mentions.** Whether @team mentions are allowed. It distinguishes the provider-defined allow team mentions state or classification for the team messaging setting.
* **Enables:** Filter Team Details by whether @team mentions are allowed in `team_details.TeamMessagingSettings.allowTeamMentions`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports @team mentions are allowed as a boolean on each team messaging setting; a missing field is unknown, not false.
Developer identifier: `team_details.messagingSettings.allowUserDeleteMessages`
**Allow User Delete Messages.** Whether users can delete their own messages. It distinguishes the provider-defined allow user delete messages state or classification for the team messaging setting.
* **Enables:** Filter Team Details by whether users can delete their own messages in `team_details.TeamMessagingSettings.allowUserDeleteMessages`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports users can delete their own messages as a boolean on each team messaging setting; a missing field is unknown, not false.
Developer identifier: `team_details.messagingSettings.allowUserEditMessages`
**Allow User Edit Messages.** Whether users can edit their own messages. It distinguishes the provider-defined allow user edit messages state or classification for the team messaging setting.
* **Enables:** Filter Team Details by whether users can edit their own messages in `team_details.TeamMessagingSettings.allowUserEditMessages`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports users can edit their own messages as a boolean on each team messaging setting; a missing field is unknown, not false.
Developer identifier: `team_details.specialization`
**Specialization.** Creation-time specialization of the team (evolvable enum, e.g. none, educationStandard, educationClass, healthcareStandard). Stored as string because Microsoft adds values over time (education/healthcare variants) and a strict enum would quarantine records on any new value. It identifies the related provider object that gives the team detail its parent, owner, or container context.
* **Enables:** Connect each team detail to the related specialization in `team_details.specialization` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** Microsoft 365 reports specialization as relationship context on each team detail; resolve it in the named provider namespace rather than by display text alone.
Developer identifier: `team_details.team_id`
**Team ID.** Parent team reference copied into each team detail because the child operation does not return that relationship. It provides the reference needed to connect the team detail to the corresponding provider object.
* **Enables:** Connect each team detail in Team Details to the referenced team through `team_details.team_id`; flag team ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies team ID from the parent traversal record into each team detail; the child Microsoft 365 operation does not return it.
Developer identifier: `team_details.tenantId`
**Tenant ID.** Identifier (GUID) of the Microsoft Entra tenant the team belongs to. Kept as string (not Identity.UUID) to match this connector's ID-field convention. It provides the reference needed to connect the team detail to the corresponding provider object.
* **Enables:** Connect each team detail in Team Details to the referenced tenant through `team_details.tenantId`; flag tenant ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports tenant ID as an identifier in its tenant namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `team_details.visibility`
**Visibility.** Visibility of the underlying group: private, public, or hiddenMembership. It distinguishes the provider-defined visibility state or classification for the team detail.
* **Enables:** Segment team detail entries in Team Details by visibility in `team_details.visibility`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports visibility as a label from its own taxonomy on each team detail; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `team_details.webUrl`
**Web URL.** URL to open the team in the Microsoft Teams client. It locates the provider resource or path associated with the team detail.
* **Enables:** Associate each team detail with the resource identified by web URL in `team_details.webUrl`; verify the link resolves to the expected Microsoft 365 object.
* **Interpretation:** Microsoft 365 reports web URL as a resource locator for each team detail; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `teams`
**Teams.** Microsoft Teams represented as groups.
* **Enables:** Inventory Entra groups provisioned as Teams and preserve their visibility, lifecycle, and mail settings for child traversal.
* **Scope:** Reads the records selected by Microsoft 365's `/v1.0/groups` operation as a snapshot stream using full synchronization. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `teams.classification`
**Classification.** Classification of the group (e.g. Low, Medium, High) when classifications are configured for the organization. It distinguishes the provider-defined classification state or classification for the team.
* **Enables:** Segment team entries in Teams by classification in `teams.classification`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports classification as a label from its own taxonomy on each team; preserve unknown labels rather than mapping them by assumption. Microsoft 365 generated or classified this result; it may be incomplete and is not a Parable-authored judgment.
Developer identifier: `teams.createdDateTime`
**Created Date Time.** When the group was created. It anchors the team on the provider's reported timeline.
* **Enables:** Order Teams by created date time in `teams.createdDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports created date time as a timestamp on each team; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `teams.deletedDateTime`
**Deleted Date Time.** When the group was soft-deleted, if it is in the deleted items. It anchors the team on the provider's reported timeline.
* **Enables:** Order Teams by deleted date time in `teams.deletedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports deleted date time as a timestamp on each team; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `teams.description`
**Description.** Description of the group. It defines the content surface available for this team.
* **Enables:** Locate team records by description in `teams.description`; attribute each text match to its parent team and, when present, its reported author.
* **Interpretation:** Microsoft 365 supplies description as text on each team; referenced files or media are not implied unless explicitly represented.
Developer identifier: `teams.displayName`
**Display Name.** Display name of the group. It distinguishes the provider-defined display name state or classification for the team.
* **Enables:** Label each team with display name from `teams.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each team; names are mutable and are not stable identities.
Developer identifier: `teams.expirationDateTime`
**Expiration Date Time.** When the group is set to expire under the group lifecycle policy. It anchors the team on the provider's reported timeline.
* **Enables:** Order Teams by expiration date time in `teams.expirationDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports expiration date time as a timestamp on each team; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `teams.groupTypes`
**Group Types.** Group type markers (e.g. Unified for M365 groups, DynamicMembership). It preserves the nested context needed to interpret the parent team.
* **Enables:** Compare the exact Microsoft 365-configured group types set in `teams.groupTypes` for each team; preserve provider labels and unknown entries.
* **Interpretation:** Microsoft 365 returns group types as an array of group type value entries on each team; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `teams.id`
**ID.** Unique identifier for the group. It provides the reference needed to connect the team to the corresponding provider object.
* **Enables:** Match repeated team entries on ID in `teams.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its team namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `teams.mail`
**Mail.** SMTP address for the group. It supplies the provider-reported address or location facet for the team, not a residency determination.
* **Enables:** Group Teams by the exact mail in `teams.mail` while keeping that address or location separate from geolocation and residency claims.
* **Interpretation:** Microsoft 365 reports mail as an address or location facet on each team; it does not establish verified geolocation or data residency.
Developer identifier: `teams.mailEnabled`
**Mail Enabled.** Whether the group is mail-enabled. It distinguishes the provider-defined mail enabled state or classification for the team.
* **Enables:** Filter Teams by whether the group is mail-enabled in `teams.mailEnabled`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the group is mail-enabled as a boolean on each team; a missing field is unknown, not false.
Developer identifier: `teams.mailNickname`
**Mail Nickname.** Mail alias for the group. It supplies the mail nickname profile facet used to reconcile or attribute the team.
* **Enables:** Reconcile the team's mail nickname in `teams.mailNickname` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Microsoft 365 reports mail nickname as a mutable profile or directory attribute on each team; it may be absent, shared, or non-unique.
Developer identifier: `teams.renewedDateTime`
**Renewed Date Time.** When the group was last renewed under the group lifecycle policy. It anchors the team on the provider's reported timeline.
* **Enables:** Order Teams by renewed date time in `teams.renewedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports renewed date time as a timestamp on each team; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `teams.resourceProvisioningOptions`
**Resource Provisioning Options.** Provisioned resources for the group (e.g. Team). It preserves the nested context needed to interpret the parent team.
* **Enables:** Compare the exact Microsoft 365-configured resource provisioning options set in `teams.resourceProvisioningOptions` for each team; preserve provider labels and unknown entries.
* **Interpretation:** Microsoft 365 returns resource provisioning options as an array of resource provisioning option value entries on each team; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `teams.securityEnabled`
**Security Enabled.** Whether the group is a security group. It distinguishes the provider-defined security enabled state or classification for the team.
* **Enables:** Filter Teams by whether the group is a security group in `teams.securityEnabled`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the group is a security group as a boolean on each team; a missing field is unknown, not false.
Developer identifier: `teams.visibility`
**Visibility.** Group visibility: Public, Private, or HiddenMembership. It distinguishes the provider-defined visibility state or classification for the team.
* **Enables:** Segment team entries in Teams by visibility in `teams.visibility`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports visibility as a label from its own taxonomy on each team; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `user_calendar_events`
**User Calendar Events.** DEPRECATED expansion tap. Duplicates the calendar\_events tap with a narrower \$select. The legacy ingestion-service only defines a single user-calendar tap (calendar\_events). Disabled by default; retained for backward compatibility.
* **Enables:** Preserve the deprecated narrower calendar projection for compatibility while directing new workflows to Calendar Events.
* **Scope:** Reads the records selected by Microsoft 365's `/v1.0/users/{id}/calendarView` operation as an event stream using incremental synchronization. This stream is opt-in. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. This opt-in stream is deprecated, duplicates Calendar Events with a narrower selection, and is retained only for compatibility. This stream supplies no reliable deletion signal.
Developer identifier: `user_calendar_events.@odata.etag`
**@odata ETag.** OData entity tag for concurrency. It is needed for conditional reads and provider-version checks, not as a stable business identifier.
* **Enables:** Use `user_calendar_events.@odata.etag` for conditional provider reads and revision checks; pair the ETag with the user calendar event ID rather than joining on it.
* **Interpretation:** Microsoft 365 returns this ETag as an opaque revision token for each user calendar event; it can change when the resource changes and is not a universal identifier.
Developer identifier: `user_calendar_events.attendees`
**Attendees.** List of attendees. It preserves the nested context needed to interpret the parent user calendar event.
* **Enables:** Attribute each returned attendee in `user_calendar_events.attendees` to the parent user calendar event; preserve whether the field represents an attendee, To, Cc, or Bcc relationship.
* **Interpretation:** Microsoft 365 returns attendees as an array of attendee entries on each user calendar event; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `user_calendar_events.attendees.emailAddress`
**Email Address.** The structured email address details attached to each attendee in User Calendar Events. It preserves the nested context needed to interpret the parent user calendar event.
* **Enables:** Match repeated attendee entries on email address in `user_calendar_events.Attendee.emailAddress`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Microsoft 365 reports email address as a nested object on each attendee; optional children may be absent from a valid response.
Developer identifier: `user_calendar_events.attendees.emailAddress.address`
**Address.** Email/contact address returned for this recipient or account; needed to attribute it to the corresponding Microsoft 365 identity.
* **Enables:** Attribute each email address to a person or account by the exact address in `user_calendar_events.EmailAddress.address`; identify addresses that do not match the Microsoft 365 directory.
* **Interpretation:** Microsoft 365 reports address as an address on each email address; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `user_calendar_events.attendees.emailAddress.name`
**Name.** The provider-reported name for each email address in User Calendar Events. It gives the email address a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each email address with name from `user_calendar_events.EmailAddress.name`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports name as display text for each email address; names are mutable and are not stable identities.
Developer identifier: `user_calendar_events.attendees.status`
**Status.** The structured status details attached to each attendee in User Calendar Events. It preserves the nested context needed to interpret the parent user calendar event.
* **Enables:** Attribute status in `user_calendar_events.Attendee.status` to the parent user calendar event; identify parent records where that nested status object is absent.
* **Interpretation:** Microsoft 365 reports status as a nested object on each attendee; optional children may be absent from a valid response.
Developer identifier: `user_calendar_events.attendees.status.response`
**Response.** Response type (none, organizer, tentativelyAccepted, accepted, declined, notResponded). It defines the content surface available for this user calendar event.
* **Enables:** Locate response status records by response in `user_calendar_events.ResponseStatus.response`; attribute each text match to its parent user calendar event and, when present, its reported author.
* **Interpretation:** Microsoft 365 supplies response as text on each response status; referenced files or media are not implied unless explicitly represented.
Developer identifier: `user_calendar_events.attendees.status.time`
**Time.** Response timestamp. It anchors the user calendar event on the provider's reported timeline.
* **Enables:** Order User Calendar Events by time in `user_calendar_events.ResponseStatus.time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports time as a timestamp on each response status; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `user_calendar_events.attendees.type`
**Type.** Attendee type (required, optional, resource). It distinguishes the provider-defined type state or classification for the attendee.
* **Enables:** Segment attendee entries in User Calendar Events by type in `user_calendar_events.Attendee.type`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports type as a label from its own taxonomy on each attendee; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `user_calendar_events.bodyPreview`
**Body Preview.** Plain text preview of the event body. It defines the content surface available for this user calendar event.
* **Enables:** Locate user calendar event records whose body preview in `user_calendar_events.bodyPreview` contains the search term; open the Microsoft 365 record when the excerpt lacks needed context.
* **Interpretation:** This is an excerpt supplied by the provider, not the complete body or an attachment.
Developer identifier: `user_calendar_events.createdDateTime`
**Created Date Time.** Event creation timestamp. It anchors the user calendar event on the provider's reported timeline.
* **Enables:** Order User Calendar Events by created date time in `user_calendar_events.createdDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports created date time as a timestamp on each user calendar event; timezone and precision follow this API field, and absence is not an inferred event time. The schema designates this field as the event timestamp.
Developer identifier: `user_calendar_events.end`
**End.** Event end date/time with timezone. It preserves the nested context needed to interpret the parent user calendar event.
* **Enables:** Attribute end in `user_calendar_events.end` to the parent user calendar event; identify parent records where that nested end object is absent.
* **Interpretation:** Microsoft 365 reports end as a nested object on each user calendar event; optional children may be absent from a valid response.
Developer identifier: `user_calendar_events.end.dateTime`
**Date Time.** Date and time in ISO 8601 format. It anchors the user calendar event on the provider's reported timeline.
* **Enables:** Order User Calendar Events by date time in `user_calendar_events.DateTimeTimeZone.dateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports date time as a timestamp on each date time time zone; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `user_calendar_events.end.timeZone`
**Time Zone.** IANA timezone identifier. It is needed to interpret companion dates and times for the date time time zone in the provider's intended zone.
* **Enables:** Apply the zone in `user_calendar_events.DateTimeTimeZone.timeZone` when converting the user calendar event's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** Microsoft 365 reports time zone as a timezone identifier for each date time time zone; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `user_calendar_events.id`
**ID.** Unique event identifier. It provides the reference needed to connect the user calendar event to the corresponding provider object.
* **Enables:** Match repeated user calendar event entries on ID in `user_calendar_events.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its user calendar event namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `user_calendar_events.importance`
**Importance.** Event importance (low, normal, high). It distinguishes the provider-defined importance state or classification for the user calendar event.
* **Enables:** Filter User Calendar Events by the exact Microsoft 365-defined importance in `user_calendar_events.importance` and preserve unknown values as distinct categories.
* **Interpretation:** Microsoft 365 supplies importance from its own taxonomy on each user calendar event; preserve unknown and newly introduced labels.
Developer identifier: `user_calendar_events.isAllDay`
**Is All Day.** Whether this is an all-day event. It distinguishes the provider-defined is all day state or classification for the user calendar event.
* **Enables:** Filter User Calendar Events by whether this is an all-day event in `user_calendar_events.isAllDay`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports this is an all-day event as a boolean on each user calendar event; a missing field is unknown, not false.
Developer identifier: `user_calendar_events.isCancelled`
**Is Cancelled.** Whether the event is cancelled. It distinguishes the provider-defined is cancelled state or classification for the user calendar event.
* **Enables:** Filter User Calendar Events by whether the event is cancelled in `user_calendar_events.isCancelled`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the event is cancelled as a boolean on each user calendar event; a missing field is unknown, not false.
Developer identifier: `user_calendar_events.lastModifiedDateTime`
**Last Modified Date Time.** Last modification timestamp. It anchors the user calendar event on the provider's reported timeline.
* **Enables:** Order User Calendar Events by last modified date time in `user_calendar_events.lastModifiedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports last modified date time as a timestamp on each user calendar event; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `user_calendar_events.location`
**Location.** Event location. It preserves the nested context needed to interpret the parent user calendar event.
* **Enables:** Attribute location in `user_calendar_events.location` to the parent user calendar event; identify parent records where that nested location object is absent.
* **Interpretation:** Microsoft 365 reports location as a nested object on each user calendar event; optional children may be absent from a valid response. This nested location attribute does not establish where data is stored or processed and is not a residency signal.
Developer identifier: `user_calendar_events.location.displayName`
**Display Name.** Location display name. It distinguishes the provider-defined display name state or classification for the location.
* **Enables:** Label each location with display name from `user_calendar_events.Location.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each location; names are mutable and are not stable identities.
Developer identifier: `user_calendar_events.location.locationType`
**Location Type.** Location type. It supplies the provider-reported address or location facet for the location, not a residency determination.
* **Enables:** Group User Calendar Events by location type in `user_calendar_events.Location.locationType` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports location type as a user, device, request, or resource location attribute on each location; it does not establish where data is stored or processed.
Developer identifier: `user_calendar_events.organizer`
**Organizer.** Event organizer. It preserves the nested context needed to interpret the parent user calendar event.
* **Enables:** Attribute organizer in `user_calendar_events.organizer` to the parent user calendar event; identify parent records where that nested organizer object is absent.
* **Interpretation:** Microsoft 365 reports organizer as a nested object on each user calendar event; optional children may be absent from a valid response.
Developer identifier: `user_calendar_events.organizer.emailAddress`
**Email Address.** The structured email address details attached to each recipient in User Calendar Events. It preserves the nested context needed to interpret the parent user calendar event.
* **Enables:** Attribute email address in `user_calendar_events.Recipient.emailAddress` to the parent user calendar event; identify parent records where that nested email address object is absent.
* **Interpretation:** Microsoft 365 reports email address as a nested object on each recipient; optional children may be absent from a valid response.
Developer identifier: `user_calendar_events.sensitivity`
**Sensitivity.** Event sensitivity (normal, personal, private, confidential). It distinguishes the provider-defined sensitivity state or classification for the user calendar event.
* **Enables:** Filter User Calendar Events by the exact Microsoft 365-defined sensitivity in `user_calendar_events.sensitivity` and preserve unknown values as distinct categories.
* **Interpretation:** Microsoft 365 supplies sensitivity from its own taxonomy on each user calendar event; preserve unknown and newly introduced labels.
Developer identifier: `user_calendar_events.showAs`
**Show As.** Free/busy status (free, tentative, busy, oof, workingElsewhere, unknown). It distinguishes the provider-defined show as state or classification for the user calendar event.
* **Enables:** Filter User Calendar Events by the exact Microsoft 365-defined show as in `user_calendar_events.showAs` and preserve unknown values as distinct categories.
* **Interpretation:** Microsoft 365 supplies show as from its own taxonomy on each user calendar event; preserve unknown and newly introduced labels.
Developer identifier: `user_calendar_events.start`
**Start.** Event start date/time with timezone. It preserves the nested context needed to interpret the parent user calendar event.
* **Enables:** Attribute start in `user_calendar_events.start` to the parent user calendar event; identify parent records where that nested start object is absent.
* **Interpretation:** Microsoft 365 reports start as a nested object on each user calendar event; optional children may be absent from a valid response.
Developer identifier: `user_calendar_events.subject`
**Subject.** Event subject/title. It defines the content surface available for this user calendar event.
* **Enables:** Locate user calendar event records by subject in `user_calendar_events.subject`; attribute each text match to its parent user calendar event and, when present, its reported author.
* **Interpretation:** Microsoft 365 supplies subject as text on each user calendar event; referenced files or media are not implied unless explicitly represented.
Developer identifier: `users`
**Users.** Microsoft Entra ID users.
* **Enables:** Reconcile Microsoft Entra users to account status, directory identity, organization, licenses, job attributes, and synchronization state.
* **Scope:** Reads the records selected by Microsoft 365's `/v1.0/users` operation as a snapshot stream using full synchronization. Visibility is limited to the Microsoft Graph application permissions and tenant resources granted to the configured app. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `users.accountEnabled`
**Account Enabled.** Whether the user account is enabled. It distinguishes the provider-defined account enabled state or classification for the user.
* **Enables:** Filter Users by whether the user account is enabled in `users.accountEnabled`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the user account is enabled as a boolean on each user; a missing field is unknown, not false.
Developer identifier: `users.assignedLicenses`
**Assigned Licenses.** Licenses assigned to the user, including inherited (group-based) licenses. It preserves the nested context needed to interpret the parent user.
* **Enables:** Compare the exact Microsoft 365-configured assigned licenses set in `users.assignedLicenses` for each user; preserve provider labels and unknown entries.
* **Interpretation:** Microsoft 365 returns assigned licenses as an array of assigned license entries on each user; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `users.assignedLicenses.disabledPlans`
**Disabled Plans.** Unique identifiers (GUIDs) for the service plans disabled within this license assignment. It preserves the nested context needed to interpret the parent user.
* **Enables:** Connect the parent user to every referenced disabled plan value in `users.AssignedLicense.disabledPlans`; identify provider IDs that do not resolve to the expected related object.
* **Interpretation:** Microsoft 365 returns disabled plans as an array of disabled plan value entries on each assigned license; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `users.assignedLicenses.skuId`
**Sku ID.** Unique identifier (GUID) for the SKU of the assigned license. Kept as string (not Identity.UUID) to match this connector's ID-field convention and avoid quarantining records if Microsoft returns a non-canonical GUID form. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Match repeated assigned license entries on sku ID in `users.AssignedLicense.skuId`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Microsoft 365 reports sku ID as an identifier in its sku namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `users.city`
**City.** City of the user's address. It supplies the provider-reported address or location facet for the user, not a residency determination.
* **Enables:** Group Users by city in `users.city` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports city as a user, device, request, or resource location attribute on each user; it does not establish where data is stored or processed.
Developer identifier: `users.companyName`
**Company Name.** Company name associated with the user. It gives the user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each user with company name from `users.companyName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports company name as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.country`
**Country.** Country or region of the user's address. It supplies the provider-reported address or location facet for the user, not a residency determination.
* **Enables:** Group Users by country in `users.country` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports country as a user, device, request, or resource location attribute on each user; it does not establish where data is stored or processed.
Developer identifier: `users.createdDateTime`
**Created Date Time.** When the user account was created. It anchors the user on the provider's reported timeline.
* **Enables:** Order Users by created date time in `users.createdDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports created date time as a timestamp on each user; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `users.creationType`
**Creation Type.** How the user account was created (e.g. Invitation, LocalAccount). It distinguishes the provider-defined creation type state or classification for the user.
* **Enables:** Segment user entries in Users by creation type in `users.creationType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports creation type as a label from its own taxonomy on each user; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `users.deletedDateTime`
**Deleted Date Time.** When the user was soft-deleted, if in the deleted items. It anchors the user on the provider's reported timeline.
* **Enables:** Order Users by deleted date time in `users.deletedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports deleted date time as a timestamp on each user; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `users.department`
**Department.** Department the user belongs to. It identifies the related provider object that gives the user its parent, owner, or container context.
* **Enables:** Connect each user to the related department in `users.department` and verify that the referenced provider object resolves in the expected parent or container.
* **Interpretation:** Microsoft 365 reports department as relationship context on each user; resolve it in the named provider namespace rather than by display text alone.
Developer identifier: `users.displayName`
**Display Name.** Full display name of the user. It distinguishes the provider-defined display name state or classification for the user.
* **Enables:** Label each user with display name from `users.displayName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports display name as display text for each user; names are mutable and are not stable identities. A connector directive maps this field to a person's display name.
Developer identifier: `users.employeeId`
**Employee ID.** Employee identifier assigned by the organization. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Connect each user in Users to the referenced employee through `users.employeeId`; flag employee ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports employee ID as an identifier in its employee namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `users.employeeType`
**Employee Type.** Type of worker (e.g. Employee, Contractor, Vendor). It distinguishes the provider-defined employee type state or classification for the user.
* **Enables:** Segment user entries in Users by employee type in `users.employeeType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports employee type as a label from its own taxonomy on each user; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `users.givenName`
**Given Name.** First name of the user. It gives the user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each user with given name from `users.givenName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports given name as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.id`
**ID.** Unique identifier for the user in Entra ID. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Match repeated user entries on ID in `users.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its user namespace; it is not a universal identity outside Microsoft 365. The connector explicitly marks this field as a transform deduplication key. A connector directive maps this field to account identity.
Developer identifier: `users.identities`
**Identities.** Identities used to sign in to the account (local, social, or federated). It preserves the nested context needed to interpret the parent user.
* **Enables:** Reconcile each returned object identity in `users.identities` with the parent user's provider profile; preserve distinct aliases, contact points, and organization attributes.
* **Interpretation:** Microsoft 365 returns identities as an array of object identity entries on each user; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `users.identities.issuer`
**Issuer.** Issuer of the identity (e.g. the tenant domain or an external identity provider). It supplies the issuer profile facet used to reconcile or attribute the object identity.
* **Enables:** Match repeated object identity entries on issuer in `users.ObjectIdentity.issuer`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Microsoft 365 reports issuer on each object identity; missing and empty values can have different meanings.
Developer identifier: `users.identities.issuerAssignedId`
**Issuer Assigned ID.** Identifier assigned to the user by the issuer. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Match repeated object identity entries on issuer assigned ID in `users.ObjectIdentity.issuerAssignedId`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Microsoft 365 reports issuer assigned ID as an identifier in its issuer assigned namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `users.identities.signInType`
**Sign In Type.** Sign-in type of the identity (e.g. emailAddress, userName, federated). It distinguishes the provider-defined sign in type state or classification for the object identity.
* **Enables:** Segment object identity entries in Users by sign in type in `users.ObjectIdentity.signInType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports sign in type as a label from its own taxonomy on each object identity; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `users.jobTitle`
**Job Title.** User's job title. It supplies the job title profile facet used to reconcile or attribute the user.
* **Enables:** Label each user with job title from `users.jobTitle`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports job title as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.lastPasswordChangeDateTime`
**Last Password Change Date Time.** When the user last changed their password. It anchors the user on the provider's reported timeline.
* **Enables:** Order Users by last password change date time in `users.lastPasswordChangeDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports last password change date time as a timestamp on each user; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `users.mail`
**Mail.** SMTP email address of the user. It supplies the provider-reported address or location facet for the user, not a residency determination.
* **Enables:** Group Users by the exact mail in `users.mail` while keeping that address or location separate from geolocation and residency claims.
* **Interpretation:** Microsoft 365 reports mail as an address or location facet on each user; it does not establish verified geolocation or data residency. A connector directive maps this field to a person's email identity.
Developer identifier: `users.mailNickname`
**Mail Nickname.** Mail alias for the user. It supplies the mail nickname profile facet used to reconcile or attribute the user.
* **Enables:** Reconcile the user's mail nickname in `users.mailNickname` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Microsoft 365 reports mail nickname as a mutable profile or directory attribute on each user; it may be absent, shared, or non-unique.
Developer identifier: `users.memberOf`
**Member Of.** Groups and directory roles the user is a member of, expanded via $expand=memberOf($select=ID,deletedDateTime). It preserves the nested context needed to interpret the parent user.
* **Enables:** Match every returned directory object ref in `users.memberOf` to the parent user; use the element's provider identity or role to reconcile membership and attribution.
* **Interpretation:** Microsoft 365 returns member of as an array of directory object ref entries on each user; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `users.memberOf.deletedDateTime`
**Deleted Date Time.** When the directory object was soft-deleted, if applicable. It anchors the user on the provider's reported timeline.
* **Enables:** Order Users by deleted date time in `users.DirectoryObjectRef.deletedDateTime` and isolate records inside an exact provider reporting window.
* **Interpretation:** Microsoft 365 reports deleted date time as a timestamp on each directory object ref; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `users.memberOf.id`
**ID.** Unique identifier of the directory object. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Match repeated directory object ref entries on ID in `users.DirectoryObjectRef.id`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Microsoft 365 reports ID as an identifier in its directory object ref namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `users.officeLocation`
**Office Location.** Physical office location of the user. It supplies the provider-reported address or location facet for the user, not a residency determination.
* **Enables:** Group Users by office location in `users.officeLocation` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports office location as a user, device, request, or resource location attribute on each user; it does not establish where data is stored or processed.
Developer identifier: `users.onPremisesImmutableId`
**On Premises Immutable ID.** Immutable identifier associating an on-premises AD user with the Entra ID user. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Connect each user in Users to the referenced on premises immutable through `users.onPremisesImmutableId`; flag on premises immutable ID values that do not resolve in that provider namespace.
* **Interpretation:** Microsoft 365 reports on premises immutable ID as an identifier in its on premises immutable namespace; it is not a universal identity outside Microsoft 365.
Developer identifier: `users.onPremisesSamAccountName`
**On Premises Sam Account Name.** On-premises SAM account name synchronized from the on-premises directory. It locates the provider resource or path associated with the user.
* **Enables:** Label each user with on premises sam account name from `users.onPremisesSamAccountName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports on premises sam account name as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.onPremisesSyncEnabled`
**On Premises Sync Enabled.** Whether the user is synchronized from an on-premises directory. It distinguishes the provider-defined on premises sync enabled state or classification for the user.
* **Enables:** Filter Users by whether the user is synchronized from an on-premises directory in `users.onPremisesSyncEnabled`; count true, false, and missing results separately.
* **Interpretation:** Microsoft 365 reports the user is synchronized from an on-premises directory as a boolean on each user; a missing field is unknown, not false.
Developer identifier: `users.state`
**State.** State or province of the user's address. It supplies the provider-reported address or location facet for the user, not a residency determination.
* **Enables:** Group Users by state in `users.state` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports state as a user, device, request, or resource location attribute on each user; it does not establish where data is stored or processed.
Developer identifier: `users.surname`
**Surname.** Last name (family name) of the user. It supplies the surname profile facet used to reconcile or attribute the user.
* **Enables:** Reconcile the user's surname in `users.surname` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Microsoft 365 reports surname as a mutable profile or directory attribute on each user; it may be absent, shared, or non-unique.
Developer identifier: `users.usageLocation`
**Usage Location.** Two-letter country code used for license assignment compliance. It supplies the provider-reported address or location facet for the user, not a residency determination.
* **Enables:** Group Users by usage location in `users.usageLocation` without treating that user, device, or request attribute as a data-residency signal.
* **Interpretation:** Microsoft 365 reports usage location as a user, device, request, or resource location attribute on each user; it does not establish where data is stored or processed.
Developer identifier: `users.userPrincipalName`
**User Principal Name.** Sign-in name (typically email format) for the user. It gives the user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each user with user principal name from `users.userPrincipalName`; distinguish records that share that display name but have different Microsoft 365 identifiers.
* **Interpretation:** Microsoft 365 reports user principal name as display text for each user; names are mutable and are not stable identities.
Developer identifier: `users.userType`
**User Type.** Type of user: Member or Guest. It supplies the user type profile facet used to reconcile or attribute the user.
* **Enables:** Segment user entries in Users by user type in `users.userType`; compare counts only within the same Microsoft 365 taxonomy.
* **Interpretation:** Microsoft 365 reports user type as a label from its own taxonomy on each user; preserve unknown labels rather than mapping them by assumption.
| Error | Meaning | Solution |
| - | - | - |
| `AADSTS700016` | App not found | Verify Client ID and Tenant ID |
| `AADSTS7000215` | Invalid client secret | Regenerate client secret |
| `AADSTS65001` | Consent not granted | Grant admin consent for permissions |
| `403 Forbidden` | Missing permission | Add required API permission and grant consent |
#### Common Issues
#### "Insufficient privileges to complete the operation"
Ensure admin consent was granted for all required permissions. Check **API permissions** in the app registration.
**[Microsoft Graph API](https://docs.microsoft.com/en-us/graph/overview)** - Official Graph API documentation
**[App Registration](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app)** - Azure AD app registration guide
# Microsoft Entra ID
Source: https://docs.parable.work/plugins/provider-plugins/microsoftentra
Sync users and groups from Microsoft Entra ID (Azure AD)
Sync users and groups from Microsoft Entra ID (Azure AD).
Create an Azure AD app registration to connect Parable to Microsoft 365 using OAuth 2.0 client credentials. This enables secure, automated access without user sign-in.
## Data streams
This Provider Plugin defines 0 data streams.
| Stream | Description | Sync |
| - | - | - |
| — | No customer-selectable data streams are declared. | — |
### App registration
#### What You'll Need
| Credential | What it is |
| - | - |
| **Tenant ID** | Azure AD tenant identifier |
| **Client ID** | Application (client) ID |
| **Client Secret** | Generated client secret |
> **Info:** **Setup access in Azure.** These steps require **Administrator**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Azure administrator.
* **Global Administrator** or **Application Administrator** role in Azure AD
* Permission to grant admin consent for API permissions
#### Step 1: Access Azure Portal
1. Navigate to Azure Portal
2. Go to **Azure Active Directory** → **App registrations**
3. Click **New registration**
#### Step 2: Register Application
| Field | Value |
| - | - |
| Name | `Parable Integration` |
| Supported account types | Accounts in this organizational directory only |
| Redirect URI | Leave blank (not needed for client credentials) |
Click **Register**
#### Step 3: Note Application Details
From the **Overview** page, copy:
* **Application (client) ID**
* **Directory (tenant) ID**
#### Step 4: Create Client Secret
1. Go to **Certificates & secrets**
2. Click **New client secret**
3. Add description: `Parable Integration Secret`
4. Select expiration (recommend: 24 months)
5. Click **Add**
> **Warning:** Copy the secret **Value** immediately - it won't be shown again!
#### Step 5: Configure API Permissions
1. Go to **API permissions**
2. Click **Add a permission** → **Microsoft Graph**
3. Select **Application permissions**
4. Add these permissions:
| Permission | Purpose |
| - | - |
| `User.Read.All` | Read all user profiles |
| `Directory.Read.All` | Read directory data (also covers org metadata and channel list when present) |
| `Team.ReadBasic.All` | Read Microsoft Teams details |
| `Channel.ReadBasic.All` | List Teams channels (required if Directory.Read.All is not granted) |
| `ChannelMessage.Read.All` | Read Teams channel messages via the Teams export API |
| `ChannelMember.Read.All` | Read Teams channel membership |
| `AuditLog.Read.All` | Read sign-in and directory audit logs |
| `AuditLogsQuery.Read.All` | Read Microsoft Purview audit log queries |
| `Mail.Read` | Read mail (if needed) |
| `Calendars.Read` | Read calendars (if needed) |
> **Optional: Restrict mailbox access**
>
> By default, Microsoft Graph application permissions can cover every user in the
> directory. Use Microsoft's
> [mailbox access guidance](https://learn.microsoft.com/en-us/graph/auth-limit-mailbox-access)
> when your organization needs to restrict the app to an approved population.
> **Warning:** `ChannelMessage.Read.All` is a protected Teams export permission. Admin
> consent alone is not enough: Microsoft must also approve protected-API
> access for your app, and your tenant needs Teams message export
> eligibility. See Microsoft's
> [Export content with the Microsoft Teams export APIs](https://learn.microsoft.com/en-us/microsoftteams/export-teams-content)
> guide. Until that is in place, leave the Parable `channel_messages` tap
> disabled (it ships opt-in).
#### Step 6: Grant Admin Consent
1. Click **Grant admin consent for \[Your Org]**
2. Confirm the consent dialog
> **Info:** All permissions should show a green checkmark indicating consent was granted.
> Channel / message taps that ship disabled stay off until you enable them
> in Parable after consent and protected-API approval succeed.
#### Step 7: Enter values in the form
1. **Tenant ID**, **Client ID**, and **Client Secret**: Paste the Directory (tenant) ID, Application (client) ID, and client secret value.
2. Click **Save & test connection**.
### App registration
| Permission | Data Accessed |
| - | - |
| `User.Read.All` | User profiles, managers, photos |
| `Directory.Read.All` | Groups, org hierarchy, devices; sufficient for listing channels when granted |
| `Team.ReadBasic.All` | Microsoft Teams names, settings, and membership counts |
| `Channel.ReadBasic.All` | Channel list (standard / private / shared) when Directory.Read.All is not used |
| `ChannelMessage.Read.All` | Channel message content via Teams export APIs (protected API; Global cloud only - not US Gov L4/L5 or China 21Vianet) |
| `ChannelMember.Read.All` | Teams channel member lists |
| `AuditLog.Read.All` | Sign-in logs, directory audits |
| `AuditLogsQuery.Read.All` | Purview audit log records (SharePoint/OneDrive file operations) |
| `Mail.Read` | Email metadata and content |
| `Calendars.Read` | Calendar events and availability |
> **Info:** Channel message export covers public and private channels. Shared-channel
> coverage follows Microsoft Graph's getAllMessages behavior and may omit
> some shared-channel traffic. 1:1 and group chats are not included in this
> Provider version.
> **Tip:** **Rate Limits:** Microsoft Graph enforces rate limits of **10,000 requests per 10 minutes per app; throttling returns 429 with Retry-After header**.
>
> Parable handles rate limiting automatically with exponential backoff, but initial syncs of large datasets may take longer due to these limits.
This Provider Plugin does not declare any data streams.
| Error | Meaning | Solution |
| - | - | - |
| `AADSTS700016` | App not found | Verify Client ID and Tenant ID |
| `AADSTS7000215` | Invalid client secret | Regenerate client secret |
| `AADSTS65001` | Consent not granted | Grant admin consent for permissions |
| `403 Forbidden` | Missing permission | Add required API permission and grant consent |
#### Common Issues
#### "Insufficient privileges to complete the operation"
Ensure admin consent was granted for all required permissions. Check **API permissions** in the app registration.
**[Microsoft Graph API](https://docs.microsoft.com/en-us/graph/overview)** - Official Graph API documentation
**[App Registration](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app)** - Azure AD app registration guide
# Miro REST API
Source: https://docs.parable.work/plugins/provider-plugins/miro
Miro is a collaborative online whiteboard platform that enables teams to work together on visual projects including brainstorming, planning, design, and agile workflows. The REST API v2 provides access to boards, board items (sticky notes, shapes, cards, text, images, etc.), connectors, tags, board members, groups, and enterprise features like organization members, teams, and audit logs.
Miro is a collaborative online whiteboard platform that enables teams to work together on visual projects including brainstorming, planning, design, and agile workflows. The REST API v2 provides access to boards, board items (sticky notes, shapes, cards, text, images, etc.), connectors, tags, board members, groups, and enterprise features like organization members, teams, and audit logs.
Connect Parable to Miro using a non-expiring access token. Parable ingests boards, all board items (sticky notes, shapes, cards, frames, and more), board members, tags, groups, connectors, and -- on Enterprise plans -- organization members, teams, and audit logs.
#### Board data
Boards, items, members, tags, groups, and connectors
#### Activity & admin
Audit logs and organization/team membership (Enterprise)
## Data streams
This Provider Plugin defines 10 data streams.
| Stream | Description | Sync |
| - | - | - |
| `boards` | Extracts all boards accessible to the authenticated user from Miro. Boards are the central resource in Miro, containing items, members, and collaboration data. | full |
| `board_items` | Extracts all items (widgets) from a specific Miro board. Items include sticky notes, shapes, text, cards, images, documents, frames, embeds, app cards, and more. Requires board\_id from parent boards tap. | full |
| `board_members` | Extracts all members of a specific Miro board, including their roles and permissions. Requires board\_id from parent boards tap. | full |
| `board_tags` | Extracts all tags defined on a specific Miro board. Tags are used to categorize and label items. Requires board\_id from parent boards tap. | full |
| `board_connectors` | Extracts all connectors (lines/arrows connecting items) from a specific Miro board. Requires board\_id from parent boards tap. | full |
| `board_groups` | Extracts all groups from a specific Miro board. Groups are collections of items that are logically grouped together. Requires board\_id from parent boards tap. | full |
| `audit_logs` | Extracts audit log events from Miro (Enterprise plan only). Provides who-did-what-when activity data for compliance and monitoring. Requires auditlogs:read scope and an Enterprise plan. Supports incremental sync via createdAfter parameter. | incremental |
| `organization_members` | Extracts all members of a Miro organization (Enterprise plan only). Requires org\_id ingestion config field. Provides user records with roles and activity data. | full |
| `organization_teams` | Extracts all teams within a Miro organization (Enterprise plan only). Requires org\_id ingestion config field. | full |
| `team_members` | Extracts all members of a specific team within a Miro organization (Enterprise plan only). Requires org\_id ingestion config field and team\_id from parent organization\_teams tap. | full |
### Miro
#### What You'll Need
| Credential | What it is |
| - | - |
| **Access Token** | Non-expiring token from your Miro Developer Portal app |
| **Organization ID** | Numeric org ID from Company Settings (Enterprise only) |
> **Info:** **Dedicated app required.** Create a Miro app specifically for Parable in the Developer Portal. The non-expiring token option must be selected at app creation time -- it cannot be changed later.
* A **Miro account** on any paid plan (Starter, Business, or Enterprise).
* Enterprise-gated taps (`audit_logs`, `organization_members`, `organization_teams`, `team_members`) additionally require an **Enterprise plan** and your **organization ID**.
#### Step 1: Open the Miro Developer Portal
1. Sign in to Miro.
2. Go to [miro.com/app/settings/user-profile/apps](https://miro.com/app/settings/user-profile/apps).
3. Click **Create new app**.
#### Step 2: Configure the app
1. Enter an app name such as `Parable Platform`.
2. Select your workspace team.
3. Under **Token expiration**, select **Non-expiring** (this option cannot be changed after creation).
4. Click **Create app**.
#### Step 3: Set app permissions (scopes)
In your app settings, enable the following permissions:
| Scope | Purpose |
| - | - |
| `boards:read` | Read all board data (required) |
| `identity:read` | Token validation |
| `team:read` | Team information |
| `auditlogs:read` | Audit logs -- Enterprise only |
| `organizations:read` | Organization members -- Enterprise only |
| `organizations:teams:read` | Organization teams -- Enterprise only |
Click **Save** after selecting permissions.
#### Step 4: Copy the access token
1. In your app settings, scroll to the **App credentials** section.
2. Copy the **Access token**.
> **Warning:** **Copy your now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
#### Step 5: Find your Organization ID (Enterprise)
Required for Enterprise-gated taps: `audit_logs`, `organization_members`, `organization_teams`, and `team_members`. Skip this step if you are not on an Enterprise plan.
1. Sign in to Miro as a company admin.
2. Open **Settings** (profile menu) **> Company Settings > Security > Audit log**.
3. On the Audit log page, copy your **Organization ID** (a numeric value, typically 10-25 digits).
4. Keep this value for the Parable Provider form.
> **Info:** Without a valid Organization ID, Enterprise taps are skipped during sync. Board-level taps still run.
#### Step 6: Connect in Parable
1. In Parable, open **Platform → Providers** and choose the Provider to add.
2. Select **Miro**.
3. Paste your access token into the **Token** field.
4. (Enterprise) Paste your **Organization ID** from the previous step.
5. Click **Save & verify**.
### Miro
| Scope | Taps enabled | Required |
| - | - | - |
| `boards:read` | `boards`, `board_items`, `board_members`, `board_tags`, `board_connectors`, `board_groups` | Yes |
| `identity:read` | Token validation probe | Yes |
| `team:read` | Team metadata on boards | Recommended |
| `auditlogs:read` | `audit_logs` | Enterprise only |
| `organizations:read` | `organization_members` | Enterprise only |
| `organizations:teams:read` | `organization_teams`, `team_members` | Enterprise only |
Taps that require scopes not granted will be skipped during ingestion without failing the sync.
Developer identifier: `audit_logs`
Audit Logs contain audit log events from Miro (Enterprise plan only). Provides who-did-what-when activity data for compliance and monitoring. Requires auditlogs:read scope and an Enterprise plan. Supports incremental sync via `createdAfter` parameter.
* **Enables:** trace recorded Enterprise organization actions to their actors and event times.
* **Scope:** Reads provider changes through `GET /{apiVersion}/audit/logs` using the declared incremental request boundary. The operation is Enterprise-only and is limited to the configured organization and token scopes.
Developer identifier: `audit_logs.category`
Category states event category grouping from Miro (e.g., `boards_and_templates`, authentication). It preserves the provider's current classification of this record.
* **Enables:** separate audit log records by the exact provider-reported category value when describing their recorded state.
* **Interpretation:** The provider supplies `category` per audit log event record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, category is the work record's classification, not an individual-performance measure.
Developer identifier: `audit_logs.context`
Context records context information about where and how the event occurred. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested context object into its declared child fields for each audit log event record.
* **Interpretation:** The provider returns `context` as a nested object or reference on `AuditLogEvent`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `audit_logs.context.board`
Board captures the board related to the event. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each audit context record with the specific provider container named by board.
* **Interpretation:** The provider returns `board` as a nested object or reference on `AuditContext`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `audit_logs.context.board.id`
ID is the unique identifier of the context entity. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit log records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `AuditContextEntity`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_logs.context.board.name`
Name records display name of the context entity. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each audit context entity record.
* **Interpretation:** The provider supplies `name` at audit context entity granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_logs.context.board.type`
Type states type of the context entity. It preserves the provider's current classification of this record.
* **Enables:** separate audit log records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per audit context entity record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `audit_logs.context.ip`
IP records IP address from which the action was performed. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** segment audit log records by the recorded IP without inferring a person's physical presence.
* **Interpretation:** The provider supplies `ip` as location or localization context per audit context record; it does not establish a person's real-time physical location.
Developer identifier: `audit_logs.context.organization`
Organization captures the organization in which the event occurred. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each audit context record with the specific provider container named by organization.
* **Interpretation:** The provider returns `organization` as a nested object or reference on `AuditContext`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `audit_logs.context.project`
Project captures the project related to the event. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each audit context record with the specific provider container named by project.
* **Interpretation:** The provider returns `project` as a nested object or reference on `AuditContext`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `audit_logs.context.team`
Team captures the team in which the event occurred. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each audit context record with the specific provider container named by team.
* **Interpretation:** The provider returns `team` as a nested object or reference on `AuditContext`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `audit_logs.createdAt`
Created At records ISO 8601 timestamp when the event occurred. It anchors the named event or boundary on the record's timeline.
* **Enables:** place audit log records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per audit log event record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `audit_logs.createdBy`
Created By captures the user or automation that performed the action. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the audit log event record to the provider-reported person or account represented by created by.
* **Interpretation:** The provider supplies `createdBy` as identity or attribution context on each audit log event record. In Miro, created by is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `audit_logs.createdBy.email`
Email records email address of the creator when type is user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the audit created by record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each audit created by record. In Miro, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `audit_logs.createdBy.id`
ID is the unique identifier of the creator. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit log records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `AuditCreatedBy`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_logs.createdBy.name`
Name records display name of the creator. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the audit created by record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each audit created by record. In Miro, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `audit_logs.createdBy.type`
Type states type of the creator (user, application, `scim_provisioner`, `miro_automation`). It preserves the provider's current classification of this record.
* **Enables:** separate audit log records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per audit created by record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `audit_logs.details`
Details records event-specific detail object. Shape varies by event type (e.g., `board_opened`, `sign_in_succeeded`). Branch on the parent event field. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret details according to the provider and Workspace configuration that produced each audit log record.
* **Interpretation:** Keys and value shapes within `details` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Provider-defined fields may also be returned for this field.
Developer identifier: `audit_logs.event`
Event states type/name of the audit event. It preserves the provider's current classification of this record.
* **Enables:** separate audit log records by the exact provider-reported event value when describing their recorded state.
* **Interpretation:** The provider supplies `event` per audit log event record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, event is the work record's classification, not an individual-performance measure.
Developer identifier: `audit_logs.id`
ID is the unique identifier of the audit event. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same audit log event source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per audit log event record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `audit_logs.object`
Object captures the object that was acted upon. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested object object into its declared child fields for each audit log event record.
* **Interpretation:** The provider returns `object` as a nested object or reference on `AuditLogEvent`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `audit_logs.object.email`
Email records email address of the object, if the object is a user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the audit object record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each audit object record. In Miro, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `audit_logs.object.id`
ID is the unique identifier of the object. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit log records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `AuditObject`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_logs.object.name`
Name records display name or title of the object. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each audit object record.
* **Interpretation:** The provider supplies `name` at audit object granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_logs.object.type`
Type states type of the object. It preserves the provider's current classification of this record.
* **Enables:** separate audit log records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per audit object record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `audit_logs.type`
Type states type of the resource, typically 'event'. It preserves the provider's current classification of this record.
* **Enables:** separate audit log records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per audit log event record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `board_connectors`
Board Connectors contain all connectors (lines/arrows connecting items) from a specific Miro board. Requires `board_id` from parent boards tap.
* **Enables:** reconstruct the lines and arrows that connect items on a board.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/boards/{board_id}/connectors` as a full snapshot. Results contain only boards and child records visible to the configured token.
Developer identifier: `board_connectors.board_id`
Board ID identifies parent id injected by the ingestor from the boards to `board_connectors` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board connector records to provider records that carry the same board ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `board_id` as a record-level identifier on `BoardConnector`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `board_connectors.captions`
Captions records text captions displayed on the connector. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact captions value attached to each board connector record.
* **Interpretation:** The provider supplies `captions` at board connector granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `board_connectors.captions.content`
Content captures the text content of the caption. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact content value attached to each connector caption record.
* **Interpretation:** The provider supplies `content` at connector caption granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `board_connectors.captions.position`
Position records position of the caption along the connector (0.0 to 1.0). It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** place the represented design or board object using its provider canvas position.
* **Interpretation:** The provider supplies `position` in its canvas coordinate system for this object; it is not a geographic coordinate.
Developer identifier: `board_connectors.captions.textAlignVertical`
Text Align Vertical records vertical text alignment of the caption. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied text align vertical for the represented design or board object.
* **Interpretation:** The provider supplies `textAlignVertical` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_connectors.createdAt`
Created At records ISO 8601 timestamp when the connector was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place board connector records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per board connector record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `board_connectors.createdBy`
Created By records user who created the connector. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the board connector record to the provider-reported person or account represented by created by.
* **Interpretation:** The provider supplies `createdBy` as identity or attribution context on each board connector record. In Miro, created by is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `board_connectors.createdBy.id`
ID is the unique identifier of the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board connector records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `UserReference`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `board_connectors.createdBy.type`
Type states resource type, typically 'user'. It preserves the provider's current classification of this record.
* **Enables:** separate board connector records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per user reference record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `board_connectors.endItem`
End Item records end item reference for the connector. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested end item records contained by each board connector record.
* **Interpretation:** The provider returns `endItem` as a nested object or reference on `BoardConnector`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `board_connectors.endItem.id`
ID is the unique identifier of the connected item. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board connector records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ConnectorEndpoint`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `board_connectors.endItem.position`
Position groups the relative X and Y coordinates where the connector attaches to an item. It preserves the endpoint placement needed to reconstruct the connector.
* **Enables:** reproduce connector attachment points and compare endpoint placement on board items.
* **Interpretation:** The provider returns `position` as a nested coordinate object with each axis expressed as a 0-to-1 relative value, not an ordinal rank.
Developer identifier: `board_connectors.endItem.position.x`
X Coordinate records relative X position (0.0 = left, 1.0 = right). It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** place the represented design or board object using its provider canvas x coordinate.
* **Interpretation:** The provider supplies `x` in its canvas coordinate system for this object; it is not a geographic coordinate.
Developer identifier: `board_connectors.endItem.position.y`
Y Coordinate records relative Y position (0.0 = top, 1.0 = bottom). It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** place the represented design or board object using its provider canvas y coordinate.
* **Interpretation:** The provider supplies `y` in its canvas coordinate system for this object; it is not a geographic coordinate.
Developer identifier: `board_connectors.endItem.snapTo`
Snap To records snap-to point on the item. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied snap to for the represented design or board object.
* **Interpretation:** The provider supplies `snapTo` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_connectors.id`
ID is the unique identifier of the connector. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same board connector source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per board connector record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `board_connectors.isSupported`
Is Supported indicates whether the connector is supported in the current context. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select board connector records for which the provider reports is supported as true or false.
* **Interpretation:** The provider supplies `isSupported` as a boolean per board connector record; false and missing are distinct when the field is optional. In Miro, is supported is a condition on the work record, not an individual-performance measure.
Developer identifier: `board_connectors.links`
Links groups the provider URLs for the board connector resource. It preserves the exact resource reference returned with the connector.
* **Enables:** open the connector resource without treating the link object as an integration or inline connector snapshot.
* **Interpretation:** The provider returns `links` as a nested `ConnectorLinks` object; each value is a resource locator whose availability still follows provider permissions.
Developer identifier: `board_connectors.links.self`
Self records URL to the connector resource itself. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a connector link record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each connector link record. Availability still follows the provider's permissions and retention.
Developer identifier: `board_connectors.modifiedAt`
Modified At records ISO 8601 timestamp when the connector was last modified. It anchors the named event or boundary on the record's timeline.
* **Enables:** place board connector records on a timeline by modified at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `modifiedAt` per board connector record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `board_connectors.modifiedBy`
Modified By records user who last modified the connector. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the board connector record to the provider-reported person or account represented by modified by.
* **Interpretation:** The provider supplies `modifiedBy` as identity or attribution context on each board connector record. In Miro, modified by is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `board_connectors.shape`
Shape records shape/type of the connector line (straight, elbowed, curved). It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied shape for the represented design or board object.
* **Interpretation:** The provider supplies `shape` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_connectors.startItem`
Start Item records start item reference for the connector. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested start item records contained by each board connector record.
* **Interpretation:** The provider returns `startItem` as a nested object or reference on `BoardConnector`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `board_connectors.style`
Style records visual style of the connector (color, stroke, etc.). It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied style for the represented design or board object.
* **Interpretation:** The provider supplies `style` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_connectors.style.color`
Color records hex color code of the connector line. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied color for the represented design or board object.
* **Interpretation:** The provider supplies `color` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_connectors.style.endStrokeCap`
End Stroke Cap records stroke cap style at the end of the connector. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied end stroke cap for the represented design or board object.
* **Interpretation:** The provider supplies `endStrokeCap` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_connectors.style.fontSize`
Font Size records font size for connector captions. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied font size for the represented design or board object.
* **Interpretation:** The provider supplies `fontSize` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_connectors.style.startStrokeCap`
Start Stroke Cap records stroke cap style at the start of the connector. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied start stroke cap for the represented design or board object.
* **Interpretation:** The provider supplies `startStrokeCap` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_connectors.style.strokeColor`
Stroke Color records stroke color of the connector line. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied stroke color for the represented design or board object.
* **Interpretation:** The provider supplies `strokeColor` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_connectors.style.strokeStyle`
Stroke Style records stroke style of the connector line. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied stroke style for the represented design or board object.
* **Interpretation:** The provider supplies `strokeStyle` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_connectors.style.strokeWidth`
Stroke Width records width of the connector stroke. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied stroke width for the represented design or board object.
* **Interpretation:** The provider supplies `strokeWidth` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_connectors.style.textOrientation`
Text Orientation records orientation of text on the connector. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied text orientation for the represented design or board object.
* **Interpretation:** The provider supplies `textOrientation` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_connectors.type`
Type states resource type, typically 'connector'. It preserves the provider's current classification of this record.
* **Enables:** separate board connector records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per board connector record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `board_groups`
Board Groups contain all groups from a specific Miro board. Groups are collections of items that are logically grouped together. Requires `board_id` from parent boards tap.
* **Enables:** reconstruct the logical item groupings returned for a board.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/boards/{board_id}/groups` as a full snapshot. Results contain only boards and child records visible to the configured token.
Developer identifier: `board_groups.board_id`
Board ID identifies parent id injected by the ingestor from the boards to `board_groups` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board group records to provider records that carry the same board ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `board_id` as a record-level identifier on `BoardGroup`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `board_groups.data`
Data records group payload containing the IDs of the board items in the group. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret data according to the provider and Workspace configuration that produced each board group record.
* **Interpretation:** Keys and value shapes within `data` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `board_groups.data.items`
Items records IDs of the board items contained in the group. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested items records contained by each board group data record.
* **Interpretation:** The provider returns `items` as a list on `BoardGroupData`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `board_groups.id`
ID is the unique identifier of the group. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same board group source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per board group record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `board_groups.type`
Type states type of the resource. For groups this is typically 'group'. It preserves the provider's current classification of this record.
* **Enables:** separate board group records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per board group record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `board_items`
Board Items contain all items (widgets) from a specific Miro board. Items include sticky notes, shapes, text, cards, images, documents, frames, embeds, app cards, and more. Requires `board_id` from parent boards tap.
* **Enables:** inspect the exact sticky notes, shapes, cards, text, images, documents, frames, embeds, and app cards returned for each board.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/boards/{board_id}/items` as a full snapshot. Results contain only boards and child records visible to the configured token.
Developer identifier: `board_items.board_id`
Board ID identifies parent id injected by the ingestor from the boards to `board_items` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board item records to provider records that carry the same board ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `board_id` as a record-level identifier on `BoardItem`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `board_items.createdAt`
Created At records ISO 8601 timestamp when the item was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place board item records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per board item record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `board_items.createdBy`
Created By records user who created the item. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the board item record to the provider-reported person or account represented by created by.
* **Interpretation:** The provider supplies `createdBy` as identity or attribution context on each board item record. In Miro, created by is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `board_items.createdBy.id`
ID is the unique identifier of the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board item records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `UserReference`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `board_items.createdBy.name`
Name records display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user reference record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each user reference record. In Miro, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `board_items.createdBy.type`
Type states type of the reference, typically 'user'. It preserves the provider's current classification of this record.
* **Enables:** separate board item records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per user reference record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `board_items.data`
Data records item-specific data content such as text, title, description, URL, and other type-dependent fields. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret data according to the provider and Workspace configuration that produced each board item record.
* **Interpretation:** Keys and value shapes within `data` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `board_items.data.assigneeId`
Assignee ID identifies user ID of the assignee for card items. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board item records to provider records that carry the same assignee ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `assigneeId` as a record-level identifier on `ItemData`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `board_items.data.content`
Content records text or HTML content of the item (sticky notes, shapes, text items). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact content value attached to each item data record.
* **Interpretation:** The provider supplies `content` at item data granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `board_items.data.description`
Description records description of the item (cards, app cards). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each item data record.
* **Interpretation:** The provider supplies `description` at item data granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `board_items.data.dueDate`
Due Date records due date for card items in ISO 8601 format. It anchors the named event or boundary on the record's timeline.
* **Enables:** place board item records on a timeline by due date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `dueDate` per item data record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `board_items.data.fields`
Fields records custom fields for app card items. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret fields according to the provider and Workspace configuration that produced each board item record.
* **Interpretation:** Keys and value shapes within `fields` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `board_items.data.fields.fillColor`
Fill Color records background fill color of the field in hex format. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied fill color for the represented design or board object.
* **Interpretation:** The provider supplies `fillColor` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.data.fields.iconShape`
Icon Shape records shape of the icon in the field. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by icon shape on a app card field record.
* **Interpretation:** The provider supplies `iconShape` as a URL or resource locator on each app card field record. Availability still follows the provider's permissions and retention.
Developer identifier: `board_items.data.fields.iconUrl`
Icon URL records URL of the icon displayed in the field. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by icon URL on a app card field record.
* **Interpretation:** The provider supplies `iconUrl` as a URL or resource locator on each app card field record. Availability still follows the provider's permissions and retention.
Developer identifier: `board_items.data.fields.textColor`
Text Color records text color of the field in hex format. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied text color for the represented design or board object.
* **Interpretation:** The provider supplies `textColor` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.data.fields.tooltip`
Tooltip records tooltip text for the field. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact tooltip value attached to each app card field record.
* **Interpretation:** The provider supplies `tooltip` at app card field granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `board_items.data.fields.value`
Value records display value of the field. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded value with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `value` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `board_items.data.format`
Format records format type for frame items. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact format when validating the configuration or technical definition of a item data record.
* **Interpretation:** The provider supplies `format` as configuration or technical metadata on `ItemData`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `board_items.data.imageUrl`
Image URL records URL of the image resource for image items. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by image URL on a item data record.
* **Interpretation:** The provider supplies `imageUrl` as a URL or resource locator on each item data record. Availability still follows the provider's permissions and retention.
Developer identifier: `board_items.data.mode`
Mode states display mode for embed items. It preserves the provider's current classification of this record.
* **Enables:** separate board item records by the exact provider-reported mode value when describing their recorded state.
* **Interpretation:** The provider supplies `mode` per item data record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, mode is the work record's classification, not an individual-performance measure.
Developer identifier: `board_items.data.previewUrl`
Preview URL records preview URL for embed items. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by preview URL on a item data record.
* **Interpretation:** The provider supplies `previewUrl` as a URL or resource locator on each item data record. Availability still follows the provider's permissions and retention.
Developer identifier: `board_items.data.shape`
Shape records shape type for shape items (rectangle, circle, triangle, etc.). It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied shape for the represented design or board object.
* **Interpretation:** The provider supplies `shape` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.data.showContent`
Show Content indicates whether to show content inside a frame. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select board item records for which the provider reports show content as true or false.
* **Interpretation:** The provider supplies `showContent` as a boolean per item data record; false and missing are distinct when the field is optional. In Miro, show content is a condition on the work record, not an individual-performance measure.
Developer identifier: `board_items.data.status`
Status states status of an app card item. It preserves the provider's current classification of this record.
* **Enables:** separate board item records by the exact provider-reported status value when describing their recorded state.
* **Interpretation:** The provider supplies `status` per item data record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, status is the work record's classification, not an individual-performance measure.
Developer identifier: `board_items.data.title`
Title records title of the item (cards, app cards, images, documents, frames). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact title value attached to each item data record.
* **Interpretation:** The provider supplies `title` at item data granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `board_items.data.type`
Type states sub-type qualifier within the data object. It preserves the provider's current classification of this record.
* **Enables:** separate board item records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per item data record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `board_items.data.url`
URL records URL associated with the item (images, documents, embeds). It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a item data record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each item data record. Availability still follows the provider's permissions and retention.
Developer identifier: `board_items.geometry`
Geometry groups the board item's width, height, and rotation. It preserves the dimensions and orientation needed to reconstruct the item on the canvas.
* **Enables:** compare item footprints and reproduce board layout using the declared dimension units.
* **Interpretation:** The provider returns `geometry` as a nested object: width and height are in density-independent pixels, while rotation is in degrees.
Developer identifier: `board_items.geometry.height`
Height reports the board item's vertical dimension in density-independent pixels (`dp`). It preserves the provider's canvas sizing unit.
* **Enables:** compare item footprints and reproduce vertical sizing on the board.
* **Interpretation:** The provider supplies `height` as a numeric `dp` value per geometry object; zero and missing are not interchangeable.
Developer identifier: `board_items.geometry.rotation`
Rotation reports the board item's orientation in degrees from 0 through 360. It preserves the provider's angular canvas setting.
* **Enables:** reproduce item orientation and identify rotated content in board layouts.
* **Interpretation:** The provider supplies `rotation` as a numeric degree value per geometry object; zero means no rotation and missing means no angle was reported.
Developer identifier: `board_items.geometry.width`
Width reports the board item's horizontal dimension in density-independent pixels (`dp`). It preserves the provider's canvas sizing unit.
* **Enables:** compare item footprints and reproduce horizontal sizing on the board.
* **Interpretation:** The provider supplies `width` as a numeric `dp` value per geometry object; zero and missing are not interchangeable.
Developer identifier: `board_items.id`
ID is the unique identifier of the item. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same board item source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per board item record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `board_items.isSupported`
Is Supported indicates whether the item type is fully supported by the API. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select board item records for which the provider reports is supported as true or false.
* **Interpretation:** The provider supplies `isSupported` as a boolean per board item record; false and missing are distinct when the field is optional. In Miro, is supported is a condition on the work record, not an individual-performance measure.
Developer identifier: `board_items.links`
Links groups the provider URLs for the board item and related resources. It preserves resource references returned with the item.
* **Enables:** open the exact item or follow its related-resource link without treating linked resources as inline snapshots.
* **Interpretation:** The provider returns `links` as a nested `ItemLinks` object; each value is a resource locator whose availability still follows provider permissions.
Developer identifier: `board_items.links.related`
Related records URL to related resources. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by related on a item link record.
* **Interpretation:** The provider supplies `related` as a URL or resource locator on each item link record. Availability still follows the provider's permissions and retention.
Developer identifier: `board_items.links.self`
Self records URL to the item resource itself. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a item link record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each item link record. Availability still follows the provider's permissions and retention.
Developer identifier: `board_items.modifiedAt`
Modified At records ISO 8601 timestamp when the item was last modified. It anchors the named event or boundary on the record's timeline.
* **Enables:** place board item records on a timeline by modified at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `modifiedAt` per board item record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `board_items.modifiedBy`
Modified By records user who last modified the item. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the board item record to the provider-reported person or account represented by modified by.
* **Interpretation:** The provider supplies `modifiedBy` as identity or attribution context on each board item record. In Miro, modified by is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `board_items.parent`
Parent records parent item reference, e.g. a frame that contains this item. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by parent on each board item record.
* **Interpretation:** The provider returns `parent` as a nested object or reference on `BoardItem`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `board_items.parent.id`
ID is the unique identifier of the parent item. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board item records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ParentReference`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `board_items.parent.links`
Links groups the provider URLs that identify the parent item resource. It preserves the resource reference carried by the parent relationship.
* **Enables:** open the exact parent item while keeping the parent reference distinct from an inline item snapshot.
* **Interpretation:** The provider returns `links` as a nested `ItemLinks` object; each value is a resource locator whose availability still follows provider permissions.
Developer identifier: `board_items.position`
Position records position of the item on the board (x, y coordinates and optional origin). It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** place the represented design or board object using its provider canvas position.
* **Interpretation:** The provider supplies `position` in its canvas coordinate system for this object; it is not a geographic coordinate.
Developer identifier: `board_items.position.origin`
Origin captures the origin point for the position coordinates (e.g., center). It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** place the represented design or board object using its provider canvas origin.
* **Interpretation:** The provider supplies `origin` in its canvas coordinate system for this object; it is not a geographic coordinate.
Developer identifier: `board_items.position.relativeTo`
Relative To reports indicates what the position is relative to (`canvas_center`, `parent_top_left`). It preserves the stated measure at this record's granularity.
* **Enables:** order or classify board item records using the provider-defined relative to value.
* **Interpretation:** The provider supplies `relativeTo` at position granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `board_items.position.x`
X Coordinate records x-axis coordinate of the item in dp. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** place the represented design or board object using its provider canvas x coordinate.
* **Interpretation:** The provider supplies `x` in its canvas coordinate system for this object; it is not a geographic coordinate.
Developer identifier: `board_items.position.y`
Y Coordinate records y-axis coordinate of the item in dp. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** place the represented design or board object using its provider canvas y coordinate.
* **Interpretation:** The provider supplies `y` in its canvas coordinate system for this object; it is not a geographic coordinate.
Developer identifier: `board_items.style`
Style records visual style properties of the item (colors, fonts, borders, etc.). It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied style for the represented design or board object.
* **Interpretation:** The provider supplies `style` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.style.borderColor`
Border Color records border color in hex format. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied border color for the represented design or board object.
* **Interpretation:** The provider supplies `borderColor` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.style.borderOpacity`
Border Opacity records border opacity as a string value. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied border opacity for the represented design or board object.
* **Interpretation:** The provider supplies `borderOpacity` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.style.borderStyle`
Border Style records border style (normal, dashed, dotted). It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied border style for the represented design or board object.
* **Interpretation:** The provider supplies `borderStyle` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.style.borderWidth`
Border Width records border width as a string value. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied border width for the represented design or board object.
* **Interpretation:** The provider supplies `borderWidth` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.style.cardTheme`
Card Theme records theme color for card items in hex format. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied card theme for the represented design or board object.
* **Interpretation:** The provider supplies `cardTheme` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.style.color`
Color records text or foreground color in hex format. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied color for the represented design or board object.
* **Interpretation:** The provider supplies `color` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.style.fillColor`
Fill Color records background fill color in hex format. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied fill color for the represented design or board object.
* **Interpretation:** The provider supplies `fillColor` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.style.fillOpacity`
Fill Opacity records fill opacity as a string value. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied fill opacity for the represented design or board object.
* **Interpretation:** The provider supplies `fillOpacity` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.style.fontFamily`
Font Family records font family used for text rendering. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied font family for the represented design or board object.
* **Interpretation:** The provider supplies `fontFamily` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.style.fontSize`
Font Size records font size in points as a string. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied font size for the represented design or board object.
* **Interpretation:** The provider supplies `fontSize` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.style.stickyNoteShape`
Sticky Note Shape records shape of the sticky note (square, rectangle). It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied sticky note shape for the represented design or board object.
* **Interpretation:** The provider supplies `stickyNoteShape` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.style.textAlign`
Text Align records horizontal text alignment. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied text align for the represented design or board object.
* **Interpretation:** The provider supplies `textAlign` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.style.textAlignVertical`
Text Align Vertical records vertical text alignment. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied text align vertical for the represented design or board object.
* **Interpretation:** The provider supplies `textAlignVertical` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_items.type`
Type states type of the item on the board. It preserves the provider's current classification of this record.
* **Enables:** separate board item records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per board item record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `board_members`
Board Members contain all members of a specific Miro board, including their roles and permissions. Requires `board_id` from parent boards tap.
* **Enables:** describe board membership and provider-reported roles as collaboration context.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/boards/{board_id}/members` as a full snapshot. Results contain only boards and child records visible to the configured token.
Developer identifier: `board_members.board_id`
Board ID identifies parent id injected by the ingestor from the boards to `board_members` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board member records to provider records that carry the same board ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `board_id` as a record-level identifier on `BoardMember`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `board_members.id`
**ID.** Miro's identifier for the user who is a member of the board.
* **Enables:** Connect each board membership to the member's Miro account through `board_members.id`.
* **Interpretation:** Miro reports this value in its user namespace. The same value repeats once for every board the member belongs to, so it does not identify a row on its own. A connector directive maps this field to account identity.
Developer identifier: `board_members.links`
Links groups the provider URLs for the board-member resource and related profile. It preserves resource references returned with the membership.
* **Enables:** open the exact board-member resource or follow its related profile without treating either link as an inline user snapshot.
* **Interpretation:** The provider returns `links` as a nested `BoardMemberLinks` object; each value is a resource locator whose availability still follows provider permissions.
Developer identifier: `board_members.links.related`
Related records URL to a related resource, such as the user profile. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by related on a board member link record.
* **Interpretation:** The provider supplies `related` as a URL or resource locator on each board member link record. Availability still follows the provider's permissions and retention.
Developer identifier: `board_members.links.self`
Self records URL to the board member resource itself. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a board member link record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each board member link record. Availability still follows the provider's permissions and retention.
Developer identifier: `board_members.membership_key`
**Membership Key.** Parable-generated SHA-1 digest of `board_id` and `id`, joined with `|`.
* **Enables:** Deduplicate each board membership on its own, so a member who belongs to several Miro boards keeps one row per board.
* **Interpretation:** Parable calculates `membership_key` at ingestion. It identifies one board-to-member relationship, not the member or the board by itself, and is not a Miro identifier. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `board_members.name`
Name records display name of the board member. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the board member record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each board member record. In Miro, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `board_members.role`
Role states role of the member on the board (viewer, commenter, editor, coowner, owner). It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported role attached to each board member record.
* **Interpretation:** The provider supplies `role` at board member granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Miro, role is access or membership context, not an individual-performance measure.
Developer identifier: `board_members.type`
Type states type of the resource, typically '`board_member`'. It preserves the provider's current classification of this record.
* **Enables:** separate board member records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per board member record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `board_tags`
Board Tags contain all tags defined on a specific Miro board. Tags are used to categorize and label items. Requires `board_id` from parent boards tap.
* **Enables:** apply each board's defined tags to the items that reference them.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/boards/{board_id}/tags` as a full snapshot. Results contain only boards and child records visible to the configured token.
Developer identifier: `board_tags.board_id`
Board ID identifies parent id injected by the ingestor from the boards to `board_tags` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board tag records to provider records that carry the same board ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `board_id` as a record-level identifier on `BoardTag`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `board_tags.fillColor`
Fill Color records fill color of the tag. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied fill color for the represented design or board object.
* **Interpretation:** The provider supplies `fillColor` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `board_tags.id`
ID is the unique identifier of the tag. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same board tag source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per board tag record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `board_tags.title`
Title records title or label text of the tag. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact title value attached to each board tag record.
* **Interpretation:** The provider supplies `title` at board tag granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `board_tags.type`
Type states type of the resource. Always 'tag' for tag objects. It preserves the provider's current classification of this record.
* **Enables:** separate board tag records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per board tag record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `boards`
Boards contain all boards accessible to the authenticated user from Miro. Boards are the central resource in Miro, containing items, members, and collaboration data.
* **Enables:** enumerate accessible whiteboards before resolving their items and membership records.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/boards` as a full snapshot. Results contain only boards and child records visible to the configured token.
Developer identifier: `boards.createdAt`
Created At records ISO 8601 timestamp when the board was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place board records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per board record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `boards.createdBy`
Created By records user who created the board. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the board record to the provider-reported person or account represented by created by.
* **Interpretation:** The provider supplies `createdBy` as identity or attribution context on each board record. In Miro, created by is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `boards.createdBy.id`
ID is the unique identifier of the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `UserInfo`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `boards.createdBy.name`
Name records display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user info record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each user info record. In Miro, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `boards.createdBy.type`
Type states type of the resource, typically 'user'. It preserves the provider's current classification of this record.
* **Enables:** separate board records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per user info record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `boards.currentUserMembership`
Current User Membership records current authenticated user's membership details on the board. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each board record with the specific provider container named by current user membership.
* **Interpretation:** The provider returns `currentUserMembership` as a nested object or reference on `Board`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `boards.currentUserMembership.id`
ID is the unique identifier of the membership. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `CurrentUserMembership`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `boards.currentUserMembership.name`
Name records display name of the member. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the current user membership record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each current user membership record. In Miro, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `boards.currentUserMembership.role`
Role states role of the current user on the board. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported role attached to each current user membership record.
* **Interpretation:** The provider supplies `role` at current user membership granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Miro, role is access or membership context, not an individual-performance measure.
Developer identifier: `boards.currentUserMembership.type`
Type states type of the resource, typically '`board_member`'. It preserves the provider's current classification of this record.
* **Enables:** separate board records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per current user membership record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `boards.description`
Description records description of the board. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each board record.
* **Interpretation:** The provider supplies `description` at board granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `boards.id`
ID is the unique identifier of the board. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same board source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per board record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `boards.lastOpenedAt`
Last Opened At records ISO 8601 timestamp when the board was last opened. It anchors the named event or boundary on the record's timeline.
* **Enables:** place board records on a timeline by last opened at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastOpenedAt` per board record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `boards.lastOpenedBy`
Last Opened By records user who last opened the board. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the board record to the provider-reported person or account represented by last opened by.
* **Interpretation:** The provider supplies `lastOpenedBy` as identity or attribution context on each board record. In Miro, last opened by is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `boards.links`
Links groups the provider URLs for the board resource and its related web location. It preserves resource references returned with the board.
* **Enables:** open the exact board resource or related Miro page without treating either link as an inline snapshot.
* **Interpretation:** The provider returns `links` as a nested `BoardLinks` object; each value is a resource locator whose availability still follows provider permissions.
Developer identifier: `boards.links.related`
Related records URL to the board in the Miro web application. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by related on a board link record.
* **Interpretation:** The provider supplies `related` as a URL or resource locator on each board link record. Availability still follows the provider's permissions and retention.
Developer identifier: `boards.links.self`
Self records API URL for this board resource. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by self on a board link record.
* **Interpretation:** The provider supplies `self` as a URL or resource locator on each board link record. Availability still follows the provider's permissions and retention.
Developer identifier: `boards.modifiedAt`
Modified At records ISO 8601 timestamp when the board was last modified. It anchors the named event or boundary on the record's timeline.
* **Enables:** place board records on a timeline by modified at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `modifiedAt` per board record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `boards.modifiedBy`
Modified By records user who last modified the board. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the board record to the provider-reported person or account represented by modified by.
* **Interpretation:** The provider supplies `modifiedBy` as identity or attribution context on each board record. In Miro, modified by is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `boards.name`
Name records name/title of the board. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each board record.
* **Interpretation:** The provider supplies `name` at board granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `boards.owner`
Owner records owner of the board. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the board record to the provider-reported actor represented by owner.
* **Interpretation:** The provider supplies `owner` as identity or attribution context on each board record. In Miro, owner is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `boards.picture`
Picture records thumbnail/picture information for the board. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by picture on a board record.
* **Interpretation:** The provider supplies `picture` as a URL or resource locator on each board record. Availability still follows the provider's permissions and retention.
Developer identifier: `boards.picture.id`
ID is the identifier for the picture resource. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `PictureInfo`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `boards.picture.imageURL`
Image URL records URL of the board thumbnail image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by image URL on a picture info record.
* **Interpretation:** The provider supplies `imageURL` as a URL or resource locator on each picture info record. Availability still follows the provider's permissions and retention.
Developer identifier: `boards.picture.type`
Type states type of the picture resource. It preserves the provider's current classification of this record.
* **Enables:** separate board records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per picture info record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `boards.policy`
Policy states sharing and permissions policy wrapper for the board. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported policy attached to each board record.
* **Interpretation:** The provider supplies `policy` at board granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `boards.policy.permissionsPolicy`
Permissions Policy states permissions policy settings that control what collaborators can do on the board. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported permissions policy attached to each board policy record.
* **Interpretation:** The provider supplies `permissionsPolicy` at board policy granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `boards.policy.permissionsPolicy.collaborationToolsStartAccess`
Collaboration Tools Start Access states defines who can start using collaboration tools. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported collaboration tools start access attached to each permissions policy record.
* **Interpretation:** The provider supplies `collaborationToolsStartAccess` at permissions policy granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `boards.policy.permissionsPolicy.copyAccess`
Copy Access states defines who can copy the board. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported copy access attached to each permissions policy record.
* **Interpretation:** The provider supplies `copyAccess` at permissions policy granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `boards.policy.permissionsPolicy.copyAccessLevel`
Copy Access Level states defines the copy access level for the board. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported copy access level attached to each permissions policy record.
* **Interpretation:** The provider supplies `copyAccessLevel` at permissions policy granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `boards.policy.permissionsPolicy.sharingAccess`
Sharing Access states defines who can change the board's sharing and permissions settings. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported sharing access attached to each permissions policy record.
* **Interpretation:** The provider supplies `sharingAccess` at permissions policy granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `boards.policy.sharingPolicy`
Sharing Policy states sharing policy settings that control how the board can be shared. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported sharing policy attached to each board policy record.
* **Interpretation:** The provider supplies `sharingPolicy` at board policy granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `boards.policy.sharingPolicy.access`
Access states defines the public-level access for the board. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported access attached to each sharing policy record.
* **Interpretation:** The provider supplies `access` at sharing policy granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `boards.policy.sharingPolicy.accountAccess`
Account Access states defines the organization/account-level access for the board. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported account access attached to each sharing policy record.
* **Interpretation:** The provider supplies `accountAccess` at sharing policy granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `boards.policy.sharingPolicy.inviteToAccountAndBoardLinkAccess`
Invite To Account And Board Link Access states controls whether board link invitations also grant account access. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported invite to account and board link access attached to each sharing policy record.
* **Interpretation:** The provider supplies `inviteToAccountAndBoardLinkAccess` at sharing policy granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `boards.policy.sharingPolicy.teamAccess`
Team Access states defines the team-level access for the board. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported team access attached to each sharing policy record.
* **Interpretation:** The provider supplies `teamAccess` at sharing policy granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `boards.project`
Project records project information associated with the board, if any. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each board record with the specific provider container named by project.
* **Interpretation:** The provider returns `project` as a nested object or reference on `Board`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `boards.project.id`
ID is the unique identifier of the project. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ProjectInfo`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `boards.project.name`
Name records display name of the project. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each project info record.
* **Interpretation:** The provider supplies `name` at project info granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `boards.project.type`
Type states type of the resource, typically 'project'. It preserves the provider's current classification of this record.
* **Enables:** separate board records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per project info record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `boards.team`
Team records team information associated with the board. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each board record with the specific provider container named by team.
* **Interpretation:** The provider returns `team` as a nested object or reference on `Board`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `boards.team.id`
ID is the unique identifier of the team. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `TeamInfo`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `boards.team.name`
Name records display name of the team. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each team info record.
* **Interpretation:** The provider supplies `name` at team info granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `boards.team.type`
Type states type of the resource, typically 'team'. It preserves the provider's current classification of this record.
* **Enables:** separate board records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per team info record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `boards.type`
Type states type of the resource. Always 'board' for board objects. It preserves the provider's current classification of this record.
* **Enables:** separate board records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per board record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `boards.viewLink`
View Link records URL to view the board in the Miro web application. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by view link on a board record.
* **Interpretation:** The provider supplies `viewLink` as a URL or resource locator on each board record. Availability still follows the provider's permissions and retention.
Developer identifier: `organization_members`
Organization Members contain all members of a Miro organization (Enterprise plan only). Requires `org_id` ingestion config field. Provides user records with roles and activity data.
* **Enables:** enumerate Enterprise organization members and their provider-reported roles.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/orgs/{org_id}/members` as a full snapshot. The operation is Enterprise-only and is limited to the configured organization and token scopes.
Developer identifier: `organization_members.active`
Active indicates whether the member is currently active. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select organization member records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per organization member record; false and missing are distinct when the field is optional. In Miro, active is a condition on the work record, not an individual-performance measure.
Developer identifier: `organization_members.company`
Company records company name associated with the member's profile. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact company value attached to each organization member record.
* **Interpretation:** The provider supplies `company` at organization member granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `organization_members.createdAt`
Created At records ISO 8601 timestamp when the member was added. It anchors the named event or boundary on the record's timeline.
* **Enables:** place organization member records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per organization member record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `organization_members.email`
Email records email address of the member. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the organization member record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each organization member record. In Miro, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `organization_members.id`
ID is the unique identifier of the organization member. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same organization member source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per organization member record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `organization_members.industry`
Industry states industry associated with the member's profile. It preserves the provider's current classification of this record.
* **Enables:** separate organization member records by the exact provider-reported industry value when describing their recorded state.
* **Interpretation:** The provider supplies `industry` per organization member record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, industry is the work record's classification, not an individual-performance measure.
Developer identifier: `organization_members.lastActivityAt`
Last Activity At records ISO 8601 timestamp of the member's last activity. It anchors the named event or boundary on the record's timeline.
* **Enables:** place organization member records on a timeline by last activity at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastActivityAt` per organization member record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `organization_members.lastLoginAt`
Last Login At records ISO 8601 timestamp of the member's last login. It anchors the named event or boundary on the record's timeline.
* **Enables:** place organization member records on a timeline by last login at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastLoginAt` per organization member record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `organization_members.license`
License captures the license type assigned to this member. It preserves the provider's current classification of this record.
* **Enables:** separate organization member records by the exact provider-reported license value when describing their recorded state.
* **Interpretation:** The provider supplies `license` per organization member record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, license is the work record's classification, not an individual-performance measure.
Developer identifier: `organization_members.modifiedAt`
Modified At records ISO 8601 timestamp when the member record was last modified. It anchors the named event or boundary on the record's timeline.
* **Enables:** place organization member records on a timeline by modified at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `modifiedAt` per organization member record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `organization_members.name`
Name records full name of the member. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the organization member record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each organization member record. In Miro, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `organization_members.role`
Role states role of the member in the organization. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported role attached to each organization member record.
* **Interpretation:** The provider supplies `role` at organization member granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Miro, role is access or membership context, not an individual-performance measure.
Developer identifier: `organization_members.state`
State states current state of the member account. It preserves the provider's current classification of this record.
* **Enables:** separate organization member records by the exact provider-reported state value when describing their recorded state.
* **Interpretation:** The provider supplies `state` per organization member record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, state is the work record's classification, not an individual-performance measure.
Developer identifier: `organization_members.type`
Type states type of the resource. It preserves the provider's current classification of this record.
* **Enables:** separate organization member records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per organization member record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `organization_teams`
Organization Teams contain all teams within a Miro organization (Enterprise plan only). Requires `org_id` ingestion config field.
* **Enables:** map the teams configured within a Miro Enterprise organization.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/orgs/{org_id}/teams` as a full snapshot. The operation is Enterprise-only and is limited to the configured organization and token scopes.
Developer identifier: `organization_teams.id`
ID is the unique identifier of the team. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same organization team source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per organization team record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `organization_teams.name`
Name records name of the team. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each organization team record.
* **Interpretation:** The provider supplies `name` at organization team granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `organization_teams.picture`
Picture records optional picture metadata for the team. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each organization team record with the specific provider container named by picture.
* **Interpretation:** The provider returns `picture` as a nested object or reference on `OrganizationTeam`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `organization_teams.picture.id`
ID is the identifier for the picture resource. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match organization team records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `OrganizationTeamPicture`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `organization_teams.picture.imageURL`
Image URL records URL of the team picture image. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by image URL on a organization team picture record.
* **Interpretation:** The provider supplies `imageURL` as a URL or resource locator on each organization team picture record. Availability still follows the provider's permissions and retention.
Developer identifier: `organization_teams.picture.type`
Type states type of the picture resource. It preserves the provider's current classification of this record.
* **Enables:** separate organization team records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per organization team picture record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `organization_teams.type`
Type states type of the resource. It preserves the provider's current classification of this record.
* **Enables:** separate organization team records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per organization team record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
Developer identifier: `team_members`
Team Members contain all members of a specific team within a Miro organization (Enterprise plan only). Requires `org_id` ingestion config field and `team_id` from parent `organization_teams` tap.
* **Enables:** map members to each Enterprise organization team.
* **Scope:** Reads the declared collection through `GET /{apiVersion}/orgs/{org_id}/teams/{team_id}/members` as a full snapshot. The operation is Enterprise-only and is limited to the configured organization and token scopes.
Developer identifier: `team_members.active`
Active indicates whether the team member account is currently active. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select team member records for which the provider reports active as true or false.
* **Interpretation:** The provider supplies `active` as a boolean per team member record; false and missing are distinct when the field is optional. In Miro, active is a condition on the work record, not an individual-performance measure.
Developer identifier: `team_members.company`
Company records company name associated with the team member. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact company value attached to each team member record.
* **Interpretation:** The provider supplies `company` at team member granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `team_members.createdAt`
Created At records the timestamp indicating when the team member was added to the team. It anchors the named event or boundary on the record's timeline.
* **Enables:** place team member records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `createdAt` per team member record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `team_members.email`
Email records email address of the team member. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the team member record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each team member record. In Miro, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `team_members.id`
**ID.** Miro's identifier for the user who is a member of the team.
* **Enables:** Connect each team membership to the member's Miro account through `team_members.id`.
* **Interpretation:** Miro reports this value in its user namespace. The same value repeats once for every team the member belongs to, so it does not identify a row on its own. A connector directive maps this field to account identity.
Developer identifier: `team_members.industry`
Industry states industry associated with the team member's profile. It preserves the provider's current classification of this record.
* **Enables:** separate team member records by the exact provider-reported industry value when describing their recorded state.
* **Interpretation:** The provider supplies `industry` per team member record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, industry is the work record's classification, not an individual-performance measure.
Developer identifier: `team_members.lastActivityAt`
Last Activity At records the timestamp of the member's last activity within the team. It anchors the named event or boundary on the record's timeline.
* **Enables:** place team member records on a timeline by last activity at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `lastActivityAt` per team member record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `team_members.membership_key`
**Membership Key.** Parable-generated SHA-1 digest of `team_id` and `id`, joined with `|`.
* **Enables:** Deduplicate each team membership on its own, so a member who belongs to several Miro teams keeps one row per team.
* **Interpretation:** Parable calculates `membership_key` at ingestion. It identifies one team-to-member relationship, not the member or the team by itself, and is not a Miro identifier. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `team_members.modifiedAt`
Modified At records the timestamp indicating when the team member record was last modified. It anchors the named event or boundary on the record's timeline.
* **Enables:** place team member records on a timeline by modified at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `modifiedAt` per team member record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `team_members.name`
Name records full name of the team member. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the team member record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each team member record. In Miro, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `team_members.role`
Role states role of the member within the team. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported role attached to each team member record.
* **Interpretation:** The provider supplies `role` at team member granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In Miro, role is access or membership context, not an individual-performance measure.
Developer identifier: `team_members.team_id`
Team ID identifies parent id injected by the ingestor from the `organization_teams` to `team_members` traversal `parentContextFields`. Not part of the upstream API response; written into each row at bronze ingestion time. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match team member records to provider records that carry the same team ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `team_id` as a record-level identifier on `TeamMember`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `team_members.type`
Type states type of the resource. It preserves the provider's current classification of this record.
* **Enables:** separate team member records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per team member record using its own state vocabulary; unknown and missing values must remain distinct. In Miro, type is the work record's classification, not an individual-performance measure.
**[Miro REST API Quickstart](https://developers.miro.com/docs/rest-api-build-your-first-hello-world-app)** — Official guide for creating a developer app and obtaining an access token
**Validation fails immediately after pasting the token**
* Confirm you selected the **non-expiring token** option when creating the Miro app. Tokens from apps configured with expiring tokens will show as invalid after 1 hour.
* Verify `boards:read` and `identity:read` are enabled in your app permissions.
* Ensure you copied the **Access token** (not the Client ID or Client Secret).
**Enterprise taps are not syncing**
* Confirm your Miro account is on an **Enterprise plan**.
* Confirm you provided the correct **Organization ID** in the Provider configuration. Find it in Miro under **Settings > Company Settings > Security > Audit log**.
* Confirm `auditlogs:read`, `organizations:read`, and `organizations:teams:read` scopes are enabled on the app.
**Boards tap returns only some boards**
* The token's access is scoped to the workspace team it was created in. If boards belong to a different team, the token will not return them.
# Mixpanel
Source: https://docs.parable.work/plugins/provider-plugins/mixpanel
Sync product analytics data from Mixpanel: raw events, user and group profiles, cohorts, funnels, and annotations.
Sync product analytics data from Mixpanel: raw events, user and group profiles, cohorts, funnels, and annotations.
Connect Parable to Mixpanel for product analytics using HTTP Basic authentication with an organization service account. Parable syncs raw events, user profiles, cohorts, funnels, and optionally annotations and group profiles.
#### Events & people
Raw event export and People / Engage profiles
#### Definitions
Cohorts, funnel list, annotations
| Field | Required | Notes |
| - | - | - |
| Service Account Username | Yes | Basic auth username |
| Service Account Secret | Yes | Basic auth password; shown once at creation |
| Project ID | Yes | Sent as `project_id` on Query and Export requests |
| Query base URL | No (defaults US) | Engage, cohorts, funnels, annotations |
| Export base URL | No (defaults US) | Raw event export only |
| Data Group ID | No | Required for `group_profiles` |
| Tap | Sync | Notes |
| - | - | - |
| `raw_events` | Incremental date windows | Export API; JSONL; up to 30-day windows |
| `user_profiles` | Incremental via `$last_seen` | Engage POST form body + session/page pagination |
| `cohorts` | Full | Cohort list |
| `funnels_list` | Full | Funnel definitions |
| `annotations` | Full | Off by default |
| `group_profiles` | Full | Off by default; needs Data Group ID |
## Data streams
This Provider Plugin defines 6 data streams.
| Stream | Description | Sync |
| - | - | - |
| `raw_events` | Raw Mixpanel events as newline-delimited JSON from the Export API. Date-window incremental sync via from\_date/to\_date; each line is one tracked event with its full properties bag. | incremental |
| `user_profiles` | Mixpanel People (user) profiles via the Engage API. Incremental by \$last\_seen using a where filter; session\_id + page hybrid pagination. | incremental |
| `cohorts` | Saved cohort definitions from Mixpanel. Full sync; the cohort list is small and has no incremental cursor. | full |
| `funnels_list` | List of saved funnel definitions from Mixpanel. Full sync; enumerates funnels by id and name. | full |
| `annotations` | Project annotations (notes attached to dates on Mixpanel charts). Full sync; opt-in. | full |
| `group_profiles` | Mixpanel Group Analytics profiles via the Engage API with a data\_group\_id. Full sync; session\_id + page hybrid pagination. Requires Group Analytics; opt-in. | full |
### Mixpanel
#### What You'll Need
| Credential | What it is |
| - | - |
| **Service Account Username** | Username from Mixpanel Organization Settings → Service Accounts |
| **Service Account Secret** | Secret shown once when the service account is created |
| **Project ID** | Numeric Mixpanel project ID |
| **Query / Export base URLs** | Regional hosts for your project's data residency (defaults to US) |
| **Data Group ID** | Optional. Required only if syncing group profiles |
> **Info:** **Setup access in Mixpanel.** These steps require **Organization Owner or Admin**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Mixpanel administrator.
* Organization **Owner** or **Admin** to create service accounts
* Service account granted at least **Analyst** (or equivalent read) access on the target project
* Your project's **Project ID** and data residency region (US, EU, or India)
#### Step 1: Create a service account
1. Sign in to Mixpanel as an organization Owner or Admin.
2. Open **Organization Settings → Service Accounts** (or go to mixpanel.com/settings/org#serviceaccounts).
3. Click **Create Service Account**.
4. Choose a name (for example `parable-sync`) and grant the account access to the project(s) Parable should read.
5. Copy the **Username** and **Secret**.
> **Warning:** **Copy your Service Account Secret now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
#### Step 2: Find your Project ID and residency
1. Open **Organization Settings → Projects**, or **Project Settings** for the active project.
2. Copy the **Project ID** (numeric).
3. Note **Data Residency** (US, EU, or India). Hosts must match residency:
| Region | Query base URL | Export base URL |
| - | - | - |
| US (default) | `https://mixpanel.com/api/query` | `https://data.mixpanel.com` |
| EU | `https://eu.mixpanel.com/api/query` | `https://data-eu.mixpanel.com` |
| India | `https://in.mixpanel.com/api/query` | `https://data-in.mixpanel.com` |
#### Step 3: Optional — Group Analytics data group ID
Only needed if you enable the `group_profiles` tap.
1. In Mixpanel, open Group Analytics settings for the project.
2. Copy the **data group ID** for the group key you want to sync.
3. Keep it for the Parable form's **Data Group ID** field.
#### Step 4: Enter values in the form
1. In Parable, open **Platform → Providers** and choose the Provider to add.
2. Select **Mixpanel**.
3. Enter **Service Account Username**, **Service Account Secret**, and **Project ID**.
4. If not US residency, set **Query base URL** and **Export base URL** from the table above.
5. (Optional) Enter **Data Group ID** for group profiles.
6. Click **Save & test connection**.
Developer identifier: `annotations`
Annotations contain project annotations (notes attached to dates on Mixpanel charts). Full sync; opt-in.
* **Enables:** place project notes on the dates to which Mixpanel attaches them.
* **Scope:** Reads the declared collection through `GET /annotations` as a full snapshot. Results are limited to the configured Mixpanel project and service-account access.
Developer identifier: `annotations.date`
Date records the date the annotation is attached to. It anchors the named event or boundary on the record's timeline.
* **Enables:** place annotation records on a timeline by date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `date` per mixpanel annotation record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `annotations.description`
Description records annotation text. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each mixpanel annotation record.
* **Interpretation:** The provider supplies `description` at mixpanel annotation granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `annotations.id`
ID is the unique annotation identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same mixpanel annotation source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per mixpanel annotation record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `annotations.project_id`
Project ID identifies Mixpanel project ID the annotation belongs to. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match annotation records to provider records that carry the same project ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `project_id` as a record-level identifier on `MixpanelAnnotation`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cohorts`
Cohorts contain saved cohort definitions from Mixpanel. Full sync; the cohort list is small and has no incremental cursor.
* **Enables:** catalog saved cohort definitions for interpreting cohort references in Mixpanel.
* **Scope:** Reads the declared collection through `GET /cohorts/list` as a full snapshot. Results are limited to the configured Mixpanel project and service-account access.
Developer identifier: `cohorts.count`
Count reports the number of users currently matching the cohort. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported count for each mixpanel cohort record.
* **Interpretation:** The provider supplies `count` at mixpanel cohort granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `cohorts.created`
Created records the timestamp when the cohort was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place cohort records on a timeline by created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created` per mixpanel cohort record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `cohorts.data_group_id`
Data Group ID identifies data group identifier when the cohort is a group cohort. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match cohort records to provider records that carry the same data group ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `data_group_id` as a record-level identifier on `MixpanelCohort`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `cohorts.description`
Description records cohort description. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each mixpanel cohort record.
* **Interpretation:** The provider supplies `description` at mixpanel cohort granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `cohorts.id`
ID is the unique cohort identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same mixpanel cohort source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per mixpanel cohort record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `cohorts.is_visible`
Is Visible indicates whether the cohort appears in the Mixpanel UI. It preserves the provider's integer-encoded visibility condition.
* **Enables:** separate UI-visible cohorts from cohorts the provider marks as hidden.
* **Interpretation:** The provider supplies `is_visible` as an integer flag, not a quantity; preserve the provider encoding and keep zero distinct from missing.
Developer identifier: `cohorts.name`
Name records cohort name. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each mixpanel cohort record.
* **Interpretation:** The provider supplies `name` at mixpanel cohort granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `funnels_list`
Funnels List contains the saved funnel definitions returned by Mixpanel.
* **Enables:** resolve saved funnel identifiers to their Mixpanel names.
* **Scope:** Reads the declared collection through `GET /funnels/list` as a full snapshot. Results are limited to the configured Mixpanel project and service-account access.
Developer identifier: `funnels_list.funnel_id`
Funnel ID is the unique funnel identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same mixpanel funnel source row before constructing its represented state.
* **Interpretation:** The provider supplies `funnel_id` at one value per mixpanel funnel record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `funnels_list.name`
Name records funnel name. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each mixpanel funnel record.
* **Interpretation:** The provider supplies `name` at mixpanel funnel granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `group_profiles`
Group Profiles contain the property map returned for each Mixpanel Group Analytics entity.
* **Enables:** segment Group Analytics profiles by the provider-supplied group properties.
* **Scope:** Reads the declared collection through `POST /engage` as a full snapshot. The operation requires Group Analytics and is opt-in; projects without that feature return no group profiles.
Developer identifier: `group_profiles.$distinct_id`
\$distinct ID is the unique identifier of the group profile. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same mixpanel group profile source row before constructing its represented state.
* **Interpretation:** The provider supplies `$distinct_id` at one value per mixpanel group profile record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `group_profiles.$group_id`
\$group ID captures the group ID value. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match group profile records to provider records that carry the same \$group ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `$group_id` as a record-level identifier on `MixpanelGroupProfile`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `group_profiles.$group_key`
\$group Key captures the group key (property) this group is keyed on. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match group profile records to provider records that carry the same \$group key, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `$group_key` as a record-level identifier on `MixpanelGroupProfile`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `group_profiles.$properties`
\$properties captures the group profile property bag. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret \$properties according to the provider and Workspace configuration that produced each group profile record.
* **Interpretation:** Keys and value shapes within `$properties` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `group_profiles.$properties.$last_seen`
\$last Seen records the timestamp when the group was last seen. It anchors the named event or boundary on the record's timeline.
* **Enables:** place group profile records on a timeline by \$last seen and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `$last_seen` per mixpanel group profile property record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `raw_events`
Raw Events contain raw Mixpanel events as newline-delimited JSON from the Export API. Date-window incremental sync via `from_date`/`to_date`; each line is one tracked event with its full properties bag.
* **Enables:** measure occurrences of tracked product events using each event's timestamp, name, and property bag.
* **Scope:** Reads provider changes through `GET {exportBaseUrl}/api/2.0/export` using the declared incremental request boundary. Results are limited to the configured Mixpanel project and service-account access.
Developer identifier: `raw_events.event`
Event captures the name of the tracked event. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact event value attached to each mixpanel raw event record.
* **Interpretation:** The provider supplies `event` at mixpanel raw event granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `raw_events.id`
ID identifies synthetic deduplication key hashed from `$insert_id`, time, event, `distinct_id`, and `device_id`. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same mixpanel raw event source row before constructing its represented state.
* **Interpretation:** Parable generates `id` at one value per mixpanel raw event record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `raw_events.properties`
Properties captures the event property bag. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret properties according to the provider and Workspace configuration that produced each raw event record.
* **Interpretation:** Keys and value shapes within `properties` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `raw_events.properties.$browser`
\$browser records browser used when the event was sent. It preserves the client environment reported with the event.
* **Enables:** count Mixpanel events by the reported \$browser client environment.
* **Interpretation:** Mixpanel supplies `$browser` per tracked event from client metadata; missing values do not identify an operating system or browser.
Developer identifier: `raw_events.properties.$city`
\$city records city derived from IP geolocation at event time. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** segment raw event records by the recorded \$city without inferring a person's physical presence.
* **Interpretation:** The provider supplies `$city` as location or localization context per mixpanel event property record; it does not establish a person's real-time physical location.
Developer identifier: `raw_events.properties.$insert_id`
\$insert ID is the unique ID assigned to the event. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match raw event records to provider records that carry the same \$insert ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `$insert_id` as a record-level identifier on `MixpanelEventProperties`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `raw_events.properties.$lib_version`
\$lib Version records version of the Mixpanel SDK library used to send the event. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact \$lib version when validating the configuration or technical definition of a mixpanel event property record.
* **Interpretation:** The provider supplies `$lib_version` as configuration or technical metadata on `MixpanelEventProperties`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `raw_events.properties.$os`
\$OS records operating system of the device that sent the event. It preserves the client environment reported with the event.
* **Enables:** count Mixpanel events by the reported \$OS client environment.
* **Interpretation:** Mixpanel supplies `$os` per tracked event from client metadata; missing values do not identify an operating system or browser.
Developer identifier: `raw_events.properties.$user_id`
\$user ID identifies identified user ID (post identity-merge), when present. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match raw event records to provider records that carry the same \$user ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `$user_id` as a record-level identifier on `MixpanelEventProperties`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `raw_events.properties.device_id`
Device ID identifies device identifier when the event is not yet identified to a `distinct_id`. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match raw event records to provider records that carry the same device ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `device_id` as a record-level identifier on `MixpanelEventProperties`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `raw_events.properties.distinct_id`
Distinct ID is the unique identifier of the user who triggered the event, when present. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match raw event records to provider records that carry the same distinct ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `distinct_id` as a record-level identifier on `MixpanelEventProperties`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `raw_events.properties.email`
Email records email property carried on the event, when present. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the mixpanel event property record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each mixpanel event property record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `raw_events.properties.mp_country_code`
Mp Country Code records ISO 3166-1 alpha-2 country code derived from IP geolocation. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact mp country code when validating the configuration or technical definition of a mixpanel event property record.
* **Interpretation:** The provider supplies `mp_country_code` as configuration or technical metadata on `MixpanelEventProperties`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `raw_events.properties.project_id`
Project ID identifies Mixpanel project ID the event belongs to. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match raw event records to provider records that carry the same project ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `project_id` as a record-level identifier on `MixpanelEventProperties`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `raw_events.properties.time`
**Time.** The instant the event occurred, as Mixpanel reports it in `properties.time`. It anchors the raw event on the activity timeline.
* **Enables:** order Raw Events by time and select the events inside an explicit reporting window.
* **Interpretation:** The Export API sends `time` as whole seconds since the Unix epoch (the tap does not request `time_in_ms`). It represents an instant, not an elapsed duration. A connector directive uses this field to order records, and the schema designates it as the event timestamp.
Developer identifier: `raw_events.properties.user_email`
User Email records user email carried on the event, when present. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the mixpanel event property record to the provider-reported actor represented by user email.
* **Interpretation:** The provider supplies `user_email` as identity or attribution context on each mixpanel event property record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `user_profiles`
User Profiles contain Mixpanel People (user) profiles via the Engage API. Incremental by `$last_seen` using a where filter; `session_id` + page hybrid pagination.
* **Enables:** segment Mixpanel People profiles by provider-supplied profile attributes and last-seen time.
* **Scope:** Reads provider changes through `POST /engage` using the declared incremental request boundary. Results are limited to the configured Mixpanel project and service-account access.
Developer identifier: `user_profiles.$distinct_id`
\$distinct ID is the unique identifier of the user profile. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same mixpanel user profile source row before constructing its represented state.
* **Interpretation:** The provider supplies `$distinct_id` at one value per mixpanel user profile record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `user_profiles.$properties`
\$properties captures the user profile property bag. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret \$properties according to the provider and Workspace configuration that produced each user profile record.
* **Interpretation:** Keys and value shapes within `$properties` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `user_profiles.$properties.$city`
\$city records city derived from IP geolocation. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** segment user profile records by the recorded \$city without inferring a person's physical presence.
* **Interpretation:** The provider supplies `$city` as location or localization context per mixpanel user profile property record; it does not establish a person's real-time physical location.
Developer identifier: `user_profiles.$properties.$country_code`
\$country Code records ISO 3166-1 alpha-2 country code derived from IP geolocation. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact \$country code when validating the configuration or technical definition of a mixpanel user profile property record.
* **Interpretation:** The provider supplies `$country_code` as configuration or technical metadata on `MixpanelUserProfileProperties`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `user_profiles.$properties.$created`
\$created records the timestamp when the profile was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place user profile records on a timeline by \$created and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `$created` per mixpanel user profile property record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `user_profiles.$properties.$email`
\$email records user email address. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the mixpanel user profile property record to the provider-reported person or account represented by \$email.
* **Interpretation:** The provider supplies `$email` as identity or attribution context on each mixpanel user profile property record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `user_profiles.$properties.$first_name`
\$first Name records user first name. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the mixpanel user profile property record to the provider-reported person or account represented by \$first name.
* **Interpretation:** The provider supplies `$first_name` as identity or attribution context on each mixpanel user profile property record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `user_profiles.$properties.$last_name`
\$last Name records user last name. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the mixpanel user profile property record to the provider-reported person or account represented by \$last name.
* **Interpretation:** The provider supplies `$last_name` as identity or attribution context on each mixpanel user profile property record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `user_profiles.$properties.$last_seen`
\$last Seen records the timestamp when the user was last seen. Incremental cursor. It anchors the named event or boundary on the record's timeline.
* **Enables:** place user profile records on a timeline by \$last seen and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `$last_seen` per mixpanel user profile property record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `user_profiles.$properties.$phone`
\$phone records user phone number. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the mixpanel user profile property record to the provider-reported person or account represented by \$phone.
* **Interpretation:** The provider supplies `$phone` as identity or attribution context on each mixpanel user profile property record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
| Error | Meaning | Solution |
| - | - | - |
| `401 Unauthorized` | Bad username or secret | Recreate the service account; secret is shown once |
| `403 Forbidden` | No access to the project | Grant the service account a project role with read access |
| `400 Bad Request` | Bad Project ID or params | Confirm Project ID and regional hosts match residency |
| Empty `raw_events` | No events in the date window | Widen the sync window or confirm the project has events |
| `group_profiles` skipped / empty | Missing or wrong Data Group ID | Set Data Group ID; Group Analytics must be enabled |
#### Common Issues
#### Wrong region hosts
If Project ID is correct but requests fail or return empty, confirm Query and Export base URLs match the project's data residency (US / EU / India).
#### Service account cannot see the project
Creating the account at the org is not enough — grant it membership on the specific project with a read-capable role.
**[Service Accounts](https://docs.mixpanel.com/docs/orgs-and-projects/managing-roles#service-accounts)** — Roles and creation
**[Authentication](https://developer.mixpanel.com/reference/service-accounts-api-authentication)** — HTTP Basic auth with service accounts
**[Raw Export API](https://developer.mixpanel.com/reference/raw-event-export)** — Endpoint used by `raw_events`
**[Data residency](https://docs.mixpanel.com/docs/privacy/resident-data)** — Regional Query and Export hosts
# monday.com
Source: https://docs.parable.work/plugins/provider-plugins/monday
Sync boards, items, users, teams, workspaces, updates, tags, docs, and activity logs from monday.com
Sync boards, items, users, teams, workspaces, updates, tags, docs, and activity logs from monday.com.
### Personal API Token
Connect Parable to Monday.com using a personal API token and the GraphQL API. The token is tied to your user and inherits your account permissions, so the data Parable can sync depends on what your user can see. For full-account coverage, use an administrator's token.
> **Info:** The token inherits your user's permissions. A member token only reaches boards that user is subscribed to; an administrator token reaches the whole account.
#### Boards & work items
Boards, groups, columns, items, subitems, tags, activity logs
#### People & workspaces
Users, teams, workspaces
#### Collaboration
Updates, replies, WorkDocs
### Personal API Token
All of the tables below are collected for a connection. The access level of your token determines how much data each returns.
| Data | Access needed |
| - | - |
| Boards, groups, columns | Admin, or member subscribed to the board |
| Items, subitems, column values | Admin, or member subscribed to the board |
| Users | Admin (member tokens return limited results) |
| Teams | Admin |
| Workspaces | Admin |
| Updates & replies | Admin, or access to the item's board |
| Tags | Admin |
| WorkDocs | Access to the doc or its workspace |
| Activity logs | Admin **and** an Enterprise plan |
### OAuth 2.0 Authorization Code (3LO)
Connect Parable to Monday.com using OAuth 2.0. You create a Monday.com app in the Developer Center, create the connection in Parable, register Parable's redirect URI on your app, then authorize through Parable's in-app wizard. Parable exchanges the authorization code for an access token and stores it securely.
> **Info:** You do not enter an access token manually. The in-app wizard completes the OAuth flow for you.
#### Boards & work items
Boards, groups, columns, items, subitems, tags, activity logs
#### People & workspaces
Users, teams, workspaces
#### Collaboration
Updates, replies, WorkDocs
## Data streams
This Provider Plugin defines 9 data streams.
| Stream | Description | Sync |
| - | - | - |
| `boards` | Extracts all boards from Monday.com, including metadata such as name, description, board kind, type, state, workspace, creator, owners, subscribers, top group, columns, groups, tags, and views. Uses page-based pagination with limit=50 per page. Requires boards:read scope. | full |
| `items` | Extracts all items (tasks/rows) from Monday.com boards using cursor-based pagination via items\_page per board, then next\_items\_page for subsequent pages. Includes column values, group membership, creator, board reference, parent item, assets, subscribers, and subitem references. Requires iterating over all boards first. Requires boards:read scope. | full |
| `users` | Extracts all users from Monday.com, including profile details, admin/guest status, timezone, and team memberships. Uses page-based pagination with limit=500 per page. Requires users:read scope. | full |
| `teams` | Extracts all teams from Monday.com, including team name, picture URL, and member user references. No pagination documented; returns all teams in a single response. Requires teams:read scope. | full |
| `workspaces` | Extracts all workspaces from Monday.com, including name, kind, and description. Uses page-based pagination with limit=50 per page. Requires workspaces:read scope. | full |
| `updates` | Extracts all updates (comments and activity posts) on Monday.com items, including body text, creator, timestamps, and nested replies. Uses page-based pagination with limit=100 per page. Requires updates:read scope. | full |
| `tags` | Extracts all tags from Monday.com, including name and color. No pagination documented; returns all tags in a single response. Requires tags:read scope. | full |
| `docs` | Extracts all WorkDocs from Monday.com, including name, kind, creation timestamp, associated object, relative URL, and content blocks. Uses page-based pagination with limit=50 per page. Requires docs:read scope. | full |
| `activity_logs` | Extracts activity log entries per board from Monday.com (Enterprise plan only). Each entry records who performed what action on a board and when. Traverses all boards and fetches activity\_logs per board with time-range filtering for incremental sync. Confidence on data field schema is moderate (0.70) as the field is JSON-encoded and its internal structure is not fully documented. Requires boards:read scope; Enterprise plan required. | incremental |
### Personal API Token
#### What You'll Need
| Credential | What it is |
| - | - |
| **API Token** | Personal API token from your Monday.com account |
> **Info:** **Setup access in Monday.com.** These steps require **Administrator (recommended, for full-account access)**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Monday.com administrator.
* Any account member can generate a personal token, but the token only reaches data that user can access.
* An **Administrator** token is recommended so Parable can sync all boards, users, teams, and workspaces.
* Activity logs require a Monday.com **Enterprise** plan.
#### Step 1: Open your developer settings
1. Sign in to Monday.com (use an administrator account for full-account access).
2. Click your **avatar** (bottom-left) and open **Developers**.
3. Select **API token**.
#### Step 2: Copy your API token
1. Click **Show** to reveal your personal token, or **Regenerate** to create a new one.
2. Copy the token.
You can return to this page and click **Show** whenever you need to display the token again.
> **Warning:** Regenerating a token invalidates the previous one. Any connection still using the old token stops syncing until you update it.
#### Step 3: Confirm the token's access level
The token inherits the permissions of your user account:
* **Administrators** reach every board, user, team, and workspace.
* **Members** reach only the boards they are subscribed to.
> **Tip:** Use an administrator account so Parable can sync your full account.
#### Step 4: Enter the token in Parable
1. Open the Monday.com **API Token** Provider in Parable and add a connection.
2. Enter a **connection name**.
3. Paste your **API Token**.
4. Click **Save & test connection**.
### OAuth 2.0 Authorization Code (3LO)
#### What You'll Need
| Credential | What it is |
| - | - |
| **Client ID** | OAuth application client ID from the Monday.com Developer Center |
| **Client Secret** | OAuth application client secret |
> **Info:** **Setup access in Monday.com.** These steps require **Administrator (to create apps in the Developer Center)**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Monday.com administrator.
* A Monday.com app created in the Developer Center with OAuth enabled
* The read scopes listed in step 2 enabled on the app
* Permission to register a redirect URI on the app's OAuth settings
* Activity logs require a Monday.com **Enterprise** plan
#### Step 1: Create a Monday.com app
1. Sign in to Monday.com as an administrator.
2. Open `https://{your-account}.monday.com/apps/manage`, replacing `{your-account}` with your Monday.com account subdomain. Confirm **My Apps** is selected, then click **Create app**.
3. Open the app's **OAuth & Permissions** section and note the **Client ID** and **Client Secret**.
4. If Monday.com requires a redirect URL before you can continue, enter a valid placeholder URL. You will replace it with the Parable redirect URI in step 4.
> **Warning:** **Copy your Client Secret now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
#### Step 2: Enable the required scopes
On the app's **OAuth & Permissions** page, enable every read scope below so Parable can sync all Monday.com data:
| Scope | Enables |
| - | - |
| `boards:read` | Boards, groups, columns, items, subitems, activity logs |
| `users:read` | Users |
| `teams:read` | Teams |
| `workspaces:read` | Workspaces |
| `updates:read` | Updates and replies |
| `tags:read` | Tags |
| `docs:read` | WorkDocs |
> **Info:** These are read-only scopes. Monday.com's OAuth here is 3-legged (authorization code); Parable stores the access token after you approve. Activity logs also require an Enterprise plan.
#### Step 3: Create the connection in Parable
1. Open the Monday.com **OAuth** Provider in Parable and add a connection.
2. Enter a **connection name**.
3. Copy the **Redirect URI** shown on the form.
4. Click **Continue to OAuth setup**.
Parable creates the connection and opens the OAuth authorization screen.
#### Step 4: Register the redirect URI in Monday.com
1. In your Monday.com app **OAuth & Permissions** settings, add the **Redirect URI** you copied from Parable under **Redirect URLs**, replacing any placeholder URL entered in step 1.
2. Register it **exactly** as shown, including your workspace subdomain and path.
> **Info:** The redirect URI includes your workspace subdomain. Example:
> `https://{tenant-name}.parable.work/platform/providers/oauth/callback`.
> Do **not** register the apex host alone (`https://parable.work/...`). Monday.com must match the subdomain of the workspace where you started the connection.
#### Step 5: Authorize with Parable
1. On the OAuth authorization screen, enter your **Client ID** and **Client Secret**.
2. Click **Connect with OAuth**. You are redirected to Monday.com to approve the requested permissions.
3. After you approve, Parable redirects back automatically, stores your access token securely, and validates the connection.
> **Info:** Monday.com's legacy OAuth returns a long-lived access token that stays valid until the app is uninstalled. To rotate credentials or recover from a revoked token, click **Re-authorize with OAuth** on the connection page.
### OAuth 2.0 Authorization Code (3LO)
| Scope | Enables |
| - | - |
| `boards:read` | Boards, groups, columns, items, subitems, activity logs |
| `users:read` | Users |
| `teams:read` | Teams |
| `workspaces:read` | Workspaces |
| `updates:read` | Updates and replies |
| `tags:read` | Tags |
| `docs:read` | WorkDocs |
> **Info:** Enable all scopes above for complete coverage. Activity logs also require a Monday.com Enterprise plan.
> **Success:** After authorization, Parable shows an authorized status and validates the connection automatically.
> **Tip:** **Rate Limits:** Monday.com enforces rate limits of **complexity-based (up to 10,000,000 complexity points/minute depending on plan), plus a global cap of about 1.67 requests/second**.
>
> Parable handles rate limiting automatically with exponential backoff, but initial syncs of large datasets may take longer due to these limits.
Developer identifier: `activity_logs`
Activity Logs contain activity log entries per board from Monday.com (Enterprise plan only). Each entry records who performed what action on a board and when. Traverses all boards and fetches `activity_logs` per board with an explicit time-range request for incremental sync. Confidence on data field schema is moderate (0.70) as the field is JSON-encoded and its internal structure is not fully documented. Requires boards:read scope; Enterprise plan required.
* **Enables:** trace Enterprise board actions to the provider-reported actor, event, and time.
* **Scope:** Reads provider changes through the declared GraphQL operation using the declared incremental request boundary. The operation requires the stated monday.com read scope and an Enterprise plan.
Developer identifier: `activity_logs.account_id`
Account ID is the ID of the account that initiated the event. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match activity log records to provider records that carry the same account ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `account_id` as a record-level identifier on `ActivityLog`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `activity_logs.board_id`
Board ID is the ID of the board on which the activity occurred. Derived from the parent boards query traversal. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match activity log records to provider records that carry the same board ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `board_id` as a record-level identifier on `ActivityLog`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `activity_logs.created_at`
Created At records the timestamp indicating when the event occurred. Board logs use 17-digit Unix time. It anchors the named event or boundary on the record's timeline.
* **Enables:** place activity log records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per activity log record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `activity_logs.data`
Data records JSON-encoded event-specific data payload. Internal structure varies by event type and is not fully documented. Confidence: 0.70. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret data according to the provider and Workspace configuration that produced each activity log record.
* **Interpretation:** Keys and value shapes within `data` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `activity_logs.entity`
Entity records entity the event refers to (e.g. board, pulse, column). It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the declared entity layout or dimensional scope of each activity log record.
* **Interpretation:** The provider returns `entity` as a nested object or reference on `ActivityLog`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `activity_logs.event`
Event states event type describing the action performed (e.g., `create_item`, `change_column_value`). It preserves the provider's current classification of this record.
* **Enables:** separate activity log records by the exact provider-reported event value when describing their recorded state.
* **Interpretation:** The provider supplies `event` per activity log record using its own state vocabulary; unknown and missing values must remain distinct. In monday.com, event is the work record's classification, not an individual-performance measure.
Developer identifier: `activity_logs.id`
ID is the unique activity log entry identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same activity log source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per activity log record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `activity_logs.user_id`
User ID is the ID of the user who performed the action. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match activity log records to provider records that carry the same user ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `user_id` as a record-level identifier on `ActivityLog`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `boards`
Boards contain all boards from Monday.com, including metadata such as name, description, board kind, type, state, workspace, creator, owners, subscribers, top group, columns, groups, tags, and views. Uses page-based pagination with `limit=50` per page. Requires boards:read scope.
* **Enables:** catalog monday.com boards and their workspace, owners, columns, groups, tags, and views.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects returned under the tap's stated monday.com read scope.
Developer identifier: `boards.board_folder_id`
Board Folder ID is the ID of the folder containing this board, if any. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board records to provider records that carry the same board folder ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `board_folder_id` as a record-level identifier on `Board`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `boards.board_kind`
Board Kind states visibility kind of the board: public, private, or share. It preserves the provider's current classification of this record.
* **Enables:** separate board records by the exact provider-reported board kind value when describing their recorded state.
* **Interpretation:** The provider supplies `board_kind` per board record using its own state vocabulary; unknown and missing values must remain distinct. In monday.com, board kind is the work record's classification, not an individual-performance measure.
Developer identifier: `boards.columns`
Columns records array of column definitions on this board. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the declared columns layout or dimensional scope of each board record.
* **Interpretation:** The provider returns `columns` as a list on `Board`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `boards.columns.id`
ID is the unique column identifier within the board. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same column source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per column record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `boards.columns.title`
Title records display title of the column. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact title value attached to each column record.
* **Interpretation:** The provider supplies `title` at column granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `boards.columns.type`
Type states column type identifier (e.g., text, status, date, people, numbers). It preserves the provider's current classification of this record.
* **Enables:** separate board records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per column record using its own state vocabulary; unknown and missing values must remain distinct. In monday.com, type is the work record's classification, not an individual-performance measure.
Developer identifier: `boards.creator`
Creator captures the user who created this board. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the board record to the provider-reported actor represented by creator.
* **Interpretation:** The provider supplies `creator` as identity or attribution context on each board record. In monday.com, creator is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `boards.creator.email`
Email records email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each user record. In monday.com, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `boards.creator.id`
ID is the unique user identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same user source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per user record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `boards.creator.name`
Name records display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each user record. In monday.com, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `boards.description`
Description records optional description of the board. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each board record.
* **Interpretation:** The provider supplies `description` at board granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `boards.groups`
Groups records array of group definitions on this board. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each board record with the specific provider container named by groups.
* **Interpretation:** The provider returns `groups` as a list on `Board`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `boards.groups.color`
Color records hex color code associated with the group. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied color for the represented design or board object.
* **Interpretation:** The provider supplies `color` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `boards.groups.id`
ID is the unique group identifier within the board. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same group source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per group record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `boards.groups.title`
Title records display title of the group. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact title value attached to each group record.
* **Interpretation:** The provider supplies `title` at group granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `boards.id`
ID is the unique board identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same board source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per board record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `boards.items_count`
Items Count reports the number of items on the board. It preserves the stated measure at this record's granularity.
* **Enables:** measure the provider-reported items count for each board record.
* **Interpretation:** The provider supplies `items_count` at board granularity as a count at one value per record; zero and missing are not interchangeable.
Developer identifier: `boards.name`
Name records display name of the board. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each board record.
* **Interpretation:** The provider supplies `name` at board granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `boards.owners`
Owners records users who own this board. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the board record to the provider-reported actor represented by owners.
* **Interpretation:** The provider supplies `owners` as identity or attribution context on each board record. In monday.com, owners is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `boards.permissions`
Permissions states board permission setting. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported permissions attached to each board record.
* **Interpretation:** The provider supplies `permissions` at board granularity. It describes provider-reported context and does not prove effective access beyond the returned record.
Developer identifier: `boards.state`
State states lifecycle state of the board: active, archived, or deleted. It preserves the provider's current classification of this record.
* **Enables:** separate board records by the exact provider-reported state value when describing their recorded state.
* **Interpretation:** The provider supplies `state` per board record using its own state vocabulary; unknown and missing values must remain distinct. In monday.com, state is the work record's classification, not an individual-performance measure.
Developer identifier: `boards.subscribers`
Subscribers records users subscribed to this board. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the board record to the provider-reported person or account represented by subscribers.
* **Interpretation:** The provider supplies `subscribers` as identity or attribution context on each board record. In monday.com, subscribers is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `boards.tags`
Tags records tags applied on this board. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** apply the provider-defined tags classifications to each board record.
* **Interpretation:** The provider returns `tags` as a list on `Board`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `boards.tags.color`
Color records tag color. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied color for the represented design or board object.
* **Interpretation:** The provider supplies `color` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `boards.tags.id`
ID is the unique tag identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same tag source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per tag record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `boards.tags.name`
Name records tag name. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each tag record.
* **Interpretation:** The provider supplies `name` at tag granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `boards.top_group`
Top Group captures the top group on this board. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each board record with the specific provider container named by top group.
* **Interpretation:** The provider returns `top_group` as a nested object or reference on `Board`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `boards.type`
Type states board object type (board, `sub_items_board`, document, `custom_object`). It preserves the provider's current classification of this record.
* **Enables:** separate board records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per board record using its own state vocabulary; unknown and missing values must remain distinct. In monday.com, type is the work record's classification, not an individual-performance measure.
Developer identifier: `boards.updated_at`
Updated At records ISO 8601 timestamp when the board was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place board records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated_at` per board record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `boards.url`
URL records direct URL to the board. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a board record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each board record. Availability still follows the provider's permissions and retention.
Developer identifier: `boards.views`
Views records views configured on this board. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each board record with the specific provider container named by views.
* **Interpretation:** The provider returns `views` as a list on `Board`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `boards.views.id`
ID is the unique view identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same board view source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per board view record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `boards.views.name`
Name records view name. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each board view record.
* **Interpretation:** The provider supplies `name` at board view granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `boards.views.type`
Type states view type. It preserves the provider's current classification of this record.
* **Enables:** separate board records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per board view record using its own state vocabulary; unknown and missing values must remain distinct. In monday.com, type is the work record's classification, not an individual-performance measure.
Developer identifier: `boards.workspace`
Workspace captures the workspace this board belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each board record with the specific provider container named by workspace.
* **Interpretation:** The provider returns `workspace` as a nested object or reference on `Board`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `boards.workspace.id`
ID is the unique workspace identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `Workspace`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `boards.workspace.name`
Name records display name of the workspace. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each workspace record.
* **Interpretation:** The provider supplies `name` at workspace granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `boards.workspace_id`
Workspace ID identifies Workspace ID the board belongs to (scalar form). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match board records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspace_id` as a record-level identifier on `Board`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `docs`
Docs contain all WorkDocs from Monday.com, including name, kind, creation timestamp, associated object, relative URL, and content blocks. Uses page-based pagination with `limit=50` per page. Requires docs:read scope.
* **Enables:** inspect WorkDoc names, associated objects, links, and returned content blocks.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects returned under the tap's stated monday.com read scope.
Developer identifier: `docs.blocks`
Blocks records ordered list of content blocks that make up the body of the doc. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact blocks value attached to each doc record.
* **Interpretation:** The provider supplies `blocks` at doc granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `docs.blocks.content`
Content captures the raw content payload of the block. It retains configured attributes whose keys or shape are not fixed by this base schema.
* **Enables:** interpret content according to the provider and Workspace configuration that produced each doc record.
* **Interpretation:** Keys and value shapes within `content` can vary with provider and customer configuration; consumers must inspect the observed Workspace schema rather than assume a fixed contract.
Developer identifier: `docs.blocks.created_at`
Created At records the timestamp when the block was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place doc records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per doc block record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `docs.blocks.id`
ID is the unique identifier for the content block. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same doc block source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per doc block record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `docs.blocks.parent_block_id`
Parent Block ID captures the parent block's unique identifier (null for first-level blocks). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match doc records to provider records that carry the same parent block ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `parent_block_id` as a record-level identifier on `DocBlock`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `docs.blocks.position`
Position captures the block's position in the document. It preserves the stated measure at this record's granularity.
* **Enables:** order or classify doc records using the provider-defined position value.
* **Interpretation:** The provider supplies `position` at doc block granularity as a provider-defined ordinal or planning value rather than elapsed time or money; zero and missing are not interchangeable.
Developer identifier: `docs.blocks.type`
Type captures the type of content block. It preserves the provider's current classification of this record.
* **Enables:** separate doc records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per doc block record using its own state vocabulary; unknown and missing values must remain distinct. In monday.com, type is the work record's classification, not an individual-performance measure.
Developer identifier: `docs.blocks.updated_at`
Updated At records the timestamp when the block was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place doc records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated_at` per doc block record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `docs.created_at`
Created At records ISO 8601 timestamp indicating when the doc was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place doc records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per doc record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `docs.created_by`
Created By captures the user who created the doc. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the doc record to the provider-reported person or account represented by created by.
* **Interpretation:** The provider supplies `created_by` as identity or attribution context on each doc record. In monday.com, created by is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `docs.created_by.id`
ID is the unique user identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match doc records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `UserRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `docs.created_by.name`
Name records display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user ref record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each user ref record. In monday.com, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `docs.doc_folder_id`
Doc Folder ID is the ID of the folder containing the doc. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match doc records to provider records that carry the same doc folder ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `doc_folder_id` as a record-level identifier on `Doc`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `docs.doc_kind`
Doc Kind captures the kind/type of the WorkDoc. It preserves the provider's current classification of this record.
* **Enables:** separate doc records by the exact provider-reported doc kind value when describing their recorded state.
* **Interpretation:** The provider supplies `doc_kind` per doc record using its own state vocabulary; unknown and missing values must remain distinct. In monday.com, doc kind is the work record's classification, not an individual-performance measure.
Developer identifier: `docs.id`
ID is the unique identifier for the doc. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same doc source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per doc record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `docs.name`
Name records display name of the doc. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each doc record.
* **Interpretation:** The provider supplies `name` at doc granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `docs.object_id`
Object ID is the identifier of the associated Monday.com object this doc belongs to. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match doc records to provider records that carry the same object ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `object_id` as a record-level identifier on `Doc`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `docs.relative_url`
Relative URL records relative URL path to access the doc within Monday.com. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by relative URL on a doc record.
* **Interpretation:** The provider supplies `relative_url` as a URL or resource locator on each doc record. Availability still follows the provider's permissions and retention.
Developer identifier: `docs.settings`
Settings states document-level settings, returned as escaped JSON. It preserves the provider's current classification of this record.
* **Enables:** separate doc records by the exact provider-reported settings value when describing their recorded state.
* **Interpretation:** The provider supplies `settings` per doc record using its own state vocabulary; unknown and missing values must remain distinct. In monday.com, settings is the work record's classification, not an individual-performance measure.
Developer identifier: `docs.updated_at`
Updated At records ISO 8601 timestamp indicating when the doc was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place doc records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated_at` per doc record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `docs.url`
URL records absolute URL to access the doc. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a doc record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each doc record. Availability still follows the provider's permissions and retention.
Developer identifier: `docs.workspace`
Workspace captures the workspace this doc belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each doc record with the specific provider container named by workspace.
* **Interpretation:** The provider returns `workspace` as a nested object or reference on `Doc`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `docs.workspace.id`
ID is the unique workspace identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match doc records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `WorkspaceRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `docs.workspace.name`
Name records display name of the workspace. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each workspace ref record.
* **Interpretation:** The provider supplies `name` at workspace ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `docs.workspace_id`
Workspace ID is the ID of the workspace containing the doc. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match doc records to provider records that carry the same workspace ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `workspace_id` as a record-level identifier on `Doc`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `items`
Items contain all items (tasks/rows) from Monday.com boards using cursor-based pagination via `items_page` per board, then `next_items_page` for subsequent pages. Includes column values, group membership, creator, board reference, parent item, assets, subscribers, and subitem references. Requires iterating over all boards first. Requires boards:read scope.
* **Enables:** report board rows with their column values, group, parent, creator, and subscriber context.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects returned under the tap's stated monday.com read scope.
Developer identifier: `items.assets`
Assets records assets/files attached to this item. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested assets records contained by each item record.
* **Interpretation:** The provider returns `assets` as a list on `Item`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `items.assets.file_extension`
File Extension records file extension of the asset. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact file extension when validating the configuration or technical definition of a asset record.
* **Interpretation:** The provider supplies `file_extension` as configuration or technical metadata on `Asset`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `items.assets.id`
ID is the unique asset identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same asset source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per asset record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `items.assets.name`
Name records asset file name. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each asset record.
* **Interpretation:** The provider supplies `name` at asset granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `items.assets.url`
URL records public URL to the asset. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a asset record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each asset record. Availability still follows the provider's permissions and retention.
Developer identifier: `items.board`
Board captures the board this item belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested board records contained by each item record.
* **Interpretation:** The provider returns `board` as a nested object or reference on `Item`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `items.board.id`
ID identifies board identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match item records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `BoardRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `items.board.name`
Name records board name. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each board ref record.
* **Interpretation:** The provider supplies `name` at board ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `items.board_id`
Board ID is the ID of the board this item belongs to. Derived from parent boards traversal. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match item records to provider records that carry the same board ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `board_id` as a record-level identifier on `Item`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `items.column_values`
Column Values records array of column values for this item. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the declared column values layout or dimensional scope of each item record.
* **Interpretation:** The provider returns `column_values` as a list on `Item`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `items.column_values.id`
ID identifies column identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same column value source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per column value record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `items.column_values.text`
Text records human-readable text representation of the value. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact text value attached to each column value record.
* **Interpretation:** The provider supplies `text` at column value granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `items.column_values.type`
Type states column type. It preserves the provider's current classification of this record.
* **Enables:** separate item records by the exact provider-reported type value when describing their recorded state.
* **Interpretation:** The provider supplies `type` per column value record using its own state vocabulary; unknown and missing values must remain distinct. In monday.com, type is the work record's classification, not an individual-performance measure.
Developer identifier: `items.column_values.value`
Value records raw JSON-encoded value. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded value with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `value` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `items.created_at`
Created At records ISO 8601 timestamp when item was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place item records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per item record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `items.creator`
Creator captures the user who created this item. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the item record to the provider-reported actor represented by creator.
* **Interpretation:** The provider supplies `creator` as identity or attribution context on each item record. In monday.com, creator is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `items.creator.email`
Email records email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each user record. In monday.com, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `items.creator.id`
ID is the unique user identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same user source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per user record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `items.creator.name`
Name records display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each user record. In monday.com, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `items.creator_id`
Creator ID is the ID of the user who created the item. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match item records to provider records that carry the same creator ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `creator_id` as a record-level identifier on `Item`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `items.email`
Email records item email address for the board's item email integration. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the item record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each item record. In monday.com, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `items.group`
Group records group the item belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested group records contained by each item record.
* **Interpretation:** The provider returns `group` as a nested object or reference on `Item`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `items.group.id`
ID identifies group identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match item records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `GroupRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `items.group.title`
Title records group title. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact title value attached to each group ref record.
* **Interpretation:** The provider supplies `title` at group ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `items.id`
ID is the unique item identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same item source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per item record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `items.name`
Name records item name/title. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each item record.
* **Interpretation:** The provider supplies `name` at item granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `items.parent_item`
Parent Item captures the parent item, when this item is a subitem. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by parent item on each item record.
* **Interpretation:** The provider returns `parent_item` as a nested object or reference on `Item`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `items.parent_item.id`
ID identifies item identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match item records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ItemRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `items.parent_item.name`
Name records item name. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each item ref record.
* **Interpretation:** The provider supplies `name` at item ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `items.relative_link`
Relative Link records relative link to the item. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by relative link on a item record.
* **Interpretation:** The provider supplies `relative_link` as a URL or resource locator on each item record. Availability still follows the provider's permissions and retention.
Developer identifier: `items.state`
State states item state (active, archived, deleted). It preserves the provider's current classification of this record.
* **Enables:** separate item records by the exact provider-reported state value when describing their recorded state.
* **Interpretation:** The provider supplies `state` per item record using its own state vocabulary; unknown and missing values must remain distinct. In monday.com, state is the work record's classification, not an individual-performance measure.
Developer identifier: `items.subitems`
Subitems records array of subitem references. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** reconstruct the parent-child structure expressed by subitems on each item record.
* **Interpretation:** The provider returns `subitems` as a list on `Item`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `items.subitems.id`
ID identifies subitem identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same subitem ref source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per subitem ref record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `items.subitems.name`
Name records subitem name. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each subitem ref record.
* **Interpretation:** The provider supplies `name` at subitem ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `items.subscribers`
Subscribers records users subscribed to this item. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the item record to the provider-reported person or account represented by subscribers.
* **Interpretation:** The provider supplies `subscribers` as identity or attribution context on each item record. In monday.com, subscribers is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `items.updated_at`
Updated At records ISO 8601 timestamp when item was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place item records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated_at` per item record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `items.url`
URL records direct URL to the item. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a item record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each item record. Availability still follows the provider's permissions and retention.
Developer identifier: `tags`
Tags contain all tags from Monday.com, including name and color. No pagination documented; returns all tags in a single response. Requires tags:read scope.
* **Enables:** apply monday.com tag names and colors to records that reference them.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects returned under the tap's stated monday.com read scope.
Developer identifier: `tags.color`
Color records color associated with the tag. It preserves the provider's visual treatment for the represented object.
* **Enables:** reproduce or compare the provider-supplied color for the represented design or board object.
* **Interpretation:** The provider supplies `color` in its own color, opacity, stroke, emoji, or style vocabulary for the represented object.
Developer identifier: `tags.id`
ID is the unique identifier for the tag. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same tag source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per tag record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `tags.name`
Name records display name of the tag. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each tag record.
* **Interpretation:** The provider supplies `name` at tag granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `teams`
Teams contain all teams from Monday.com, including team name, picture URL, and member user references. No pagination documented; returns all teams in a single response. Requires teams:read scope.
* **Enables:** map monday.com teams to their member accounts.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects returned under the tap's stated monday.com read scope.
Developer identifier: `teams.id`
ID is the unique team identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same team source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per team record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `teams.name`
Name records display name of the team. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each team record.
* **Interpretation:** The provider supplies `name` at team granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `teams.picture_url`
Picture URL records URL of the team's profile picture. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by picture URL on a team record.
* **Interpretation:** The provider supplies `picture_url` as a URL or resource locator on each team record. Availability still follows the provider's permissions and retention.
Developer identifier: `teams.users`
Users records list of users who are members of this team. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the team record to the provider-reported actor represented by users.
* **Interpretation:** The provider supplies `users` as identity or attribution context on each team record. In monday.com, users is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `teams.users.email`
Email records email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the team user record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each team user record. In monday.com, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `teams.users.id`
ID is the unique user identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same team user source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per team user record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `teams.users.name`
Name records full display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the team user record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each team user record. In monday.com, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `updates`
Updates contain all updates (comments and activity posts) on Monday.com items, including body text, creator, timestamps, and nested replies. Uses page-based pagination with `limit=100` per page. Requires updates:read scope.
* **Enables:** inspect item update and reply text with creator and timestamp context.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects returned under the tap's stated monday.com read scope.
Developer identifier: `updates.assets`
Assets records assets/files attached to the update. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested assets object into its declared child fields for each update record.
* **Interpretation:** The provider returns `assets` as a list on `Update`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `updates.assets.file_extension`
File Extension records file extension of the asset. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact file extension when validating the configuration or technical definition of a asset record.
* **Interpretation:** The provider supplies `file_extension` as configuration or technical metadata on `Asset`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `updates.assets.id`
ID is the unique asset identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same asset source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per asset record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `updates.assets.name`
Name records asset file name. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each asset record.
* **Interpretation:** The provider supplies `name` at asset granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `updates.assets.url`
URL records public URL to the asset. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a asset record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each asset record. Availability still follows the provider's permissions and retention.
Developer identifier: `updates.body`
Body records HTML body of the update. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact body value attached to each update record.
* **Interpretation:** The provider supplies `body` at update granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `updates.created_at`
Created At records ISO 8601 timestamp when the update was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place update records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per update record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `updates.creator`
Creator carries the source person or account value named Creator for each update row. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the update record to the provider-reported actor represented by creator.
* **Interpretation:** The provider supplies `creator` as identity or attribution context on each update record. In monday.com, creator is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `updates.creator.email`
Email records email address of the creator. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the update creator record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each update creator record. In monday.com, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `updates.creator.id`
ID is the unique identifier of the creator user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match update records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `UpdateCreator`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `updates.creator.name`
Name records display name of the creator. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the update creator record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each update creator record. In monday.com, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `updates.creator_id`
Creator ID is the ID of the user who created the update. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match update records to provider records that carry the same creator ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `creator_id` as a record-level identifier on `Update`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `updates.edited_at`
Edited At records ISO 8601 timestamp when the update was last edited. It anchors the named event or boundary on the record's timeline.
* **Enables:** place update records on a timeline by edited at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `edited_at` per update record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `updates.id`
ID is the unique update identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same update source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per update record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `updates.item`
Item captures the item this update belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** enumerate the nested item records contained by each update record.
* **Interpretation:** The provider returns `item` as a nested object or reference on `Update`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `updates.item.id`
ID identifies item identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match update records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ItemRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `updates.item_id`
Item ID is the ID of the item this update belongs to. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match update records to provider records that carry the same item ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `item_id` as a record-level identifier on `Update`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `updates.replies`
Replies records array of replies to this update. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested replies object into its declared child fields for each update record.
* **Interpretation:** The provider returns `replies` as a list on `Update`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `updates.replies.body`
Body records HTML body of the reply. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact body value attached to each reply record.
* **Interpretation:** The provider supplies `body` at reply granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `updates.replies.created_at`
Created At records ISO 8601 timestamp when the reply was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place update records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per reply record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `updates.replies.creator`
Creator carries the source person or account value named Creator for each reply row. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the reply record to the provider-reported actor represented by creator.
* **Interpretation:** The provider supplies `creator` as identity or attribution context on each reply record. In monday.com, creator is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `updates.replies.creator.id`
ID is the unique identifier of the reply creator user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match update records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `ReplyCreator`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `updates.replies.creator.name`
Name records display name of the reply creator. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the reply creator record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each reply creator record. In monday.com, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `updates.replies.creator_id`
Creator ID is the ID of the user who created the reply. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match update records to provider records that carry the same creator ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `creator_id` as a record-level identifier on `Reply`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `updates.replies.id`
ID is the unique identifier of the reply. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same reply source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per reply record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `updates.replies.text_body`
Text Body records plain text body of the reply, stripped of HTML. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact text body value attached to each reply record.
* **Interpretation:** The provider supplies `text_body` at reply granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `updates.replies.updated_at`
Updated At records ISO 8601 timestamp when the reply was last updated. It anchors the named event or boundary on the record's timeline.
* **Enables:** place update records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated_at` per reply record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `updates.text_body`
Text Body records plain text body of the update, stripped of HTML. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact text body value attached to each update record.
* **Interpretation:** The provider supplies `text_body` at update granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `updates.updated_at`
Updated At records ISO 8601 timestamp when the update was last modified. It anchors the named event or boundary on the record's timeline.
* **Enables:** place update records on a timeline by updated at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `updated_at` per update record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `users`
Users contain all users from Monday.com, including profile details, admin/guest status, timezone, and team memberships. Uses page-based pagination with `limit=500` per page. Requires users:read scope.
* **Enables:** resolve monday.com accounts, guest or administrator flags, time zones, and team memberships.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects returned under the tap's stated monday.com read scope.
Developer identifier: `users.account`
Account captures the Monday.com account this user belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** expand the nested account object into its declared child fields for each user record.
* **Interpretation:** The provider returns `account` as a nested object or reference on `User`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `users.account.id`
ID is the unique account identifier. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match user records to provider records that carry the same ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `id` as a record-level identifier on `AccountRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `users.account.name`
Name records display name of the account. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each account ref record.
* **Interpretation:** The provider supplies `name` at account ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `users.account.slug`
Slug identifies account slug (subdomain). It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match user records to provider records that carry the same slug, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `slug` as a record-level identifier on `AccountRef`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `users.account.tier`
Tier states account subscription tier. It preserves the provider's current classification of this record.
* **Enables:** separate user records by the exact provider-reported tier value when describing their recorded state.
* **Interpretation:** The provider supplies `tier` per account ref record using its own state vocabulary; unknown and missing values must remain distinct. In monday.com, tier is the work record's classification, not an individual-performance measure.
Developer identifier: `users.country_code`
Country Code records user country code. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact country code when validating the configuration or technical definition of a user record.
* **Interpretation:** The provider supplies `country_code` as configuration or technical metadata on `User`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `users.created_at`
Created At records ISO 8601 timestamp when the user account was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place user records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per user record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `users.current_language`
Current Language records user's current language setting. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** interpret dates, times, or localized text for users using the recorded current language.
* **Interpretation:** The provider supplies `current_language` as location or localization context per user record; it does not establish a person's real-time physical location.
Developer identifier: `users.email`
Email records user email address. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each user record. In monday.com, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `users.enabled`
Enabled indicates whether the user account is active. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select user records for which the provider reports enabled as true or false.
* **Interpretation:** The provider supplies `enabled` as a boolean per user record; false and missing are distinct when the field is optional. In monday.com, enabled is a condition on the work record, not an individual-performance measure.
Developer identifier: `users.id`
ID is the unique user identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same user source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per user record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `users.is_admin`
Is Admin indicates whether the user has account admin privileges. It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported is admin attached to each user record.
* **Interpretation:** The provider supplies `is_admin` at user granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In monday.com, is admin is access or membership context, not an individual-performance measure.
Developer identifier: `users.is_guest`
Is Guest indicates whether the user is a guest (external collaborator). It documents the access-related value reported for this object or membership.
* **Enables:** describe the provider-reported is guest attached to each user record.
* **Interpretation:** The provider supplies `is_guest` at user granularity. It describes provider-reported context and does not prove effective access beyond the returned record. In monday.com, is guest is access or membership context, not an individual-performance measure.
Developer identifier: `users.is_pending`
Is Pending indicates whether the user invitation is still pending. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select user records for which the provider reports is pending as true or false.
* **Interpretation:** The provider supplies `is_pending` as a boolean per user record; false and missing are distinct when the field is optional. In monday.com, is pending is a condition on the work record, not an individual-performance measure.
Developer identifier: `users.is_view_only`
Is View Only indicates whether the user has view-only access. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select user records for which the provider reports is view only as true or false.
* **Interpretation:** The provider supplies `is_view_only` as a boolean per user record; false and missing are distinct when the field is optional. In monday.com, is view only is a condition on the work record, not an individual-performance measure.
Developer identifier: `users.join_date`
Join Date records the date the user joined the account. It anchors the named event or boundary on the record's timeline.
* **Enables:** place user records on a timeline by join date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `join_date` per user record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `users.location`
Location records user location. It preserves the geographic, locale, time-zone, or coordinate context represented by the field.
* **Enables:** segment user records by the recorded location without inferring a person's physical presence.
* **Interpretation:** The provider supplies `location` as location or localization context per user record; it does not establish a person's real-time physical location.
Developer identifier: `users.mobile_phone`
Mobile Phone records user mobile phone number. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by mobile phone.
* **Interpretation:** The provider supplies `mobile_phone` as identity or attribution context on each user record. In monday.com, mobile phone is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `users.name`
Name records user display name. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each user record. In monday.com, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `users.phone`
Phone records user phone number. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by phone.
* **Interpretation:** The provider supplies `phone` as identity or attribution context on each user record. In monday.com, phone is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `users.teams`
Teams records list of teams the user belongs to. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each user record with the specific provider container named by teams.
* **Interpretation:** The provider returns `teams` as a list on `User`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `users.teams.id`
ID is the unique team identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same team ref source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per team ref record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `users.teams.name`
Name records display name of the team. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each team ref record.
* **Interpretation:** The provider supplies `name` at team ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `users.time_zone_identifier`
Time Zone Identifier identifies IANA timezone identifier for the user. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match user records to provider records that carry the same time zone identifier, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `time_zone_identifier` as a record-level identifier on `User`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `users.title`
Title records user job title. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by title.
* **Interpretation:** The provider supplies `title` as identity or attribution context on each user record. In monday.com, title is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `users.url`
URL records URL to the user profile. It retains the exact provider location for the referenced resource.
* **Enables:** open or trace the exact provider resource referenced by URL on a user record.
* **Interpretation:** The provider supplies `url` as a URL or resource locator on each user record. Availability still follows the provider's permissions and retention.
Developer identifier: `workspaces`
Workspaces contain all workspaces from Monday.com, including name, kind, and description. Uses page-based pagination with `limit=50` per page. Requires workspaces:read scope.
* **Enables:** organize boards by the monday.com workspaces that contain them.
* **Scope:** Reads the declared collection through the declared GraphQL operation as a full snapshot. Results are limited to objects returned under the tap's stated monday.com read scope.
Developer identifier: `workspaces.created_at`
Created At records ISO 8601 timestamp when the workspace was created. It anchors the named event or boundary on the record's timeline.
* **Enables:** place workspace records on a timeline by created at and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `created_at` per workspace record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `workspaces.description`
Description records optional description of the workspace. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each workspace record.
* **Interpretation:** The provider supplies `description` at workspace granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `workspaces.id`
ID is the unique workspace identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same workspace source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per workspace record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `workspaces.is_default_workspace`
Is Default Workspace indicates whether this is the default workspace of the product or account. It preserves the provider-reported yes-or-no condition for this record.
* **Enables:** select workspace records for which the provider reports is default workspace as true or false.
* **Interpretation:** The provider supplies `is_default_workspace` as a boolean per workspace record; false and missing are distinct when the field is optional. In monday.com, is default workspace is a condition on the work record, not an individual-performance measure.
Developer identifier: `workspaces.kind`
Kind captures the kind of workspace: open or closed. It preserves the provider's current classification of this record.
* **Enables:** separate workspace records by the exact provider-reported kind value when describing their recorded state.
* **Interpretation:** The provider supplies `kind` per workspace record using its own state vocabulary; unknown and missing values must remain distinct. In monday.com, kind is the work record's classification, not an individual-performance measure.
Developer identifier: `workspaces.name`
Name records display name of the workspace. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each workspace record.
* **Interpretation:** The provider supplies `name` at workspace granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `workspaces.owners_subscribers`
Owners Subscribers records users who own the workspace. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the workspace record to the provider-reported actor represented by owners subscribers.
* **Interpretation:** The provider supplies `owners_subscribers` as identity or attribution context on each workspace record. In monday.com, owners subscribers is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `workspaces.owners_subscribers.email`
Email records email address of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by email.
* **Interpretation:** The provider supplies `email` as identity or attribution context on each user record. In monday.com, email is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `workspaces.owners_subscribers.id`
ID is the unique user identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same user source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per user record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `workspaces.owners_subscribers.name`
Name records display name of the user. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the user record to the provider-reported person or account represented by name.
* **Interpretation:** The provider supplies `name` as identity or attribution context on each user record. In monday.com, name is attribution or membership context for the work record, not a measure of an individual's performance.
Developer identifier: `workspaces.state`
State states Workspace state (all, active, archived, deleted). It preserves the provider's current classification of this record.
* **Enables:** separate workspace records by the exact provider-reported state value when describing their recorded state.
* **Interpretation:** The provider supplies `state` per workspace record using its own state vocabulary; unknown and missing values must remain distinct. In monday.com, state is the work record's classification, not an individual-performance measure.
Developer identifier: `workspaces.teams_subscribers`
Teams Subscribers records teams subscribed to the workspace. It preserves the containing or referenced object needed to reconstruct the provider relationship.
* **Enables:** associate each workspace record with the specific provider container named by teams subscribers.
* **Interpretation:** The provider returns `teams_subscribers` as a list on `Workspace`; an absent value does not prove that no related object exists outside the credential's visibility.
Developer identifier: `workspaces.teams_subscribers.id`
ID is the unique team identifier. It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same team ref source row before constructing its represented state.
* **Interpretation:** The provider supplies `id` at one value per team ref record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `workspaces.teams_subscribers.name`
Name records display name of the team. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact name value attached to each team ref record.
* **Interpretation:** The provider supplies `name` at team ref granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `workspaces.users_subscribers`
Users Subscribers records users subscribed to the workspace. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the workspace record to the provider-reported actor represented by users subscribers.
* **Interpretation:** The provider supplies `users_subscribers` as identity or attribution context on each workspace record. In monday.com, users subscribers is attribution or membership context for the work record, not a measure of an individual's performance.
### Personal API Token
| Error | Meaning | Solution |
| - | - | - |
| `Not Authenticated` | Invalid or revoked token | Re-copy the token from **API token**, or regenerate it |
| `Unauthorized` | Token lacks access to the resource | Use an administrator token for full-account access |
| Missing users, teams, or workspaces | Member-level token | Reconnect with an administrator token |
| Empty activity logs | Non-Enterprise plan | Activity logs require an Enterprise plan |
| `ComplexityException` | Query exceeded the complexity budget | Parable batches and retries automatically; retry after the reset window |
#### Common Issues
#### Some boards are missing
Token access is limited to boards the user can see. Reconnect with an administrator account for full access.
### OAuth 2.0 Authorization Code (3LO)
| Error | Meaning | Solution |
| - | - | - |
| `401 Unauthorized` | Invalid client credentials or access token | Verify the Client ID and Secret, or re-authorize with OAuth |
| `403 Forbidden` | Missing OAuth scope | Enable the required scope on the app and re-authorize |
| Authorization redirect fails | Redirect URI mismatch | Copy the redirect URI from Parable (must include your workspace subdomain, e.g. `{tenant-name}.parable.work`) and add it exactly under Redirect URLs |
| Re-authorization required | Access token revoked or app uninstalled | Click **Re-authorize with OAuth** on the connection page |
| Empty activity logs | Non-Enterprise plan | Activity logs require an Enterprise plan |
| `ComplexityException` | Query exceeded the complexity budget | Parable batches and retries automatically; retry after the reset window |
**[Monday.com OAuth guide](https://developer.monday.com/apps/docs/oauth)** — Official OAuth 2.0 documentation
**[Monday.com API](https://developer.monday.com/api-reference/)** — GraphQL API reference
# Notion
Source: https://docs.parable.work/plugins/provider-plugins/notion
Sync pages, databases, and users from Notion
Sync pages, databases, and users from Notion.
Connect Parable to Notion via an internal connection for access to pages, databases, and workspace data.
#### Pages & Databases
Page content, database records, properties
#### Users
Workspace members and collaborators
## Data streams
This Provider Plugin defines 6 data streams.
| Stream | Description | Sync |
| - | - | - |
| `users` | Workspace users | full |
| `databases` | Databases in the workspace | incremental |
| `database_items` | Items (pages) within a data source | incremental |
| `pages` | Pages in the workspace | incremental |
| `blocks` | Block children of a page | full |
| `comments` | Comments on a page or block | full |
### API token
#### What You'll Need
| Credential | What it is |
| - | - |
| **Token** | Internal connection token |
> **Info:** **Setup access in Notion.** These steps require **Administrator**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Notion administrator.
* **Workspace Owner** or **Admin** role
* Pages/databases must be explicitly shared with the connection
#### Step 1: Create Connection
1. Go to Notion Creator Dashboard
2. Click **Create a new connection**
3. Fill in:
| Field | Value |
| - | - |
| Name | `Parable` (Notion rejects names containing "Integration") |
| Associated workspace | Select your workspace |
| Logo | Optional |
| Type | Internal |
#### Step 2: Configure Capabilities
Under **Configuration** > **Capabilities**, enable:
| Capability | Setting |
| - | - |
| Read content | ✅ |
| Update content | ❌ (not needed) |
| Insert content | ❌ (not needed) |
| Read comments | ✅ |
| Read user information | ✅ (including email) |
#### Step 3: Copy Token
1. Click **Show** next to the internal integration secret
2. Copy the token
> **Warning:** **Copy your token now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
#### Step 4: Share Content with Connection
The connection can only access pages and databases you explicitly share with it. You need to share each top-level page or database that contains data you want Parable to sync.
For each top-level page or database:
1. Open it in Notion
2. Click **•••** (three dots) menu in the top right
3. Click **Add connections**
4. Search for and select **Parable**
> **Tip:** Child pages automatically inherit access from their parent. Share at the highest level that covers the content you need -- for example, sharing a team workspace page gives the connection access to all pages nested underneath it.
> **Warning:** Any page or database not explicitly shared (or nested under a shared parent) will be invisible to the connection.
#### Step 5: Enter values in the form
1. **Token**: Paste your Notion internal connection token.
2. Click **Save & test connection**.
Developer identifier: `blocks`
**Blocks.** Block children of a page.
* **Enables:** Reconstruct visible Notion page content from ordered block records and their nested rich-text fragments.
* **Scope:** Reads the records selected by Notion's `/v1/blocks/{id}/children` operation as a snapshot stream using full synchronization. This stream is opt-in. Only pages and databases explicitly shared with the Notion integration, plus their reachable children, are visible. Rich-text and block payloads represent content visible to the integration; external or uploaded file bytes are not fetched. Removal is recognized from the provider's tombstone state rather than absence alone.
Developer identifier: `blocks.archived`
**Archived.** Whether the block has been archived (deleted). It distinguishes the provider-defined archived state or classification for the block.
* **Enables:** Filter Blocks by whether the block has been archived (deleted) in `blocks.archived`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the block has been archived (deleted) as a boolean on each block; a missing field is unknown, not false.
Developer identifier: `blocks.audio`
**Audio.** Audio block content. Present when type is 'audio'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute audio in `blocks.audio` to the parent block; identify parent records where that nested audio object is absent.
* **Interpretation:** Notion reports audio as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.audio.caption`
**Caption.** Caption for the file. It preserves the nested context needed to interpret the parent block.
* **Enables:** Search the returned caption content in `blocks.FileBlock.caption` while preserving element order and attribution to the parent block.
* **Interpretation:** Notion returns caption as ordered content or provider-generated content metadata on each file block; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `blocks.audio.caption.annotations`
**Annotations.** Styling annotations for the rich text. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute annotations in `blocks.RichTextObject.annotations` to the parent block; identify parent records where that nested annotations object is absent.
* **Interpretation:** Notion reports annotations as a nested object on each rich text object; optional children may be absent from a valid response.
Developer identifier: `blocks.audio.caption.annotations.bold`
**Bold.** Whether the text is bold. It distinguishes the provider-defined bold state or classification for the annotation.
* **Enables:** Filter Blocks by whether the text is bold in `blocks.Annotations.bold`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text is bold as a boolean on each annotation; a missing field is unknown, not false.
Developer identifier: `blocks.audio.caption.annotations.code`
**Code.** Whether the text is displayed as inline code. It distinguishes the provider-defined code state or classification for the annotation.
* **Enables:** Filter Blocks by whether the text is displayed as inline code in `blocks.Annotations.code`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text is displayed as inline code as a boolean on each annotation; a missing field is unknown, not false.
Developer identifier: `blocks.audio.caption.annotations.color`
**Color.** Text color or background color (e.g., 'default', 'red', 'blue\_background'). It supplies the returned color text needed to understand the annotation in context.
* **Enables:** Search the returned color text in `blocks.Annotations.color` and attribute each match to its parent block and reported author when available.
* **Interpretation:** Notion supplies color as returned text on each annotation; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `blocks.audio.caption.annotations.italic`
**Italic.** Whether the text is italic. It distinguishes the provider-defined italic state or classification for the annotation.
* **Enables:** Filter Blocks by whether the text is italic in `blocks.Annotations.italic`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text is italic as a boolean on each annotation; a missing field is unknown, not false.
Developer identifier: `blocks.audio.caption.annotations.strikethrough`
**Strikethrough.** Whether the text has strikethrough. It distinguishes the provider-defined strikethrough state or classification for the annotation.
* **Enables:** Filter Blocks by whether the text has strikethrough in `blocks.Annotations.strikethrough`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text has strikethrough as a boolean on each annotation; a missing field is unknown, not false.
Developer identifier: `blocks.audio.caption.annotations.underline`
**Underline.** Whether the text is underlined. It distinguishes the provider-defined underline state or classification for the annotation.
* **Enables:** Filter Blocks by whether the text is underlined in `blocks.Annotations.underline`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text is underlined as a boolean on each annotation; a missing field is unknown, not false.
Developer identifier: `blocks.audio.caption.equation`
**Equation.** Equation content. Present when type is 'equation'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute equation in `blocks.RichTextObject.equation` to the parent block; identify parent records where that nested equation object is absent.
* **Interpretation:** Notion reports equation as a nested object on each rich text object; optional children may be absent from a valid response.
Developer identifier: `blocks.audio.caption.equation.expression`
**Expression.** The LaTeX/KaTeX expression. It must be interpreted with the enclosing provider field name, type, or custom schema for the equation content.
* **Enables:** Interpret `blocks.EquationContent.expression` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Notion reports expression under the enclosing custom or typed field contract on each equation content; compare it only with values from the same provider key and type.
Developer identifier: `blocks.audio.caption.href`
**Href.** URL link if the text is a link. It locates the provider resource or path associated with the rich text object.
* **Enables:** Associate each rich text object with the resource identified by href in `blocks.RichTextObject.href`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports href as a resource locator for each rich text object; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `blocks.audio.caption.mention`
**Mention.** Mention content. Present when type is 'mention'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute mention in `blocks.RichTextObject.mention` to the parent block; identify parent records where that nested mention object is absent.
* **Interpretation:** Notion reports mention as a nested object on each rich text object; optional children may be absent from a valid response.
Developer identifier: `blocks.audio.caption.mention.database`
**Database.** Database mention. Present when type is 'database'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute database in `blocks.MentionContent.database` to the parent block; identify parent records where that nested database object is absent.
* **Interpretation:** Notion reports database as a nested object on each mention content; optional children may be absent from a valid response.
Developer identifier: `blocks.audio.caption.mention.database.id`
**ID.** The UUID of the referenced object. It provides the reference needed to connect the block to the corresponding provider object.
* **Enables:** Connect each ID reference in Blocks to the referenced ID reference through `blocks.IdReference.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports ID as an identifier in its ID reference namespace; it is not a universal identity outside Notion.
Developer identifier: `blocks.audio.caption.mention.date`
**Date.** Date mention. Present when type is 'date'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute date in `blocks.MentionContent.date` to the parent block; identify parent records where that nested date object is absent.
* **Interpretation:** Notion reports date as a nested object on each mention content; optional children may be absent from a valid response.
Developer identifier: `blocks.audio.caption.mention.date.end`
**End.** End date or datetime in ISO 8601 format, null for single dates. It anchors the block on the provider's reported timeline.
* **Enables:** Filter Blocks by end in `blocks.DateValue.end`; pair that boundary with the corresponding start before measuring elapsed time.
* **Interpretation:** Notion reports end as a timestamp on each date value; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `blocks.audio.caption.mention.date.start`
**Start.** Start date or datetime in ISO 8601 format. It anchors the block on the provider's reported timeline.
* **Enables:** Filter Blocks by start in `blocks.DateValue.start`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** Notion reports start as a timestamp on each date value; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `blocks.audio.caption.mention.date.time_zone`
**Time Zone.** IANA time zone identifier if the date includes a time. It is needed to interpret companion dates and times for the date value in the provider's intended zone.
* **Enables:** Apply the zone in `blocks.DateValue.time_zone` when converting the block's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** Notion reports time zone as a timezone identifier for each date value; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `blocks.audio.caption.mention.link_preview`
**Link Preview.** Link preview mention. Present when type is 'link\_preview'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute link preview in `blocks.MentionContent.link_preview` to the parent block; identify parent records where that nested link preview object is absent.
* **Interpretation:** Notion reports link preview as a nested object on each mention content; optional children may be absent from a valid response.
Developer identifier: `blocks.audio.caption.mention.link_preview.url`
**URL.** The URL being previewed. It locates the provider resource or path associated with the link preview content.
* **Enables:** Associate each link preview content with the resource identified by URL in `blocks.LinkPreviewContent.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each link preview content; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `blocks.audio.caption.mention.page`
**Page.** Page mention. Present when type is 'page'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute page in `blocks.MentionContent.page` to the parent block; identify parent records where that nested page object is absent.
* **Interpretation:** Notion reports page as a nested object on each mention content; optional children may be absent from a valid response.
Developer identifier: `blocks.audio.caption.mention.template_mention`
**Template Mention.** Template mention data. Present when type is 'template\_mention'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute template mention in `blocks.MentionContent.template_mention` to the parent block; identify parent records where that nested template mention object is absent.
* **Interpretation:** Notion reports template mention as a nested object on each mention content; optional children may be absent from a valid response.
Developer identifier: `blocks.audio.caption.mention.type`
**Type.** The type of mention (user, page, database, date, link\_preview, template\_mention). It distinguishes the provider-defined type state or classification for the mention content.
* **Enables:** Segment mention content entries in Blocks by type in `blocks.MentionContent.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each mention content; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `blocks.audio.caption.mention.user`
**User.** User mention. Present when type is 'user'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute user in `blocks.MentionContent.user` to the parent block; identify parent records where that nested user object is absent.
* **Interpretation:** Notion reports user as a nested object on each mention content; optional children may be absent from a valid response.
Developer identifier: `blocks.audio.caption.mention.user.id`
**ID.** UUID of the user. It provides the reference needed to connect the block to the corresponding provider object.
* **Enables:** Connect each partial user in Blocks to the referenced partial user through `blocks.PartialUser.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports ID as an identifier in its partial user namespace; it is not a universal identity outside Notion.
Developer identifier: `blocks.audio.caption.mention.user.object`
**Object.** Always 'user' for user objects. It distinguishes the provider-defined object state or classification for the partial user.
* **Enables:** Filter Blocks by the exact Notion-defined object in `blocks.PartialUser.object` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies object from its own taxonomy on each partial user; preserve unknown and newly introduced labels.
Developer identifier: `blocks.audio.caption.plain_text`
**Plain Text.** Plain text representation without annotations. It defines the content surface available for this block.
* **Enables:** Locate rich text object records by plain text in `blocks.RichTextObject.plain_text`; attribute each text match to its parent block and, when present, its reported author.
* **Interpretation:** Notion returns the visible rich-text or block representation; external and uploaded file bytes are not embedded by this field.
Developer identifier: `blocks.audio.caption.text`
**Text.** Text content. Present when type is 'text'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute text in `blocks.RichTextObject.text` to the parent block; identify parent records where that nested text object is absent.
* **Interpretation:** Notion reports text as a nested object on each rich text object; optional children may be absent from a valid response.
Developer identifier: `blocks.audio.caption.text.content`
**Content.** The actual text content. It defines the content surface available for this block.
* **Enables:** Locate text content records by content in `blocks.TextContent.content`; attribute each text match to its parent block and, when present, its reported author.
* **Interpretation:** Notion returns the visible rich-text or block representation; external and uploaded file bytes are not embedded by this field.
Developer identifier: `blocks.audio.caption.text.link`
**Link.** Optional link object if the text is a hyperlink. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute link in `blocks.TextContent.link` to the parent block; identify parent records where that nested link object is absent.
* **Interpretation:** Notion reports link as a nested object on each text content; optional children may be absent from a valid response.
Developer identifier: `blocks.audio.caption.text.link.url`
**URL.** The URL the text links to. It locates the provider resource or path associated with the link object.
* **Enables:** Associate each link object with the resource identified by URL in `blocks.LinkObject.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each link object; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `blocks.audio.caption.type`
**Type.** The type of rich text (text, mention, equation). It distinguishes the provider-defined type state or classification for the rich text object.
* **Enables:** Segment rich text object entries in Blocks by type in `blocks.RichTextObject.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each rich text object; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `blocks.audio.external`
**External.** External file details. Present when type is 'external'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute external in `blocks.FileBlock.external` to the parent block; identify parent records where that nested external object is absent.
* **Interpretation:** Notion reports external as a nested object on each file block; optional children may be absent from a valid response.
Developer identifier: `blocks.audio.external.url`
**URL.** URL of the external file. It locates the provider resource or path associated with the external file.
* **Enables:** Associate each external file with the resource identified by URL in `blocks.ExternalFile.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each external file; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `blocks.audio.file`
**File.** Notion-hosted file details. Present when type is 'file'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute file in `blocks.FileBlock.file` to the parent block; identify parent records where that nested file object is absent.
* **Interpretation:** Notion reports file as a nested object on each file block; optional children may be absent from a valid response.
Developer identifier: `blocks.audio.file.expiry_time`
**Expiry Time.** ISO 8601 expiration time for the temporary URL. It anchors the block on the provider's reported timeline.
* **Enables:** Order Blocks by expiry time in `blocks.NotionHostedFile.expiry_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports expiry time as a timestamp on each Notion hosted file; timezone and precision follow this API field, and absence is not an inferred event time. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `blocks.audio.file.url`
**URL.** Temporary authenticated URL for the Notion-hosted file. It locates the provider resource or path associated with the Notion hosted file.
* **Enables:** Associate each Notion hosted file with the resource identified by URL in `blocks.NotionHostedFile.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each Notion hosted file; access still depends on viewer permissions and the URL may expire or change. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `blocks.audio.name`
**Name.** Name of the file. It gives the file block a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each file block with name from `blocks.FileBlock.name`; distinguish records that share that display name but have different Notion identifiers.
* **Interpretation:** Notion reports name as display text for each file block; names are mutable and are not stable identities.
Developer identifier: `blocks.audio.type`
**Type.** Whether the file is hosted by Notion ('file') or externally ('external'). It distinguishes the provider-defined type state or classification for the file block.
* **Enables:** Segment file block entries in Blocks by type in `blocks.FileBlock.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each file block; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `blocks.bookmark`
**Bookmark.** Bookmark block content. Present when type is 'bookmark'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute bookmark in `blocks.bookmark` to the parent block; identify parent records where that nested bookmark object is absent.
* **Interpretation:** Notion reports bookmark as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.bookmark.caption`
**Caption.** Caption for the bookmark. It preserves the nested context needed to interpret the parent block.
* **Enables:** Search the returned caption content in `blocks.BookmarkBlock.caption` while preserving element order and attribution to the parent block.
* **Interpretation:** Notion returns caption as ordered content or provider-generated content metadata on each bookmark block; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `blocks.bookmark.url`
**URL.** The bookmarked URL. It locates the provider resource or path associated with the bookmark block.
* **Enables:** Associate each bookmark block with the resource identified by URL in `blocks.BookmarkBlock.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each bookmark block; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `blocks.breadcrumb`
**Breadcrumb.** Breadcrumb block content. Present when type is 'breadcrumb'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute breadcrumb in `blocks.breadcrumb` to the parent block; identify parent records where that nested breadcrumb object is absent.
* **Interpretation:** Notion reports breadcrumb as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.bulleted_list_item`
**Bulleted List Item.** Bulleted list item content. Present when type is 'bulleted\_list\_item'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute bulleted list item in `blocks.bulleted_list_item` to the parent block; identify parent records where that nested bulleted list item object is absent.
* **Interpretation:** Notion reports bulleted list item as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.bulleted_list_item.color`
**Color.** Color of the block text or background. It supplies the returned color text needed to understand the rich text block in context.
* **Enables:** Search the returned color text in `blocks.RichTextBlock.color` and attribute each match to its parent block and reported author when available.
* **Interpretation:** Notion supplies color as returned text on each rich text block; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `blocks.bulleted_list_item.rich_text`
**Rich Text.** Array of rich text objects forming the block content. It preserves the nested context needed to interpret the parent block.
* **Enables:** Search the returned rich text content in `blocks.RichTextBlock.rich_text` while preserving element order and attribution to the parent block.
* **Interpretation:** Notion returns rich text as ordered content or provider-generated content metadata on each rich text block; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `blocks.callout`
**Callout.** Callout block content. Present when type is 'callout'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute callout in `blocks.callout` to the parent block; identify parent records where that nested callout object is absent.
* **Interpretation:** Notion reports callout as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.callout.color`
**Color.** Color of the callout background. It distinguishes the provider-defined color state or classification for the callout block.
* **Enables:** Filter Blocks by the exact Notion-defined color in `blocks.CalloutBlock.color` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies color from its own taxonomy on each callout block; preserve unknown and newly introduced labels.
Developer identifier: `blocks.callout.icon`
**Icon.** The icon displayed in the callout. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute icon in `blocks.CalloutBlock.icon` to the parent block; identify parent records where that nested icon object is absent.
* **Interpretation:** Notion reports icon as a nested object on each callout block; optional children may be absent from a valid response.
Developer identifier: `blocks.callout.icon.emoji`
**Emoji.** The emoji character. Present when type is 'emoji'. It distinguishes the provider-defined emoji state or classification for the icon object.
* **Enables:** Filter Blocks by the exact Notion-defined emoji in `blocks.IconObject.emoji` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies emoji from its own taxonomy on each icon object; preserve unknown and newly introduced labels.
Developer identifier: `blocks.callout.icon.external`
**External.** External file reference. Present when type is 'external'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute external in `blocks.IconObject.external` to the parent block; identify parent records where that nested external object is absent.
* **Interpretation:** Notion reports external as a nested object on each icon object; optional children may be absent from a valid response.
Developer identifier: `blocks.callout.icon.type`
**Type.** The type of icon ('emoji' or 'external'). It distinguishes the provider-defined type state or classification for the icon object.
* **Enables:** Segment icon object entries in Blocks by type in `blocks.IconObject.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each icon object; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `blocks.callout.rich_text`
**Rich Text.** Array of rich text objects forming the callout content. It preserves the nested context needed to interpret the parent block.
* **Enables:** Search the returned rich text content in `blocks.CalloutBlock.rich_text` while preserving element order and attribution to the parent block.
* **Interpretation:** Notion returns rich text as ordered content or provider-generated content metadata on each callout block; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `blocks.child_database`
**Child Database.** Child database block content. Present when type is 'child\_database'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute child database in `blocks.child_database` to the parent block; identify parent records where that nested child database object is absent.
* **Interpretation:** Notion reports child database as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.child_database.title`
**Title.** The title of the child database. It gives the child database block a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each child database block with title from `blocks.ChildDatabaseBlock.title`; distinguish records that share that display name but have different Notion identifiers.
* **Interpretation:** Notion reports title as display text for each child database block; names are mutable and are not stable identities.
Developer identifier: `blocks.child_page`
**Child Page.** Child page block content. Present when type is 'child\_page'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute child page in `blocks.child_page` to the parent block; identify parent records where that nested child page object is absent.
* **Interpretation:** Notion reports child page as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.child_page.title`
**Title.** The title of the child page. It gives the child page block a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each child page block with title from `blocks.ChildPageBlock.title`; distinguish records that share that display name but have different Notion identifiers.
* **Interpretation:** Notion reports title as display text for each child page block; names are mutable and are not stable identities.
Developer identifier: `blocks.code`
**Code.** Code block content. Present when type is 'code'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute code in `blocks.code` to the parent block; identify parent records where that nested code object is absent.
* **Interpretation:** Notion reports code as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.code.caption`
**Caption.** Caption for the code block. It preserves the nested context needed to interpret the parent block.
* **Enables:** Search the returned caption content in `blocks.CodeBlock.caption` while preserving element order and attribution to the parent block.
* **Interpretation:** Notion returns caption as ordered content or provider-generated content metadata on each code block; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `blocks.code.language`
**Language.** Programming language of the code block (e.g., 'javascript', 'python'). It supplies the language profile facet used to reconcile or attribute the code block.
* **Enables:** Reconcile the block's language in `blocks.CodeBlock.language` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Notion reports language as a mutable profile or directory attribute on each code block; it may be absent, shared, or non-unique.
Developer identifier: `blocks.code.rich_text`
**Rich Text.** Array of rich text objects forming the code content. It preserves the nested context needed to interpret the parent block.
* **Enables:** Search the returned rich text content in `blocks.CodeBlock.rich_text` while preserving element order and attribution to the parent block.
* **Interpretation:** Notion returns rich text as ordered content or provider-generated content metadata on each code block; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `blocks.column`
**Column.** Column block content. Present when type is 'column'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute column in `blocks.column` to the parent block; identify parent records where that nested column object is absent.
* **Interpretation:** Notion reports column as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.column_list`
**Column List.** Column list block content. Present when type is 'column\_list'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute column list in `blocks.column_list` to the parent block; identify parent records where that nested column list object is absent.
* **Interpretation:** Notion reports column list as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.created_by`
**Created By.** User who created the block. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute created by in `blocks.created_by` to the parent block; identify parent records where that nested created by object is absent.
* **Interpretation:** Notion reports created by as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.created_time`
**Created Time.** ISO 8601 timestamp when the block was created. It anchors the block on the provider's reported timeline.
* **Enables:** Order Blocks by created time in `blocks.created_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports created time as a timestamp on each block; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `blocks.divider`
**Divider.** Divider block content. Present when type is 'divider'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute divider in `blocks.divider` to the parent block; identify parent records where that nested divider object is absent.
* **Interpretation:** Notion reports divider as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.embed`
**Embed.** Embed block content. Present when type is 'embed'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute embed in `blocks.embed` to the parent block; identify parent records where that nested embed object is absent.
* **Interpretation:** Notion reports embed as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.embed.caption`
**Caption.** Caption for the embed. It preserves the nested context needed to interpret the parent block.
* **Enables:** Search the returned caption content in `blocks.EmbedBlock.caption` while preserving element order and attribution to the parent block.
* **Interpretation:** Notion returns caption as ordered content or provider-generated content metadata on each embed block; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `blocks.embed.url`
**URL.** The URL of the embedded content. It locates the provider resource or path associated with the embed block.
* **Enables:** Associate each embed block with the resource identified by URL in `blocks.EmbedBlock.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each embed block; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `blocks.equation`
**Equation.** Equation block content. Present when type is 'equation'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute equation in `blocks.equation` to the parent block; identify parent records where that nested equation object is absent.
* **Interpretation:** Notion reports equation as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.equation.expression`
**Expression.** The LaTeX/KaTeX expression. It must be interpreted with the enclosing provider field name, type, or custom schema for the equation block.
* **Enables:** Interpret `blocks.EquationBlock.expression` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Notion reports expression under the enclosing custom or typed field contract on each equation block; compare it only with values from the same provider key and type.
Developer identifier: `blocks.file`
**File.** File block content. Present when type is 'file'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute file in `blocks.file` to the parent block; identify parent records where that nested file object is absent.
* **Interpretation:** Notion reports file as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.has_children`
**Has Children.** Whether this block has nested child blocks. It distinguishes the provider-defined has children state or classification for the block.
* **Enables:** Filter Blocks by whether this block has nested child blocks in `blocks.has_children`; count true, false, and missing results separately.
* **Interpretation:** Notion reports this block has nested child blocks as a boolean on each block; a missing field is unknown, not false.
Developer identifier: `blocks.heading_1`
**Heading 1.** Heading 1 block content. Present when type is 'heading\_1'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute heading 1 in `blocks.heading_1` to the parent block; identify parent records where that nested heading 1 object is absent.
* **Interpretation:** Notion reports heading 1 as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.heading_1.color`
**Color.** Color of the heading text or background. It supplies the returned color text needed to understand the heading block in context.
* **Enables:** Search the returned color text in `blocks.HeadingBlock.color` and attribute each match to its parent block and reported author when available.
* **Interpretation:** Notion supplies color as returned text on each heading block; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `blocks.heading_1.is_toggleable`
**Is Toggleable.** Whether the heading can be toggled to show/hide children. It distinguishes the provider-defined is toggleable state or classification for the heading block.
* **Enables:** Filter Blocks by whether the heading can be toggled to show/hide children in `blocks.HeadingBlock.is_toggleable`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the heading can be toggled to show/hide children as a boolean on each heading block; a missing field is unknown, not false.
Developer identifier: `blocks.heading_1.rich_text`
**Rich Text.** Array of rich text objects forming the heading content. It preserves the nested context needed to interpret the parent block.
* **Enables:** Search the returned rich text content in `blocks.HeadingBlock.rich_text` while preserving element order and attribution to the parent block.
* **Interpretation:** Notion returns rich text as ordered content or provider-generated content metadata on each heading block; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `blocks.heading_2`
**Heading 2.** Heading 2 block content. Present when type is 'heading\_2'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute heading 2 in `blocks.heading_2` to the parent block; identify parent records where that nested heading 2 object is absent.
* **Interpretation:** Notion reports heading 2 as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.heading_3`
**Heading 3.** Heading 3 block content. Present when type is 'heading\_3'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute heading 3 in `blocks.heading_3` to the parent block; identify parent records where that nested heading 3 object is absent.
* **Interpretation:** Notion reports heading 3 as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.id`
**ID.** Unique identifier for the block (UUID). It provides the reference needed to connect the block to the corresponding provider object.
* **Enables:** Match repeated block entries on ID in `blocks.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Notion reports ID as an identifier in its block namespace; it is not a universal identity outside Notion. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `blocks.image`
**Image.** Image block content. Present when type is 'image'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute image in `blocks.image` to the parent block; identify parent records where that nested image object is absent.
* **Interpretation:** Notion reports image as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.in_trash`
**In Trash.** Whether the block is in the trash. It distinguishes the provider-defined in trash state or classification for the block.
* **Enables:** Filter Blocks by whether the block is in the trash in `blocks.in_trash`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the block is in the trash as a boolean on each block; a missing field is unknown, not false.
Developer identifier: `blocks.is_locked`
**Is Locked.** Whether the block is locked from edits. It distinguishes the provider-defined is locked state or classification for the block.
* **Enables:** Filter Blocks by whether the block is locked from edits in `blocks.is_locked`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the block is locked from edits as a boolean on each block; a missing field is unknown, not false.
Developer identifier: `blocks.last_edited_by`
**Last Edited By.** User who last edited the block. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute last edited by in `blocks.last_edited_by` to the parent block; identify parent records where that nested last edited by object is absent.
* **Interpretation:** Notion reports last edited by as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.last_edited_time`
**Last Edited Time.** ISO 8601 timestamp when the block was last modified. It anchors the block on the provider's reported timeline.
* **Enables:** Order Blocks by last edited time in `blocks.last_edited_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports last edited time as a timestamp on each block; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `blocks.link_preview`
**Link Preview.** Link preview block content. Present when type is 'link\_preview'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute link preview in `blocks.link_preview` to the parent block; identify parent records where that nested link preview object is absent.
* **Interpretation:** Notion reports link preview as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.link_preview.url`
**URL.** The URL being previewed. It locates the provider resource or path associated with the link preview block.
* **Enables:** Associate each link preview block with the resource identified by URL in `blocks.LinkPreviewBlock.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each link preview block; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `blocks.link_to_page`
**Link To Page.** Link to page block content. Present when type is 'link\_to\_page'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute link to page in `blocks.link_to_page` to the parent block; identify parent records where that nested link to page object is absent.
* **Interpretation:** Notion reports link to page as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.link_to_page.comment_id`
**Comment ID.** The ID of the linked comment. Present when type is 'comment\_id'. It provides the reference needed to connect the block to the corresponding provider object.
* **Enables:** Connect each link to page block in Blocks to the referenced comment through `blocks.LinkToPageBlock.comment_id`; flag comment ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports comment ID as an identifier in its comment namespace; it is not a universal identity outside Notion.
Developer identifier: `blocks.link_to_page.database_id`
**Database ID.** The ID of the linked database. Present when type is 'database\_id'. It provides the reference needed to connect the block to the corresponding provider object.
* **Enables:** Connect each link to page block in Blocks to the referenced database through `blocks.LinkToPageBlock.database_id`; flag database ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports database ID as an identifier in its database namespace; it is not a universal identity outside Notion.
Developer identifier: `blocks.link_to_page.page_id`
**Page ID.** The ID of the linked page. Present when type is 'page\_id'. It provides the reference needed to connect the block to the corresponding provider object.
* **Enables:** Connect each link to page block in Blocks to the referenced page through `blocks.LinkToPageBlock.page_id`; flag page ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports page ID as an identifier in its page namespace; it is not a universal identity outside Notion.
Developer identifier: `blocks.link_to_page.type`
**Type.** The type of link ('page\_id', 'database\_id', or 'comment\_id'). It locates the provider resource or path associated with the link to page block.
* **Enables:** Segment link to page block entries in Blocks by type in `blocks.LinkToPageBlock.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each link to page block; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `blocks.numbered_list_item`
**Numbered List Item.** Numbered list item content. Present when type is 'numbered\_list\_item'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute numbered list item in `blocks.numbered_list_item` to the parent block; identify parent records where that nested numbered list item object is absent.
* **Interpretation:** Notion reports numbered list item as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.object`
**Object.** Always 'block' for block objects. It distinguishes the provider-defined object state or classification for the block.
* **Enables:** Filter Blocks by the exact Notion-defined object in `blocks.object` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies object from its own taxonomy on each block; preserve unknown and newly introduced labels.
Developer identifier: `blocks.page_id`
**Page ID.** Parent page reference copied into each block because the child operation does not return that relationship. It provides the reference needed to connect the block to the corresponding provider object.
* **Enables:** Connect each block in Blocks to the referenced page through `blocks.page_id`; flag page ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies page ID from the parent traversal record into each block; the child Notion operation does not return it.
Developer identifier: `blocks.paragraph`
**Paragraph.** Paragraph block content. Present when type is 'paragraph'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute paragraph in `blocks.paragraph` to the parent block; identify parent records where that nested paragraph object is absent.
* **Interpretation:** Notion reports paragraph as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.parent`
**Parent.** Parent object reference (page\_id, block\_id, database\_id, or workspace). It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute parent in `blocks.parent` to the parent block; identify parent records where that nested parent object is absent.
* **Interpretation:** Notion reports parent as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.parent.block_id`
**Block ID.** The ID of the parent block. Present when type is 'block\_id'. It provides the reference needed to connect the block to the corresponding provider object.
* **Enables:** Connect each block parent in Blocks to the referenced block through `blocks.BlockParent.block_id`; flag block ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports block ID as an identifier in its block namespace; it is not a universal identity outside Notion.
Developer identifier: `blocks.parent.database_id`
**Database ID.** The ID of the parent database. Present when type is 'database\_id'. It provides the reference needed to connect the block to the corresponding provider object.
* **Enables:** Connect each block parent in Blocks to the referenced database through `blocks.BlockParent.database_id`; flag database ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports database ID as an identifier in its database namespace; it is not a universal identity outside Notion.
Developer identifier: `blocks.parent.page_id`
**Page ID.** The ID of the parent page. Present when type is 'page\_id'. It provides the reference needed to connect the block to the corresponding provider object.
* **Enables:** Connect each block parent in Blocks to the referenced page through `blocks.BlockParent.page_id`; flag page ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports page ID as an identifier in its page namespace; it is not a universal identity outside Notion.
Developer identifier: `blocks.parent.type`
**Type.** The type of parent (page\_id, block\_id, database\_id, workspace). It distinguishes the provider-defined type state or classification for the block parent.
* **Enables:** Segment block parent entries in Blocks by type in `blocks.BlockParent.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each block parent; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `blocks.parent.workspace`
**Workspace.** True if the parent is the workspace. Present when type is 'workspace'. It distinguishes the provider-defined workspace state or classification for the block parent.
* **Enables:** Filter Blocks by whether true if the parent is the workspace in `blocks.BlockParent.workspace`; count true, false, and missing results separately.
* **Interpretation:** Notion reports true if the parent is the workspace as a boolean on each block parent; a missing field is unknown, not false.
Developer identifier: `blocks.pdf`
**PDF.** PDF block content. Present when type is 'pdf'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute pdf in `blocks.pdf` to the parent block; identify parent records where that nested pdf object is absent.
* **Interpretation:** Notion reports pdf as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.public_url`
**Public URL.** Public-facing Notion URL for the block, when the block belongs to a shared page. It locates the provider resource or path associated with the block.
* **Enables:** Associate each block with the resource identified by public URL in `blocks.public_url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports public URL as a resource locator for each block; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `blocks.quote`
**Quote.** Quote block content. Present when type is 'quote'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute quote in `blocks.quote` to the parent block; identify parent records where that nested quote object is absent.
* **Interpretation:** Notion reports quote as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.synced_block`
**Synced Block.** Synced block content. Present when type is 'synced\_block'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute synced block in `blocks.synced_block` to the parent block; identify parent records where that nested synced block object is absent.
* **Interpretation:** Notion reports synced block as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.synced_block.synced_from`
**Synced From.** Reference to the original synced block. Null if this is the original. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute synced from in `blocks.SyncedBlock.synced_from` to the parent block; identify parent records where that nested synced from object is absent.
* **Interpretation:** Notion reports synced from as a nested object on each synced block; optional children may be absent from a valid response.
Developer identifier: `blocks.synced_block.synced_from.block_id`
**Block ID.** The ID of the original synced block. It provides the reference needed to connect the block to the corresponding provider object.
* **Enables:** Connect each synced from in Blocks to the referenced block through `blocks.SyncedFrom.block_id`; flag block ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports block ID as an identifier in its block namespace; it is not a universal identity outside Notion.
Developer identifier: `blocks.synced_block.synced_from.type`
**Type.** Always 'block\_id'. It distinguishes the provider-defined type state or classification for the synced from.
* **Enables:** Segment synced from entries in Blocks by type in `blocks.SyncedFrom.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each synced from; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `blocks.table`
**Table.** Table block content. Present when type is 'table'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute table in `blocks.table` to the parent block; identify parent records where that nested table object is absent.
* **Interpretation:** Notion reports table as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.table.has_column_header`
**Has Column Header.** Whether the first row is a header row. It distinguishes the provider-defined has column header state or classification for the table block.
* **Enables:** Filter Blocks by whether the first row is a header row in `blocks.TableBlock.has_column_header`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the first row is a header row as a boolean on each table block; a missing field is unknown, not false.
Developer identifier: `blocks.table.has_row_header`
**Has Row Header.** Whether the first column is a header column. It distinguishes the provider-defined has row header state or classification for the table block.
* **Enables:** Filter Blocks by whether the first column is a header column in `blocks.TableBlock.has_row_header`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the first column is a header column as a boolean on each table block; a missing field is unknown, not false.
Developer identifier: `blocks.table.table_width`
**Table Width.** Number of columns in the table. It supplies the table width measure for the table block at the provider's declared unit and grain.
* **Enables:** Measure table width through `blocks.TableBlock.table_width` for each table block and compare only values with the same unit and record grain.
* **Interpretation:** Notion reports table width as a measure on each table block; compare only records with the same unit and aggregation grain.
Developer identifier: `blocks.table_of_contents`
**Table Of Contents.** Table of contents block content. Present when type is 'table\_of\_contents'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute table of contents in `blocks.table_of_contents` to the parent block; identify parent records where that nested table of contents object is absent.
* **Interpretation:** Notion reports table of contents as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.table_of_contents.color`
**Color.** Color of the table of contents text. It supplies the returned color text needed to understand the table of contents block in context.
* **Enables:** Search the returned color text in `blocks.TableOfContentsBlock.color` and attribute each match to its parent block and reported author when available.
* **Interpretation:** Notion supplies color as returned text on each table of contents block; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `blocks.table_row`
**Table Row.** Table row block content. Present when type is 'table\_row'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute table row in `blocks.table_row` to the parent block; identify parent records where that nested table row object is absent.
* **Interpretation:** Notion reports table row as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.table_row.cells`
**Cells.** Array of cell contents. Each cell is an array of rich text objects. It preserves the nested context needed to interpret the parent block.
* **Enables:** Search the returned cells content in `blocks.TableRowBlock.cells` while preserving element order and attribution to the parent block.
* **Interpretation:** Notion returns cells as ordered content or provider-generated content metadata on each table row block; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `blocks.template`
**Template.** Template block content. Present when type is 'template'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute template in `blocks.template` to the parent block; identify parent records where that nested template object is absent.
* **Interpretation:** Notion reports template as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.to_do`
**To Do.** To-do block content. Present when type is 'to\_do'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute to do in `blocks.to_do` to the parent block; identify parent records where that nested to do object is absent.
* **Interpretation:** Notion reports to do as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.to_do.checked`
**Checked.** Whether the to-do item is checked. It distinguishes the provider-defined checked state or classification for the to do block.
* **Enables:** Filter Blocks by whether the to-do item is checked in `blocks.ToDoBlock.checked`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the to-do item is checked as a boolean on each to do block; a missing field is unknown, not false.
Developer identifier: `blocks.to_do.color`
**Color.** Color of the to-do text or background. It supplies the returned color text needed to understand the to do block in context.
* **Enables:** Search the returned color text in `blocks.ToDoBlock.color` and attribute each match to its parent block and reported author when available.
* **Interpretation:** Notion supplies color as returned text on each to do block; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `blocks.to_do.rich_text`
**Rich Text.** Array of rich text objects forming the to-do content. It preserves the nested context needed to interpret the parent block.
* **Enables:** Search the returned rich text content in `blocks.ToDoBlock.rich_text` while preserving element order and attribution to the parent block.
* **Interpretation:** Notion returns rich text as ordered content or provider-generated content metadata on each to do block; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `blocks.toggle`
**Toggle.** Toggle block content. Present when type is 'toggle'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute toggle in `blocks.toggle` to the parent block; identify parent records where that nested toggle object is absent.
* **Interpretation:** Notion reports toggle as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `blocks.type`
**Type.** The type of block (paragraph, heading\_1, to\_do, etc.). It distinguishes the provider-defined type state or classification for the block.
* **Enables:** Segment block entries in Blocks by type in `blocks.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each block; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `blocks.url`
**URL.** Internal Notion URL for the block, when one is available. It locates the provider resource or path associated with the block.
* **Enables:** Associate each block with the resource identified by URL in `blocks.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each block; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `blocks.video`
**Video.** Video block content. Present when type is 'video'. It preserves the nested context needed to interpret the parent block.
* **Enables:** Attribute video in `blocks.video` to the parent block; identify parent records where that nested video object is absent.
* **Interpretation:** Notion reports video as a nested object on each block; optional children may be absent from a valid response.
Developer identifier: `comments`
**Comments.** Comments on a page or block.
* **Enables:** Attribute visible comment text to its author, discussion, page or block, and timestamp.
* **Scope:** Reads the records selected by Notion's `/v1/comments` operation as a snapshot stream using full synchronization. This stream is opt-in. Only pages and databases explicitly shared with the Notion integration, plus their reachable children, are visible. Comment rich text is included, but referenced file bytes and unshared page content are not. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `comments.attachments`
**Attachments.** Files attached to the comment (2026 Notion API). It preserves the nested context needed to interpret the parent comment.
* **Enables:** Associate each returned Notion comment attachment metadata entry in `comments.attachments` with the parent comment; inventory the reference without assuming file, recording, or attachment bytes are present.
* **Interpretation:** Notion returns attachments as file, recording, or attachment metadata on each comment; the array does not imply that binary content was collected. This field is metadata or a reference for the file or attachment; it does not by itself include binary content.
Developer identifier: `comments.attachments.category`
**Category.** Attachment category, e.g. 'audio', 'image', 'pdf', 'video'. It identifies the file, document, recording, or attachment metadata associated with the Notion comment attachment.
* **Enables:** Segment Notion comment attachment entries in Comments by category in `comments.NotionCommentAttachment.category`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports category as a label from its own taxonomy on each Notion comment attachment; preserve unknown labels rather than mapping them by assumption. This field is metadata or a reference for the file or attachment; it does not by itself include binary content.
Developer identifier: `comments.attachments.file`
**File.** The attached Notion-hosted file with a temporary signed URL. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute file in `comments.NotionCommentAttachment.file` to the parent comment; identify parent records where that nested file object is absent.
* **Interpretation:** Notion reports file as a nested object on each Notion comment attachment; optional children may be absent from a valid response.
Developer identifier: `comments.attachments.file.expiry_time`
**Expiry Time.** ISO 8601 expiration time for the signed URL. It anchors the comment on the provider's reported timeline.
* **Enables:** Order Comments by expiry time in `comments.NotionCommentAttachment.file.expiry_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports expiry time as a timestamp on each file; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `comments.attachments.file.url`
**URL.** Temporary signed URL for the attached file. It locates the provider resource or path associated with the file.
* **Enables:** Associate each file with the resource identified by URL in `comments.NotionCommentAttachment.file.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each file; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `comments.created_by`
**Created By.** The user who created the comment. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute created by in `comments.created_by` to the parent comment; identify parent records where that nested created by object is absent.
* **Interpretation:** Notion reports created by as a nested object on each comment; optional children may be absent from a valid response.
Developer identifier: `comments.created_by.id`
**ID.** UUID of the user. It provides the reference needed to connect the comment to the corresponding provider object.
* **Enables:** Connect each partial user in Comments to the referenced partial user through `comments.PartialUser.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports ID as an identifier in its partial user namespace; it is not a universal identity outside Notion.
Developer identifier: `comments.created_by.object`
**Object.** Always 'user' for user objects. It distinguishes the provider-defined object state or classification for the partial user.
* **Enables:** Filter Comments by the exact Notion-defined object in `comments.PartialUser.object` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies object from its own taxonomy on each partial user; preserve unknown and newly introduced labels.
Developer identifier: `comments.created_time`
**Created Time.** ISO 8601 timestamp of when the comment was created. It anchors the comment on the provider's reported timeline.
* **Enables:** Order Comments by created time in `comments.created_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports created time as a timestamp on each comment; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `comments.discussion_id`
**Discussion ID.** The discussion thread UUID this comment belongs to. Groups comments into conversation threads. It provides the reference needed to connect the comment to the corresponding provider object.
* **Enables:** Connect each comment in Comments to the referenced discussion through `comments.discussion_id`; flag discussion ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports discussion ID as an identifier in its discussion namespace; it is not a universal identity outside Notion.
Developer identifier: `comments.display_name`
**Display Name.** Display name of the comment author, present for comments authored via public API integrations (2026 Notion API). It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute display name in `comments.display_name` to the parent comment; identify parent records where that nested display name object is absent.
* **Interpretation:** Notion reports display name as a nested object on each comment; optional children may be absent from a valid response.
Developer identifier: `comments.display_name.custom`
**Custom.** Custom display name payload, present when type is 'custom'. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute custom in `comments.display_name.custom` to the parent comment; identify parent records where that nested custom object is absent.
* **Interpretation:** Notion reports custom as a nested object on each display name; optional children may be absent from a valid response.
Developer identifier: `comments.display_name.resolved_name`
**Resolved Name.** The resolved display name text. It supplies the returned resolved name text needed to understand the display name in context.
* **Enables:** Label each display name with resolved name from `comments.display_name.resolved_name`; distinguish records that share that display name but have different Notion identifiers.
* **Interpretation:** Notion reports resolved name as display text for each display name; names are mutable and are not stable identities.
Developer identifier: `comments.display_name.type`
**Type.** Source of the display name: 'user', 'integration', or 'custom'. It distinguishes the provider-defined type state or classification for the display name.
* **Enables:** Segment display name entries in Comments by type in `comments.display_name.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each display name; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `comments.id`
**ID.** Unique identifier (UUID) for the comment. It provides the reference needed to connect the comment to the corresponding provider object.
* **Enables:** Match repeated comment entries on ID in `comments.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Notion reports ID as an identifier in its comment namespace; it is not a universal identity outside Notion. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `comments.last_edited_time`
**Last Edited Time.** ISO 8601 timestamp of when the comment was last edited. It anchors the comment on the provider's reported timeline.
* **Enables:** Order Comments by last edited time in `comments.last_edited_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports last edited time as a timestamp on each comment; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `comments.object`
**Object.** Always 'comment' for comment objects. It supplies the returned object text needed to understand the comment in context.
* **Enables:** Search the returned object text in `comments.object` and attribute each match to its parent comment and reported author when available.
* **Interpretation:** Notion supplies object as returned text on each comment; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `comments.page_id`
**Page ID.** Parent page reference copied into each comment because the child operation does not return that relationship. It provides the reference needed to connect the comment to the corresponding provider object.
* **Enables:** Connect each comment in Comments to the referenced page through `comments.page_id`; flag page ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies page ID from the parent traversal record into each comment; the child Notion operation does not return it.
Developer identifier: `comments.parent`
**Parent.** Parent reference indicating which page or block the comment is attached to. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute parent in `comments.parent` to the parent comment; identify parent records where that nested parent object is absent.
* **Interpretation:** Notion reports parent as a nested object on each comment; optional children may be absent from a valid response.
Developer identifier: `comments.parent.block_id`
**Block ID.** The UUID of the parent block, present when type is 'block\_id'. It provides the reference needed to connect the comment to the corresponding provider object.
* **Enables:** Connect each comment parent in Comments to the referenced block through `comments.CommentParent.block_id`; flag block ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports block ID as an identifier in its block namespace; it is not a universal identity outside Notion.
Developer identifier: `comments.parent.page_id`
**Page ID.** The UUID of the parent page, present when type is 'page\_id'. It provides the reference needed to connect the comment to the corresponding provider object.
* **Enables:** Connect each comment parent in Comments to the referenced page through `comments.CommentParent.page_id`; flag page ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports page ID as an identifier in its page namespace; it is not a universal identity outside Notion.
Developer identifier: `comments.parent.type`
**Type.** The type of parent: 'page\_id' or 'block\_id'. It distinguishes the provider-defined type state or classification for the comment parent.
* **Enables:** Segment comment parent entries in Comments by type in `comments.CommentParent.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each comment parent; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `comments.rich_text`
**Rich Text.** The comment content as an array of rich text objects. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Search the returned rich text content in `comments.rich_text` while preserving element order and attribution to the parent comment.
* **Interpretation:** Notion returns rich text as ordered content or provider-generated content metadata on each comment; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `comments.rich_text.annotations`
**Annotations.** Style annotations applied to this rich text segment. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute annotations in `comments.RichText.annotations` to the parent comment; identify parent records where that nested annotations object is absent.
* **Interpretation:** Notion reports annotations as a nested object on each rich text; optional children may be absent from a valid response.
Developer identifier: `comments.rich_text.annotations.bold`
**Bold.** Whether the text is bold. It distinguishes the provider-defined bold state or classification for the rich text annotation.
* **Enables:** Filter Comments by whether the text is bold in `comments.RichTextAnnotations.bold`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text is bold as a boolean on each rich text annotation; a missing field is unknown, not false.
Developer identifier: `comments.rich_text.annotations.code`
**Code.** Whether the text is displayed as inline code. It distinguishes the provider-defined code state or classification for the rich text annotation.
* **Enables:** Filter Comments by whether the text is displayed as inline code in `comments.RichTextAnnotations.code`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text is displayed as inline code as a boolean on each rich text annotation; a missing field is unknown, not false.
Developer identifier: `comments.rich_text.annotations.color`
**Color.** The color of the text or its background. It distinguishes the provider-defined color state or classification for the rich text annotation.
* **Enables:** Segment rich text annotation entries in Comments by color in `comments.RichTextAnnotations.color`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports color as a label from its own taxonomy on each rich text annotation; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `comments.rich_text.annotations.italic`
**Italic.** Whether the text is italic. It distinguishes the provider-defined italic state or classification for the rich text annotation.
* **Enables:** Filter Comments by whether the text is italic in `comments.RichTextAnnotations.italic`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text is italic as a boolean on each rich text annotation; a missing field is unknown, not false.
Developer identifier: `comments.rich_text.annotations.strikethrough`
**Strikethrough.** Whether the text has strikethrough. It distinguishes the provider-defined strikethrough state or classification for the rich text annotation.
* **Enables:** Filter Comments by whether the text has strikethrough in `comments.RichTextAnnotations.strikethrough`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text has strikethrough as a boolean on each rich text annotation; a missing field is unknown, not false.
Developer identifier: `comments.rich_text.annotations.underline`
**Underline.** Whether the text is underlined. It distinguishes the provider-defined underline state or classification for the rich text annotation.
* **Enables:** Filter Comments by whether the text is underlined in `comments.RichTextAnnotations.underline`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text is underlined as a boolean on each rich text annotation; a missing field is unknown, not false.
Developer identifier: `comments.rich_text.equation`
**Equation.** Equation data. Present when type is 'equation'. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute equation in `comments.RichText.equation` to the parent comment; identify parent records where that nested equation object is absent.
* **Interpretation:** Notion reports equation as a nested object on each rich text; optional children may be absent from a valid response.
Developer identifier: `comments.rich_text.equation.expression`
**Expression.** The LaTeX/KaTeX expression string. It must be interpreted with the enclosing provider field name, type, or custom schema for the rich text equation.
* **Enables:** Interpret `comments.RichTextEquation.expression` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Notion reports expression under the enclosing custom or typed field contract on each rich text equation; compare it only with values from the same provider key and type.
Developer identifier: `comments.rich_text.href`
**Href.** URL of any inline link in this rich text segment, if present. It locates the provider resource or path associated with the rich text.
* **Enables:** Associate each rich text with the resource identified by href in `comments.RichText.href`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports href as a resource locator for each rich text; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `comments.rich_text.mention`
**Mention.** Mention data. Present when type is 'mention'. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute mention in `comments.RichText.mention` to the parent comment; identify parent records where that nested mention object is absent.
* **Interpretation:** Notion reports mention as a nested object on each rich text; optional children may be absent from a valid response.
Developer identifier: `comments.rich_text.mention.database`
**Database.** Mentioned database. Present when type is 'database'. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute database in `comments.RichTextMention.database` to the parent comment; identify parent records where that nested database object is absent.
* **Interpretation:** Notion reports database as a nested object on each rich text mention; optional children may be absent from a valid response.
Developer identifier: `comments.rich_text.mention.database.id`
**ID.** UUID of the referenced page or database. It provides the reference needed to connect the comment to the corresponding provider object.
* **Enables:** Connect each mention reference in Comments to the referenced mention reference through `comments.MentionReference.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports ID as an identifier in its mention reference namespace; it is not a universal identity outside Notion.
Developer identifier: `comments.rich_text.mention.date`
**Date.** Date mention. Present when type is 'date'. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute date in `comments.RichTextMention.date` to the parent comment; identify parent records where that nested date object is absent.
* **Interpretation:** Notion reports date as a nested object on each rich text mention; optional children may be absent from a valid response.
Developer identifier: `comments.rich_text.mention.date.end`
**End.** End date or datetime in ISO 8601 format, null for single dates. It anchors the comment on the provider's reported timeline.
* **Enables:** Filter Comments by end in `comments.MentionDate.end`; pair that boundary with the corresponding start before measuring elapsed time.
* **Interpretation:** Notion reports end as a timestamp on each mention date; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `comments.rich_text.mention.date.start`
**Start.** Start date or datetime in ISO 8601 format. It anchors the comment on the provider's reported timeline.
* **Enables:** Filter Comments by start in `comments.MentionDate.start`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** Notion reports start as a timestamp on each mention date; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `comments.rich_text.mention.date.time_zone`
**Time Zone.** IANA time zone, if applicable. It is needed to interpret companion dates and times for the mention date in the provider's intended zone.
* **Enables:** Apply the zone in `comments.MentionDate.time_zone` when converting the comment's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** Notion reports time zone as a timezone identifier for each mention date; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `comments.rich_text.mention.link_preview`
**Link Preview.** Link preview mention. Present when type is 'link\_preview'. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute link preview in `comments.RichTextMention.link_preview` to the parent comment; identify parent records where that nested link preview object is absent.
* **Interpretation:** Notion reports link preview as a nested object on each rich text mention; optional children may be absent from a valid response.
Developer identifier: `comments.rich_text.mention.link_preview.url`
**URL.** The URL being previewed. It locates the provider resource or path associated with the mention link preview.
* **Enables:** Associate each mention link preview with the resource identified by URL in `comments.MentionLinkPreview.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each mention link preview; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `comments.rich_text.mention.page`
**Page.** Mentioned page. Present when type is 'page'. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute page in `comments.RichTextMention.page` to the parent comment; identify parent records where that nested page object is absent.
* **Interpretation:** Notion reports page as a nested object on each rich text mention; optional children may be absent from a valid response.
Developer identifier: `comments.rich_text.mention.type`
**Type.** The type of mention. It distinguishes the provider-defined type state or classification for the rich text mention.
* **Enables:** Segment rich text mention entries in Comments by type in `comments.RichTextMention.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each rich text mention; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `comments.rich_text.mention.user`
**User.** Mentioned user. Present when type is 'user'. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute user in `comments.RichTextMention.user` to the parent comment; identify parent records where that nested user object is absent.
* **Interpretation:** Notion reports user as a nested object on each rich text mention; optional children may be absent from a valid response.
Developer identifier: `comments.rich_text.plain_text`
**Plain Text.** Plain text representation of this rich text segment without formatting. It defines the content surface available for this comment.
* **Enables:** Locate rich text records by plain text in `comments.RichText.plain_text`; attribute each text match to its parent comment and, when present, its reported author.
* **Interpretation:** Notion returns the visible rich-text or block representation; external and uploaded file bytes are not embedded by this field.
Developer identifier: `comments.rich_text.text`
**Text.** Text content and optional link. Present when type is 'text'. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute text in `comments.RichText.text` to the parent comment; identify parent records where that nested text object is absent.
* **Interpretation:** Notion reports text as a nested object on each rich text; optional children may be absent from a valid response.
Developer identifier: `comments.rich_text.text.content`
**Content.** The actual text content. It defines the content surface available for this comment.
* **Enables:** Locate rich text text records by content in `comments.RichTextText.content`; attribute each text match to its parent comment and, when present, its reported author.
* **Interpretation:** Notion returns the visible rich-text or block representation; external and uploaded file bytes are not embedded by this field.
Developer identifier: `comments.rich_text.text.link`
**Link.** Optional inline link object. It preserves the nested context needed to interpret the parent comment.
* **Enables:** Attribute link in `comments.RichTextText.link` to the parent comment; identify parent records where that nested link object is absent.
* **Interpretation:** Notion reports link as a nested object on each rich text text; optional children may be absent from a valid response.
Developer identifier: `comments.rich_text.text.link.url`
**URL.** The URL the text links to. It locates the provider resource or path associated with the rich text link.
* **Enables:** Associate each rich text link with the resource identified by URL in `comments.RichTextLink.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each rich text link; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `comments.rich_text.type`
**Type.** The type of rich text: text, mention, or equation. It distinguishes the provider-defined type state or classification for the rich text.
* **Enables:** Segment rich text entries in Comments by type in `comments.RichText.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each rich text; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `database_items`
**Database Items.** Items (pages) within a data source.
* **Enables:** Match each data-source page to its parent data source and compare provider-defined property values and lifecycle timestamps.
* **Scope:** Reads the records selected by Notion's `/v1/data_sources/{id}/query` operation as a snapshot stream using incremental synchronization. This stream is opt-in. Only pages and databases explicitly shared with the Notion integration, plus their reachable children, are visible. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. Removal is recognized from the provider's tombstone state rather than absence alone.
Developer identifier: `database_items.archived`
**Archived.** Whether the item is archived (completed or removed). It distinguishes the provider-defined archived state or classification for the database item.
* **Enables:** Filter Database Items by whether the item is archived (completed or removed) in `database_items.archived`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the item is archived (completed or removed) as a boolean on each database item; a missing field is unknown, not false.
Developer identifier: `database_items.cover`
**Cover.** Cover image for the page, or null if none. It preserves the nested context needed to interpret the parent database item.
* **Enables:** Attribute cover in `database_items.cover` to the parent database item; identify parent records where that nested cover object is absent.
* **Interpretation:** Notion reports cover as a nested object on each database item; optional children may be absent from a valid response.
Developer identifier: `database_items.cover.external`
**External.** External file details, present when type is 'external'. It preserves the nested context needed to interpret the parent database item.
* **Enables:** Attribute external in `database_items.FileObject.external` to the parent database item; identify parent records where that nested external object is absent.
* **Interpretation:** Notion reports external as a nested object on each file object; optional children may be absent from a valid response. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `database_items.cover.external.url`
**URL.** URL of the external file. It locates the provider resource or path associated with the external file.
* **Enables:** Associate each external file with the resource identified by URL in `database_items.ExternalFile.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each external file; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `database_items.cover.file`
**File.** Notion-hosted file details, present when type is 'file'. It preserves the nested context needed to interpret the parent database item.
* **Enables:** Attribute file in `database_items.FileObject.file` to the parent database item; identify parent records where that nested file object is absent.
* **Interpretation:** Notion reports file as a nested object on each file object; optional children may be absent from a valid response. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `database_items.cover.file.expiry_time`
**Expiry Time.** ISO 8601 expiration time for the signed URL. It anchors the database item on the provider's reported timeline.
* **Enables:** Order Database Items by expiry time in `database_items.NotionHostedFile.expiry_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports expiry time as a timestamp on each Notion hosted file; timezone and precision follow this API field, and absence is not an inferred event time. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `database_items.cover.file.url`
**URL.** Temporary signed URL for the Notion-hosted file. It locates the provider resource or path associated with the Notion hosted file.
* **Enables:** Associate each Notion hosted file with the resource identified by URL in `database_items.NotionHostedFile.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each Notion hosted file; access still depends on viewer permissions and the URL may expire or change. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `database_items.cover.type`
**Type.** The type of file: 'external' or 'file' (Notion-hosted). It distinguishes the provider-defined type state or classification for the file object.
* **Enables:** Segment file object entries in Database Items by type in `database_items.FileObject.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each file object; preserve unknown labels rather than mapping them by assumption. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `database_items.created_by`
**Created By.** User who created the item. It preserves the nested context needed to interpret the parent database item.
* **Enables:** Attribute created by in `database_items.created_by` to the parent database item; identify parent records where that nested created by object is absent.
* **Interpretation:** Notion reports created by as a nested object on each database item; optional children may be absent from a valid response.
Developer identifier: `database_items.created_by.id`
**ID.** UUID of the user. It provides the reference needed to connect the database item to the corresponding provider object.
* **Enables:** Connect each partial user in Database Items to the referenced partial user through `database_items.PartialUser.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports ID as an identifier in its partial user namespace; it is not a universal identity outside Notion.
Developer identifier: `database_items.created_by.object`
**Object.** Always 'user' for user objects. It distinguishes the provider-defined object state or classification for the partial user.
* **Enables:** Filter Database Items by the exact Notion-defined object in `database_items.PartialUser.object` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies object from its own taxonomy on each partial user; preserve unknown and newly introduced labels.
Developer identifier: `database_items.created_time`
**Created Time.** ISO 8601 timestamp when the item was created. It anchors the database item on the provider's reported timeline.
* **Enables:** Order Database Items by created time in `database_items.created_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports created time as a timestamp on each database item; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `database_items.data_source_id`
**Data Source ID.** Parent data source reference copied into each database item because the child operation does not return that relationship. It provides the reference needed to connect the database item to the corresponding provider object.
* **Enables:** Connect each database item in Database Items to the referenced data source through `database_items.data_source_id`; flag data source ID values that do not resolve in that provider namespace.
* **Interpretation:** Parable copies data source ID from the parent traversal record into each database item; the child Notion operation does not return it.
Developer identifier: `database_items.icon`
**Icon.** Icon for the page (emoji or file), or null if none. It preserves the nested context needed to interpret the parent database item.
* **Enables:** Attribute icon in `database_items.icon` to the parent database item; identify parent records where that nested icon object is absent.
* **Interpretation:** Notion reports icon as a nested object on each database item; optional children may be absent from a valid response.
Developer identifier: `database_items.icon.emoji`
**Emoji.** Emoji character, present when type is 'emoji'. It distinguishes the provider-defined emoji state or classification for the icon object.
* **Enables:** Filter Database Items by the exact Notion-defined emoji in `database_items.IconObject.emoji` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies emoji from its own taxonomy on each icon object; preserve unknown and newly introduced labels.
Developer identifier: `database_items.icon.external`
**External.** External file details, present when type is 'external'. It preserves the nested context needed to interpret the parent database item.
* **Enables:** Attribute external in `database_items.IconObject.external` to the parent database item; identify parent records where that nested external object is absent.
* **Interpretation:** Notion reports external as a nested object on each icon object; optional children may be absent from a valid response.
Developer identifier: `database_items.icon.file`
**File.** Notion-hosted file details, present when type is 'file'. It preserves the nested context needed to interpret the parent database item.
* **Enables:** Attribute file in `database_items.IconObject.file` to the parent database item; identify parent records where that nested file object is absent.
* **Interpretation:** Notion reports file as a nested object on each icon object; optional children may be absent from a valid response.
Developer identifier: `database_items.icon.type`
**Type.** The type of icon: 'emoji', 'external', or 'file'. It distinguishes the provider-defined type state or classification for the icon object.
* **Enables:** Segment icon object entries in Database Items by type in `database_items.IconObject.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each icon object; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `database_items.id`
**ID.** Unique identifier for the database item (page). It provides the reference needed to connect the database item to the corresponding provider object.
* **Enables:** Match repeated database item entries on ID in `database_items.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Notion reports ID as an identifier in its database item namespace; it is not a universal identity outside Notion. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `database_items.in_trash`
**In Trash.** Whether the item is in the trash. It distinguishes the provider-defined in trash state or classification for the database item.
* **Enables:** Filter Database Items by whether the item is in the trash in `database_items.in_trash`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the item is in the trash as a boolean on each database item; a missing field is unknown, not false.
Developer identifier: `database_items.last_edited_by`
**Last Edited By.** User who last edited the item. It preserves the nested context needed to interpret the parent database item.
* **Enables:** Attribute last edited by in `database_items.last_edited_by` to the parent database item; identify parent records where that nested last edited by object is absent.
* **Interpretation:** Notion reports last edited by as a nested object on each database item; optional children may be absent from a valid response.
Developer identifier: `database_items.last_edited_time`
**Last Edited Time.** ISO 8601 timestamp when the item was last modified. Used as incremental sync cursor. It anchors the database item on the provider's reported timeline.
* **Enables:** Order Database Items by last edited time in `database_items.last_edited_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports last edited time as a timestamp on each database item; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `database_items.object`
**Object.** Always 'page' for database items. It distinguishes the provider-defined object state or classification for the database item.
* **Enables:** Filter Database Items by the exact Notion-defined object in `database_items.object` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies object from its own taxonomy on each database item; preserve unknown and newly introduced labels.
Developer identifier: `database_items.parent`
**Parent.** Parent reference linking items back to their data source or database container. It preserves the nested context needed to interpret the parent database item.
* **Enables:** Attribute parent in `database_items.parent` to the parent database item; identify parent records where that nested parent object is absent.
* **Interpretation:** Notion reports parent as a nested object on each database item; optional children may be absent from a valid response.
Developer identifier: `database_items.parent.block_id`
**Block ID.** UUID of the parent block, present when type is 'block\_id'. It provides the reference needed to connect the database item to the corresponding provider object.
* **Enables:** Connect each parent in Database Items to the referenced block through `database_items.Parent.block_id`; flag block ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports block ID as an identifier in its block namespace; it is not a universal identity outside Notion.
Developer identifier: `database_items.parent.data_source_id`
**Data Source ID.** UUID of the parent data source, present when type is 'data\_source\_id' (2026 Notion API). It provides the reference needed to connect the database item to the corresponding provider object.
* **Enables:** Connect each parent in Database Items to the referenced data source through `database_items.Parent.data_source_id`; flag data source ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports data source ID as an identifier in its data source namespace; it is not a universal identity outside Notion.
Developer identifier: `database_items.parent.database_id`
**Database ID.** UUID of the parent database, present when type is 'database\_id'. It provides the reference needed to connect the database item to the corresponding provider object.
* **Enables:** Connect each parent in Database Items to the referenced database through `database_items.Parent.database_id`; flag database ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports database ID as an identifier in its database namespace; it is not a universal identity outside Notion.
Developer identifier: `database_items.parent.page_id`
**Page ID.** UUID of the parent page, present when type is 'page\_id'. It provides the reference needed to connect the database item to the corresponding provider object.
* **Enables:** Connect each parent in Database Items to the referenced page through `database_items.Parent.page_id`; flag page ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports page ID as an identifier in its page namespace; it is not a universal identity outside Notion.
Developer identifier: `database_items.parent.type`
**Type.** The type of parent: database\_id, page\_id, workspace, or block\_id. It distinguishes the provider-defined type state or classification for the parent.
* **Enables:** Segment parent entries in Database Items by type in `database_items.Parent.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each parent; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `database_items.parent.workspace`
**Workspace.** True when the parent is the workspace (type is 'workspace'). It distinguishes the provider-defined workspace state or classification for the parent.
* **Enables:** Filter Database Items by whether true when the parent is the workspace (type is 'workspace') in `database_items.Parent.workspace`; count true, false, and missing results separately.
* **Interpretation:** Notion reports true when the parent is the workspace (type is 'workspace') as a boolean on each parent; a missing field is unknown, not false.
Developer identifier: `database_items.properties`
**Properties.** All property values for this item. Keys are property names, values are property value objects. Structure is dynamic based on database schema and includes types like title, rich\_text, number, select, multi\_select, status, date, people, checkbox, URL, email, phone\_number, formula, relation, rollup, created\_time, created\_by, last\_edited\_time, last\_edited\_by, unique\_id, verification, and files. It preserves the nested context needed to interpret the parent database item.
* **Enables:** Attribute properties in `database_items.properties` to the parent database item; identify parent records where that nested properties object is absent.
* **Interpretation:** Notion reports properties as a nested object on each database item; optional children may be absent from a valid response.
Developer identifier: `database_items.public_url`
**Public URL.** Public URL if the page is published to the web, or null. It locates the provider resource or path associated with the database item.
* **Enables:** Associate each database item with the resource identified by public URL in `database_items.public_url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports public URL as a resource locator for each database item; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `database_items.request_id`
**Request ID.** Unique ID for the API request that returned this object. It provides the reference needed to connect the database item to the corresponding provider object.
* **Enables:** Connect each database item in Database Items to the referenced request through `database_items.request_id`; flag request ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports request ID as an identifier in its request namespace; it is not a universal identity outside Notion.
Developer identifier: `database_items.url`
**URL.** URL to the item in Notion for deep linking. It locates the provider resource or path associated with the database item.
* **Enables:** Associate each database item with the resource identified by URL in `database_items.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each database item; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `databases`
**Databases.** Databases in the workspace.
* **Enables:** Inventory databases returned by search and connect each one to its parent, title, properties, owners, and data-source references.
* **Scope:** Reads the records selected by Notion's `/v1/search` operation as a snapshot stream using incremental synchronization. Only pages and databases explicitly shared with the Notion integration, plus their reachable children, are visible. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. Removal is recognized from the provider's tombstone state rather than absence alone.
Developer identifier: `databases.archived`
**Archived.** Whether the database is archived (soft-deleted). It distinguishes the provider-defined archived state or classification for the database.
* **Enables:** Filter Databases by whether the database is archived (soft-deleted) in `databases.archived`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the database is archived (soft-deleted) as a boolean on each database; a missing field is unknown, not false.
Developer identifier: `databases.cover`
**Cover.** Cover image of the database, if set. It preserves the nested context needed to interpret the parent database.
* **Enables:** Attribute cover in `databases.cover` to the parent database; identify parent records where that nested cover object is absent.
* **Interpretation:** Notion reports cover as a nested object on each database; optional children may be absent from a valid response.
Developer identifier: `databases.cover.external`
**External.** The structured external details attached to each Notion file in Databases. It preserves the nested context needed to interpret the parent database.
* **Enables:** Attribute external in `databases.NotionFile.external` to the parent database; identify parent records where that nested external object is absent.
* **Interpretation:** Notion reports external as a nested object on each Notion file; optional children may be absent from a valid response. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `databases.cover.external.url`
**URL.** The provider-reported URL for each Notion external file in Databases. It locates the provider resource or path associated with the Notion external file.
* **Enables:** Associate each Notion external file with the resource identified by URL in `databases.NotionExternalFile.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each Notion external file; access still depends on viewer permissions and the URL may expire or change. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `databases.cover.file`
**File.** The structured file details attached to each Notion file in Databases. It preserves the nested context needed to interpret the parent database.
* **Enables:** Attribute file in `databases.NotionFile.file` to the parent database; identify parent records where that nested file object is absent.
* **Interpretation:** Notion reports file as a nested object on each Notion file; optional children may be absent from a valid response. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `databases.cover.file.expiry_time`
**Expiry Time.** The provider-reported expiry time for each Notion hosted file in Databases. It anchors the database on the provider's reported timeline.
* **Enables:** Order Databases by expiry time in `databases.NotionHostedFile.expiry_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports expiry time as a timestamp on each Notion hosted file; timezone and precision follow this API field, and absence is not an inferred event time. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `databases.cover.file.url`
**URL.** The provider-reported URL for each Notion hosted file in Databases. It locates the provider resource or path associated with the Notion hosted file.
* **Enables:** Associate each Notion hosted file with the resource identified by URL in `databases.NotionHostedFile.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each Notion hosted file; access still depends on viewer permissions and the URL may expire or change. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `databases.cover.type`
**Type.** The provider-reported type for each Notion file in Databases. It distinguishes the provider-defined type state or classification for the Notion file.
* **Enables:** Segment Notion file entries in Databases by type in `databases.NotionFile.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each Notion file; preserve unknown labels rather than mapping them by assumption. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `databases.created_by`
**Created By.** User who created the database. It preserves the nested context needed to interpret the parent database.
* **Enables:** Attribute created by in `databases.created_by` to the parent database; identify parent records where that nested created by object is absent.
* **Interpretation:** Notion reports created by as a nested object on each database; optional children may be absent from a valid response.
Developer identifier: `databases.created_by.id`
**ID.** User ID (UUID). It provides the reference needed to connect the database to the corresponding provider object.
* **Enables:** Connect each Notion partial user in Databases to the referenced Notion partial user through `databases.NotionPartialUser.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports ID as an identifier in its Notion partial user namespace; it is not a universal identity outside Notion.
Developer identifier: `databases.created_by.object`
**Object.** Always 'user'. It distinguishes the provider-defined object state or classification for the Notion partial user.
* **Enables:** Filter Databases by the exact Notion-defined object in `databases.NotionPartialUser.object` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies object from its own taxonomy on each Notion partial user; preserve unknown and newly introduced labels.
Developer identifier: `databases.created_time`
**Created Time.** ISO 8601 timestamp when the database was created. It anchors the database on the provider's reported timeline.
* **Enables:** Order Databases by created time in `databases.created_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports created time as a timestamp on each database; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `databases.data_sources`
**Data Sources.** Array of data source references associated with this database (API version 2025-09-03+). It preserves the nested context needed to interpret the parent database.
* **Enables:** Attribute every returned Notion data source reference in `databases.data_sources` to its parent database; keep each relationship distinct and distinguish an absent array from an explicitly empty one.
* **Interpretation:** Notion returns data sources as an array of Notion data source reference entries on each database; missing, empty, and permission-redacted arrays are not equivalent.
Developer identifier: `databases.data_sources.data_source_id`
**Data Source ID.** The provider-reported data source ID for each Notion data source reference in Databases. It provides the reference needed to connect the database to the corresponding provider object.
* **Enables:** Match repeated Notion data source reference entries on data source ID in `databases.NotionDataSourceReference.data_source_id`; it is not a declared deduplication key, so entries stay keyed by their position in the array.
* **Interpretation:** Notion reports data source ID as an identifier in its data source namespace; it is not a universal identity outside Notion.
Developer identifier: `databases.data_sources.type`
**Type.** The provider-reported type for each Notion data source reference in Databases. It identifies the related provider object that gives the Notion data source reference its parent, owner, or container context.
* **Enables:** Segment Notion data source reference entries in Databases by type in `databases.NotionDataSourceReference.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each Notion data source reference; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `databases.database_parent`
**Database Parent.** Grandparent of the data source (the database container's parent), present on data source search results under API 2025-09-03+. It preserves the nested context needed to interpret the parent database.
* **Enables:** Attribute database parent in `databases.database_parent` to the parent database; identify parent records where that nested database parent object is absent.
* **Interpretation:** Notion reports database parent as a nested object on each database; optional children may be absent from a valid response.
Developer identifier: `databases.database_parent.block_id`
**Block ID.** The provider-reported block ID for each Notion parent in Databases. It provides the reference needed to connect the database to the corresponding provider object.
* **Enables:** Connect each Notion parent in Databases to the referenced block through `databases.NotionParent.block_id`; flag block ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports block ID as an identifier in its block namespace; it is not a universal identity outside Notion.
Developer identifier: `databases.database_parent.page_id`
**Page ID.** The provider-reported page ID for each Notion parent in Databases. It provides the reference needed to connect the database to the corresponding provider object.
* **Enables:** Connect each Notion parent in Databases to the referenced page through `databases.NotionParent.page_id`; flag page ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports page ID as an identifier in its page namespace; it is not a universal identity outside Notion.
Developer identifier: `databases.database_parent.type`
**Type.** Type of parent. It identifies the related provider object that gives the Notion parent its parent, owner, or container context.
* **Enables:** Segment Notion parent entries in Databases by type in `databases.NotionParent.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each Notion parent; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `databases.database_parent.workspace`
**Workspace.** The provider-reported workspace for each Notion parent in Databases. It distinguishes the provider-defined workspace state or classification for the Notion parent.
* **Enables:** Filter Databases by whether workspace in `databases.NotionParent.workspace`; count true, false, and missing results separately.
* **Interpretation:** Notion reports workspace as a boolean on each Notion parent; a missing field is unknown, not false.
Developer identifier: `databases.description`
**Description.** Description of the database as an array of rich text objects. It preserves the nested context needed to interpret the parent database.
* **Enables:** Search the returned description content in `databases.description` while preserving element order and attribution to the parent database.
* **Interpretation:** Notion returns description as ordered content or provider-generated content metadata on each database; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `databases.description.annotations`
**Annotations.** Styling annotations. It preserves the nested context needed to interpret the parent database.
* **Enables:** Attribute annotations in `databases.NotionRichText.annotations` to the parent database; identify parent records where that nested annotations object is absent.
* **Interpretation:** Notion reports annotations as a nested object on each Notion rich text; optional children may be absent from a valid response.
Developer identifier: `databases.description.annotations.bold`
**Bold.** The provider-reported bold for each Notion annotations in Databases. It distinguishes the provider-defined bold state or classification for the Notion annotation.
* **Enables:** Filter Databases by whether bold in `databases.NotionAnnotations.bold`; count true, false, and missing results separately.
* **Interpretation:** Notion reports bold as a boolean on each Notion annotation; a missing field is unknown, not false.
Developer identifier: `databases.description.annotations.code`
**Code.** The provider-reported code for each Notion annotations in Databases. It distinguishes the provider-defined code state or classification for the Notion annotation.
* **Enables:** Filter Databases by whether code in `databases.NotionAnnotations.code`; count true, false, and missing results separately.
* **Interpretation:** Notion reports code as a boolean on each Notion annotation; a missing field is unknown, not false.
Developer identifier: `databases.description.annotations.color`
**Color.** The provider-reported color for each Notion annotations in Databases. It distinguishes the provider-defined color state or classification for the Notion annotation.
* **Enables:** Filter Databases by the exact Notion-defined color in `databases.NotionAnnotations.color` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies color from its own taxonomy on each Notion annotation; preserve unknown and newly introduced labels.
Developer identifier: `databases.description.annotations.italic`
**Italic.** The provider-reported italic for each Notion annotations in Databases. It distinguishes the provider-defined italic state or classification for the Notion annotation.
* **Enables:** Filter Databases by whether italic in `databases.NotionAnnotations.italic`; count true, false, and missing results separately.
* **Interpretation:** Notion reports italic as a boolean on each Notion annotation; a missing field is unknown, not false.
Developer identifier: `databases.description.annotations.strikethrough`
**Strikethrough.** The provider-reported strikethrough for each Notion annotations in Databases. It distinguishes the provider-defined strikethrough state or classification for the Notion annotation.
* **Enables:** Filter Databases by whether strikethrough in `databases.NotionAnnotations.strikethrough`; count true, false, and missing results separately.
* **Interpretation:** Notion reports strikethrough as a boolean on each Notion annotation; a missing field is unknown, not false.
Developer identifier: `databases.description.annotations.underline`
**Underline.** The provider-reported underline for each Notion annotations in Databases. It distinguishes the provider-defined underline state or classification for the Notion annotation.
* **Enables:** Filter Databases by whether underline in `databases.NotionAnnotations.underline`; count true, false, and missing results separately.
* **Interpretation:** Notion reports underline as a boolean on each Notion annotation; a missing field is unknown, not false.
Developer identifier: `databases.description.href`
**Href.** URL of any link. It locates the provider resource or path associated with the Notion rich text.
* **Enables:** Associate each Notion rich text with the resource identified by href in `databases.NotionRichText.href`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports href as a resource locator for each Notion rich text; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `databases.description.plain_text`
**Plain Text.** Plain text content without annotations. It defines the content surface available for this database.
* **Enables:** Locate Notion rich text records by plain text in `databases.NotionRichText.plain_text`; attribute each text match to its parent database and, when present, its reported author.
* **Interpretation:** Notion returns the visible rich-text or block representation; external and uploaded file bytes are not embedded by this field.
Developer identifier: `databases.description.type`
**Type.** Type of rich text: 'text', 'mention', 'equation'. It supplies the returned type text needed to understand the Notion rich text in context.
* **Enables:** Segment Notion rich text entries in Databases by type in `databases.NotionRichText.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each Notion rich text; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `databases.icon`
**Icon.** Icon of the database (emoji or file). It preserves the nested context needed to interpret the parent database.
* **Enables:** Attribute icon in `databases.icon` to the parent database; identify parent records where that nested icon object is absent.
* **Interpretation:** Notion reports icon as a nested object on each database; optional children may be absent from a valid response.
Developer identifier: `databases.icon.emoji`
**Emoji.** The provider-reported emoji for each Notion icon in Databases. It distinguishes the provider-defined emoji state or classification for the Notion icon.
* **Enables:** Filter Databases by the exact Notion-defined emoji in `databases.NotionIcon.emoji` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies emoji from its own taxonomy on each Notion icon; preserve unknown and newly introduced labels.
Developer identifier: `databases.icon.external`
**External.** The structured external details attached to each Notion icon in Databases. It preserves the nested context needed to interpret the parent database.
* **Enables:** Attribute external in `databases.NotionIcon.external` to the parent database; identify parent records where that nested external object is absent.
* **Interpretation:** Notion reports external as a nested object on each Notion icon; optional children may be absent from a valid response.
Developer identifier: `databases.icon.file`
**File.** The structured file details attached to each Notion icon in Databases. It preserves the nested context needed to interpret the parent database.
* **Enables:** Attribute file in `databases.NotionIcon.file` to the parent database; identify parent records where that nested file object is absent.
* **Interpretation:** Notion reports file as a nested object on each Notion icon; optional children may be absent from a valid response.
Developer identifier: `databases.icon.type`
**Type.** The provider-reported type for each Notion icon in Databases. It distinguishes the provider-defined type state or classification for the Notion icon.
* **Enables:** Segment Notion icon entries in Databases by type in `databases.NotionIcon.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each Notion icon; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `databases.id`
**ID.** Unique identifier for the data source (UUID format with hyphens). It provides the reference needed to connect the database to the corresponding provider object.
* **Enables:** Match repeated database entries on ID in `databases.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Notion reports ID as an identifier in its database namespace; it is not a universal identity outside Notion. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `databases.in_trash`
**In Trash.** Whether the database is in the trash. It distinguishes the provider-defined in trash state or classification for the database.
* **Enables:** Filter Databases by whether the database is in the trash in `databases.in_trash`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the database is in the trash as a boolean on each database; a missing field is unknown, not false.
Developer identifier: `databases.is_inline`
**Is Inline.** Whether the database is an inline database. It distinguishes the provider-defined is inline state or classification for the database.
* **Enables:** Filter Databases by whether the database is an inline database in `databases.is_inline`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the database is an inline database as a boolean on each database; a missing field is unknown, not false.
Developer identifier: `databases.last_edited_by`
**Last Edited By.** User who last edited the database. It preserves the nested context needed to interpret the parent database.
* **Enables:** Attribute last edited by in `databases.last_edited_by` to the parent database; identify parent records where that nested last edited by object is absent.
* **Interpretation:** Notion reports last edited by as a nested object on each database; optional children may be absent from a valid response.
Developer identifier: `databases.last_edited_time`
**Last Edited Time.** ISO 8601 timestamp when the database was last edited. It anchors the database on the provider's reported timeline.
* **Enables:** Order Databases by last edited time in `databases.last_edited_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports last edited time as a timestamp on each database; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `databases.object`
**Object.** Always 'data\_source' for data source objects returned by search under Notion-Version 2025-09-03+. It distinguishes the provider-defined object state or classification for the database.
* **Enables:** Filter Databases by the exact Notion-defined object in `databases.object` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies object from its own taxonomy on each database; preserve unknown and newly introduced labels.
Developer identifier: `databases.parent`
**Parent.** Immediate parent reference; for data sources this identifies the containing database\_id. It preserves the nested context needed to interpret the parent database.
* **Enables:** Attribute parent in `databases.parent` to the parent database; identify parent records where that nested parent object is absent.
* **Interpretation:** Notion reports parent as a nested object on each database; optional children may be absent from a valid response.
Developer identifier: `databases.properties`
**Properties.** Schema definition of database properties (columns) is a NotionDatabaseProperty. It preserves the nested context needed to interpret the parent database.
* **Enables:** Attribute properties in `databases.properties` to the parent database; identify parent records where that nested properties object is absent.
* **Interpretation:** Notion reports properties as a nested object on each database; optional children may be absent from a valid response.
Developer identifier: `databases.public_url`
**Public URL.** Public URL if the database is published to the web. It locates the provider resource or path associated with the database.
* **Enables:** Associate each database with the resource identified by public URL in `databases.public_url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports public URL as a resource locator for each database; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `databases.title`
**Title.** Title of the database as an array of rich text objects. It preserves the nested context needed to interpret the parent database.
* **Enables:** Search the returned title content in `databases.title` while preserving element order and attribution to the parent database.
* **Interpretation:** Notion returns title as ordered content or provider-generated content metadata on each database; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `databases.url`
**URL.** URL to the database in the Notion UI. It locates the provider resource or path associated with the database.
* **Enables:** Associate each database with the resource identified by URL in `databases.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each database; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `pages`
**Pages.** Pages in the workspace.
* **Enables:** Inventory page metadata and properties, then connect each page to its parent and content-block traversal.
* **Scope:** Reads the records selected by Notion's `/v1/search` operation as a snapshot stream using incremental synchronization. This stream is opt-in. Only pages and databases explicitly shared with the Notion integration, plus their reachable children, are visible. Page records contain metadata and properties; ordered page body content is represented by the separate block stream, and file bytes are not downloaded. Removal is recognized from the provider's tombstone state rather than absence alone.
Developer identifier: `pages.archived`
**Archived.** Whether the object has been archived (soft-deleted). It distinguishes the provider-defined archived state or classification for the page.
* **Enables:** Filter Pages by whether the object has been archived (soft-deleted) in `pages.archived`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the object has been archived (soft-deleted) as a boolean on each page; a missing field is unknown, not false.
Developer identifier: `pages.cover`
**Cover.** Cover image for the page or database, or null if none. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute cover in `pages.cover` to the parent page; identify parent records where that nested cover object is absent.
* **Interpretation:** Notion reports cover as a nested object on each page; optional children may be absent from a valid response.
Developer identifier: `pages.cover.external`
**External.** External file details, present when type is 'external'. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute external in `pages.NotionFile.external` to the parent page; identify parent records where that nested external object is absent.
* **Interpretation:** Notion reports external as a nested object on each Notion file; optional children may be absent from a valid response. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `pages.cover.external.url`
**URL.** URL of the external file. It locates the provider resource or path associated with the Notion external file.
* **Enables:** Associate each Notion external file with the resource identified by URL in `pages.NotionExternalFile.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each Notion external file; access still depends on viewer permissions and the URL may expire or change. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `pages.cover.file`
**File.** Notion-hosted file details, present when type is 'file'. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute file in `pages.NotionFile.file` to the parent page; identify parent records where that nested file object is absent.
* **Interpretation:** Notion reports file as a nested object on each Notion file; optional children may be absent from a valid response. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `pages.cover.file.expiry_time`
**Expiry Time.** ISO 8601 expiration time for the signed URL. It anchors the page on the provider's reported timeline.
* **Enables:** Order Pages by expiry time in `pages.NotionHostedFile.expiry_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports expiry time as a timestamp on each Notion hosted file; timezone and precision follow this API field, and absence is not an inferred event time. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `pages.cover.file.url`
**URL.** Temporary signed URL for the Notion-hosted file. It locates the provider resource or path associated with the Notion hosted file.
* **Enables:** Associate each Notion hosted file with the resource identified by URL in `pages.NotionHostedFile.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each Notion hosted file; access still depends on viewer permissions and the URL may expire or change. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `pages.cover.type`
**Type.** File hosting type: 'external' or 'file'. It distinguishes the provider-defined type state or classification for the Notion file.
* **Enables:** Segment Notion file entries in Pages by type in `pages.NotionFile.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each Notion file; preserve unknown labels rather than mapping them by assumption. This stream treats the file or attachment as metadata and references; binary bytes are not included.
Developer identifier: `pages.created_by`
**Created By.** Partial user object representing who created this object. Foreign-key projection emits created\_by\_id, the id of the `users` row that created the page; the rest of the partial user is not copied into the page row.
* **Enables:** Join `pages.created_by_id` to `users.id` to attribute each page to its creator; identify pages whose creator is absent.
* **Interpretation:** Notion reports created by as a partial user on each page, carrying at least the user's id; the user may be a person or a bot.
Developer identifier: `pages.created_by.avatar_url`
**Avatar URL.** URL of the user's avatar image. It locates the provider resource or path associated with the Notion partial user.
* **Enables:** Associate each Notion partial user with the resource identified by avatar URL in `pages.NotionPartialUser.avatar_url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports avatar URL as a resource locator for each Notion partial user; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `pages.created_by.bot`
**Bot.** Bot-specific details, present when type is 'bot'. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute bot in `pages.NotionPartialUser.bot` to the parent page; identify parent records where that nested bot object is absent.
* **Interpretation:** Notion reports bot as a nested object on each Notion partial user; optional children may be absent from a valid response.
Developer identifier: `pages.created_by.bot.owner`
**Owner.** Owner of the bot integration. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute owner in `pages.NotionBotDetail.owner` to the parent page; identify parent records where that nested owner object is absent.
* **Interpretation:** Notion reports owner as a nested object on each Notion bot detail; optional children may be absent from a valid response.
Developer identifier: `pages.created_by.bot.owner.type`
**Type.** Owner type: 'workspace' or 'user'. It distinguishes the provider-defined type state or classification for the Notion bot owner.
* **Enables:** Segment Notion bot owner entries in Pages by type in `pages.NotionBotOwner.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each Notion bot owner; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `pages.created_by.bot.owner.user`
**User.** User owner if the bot is user-level. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute user in `pages.NotionBotOwner.user` to the parent page; identify parent records where that nested user object is absent.
* **Interpretation:** Notion reports user as a nested object on each Notion bot owner; optional children may be absent from a valid response.
Developer identifier: `pages.created_by.bot.owner.workspace`
**Workspace.** True if the bot is workspace-level. It distinguishes the provider-defined workspace state or classification for the Notion bot owner.
* **Enables:** Filter Pages by whether true if the bot is workspace-level in `pages.NotionBotOwner.workspace`; count true, false, and missing results separately.
* **Interpretation:** Notion reports true if the bot is workspace-level as a boolean on each Notion bot owner; a missing field is unknown, not false.
Developer identifier: `pages.created_by.bot.workspace_name`
**Workspace Name.** Name of the workspace the bot belongs to. It gives the Notion bot detail a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each Notion bot detail with workspace name from `pages.NotionBotDetail.workspace_name`; distinguish records that share that display name but have different Notion identifiers.
* **Interpretation:** Notion reports workspace name as display text for each Notion bot detail; names are mutable and are not stable identities.
Developer identifier: `pages.created_by.id`
**ID.** UUID of the user. It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Connect each Notion partial user in Pages to the referenced Notion partial user through `pages.NotionPartialUser.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports ID as an identifier in its Notion partial user namespace; it is not a universal identity outside Notion.
Developer identifier: `pages.created_by.name`
**Name.** Display name of the user (may not be present in partial references). It gives the Notion partial user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each Notion partial user with name from `pages.NotionPartialUser.name`; distinguish records that share that display name but have different Notion identifiers.
* **Interpretation:** Notion reports name as display text for each Notion partial user; names are mutable and are not stable identities.
Developer identifier: `pages.created_by.object`
**Object.** Always 'user'. It distinguishes the provider-defined object state or classification for the Notion partial user.
* **Enables:** Filter Pages by the exact Notion-defined object in `pages.NotionPartialUser.object` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies object from its own taxonomy on each Notion partial user; preserve unknown and newly introduced labels.
Developer identifier: `pages.created_by.person`
**Person.** Person-specific details, present when type is 'person'. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute person in `pages.NotionPartialUser.person` to the parent page; identify parent records where that nested person object is absent.
* **Interpretation:** Notion reports person as a nested object on each Notion partial user; optional children may be absent from a valid response.
Developer identifier: `pages.created_by.person.email`
**Email.** Email address of the person. It supplies the provider-reported address or location facet for the Notion person detail, not a residency determination.
* **Enables:** Attribute each Notion person detail to a person or account by the exact email in `pages.NotionPersonDetail.email`; identify addresses that do not match the Notion directory.
* **Interpretation:** Notion reports email as an address on each Notion person detail; aliases, casing, and unverified addresses can prevent a one-to-one person match.
Developer identifier: `pages.created_by.type`
**Type.** Type of user: 'person' or 'bot'. It distinguishes the provider-defined type state or classification for the Notion partial user.
* **Enables:** Segment Notion partial user entries in Pages by type in `pages.NotionPartialUser.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each Notion partial user; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `pages.created_time`
**Created Time.** ISO 8601 timestamp when the object was created. It anchors the page on the provider's reported timeline.
* **Enables:** Order Pages by created time in `pages.created_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports created time as a timestamp on each page; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `pages.description`
**Description.** Description rich text array (present on database objects). It preserves the nested context needed to interpret the parent page.
* **Enables:** Search the returned description content in `pages.description` while preserving element order and attribution to the parent page.
* **Interpretation:** Notion returns description as ordered content or provider-generated content metadata on each page; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `pages.description.annotations`
**Annotations.** Styling annotations applied to this text segment. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute annotations in `pages.NotionRichText.annotations` to the parent page; identify parent records where that nested annotations object is absent.
* **Interpretation:** Notion reports annotations as a nested object on each Notion rich text; optional children may be absent from a valid response.
Developer identifier: `pages.description.annotations.bold`
**Bold.** Whether the text is bold. It distinguishes the provider-defined bold state or classification for the Notion annotation.
* **Enables:** Filter Pages by whether the text is bold in `pages.NotionAnnotations.bold`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text is bold as a boolean on each Notion annotation; a missing field is unknown, not false.
Developer identifier: `pages.description.annotations.code`
**Code.** Whether the text is displayed as inline code. It distinguishes the provider-defined code state or classification for the Notion annotation.
* **Enables:** Filter Pages by whether the text is displayed as inline code in `pages.NotionAnnotations.code`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text is displayed as inline code as a boolean on each Notion annotation; a missing field is unknown, not false.
Developer identifier: `pages.description.annotations.color`
**Color.** Text color or background color name (e.g., 'default', 'red', 'blue\_background'). It supplies the returned color text needed to understand the Notion annotation in context.
* **Enables:** Search the returned color text in `pages.NotionAnnotations.color` and attribute each match to its parent page and reported author when available.
* **Interpretation:** Notion supplies color as returned text on each Notion annotation; truncation, formatting, and access boundaries can limit completeness.
Developer identifier: `pages.description.annotations.italic`
**Italic.** Whether the text is italic. It distinguishes the provider-defined italic state or classification for the Notion annotation.
* **Enables:** Filter Pages by whether the text is italic in `pages.NotionAnnotations.italic`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text is italic as a boolean on each Notion annotation; a missing field is unknown, not false.
Developer identifier: `pages.description.annotations.strikethrough`
**Strikethrough.** Whether the text has strikethrough. It distinguishes the provider-defined strikethrough state or classification for the Notion annotation.
* **Enables:** Filter Pages by whether the text has strikethrough in `pages.NotionAnnotations.strikethrough`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text has strikethrough as a boolean on each Notion annotation; a missing field is unknown, not false.
Developer identifier: `pages.description.annotations.underline`
**Underline.** Whether the text is underlined. It distinguishes the provider-defined underline state or classification for the Notion annotation.
* **Enables:** Filter Pages by whether the text is underlined in `pages.NotionAnnotations.underline`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the text is underlined as a boolean on each Notion annotation; a missing field is unknown, not false.
Developer identifier: `pages.description.equation`
**Equation.** Equation details, present when type is 'equation'. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute equation in `pages.NotionRichText.equation` to the parent page; identify parent records where that nested equation object is absent.
* **Interpretation:** Notion reports equation as a nested object on each Notion rich text; optional children may be absent from a valid response.
Developer identifier: `pages.description.equation.expression`
**Expression.** The KaTeX expression string. It must be interpreted with the enclosing provider field name, type, or custom schema for the Notion equation.
* **Enables:** Interpret `pages.NotionEquation.expression` with the enclosing custom field name, declared type, and provider schema; compare only records that share that contract.
* **Interpretation:** Notion reports expression under the enclosing custom or typed field contract on each Notion equation; compare it only with values from the same provider key and type.
Developer identifier: `pages.description.href`
**Href.** URL link if the text is a hyperlink, or null. It locates the provider resource or path associated with the Notion rich text.
* **Enables:** Associate each Notion rich text with the resource identified by href in `pages.NotionRichText.href`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports href as a resource locator for each Notion rich text; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `pages.description.mention`
**Mention.** Mention details, present when type is 'mention'. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute mention in `pages.NotionRichText.mention` to the parent page; identify parent records where that nested mention object is absent.
* **Interpretation:** Notion reports mention as a nested object on each Notion rich text; optional children may be absent from a valid response.
Developer identifier: `pages.description.mention.database`
**Database.** Mentioned database reference. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute database in `pages.NotionMention.database` to the parent page; identify parent records where that nested database object is absent.
* **Interpretation:** Notion reports database as a nested object on each Notion mention; optional children may be absent from a valid response.
Developer identifier: `pages.description.mention.database.id`
**ID.** UUID of the mentioned page. It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Connect each Notion mention object in Pages to the referenced Notion mention object through `pages.NotionMentionObject.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports ID as an identifier in its Notion mention object namespace; it is not a universal identity outside Notion.
Developer identifier: `pages.description.mention.date`
**Date.** Date value, present when type is 'date'. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute date in `pages.NotionMention.date` to the parent page; identify parent records where that nested date object is absent.
* **Interpretation:** Notion reports date as a nested object on each Notion mention; optional children may be absent from a valid response.
Developer identifier: `pages.description.mention.date.end`
**End.** End date (ISO 8601 date or datetime), or null for single dates. It anchors the page on the provider's reported timeline.
* **Enables:** Filter Pages by end in `pages.NotionDateValue.end`; pair that boundary with the corresponding start before measuring elapsed time.
* **Interpretation:** Notion reports end as a timestamp on each Notion date value; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `pages.description.mention.date.start`
**Start.** Start date (ISO 8601 date or datetime). It anchors the page on the provider's reported timeline.
* **Enables:** Filter Pages by start in `pages.NotionDateValue.start`; pair that boundary with the corresponding end before measuring elapsed time.
* **Interpretation:** Notion reports start as a timestamp on each Notion date value; timezone and precision follow this API field, and absence is not an inferred event time.
Developer identifier: `pages.description.mention.date.time_zone`
**Time Zone.** IANA time zone if the date includes a time component. It is needed to interpret companion dates and times for the Notion date value in the provider's intended zone.
* **Enables:** Apply the zone in `pages.NotionDateValue.time_zone` when converting the page's companion start, end, or scheduled timestamps; do not infer it from locale.
* **Interpretation:** Notion reports time zone as a timezone identifier for each Notion date value; supported IANA or provider-specific names and daylight-saving behavior must be preserved.
Developer identifier: `pages.description.mention.link_preview`
**Link Preview.** Link preview details. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute link preview in `pages.NotionMention.link_preview` to the parent page; identify parent records where that nested link preview object is absent.
* **Interpretation:** Notion reports link preview as a nested object on each Notion mention; optional children may be absent from a valid response.
Developer identifier: `pages.description.mention.link_preview.url`
**URL.** URL being previewed. It locates the provider resource or path associated with the Notion link preview.
* **Enables:** Associate each Notion link preview with the resource identified by URL in `pages.NotionLinkPreview.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each Notion link preview; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `pages.description.mention.page`
**Page.** Mentioned page reference. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute page in `pages.NotionMention.page` to the parent page; identify parent records where that nested page object is absent.
* **Interpretation:** Notion reports page as a nested object on each Notion mention; optional children may be absent from a valid response.
Developer identifier: `pages.description.mention.template_mention`
**Template Mention.** Template mention details. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute template mention in `pages.NotionMention.template_mention` to the parent page; identify parent records where that nested template mention object is absent.
* **Interpretation:** Notion reports template mention as a nested object on each Notion mention; optional children may be absent from a valid response.
Developer identifier: `pages.description.mention.template_mention.template_mention_date`
**Template Mention Date.** Template date keyword like 'today' or 'now'. It anchors the page on the provider's reported timeline.
* **Enables:** Order Pages by template mention date in `pages.NotionMentionTemplateMention.template_mention_date` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports template mention date as a calendar date on each Notion mention template mention; its grain is one day and no time of day should be inferred.
Developer identifier: `pages.description.mention.template_mention.template_mention_user`
**Template Mention User.** Template user keyword like 'me'. It supplies the template mention user profile facet used to reconcile or attribute the Notion mention template mention.
* **Enables:** Reconcile the page's template mention user in `pages.NotionMentionTemplateMention.template_mention_user` with its provider profile or directory identity; confirm ambiguous matches with the stable provider ID.
* **Interpretation:** Notion reports template mention user as a mutable profile or directory attribute on each Notion mention template mention; it may be absent, shared, or non-unique.
Developer identifier: `pages.description.mention.template_mention.type`
**Type.** Template mention type: 'template\_mention\_date' or 'template\_mention\_user'. It distinguishes the provider-defined type state or classification for the Notion mention template mention.
* **Enables:** Segment Notion mention template mention entries in Pages by type in `pages.NotionMentionTemplateMention.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each Notion mention template mention; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `pages.description.mention.type`
**Type.** Mention type: 'user', 'page', 'database', 'date', 'link\_preview', 'template\_mention'. It distinguishes the provider-defined type state or classification for the Notion mention.
* **Enables:** Segment Notion mention entries in Pages by type in `pages.NotionMention.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each Notion mention; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `pages.description.mention.user`
**User.** Mentioned user, present when type is 'user'. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute user in `pages.NotionMention.user` to the parent page; identify parent records where that nested user object is absent.
* **Interpretation:** Notion reports user as a nested object on each Notion mention; optional children may be absent from a valid response.
Developer identifier: `pages.description.plain_text`
**Plain Text.** Plain text content without annotations. It defines the content surface available for this page.
* **Enables:** Locate Notion rich text records by plain text in `pages.NotionRichText.plain_text`; attribute each text match to its parent page and, when present, its reported author.
* **Interpretation:** Notion returns the visible rich-text or block representation; external and uploaded file bytes are not embedded by this field.
Developer identifier: `pages.description.text`
**Text.** Text content details, present when type is 'text'. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute text in `pages.NotionRichText.text` to the parent page; identify parent records where that nested text object is absent.
* **Interpretation:** Notion reports text as a nested object on each Notion rich text; optional children may be absent from a valid response.
Developer identifier: `pages.description.text.content`
**Content.** The actual text content. It defines the content surface available for this page.
* **Enables:** Locate Notion text content records by content in `pages.NotionTextContent.content`; attribute each text match to its parent page and, when present, its reported author.
* **Interpretation:** Notion returns the visible rich-text or block representation; external and uploaded file bytes are not embedded by this field.
Developer identifier: `pages.description.text.link`
**Link.** Link object if the text contains a hyperlink, or null. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute link in `pages.NotionTextContent.link` to the parent page; identify parent records where that nested link object is absent.
* **Interpretation:** Notion reports link as a nested object on each Notion text content; optional children may be absent from a valid response.
Developer identifier: `pages.description.text.link.url`
**URL.** URL of the link. It locates the provider resource or path associated with the Notion text content link.
* **Enables:** Associate each Notion text content link with the resource identified by URL in `pages.NotionTextContentLink.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each Notion text content link; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `pages.description.type`
**Type.** Type of rich text: 'text', 'mention', or 'equation'. It distinguishes the provider-defined type state or classification for the Notion rich text.
* **Enables:** Segment Notion rich text entries in Pages by type in `pages.NotionRichText.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each Notion rich text; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `pages.icon`
**Icon.** Icon for the page or database (emoji or file), or null if none. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute icon in `pages.icon` to the parent page; identify parent records where that nested icon object is absent.
* **Interpretation:** Notion reports icon as a nested object on each page; optional children may be absent from a valid response.
Developer identifier: `pages.icon.emoji`
**Emoji.** Emoji character, present when type is 'emoji'. It distinguishes the provider-defined emoji state or classification for the Notion icon.
* **Enables:** Filter Pages by the exact Notion-defined emoji in `pages.NotionIcon.emoji` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies emoji from its own taxonomy on each Notion icon; preserve unknown and newly introduced labels.
Developer identifier: `pages.icon.external`
**External.** External file details, present when type is 'external'. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute external in `pages.NotionIcon.external` to the parent page; identify parent records where that nested external object is absent.
* **Interpretation:** Notion reports external as a nested object on each Notion icon; optional children may be absent from a valid response.
Developer identifier: `pages.icon.file`
**File.** Notion-hosted file details, present when type is 'file'. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute file in `pages.NotionIcon.file` to the parent page; identify parent records where that nested file object is absent.
* **Interpretation:** Notion reports file as a nested object on each Notion icon; optional children may be absent from a valid response.
Developer identifier: `pages.icon.type`
**Type.** Icon type: 'emoji', 'external', or 'file'. It distinguishes the provider-defined type state or classification for the Notion icon.
* **Enables:** Segment Notion icon entries in Pages by type in `pages.NotionIcon.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each Notion icon; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `pages.id`
**ID.** Unique identifier for the page or database (UUID format). It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Match repeated page entries on ID in `pages.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Notion reports ID as an identifier in its page namespace; it is not a universal identity outside Notion. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `pages.in_trash`
**In Trash.** Whether the object is in the trash. It distinguishes the provider-defined in trash state or classification for the page.
* **Enables:** Filter Pages by whether the object is in the trash in `pages.in_trash`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the object is in the trash as a boolean on each page; a missing field is unknown, not false.
Developer identifier: `pages.is_inline`
**Is Inline.** Whether the database is inline (embedded within a page) rather than full-page. It distinguishes the provider-defined is inline state or classification for the page.
* **Enables:** Filter Pages by whether the database is inline (embedded within a page) rather than full-page in `pages.is_inline`; count true, false, and missing results separately.
* **Interpretation:** Notion reports the database is inline (embedded within a page) rather than full-page as a boolean on each page; a missing field is unknown, not false.
Developer identifier: `pages.last_edited_by`
**Last Edited By.** Partial user object representing who last edited this object. Foreign-key projection emits last\_edited\_by\_id, the id of the `users` row that last edited the page; the rest of the partial user is not copied into the page row.
* **Enables:** Join `pages.last_edited_by_id` to `users.id` to attribute each page's latest edit; identify pages whose last editor is absent.
* **Interpretation:** Notion reports last edited by as a partial user on each page, carrying at least the user's id; the user may be a person or a bot.
Developer identifier: `pages.last_edited_time`
**Last Edited Time.** ISO 8601 timestamp when the object was last edited. It anchors the page on the provider's reported timeline.
* **Enables:** Order Pages by last edited time in `pages.last_edited_time` and isolate records inside an exact provider reporting window.
* **Interpretation:** Notion reports last edited time as a timestamp on each page; timezone and precision follow this API field, and absence is not an inferred event time. A connector directive uses this field to order records for latest-state or incremental processing.
Developer identifier: `pages.object`
**Object.** Object type: 'page', 'database', or 'data\_source'. It distinguishes the provider-defined object state or classification for the page.
* **Enables:** Segment page entries in Pages by object in `pages.object`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports object as a label from its own taxonomy on each page; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `pages.parent`
**Parent.** Parent reference indicating where this object lives in the hierarchy. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute parent in `pages.parent` to the parent page; identify parent records where that nested parent object is absent.
* **Interpretation:** Notion reports parent as a nested object on each page; optional children may be absent from a valid response.
Developer identifier: `pages.parent.block_id`
**Block ID.** UUID of the parent block, if type is 'block\_id'. It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Connect each Notion parent in Pages to the referenced block through `pages.NotionParent.block_id`; flag block ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports block ID as an identifier in its block namespace; it is not a universal identity outside Notion.
Developer identifier: `pages.parent.data_source_id`
**Data Source ID.** UUID of the parent data source, if type is 'data\_source\_id' (2026 Notion API). It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Connect each Notion parent in Pages to the referenced data source through `pages.NotionParent.data_source_id`; flag data source ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports data source ID as an identifier in its data source namespace; it is not a universal identity outside Notion.
Developer identifier: `pages.parent.database_id`
**Database ID.** UUID of the parent database, if type is 'database\_id'. It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Connect each Notion parent in Pages to the referenced database through `pages.NotionParent.database_id`; flag database ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports database ID as an identifier in its database namespace; it is not a universal identity outside Notion.
Developer identifier: `pages.parent.page_id`
**Page ID.** UUID of the parent page, if type is 'page\_id'. It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Connect each Notion parent in Pages to the referenced page through `pages.NotionParent.page_id`; flag page ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports page ID as an identifier in its page namespace; it is not a universal identity outside Notion.
Developer identifier: `pages.parent.type`
**Type.** Type of parent: 'database\_id', 'page\_id', 'workspace', or 'block\_id'. It distinguishes the provider-defined type state or classification for the Notion parent.
* **Enables:** Segment Notion parent entries in Pages by type in `pages.NotionParent.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each Notion parent; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `pages.parent.workspace`
**Workspace.** True if the parent is the workspace root. It distinguishes the provider-defined workspace state or classification for the Notion parent.
* **Enables:** Filter Pages by whether true if the parent is the workspace root in `pages.NotionParent.workspace`; count true, false, and missing results separately.
* **Interpretation:** Notion reports true if the parent is the workspace root as a boolean on each Notion parent; a missing field is unknown, not false.
Developer identifier: `pages.properties`
**Properties.** Page properties (title, status, assignee, dates, etc.) or database property schema definitions. Keys are property names, values are property value or definition objects. Is NotionPropertyValue. It preserves the nested context needed to interpret the parent page.
* **Enables:** Attribute properties in `pages.properties` to the parent page; identify parent records where that nested properties object is absent.
* **Interpretation:** Notion reports properties as a nested object on each page; optional children may be absent from a valid response.
Developer identifier: `pages.public_url`
**Public URL.** Public URL if the page is published to the web, or null. It locates the provider resource or path associated with the page.
* **Enables:** Associate each page with the resource identified by public URL in `pages.public_url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports public URL as a resource locator for each page; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `pages.request_id`
**Request ID.** Request ID returned by the API for tracing. It provides the reference needed to connect the page to the corresponding provider object.
* **Enables:** Connect each page in Pages to the referenced request through `pages.request_id`; flag request ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports request ID as an identifier in its request namespace; it is not a universal identity outside Notion.
Developer identifier: `pages.title`
**Title.** Title rich text array (present on database objects). It preserves the nested context needed to interpret the parent page.
* **Enables:** Search the returned title content in `pages.title` while preserving element order and attribution to the parent page.
* **Interpretation:** Notion returns title as ordered content or provider-generated content metadata on each page; truncation, omission, and inaccessible source media can limit completeness.
Developer identifier: `pages.url`
**URL.** URL to the page or database in Notion. It locates the provider resource or path associated with the page.
* **Enables:** Associate each page with the resource identified by URL in `pages.url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports URL as a resource locator for each page; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `users`
**Users.** Workspace users.
* **Enables:** Reconcile Notion people and bots to their identifiers, names, account type, email when visible, and bot-owner context.
* **Scope:** Reads the records selected by Notion's `/v1/users` operation as a snapshot stream using full synchronization. Only pages and databases explicitly shared with the Notion integration, plus their reachable children, are visible. The stream does not include records the credential, parent traversal, configured filters, or provider API omits. A later complete read can treat a previously seen record that is absent as removed.
Developer identifier: `users.avatar_url`
**Avatar URL.** URL of the user's avatar image, or null if not set. It locates the provider resource or path associated with the user.
* **Enables:** Associate each user with the resource identified by avatar URL in `users.avatar_url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports avatar URL as a resource locator for each user; access still depends on viewer permissions and the URL may expire or change. A connector directive maps this field to the person's identity photo.
Developer identifier: `users.bot`
**Bot.** Bot-specific details. Present only when type is 'bot'. It preserves the nested context needed to interpret the parent user.
* **Enables:** Attribute bot in `users.bot` to the parent user; identify parent records where that nested bot object is absent.
* **Interpretation:** Notion reports bot as a nested object on each user; optional children may be absent from a valid response.
Developer identifier: `users.bot.owner`
**Owner.** Information about who owns the bot. It preserves the nested context needed to interpret the parent user.
* **Enables:** Attribute owner in `users.BotDetails.owner` to the parent user; identify parent records where that nested owner object is absent.
* **Interpretation:** Notion reports owner as a nested object on each bot detail; optional children may be absent from a valid response.
Developer identifier: `users.bot.owner.type`
**Type.** The type of owner: 'workspace' or 'user'. It distinguishes the provider-defined type state or classification for the bot owner.
* **Enables:** Segment bot owner entries in Users by type in `users.BotOwner.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each bot owner; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `users.bot.owner.user`
**User.** The user who owns this bot. Present when type is 'user'. It preserves the nested context needed to interpret the parent user.
* **Enables:** Attribute user in `users.BotOwner.user` to the parent user; identify parent records where that nested user object is absent.
* **Interpretation:** Notion reports user as a nested object on each bot owner; optional children may be absent from a valid response.
Developer identifier: `users.bot.owner.user.avatar_url`
**Avatar URL.** URL of the owning user's avatar image. It locates the provider resource or path associated with the bot owner user.
* **Enables:** Associate each bot owner user with the resource identified by avatar URL in `users.BotOwnerUser.avatar_url`; verify the link resolves to the expected Notion object.
* **Interpretation:** Notion reports avatar URL as a resource locator for each bot owner user; access still depends on viewer permissions and the URL may expire or change.
Developer identifier: `users.bot.owner.user.id`
**ID.** Unique identifier of the owning user. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Connect each bot owner user in Users to the referenced bot owner user through `users.BotOwnerUser.id`; flag ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports ID as an identifier in its bot owner user namespace; it is not a universal identity outside Notion.
Developer identifier: `users.bot.owner.user.name`
**Name.** Display name of the owning user. It gives the bot owner user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each bot owner user with name from `users.BotOwnerUser.name`; distinguish records that share that display name but have different Notion identifiers.
* **Interpretation:** Notion reports name as display text for each bot owner user; names are mutable and are not stable identities.
Developer identifier: `users.bot.owner.user.object`
**Object.** Always 'user' for user objects. It distinguishes the provider-defined object state or classification for the bot owner user.
* **Enables:** Filter Users by the exact Notion-defined object in `users.BotOwnerUser.object` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies object from its own taxonomy on each bot owner user; preserve unknown and newly introduced labels.
Developer identifier: `users.bot.owner.user.person`
**Person.** Person details of the owning user, if applicable. It preserves the nested context needed to interpret the parent user.
* **Enables:** Attribute person in `users.BotOwnerUser.person` to the parent user; identify parent records where that nested person object is absent.
* **Interpretation:** Notion reports person as a nested object on each bot owner user; optional children may be absent from a valid response.
Developer identifier: `users.bot.owner.user.person.email`
**Email.** Email address of the person user. It supplies the provider-reported address or location facet for the person detail, not a residency determination.
* **Enables:** Attribute each person detail to a person or account by the exact email in `users.PersonDetails.email`; identify addresses that do not match the Notion directory.
* **Interpretation:** Notion reports email as an address on each person detail; aliases, casing, and unverified addresses can prevent a one-to-one person match. Identity resolution does not read this field: it is the bot owner's address, and a user's own email is `users.person.email`.
Developer identifier: `users.bot.owner.user.type`
**Type.** The type of the owning user (typically 'person'). It distinguishes the provider-defined type state or classification for the bot owner user.
* **Enables:** Segment bot owner user entries in Users by type in `users.BotOwnerUser.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each bot owner user; preserve unknown labels rather than mapping them by assumption.
Developer identifier: `users.bot.owner.workspace`
**Workspace.** True if the bot is owned by the entire workspace. Present when type is 'workspace'. It distinguishes the provider-defined workspace state or classification for the bot owner.
* **Enables:** Filter Users by whether true if the bot is owned by the entire workspace in `users.BotOwner.workspace`; count true, false, and missing results separately.
* **Interpretation:** Notion reports true if the bot is owned by the entire workspace as a boolean on each bot owner; a missing field is unknown, not false.
Developer identifier: `users.bot.workspace_name`
**Workspace Name.** Name of the workspace the bot belongs to. Present for workspace-level bots. It gives the bot detail a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each bot detail with workspace name from `users.BotDetails.workspace_name`; distinguish records that share that display name but have different Notion identifiers.
* **Interpretation:** Notion reports workspace name as display text for each bot detail; names are mutable and are not stable identities.
Developer identifier: `users.id`
**ID.** Unique identifier for the user (UUIDv4). It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Match repeated user entries on ID in `users.id`; collapse only entries that share this declared transform key.
* **Interpretation:** Notion reports ID as an identifier in its user namespace; it is not a universal identity outside Notion. The connector explicitly marks this field as a transform deduplication key. A connector directive maps this field to account identity.
Developer identifier: `users.name`
**Name.** Display name of the user. It gives the user a human-readable provider label while its identifier remains the stable reference.
* **Enables:** Label each user with name from `users.name`; distinguish records that share that display name but have different Notion identifiers.
* **Interpretation:** Notion reports name as display text for each user; names are mutable and are not stable identities. A connector directive maps this field to a person's display name.
Developer identifier: `users.object`
**Object.** Always 'user' for user objects. It distinguishes the provider-defined object state or classification for the user.
* **Enables:** Filter Users by the exact Notion-defined object in `users.object` and preserve unknown values as distinct categories.
* **Interpretation:** Notion supplies object from its own taxonomy on each user; preserve unknown and newly introduced labels.
Developer identifier: `users.person`
**Person.** Person-specific details. Present only when type is 'person'. It preserves the nested context needed to interpret the parent user.
* **Enables:** Attribute person in `users.person` to the parent user; identify parent records where that nested person object is absent.
* **Interpretation:** Notion reports person as a nested object on each user; optional children may be absent from a valid response.
Developer identifier: `users.person.email`
**Email.** Email address of the person user. It supplies the provider-reported address or location facet for the person, not a residency determination.
* **Enables:** Attribute each person to a person or account by the exact email in `users.person.email`; identify addresses that do not match the Notion directory.
* **Interpretation:** Notion reports email as an address on each person; aliases, casing, and unverified addresses can prevent a one-to-one person match. A connector directive maps this field to a person's email identity.
Developer identifier: `users.request_id`
**Request ID.** Request ID returned by the API for tracing purposes. It provides the reference needed to connect the user to the corresponding provider object.
* **Enables:** Connect each user in Users to the referenced request through `users.request_id`; flag request ID values that do not resolve in that provider namespace.
* **Interpretation:** Notion reports request ID as an identifier in its request namespace; it is not a universal identity outside Notion.
Developer identifier: `users.type`
**Type.** Whether the user is a 'person' or 'bot'. It distinguishes the provider-defined type state or classification for the user.
* **Enables:** Segment user entries in Users by type in `users.type`; compare counts only within the same Notion taxonomy.
* **Interpretation:** Notion reports type as a label from its own taxonomy on each user; preserve unknown labels rather than mapping them by assumption.
| Error | Meaning | Solution |
| - | - | - |
| `unauthorized` | Invalid token | Verify token is correct |
| `object_not_found` | No access to object | Share the page/database with the connection |
| `restricted_resource` | Insufficient capabilities | Enable required capability in connection settings |
| `rate_limited` | Too many requests | If this occurs during setup, wait briefly, then click **Save & test connection** again. If this occurs during syncing, Parable retries automatically for a limited time. If the sync still fails, review the connection error before retrying. |
#### Common Issues
#### Connection can't find pages
Content must be explicitly shared with the connection. Go to the page → **•••** → **Add connections** → select **Parable**.
#### Missing user emails
Ensure **Read user information including email addresses** is enabled in connection capabilities.
**[Notion API](https://developers.notion.com/reference)** — Official API reference
**[Integration Guide](https://developers.notion.com/docs/getting-started)** — Getting started guide
# Okta
Source: https://docs.parable.work/plugins/provider-plugins/okta
Sync users, groups, and applications from Okta
Sync users, groups, and applications from Okta.
Connect Parable to Okta for identity, access management, and audit log data.
#### Identity
Users, groups, profiles
#### Security
Audit logs, system events
## Data streams
This Provider Plugin defines 4 data streams.
| Stream | Description | Sync |
| - | - | - |
| `users` | Okta org users | incremental |
| `audit_logs` | Okta System Log events | incremental |
| `applications` | Okta org applications | incremental |
| `application_users` | Users assigned to an Okta application | full |
### API token
#### What You'll Need
| Credential | What it is |
| - | - |
| **API Token** | SSWS token from Okta admin console |
| **Domain** | Your Okta subdomain (e.g., `your-org`) |
> **Info:** **Setup access in Okta.** These steps require **Administrator**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Okta administrator.
* **Super Administrator** or **Organization Administrator** role
* Permission to create API tokens
#### Step 1: Access Okta Admin Console
1. Log in to your Okta org
2. Go to the Admin Console (click **Admin** in the top right)
#### Step 2: Navigate to API Settings
1. Go to **Security** → **API**
2. Click the **Tokens** tab
#### Step 3: Create API Token
1. Click **Create Token**
2. Name: `Parable Integration`
3. Click **Create Token**
> **Warning:** **Copy your API token now!**
>
> This is the only time it will be displayed. Store it in a secure password manager before closing this page.
> **Warning:** Token inherits the creating admin's permissions. Use a dedicated admin account.
#### Step 4: Note Your Okta Domain
Your Okta domain format:
```
https://your-org.okta.com
```
Or for Okta preview:
```
https://your-org.oktapreview.com
```
#### Step 5: Enter values in the form
1. **Domain**: Your Okta org hostname (for example `your-org.okta.com` without `https://`).
2. **API Token**: Paste your SSWS API token.
3. Click **Save & test connection**.
Developer identifier: `application_users`
Application Users covers users assigned to an Okta application.
* **Enables:** map the Okta accounts and memberships represented by Application Users records and trace a returned access assignment to its account or group.
* **Scope:** Users assigned to an Okta application; the connector reads `/api/v1/apps/{id}/users` as a snapshot stream in full mode. Object and event visibility follows the API token's Okta administrative permissions; inaccessible objects or events are not returned. A successful full collection can reveal a previously returned row as absent, but a credential or permission change can produce the same observation.
Developer identifier: `application_users._embedded`
Embedded records embedded resources related to the app user, if requested via expand parameter. It is needed to preserve the exact Okta configuration or execution metadata attached to this Okta App User record.
* **Enables:** inspect the keys in `_embedded` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Okta reports this value on the Okta App User object returned for Application Users; it is interpreted at one Okta App User record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Okta response and can vary by resource type or configuration.
Developer identifier: `application_users._links`
Links records HAL-style hypermedia links for the app user resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `_links` while retaining the containing Application Users record as provenance.
* **Interpretation:** Okta reports this value on the Okta App User object returned for Application Users; it is link at one Okta App User record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `application_users._links.app`
App records link to the parent application. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `app` while retaining the containing Application Users record as provenance.
* **Interpretation:** Okta reports this value on the Okta App User Links object returned for Application Users; it is link at one Okta App User Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `application_users._links.app.href`
Href records the URL of the linked resource. It is needed to retain the exact Okta resource or external link reported for this Application Users record.
* **Enables:** open or correlate the resource named by `href` while retaining the containing Okta Hal Link row as provenance.
* **Interpretation:** Okta reports this value on the Okta Hal Link object returned for Application Users; it is interpreted at one Okta Hal Link record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `application_users._links.app.name`
Name records optional name for the link. It is needed to compare the exact name configuration returned for this Okta Hal Link record.
* **Enables:** compare the exact `name` configuration returned for each Okta Hal Link record and select records with the configuration under review.
* **Interpretation:** Okta reports this value on the Okta Hal Link object returned for Application Users; it is interpreted at one Okta Hal Link record per row.
Developer identifier: `application_users._links.app.type`
Type records optional media type hint for the linked resource. It is needed to distinguish Application Users rows by the exact Okta-returned type value.
* **Enables:** separate Application Users rows by the exact Okta-returned `type` label when comparing type.
* **Interpretation:** Okta reports this value on the Okta Hal Link object returned for Application Users; it is interpreted at one Okta Hal Link record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `application_users._links.self`
Self records self link for this app user assignment. It is needed to preserve the nested self relationship or details on the parent Okta App User Links record.
* **Enables:** expand `self` to connect the containing Okta App User Links row to its returned self entries.
* **Interpretation:** Okta reports this value on the Okta App User Links object returned for Application Users; it is one nested object per containing Okta App User Links object when present.
Developer identifier: `application_users._links.user`
User records link to the Okta user resource. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `user` while retaining the containing Application Users record as provenance.
* **Interpretation:** Okta reports this value on the Okta App User Links object returned for Application Users; it is link at one Okta App User Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `application_users.app_id`
App ID records parent app id injected by the ingestor when iterating per-app (from the (id) path parameter in the `application_users` endpoint). Not part of the upstream Okta API response; written into each row at bronze ingestion time. It is needed to refer to the same app across records without relying on display text.
* **Enables:** match `app_id` to app references carrying the same Okta-issued value in related Okta records.
* **Interpretation:** Okta's child response does not supply this field; the connector injects parent context into each child row; it is an identifier, not a measured quantity.
Developer identifier: `application_users.created`
Created records timestamp when the user was assigned to the application. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Application Users records by `created`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Okta reports this value on the Okta App User object returned for Application Users; it is interpreted at one Okta App User record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `application_users.credentials`
Credentials records credentials for the user in the target application. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `credentials` to examine the returned credentials details for the containing Okta App User record.
* **Interpretation:** Okta reports this value on the Okta App User object returned for Application Users; it is one nested object per containing Okta App User object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `application_users.credentials.password`
Password records password object for the user in the target application. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `password` to examine the returned password details for the containing Okta App User Credentials record.
* **Interpretation:** Okta reports this value on the Okta App User Credentials object returned for Application Users; it is one nested object per containing Okta App User Credentials object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `application_users.credentials.password.value`
Value records password value (only present during creation, never returned in GET responses). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `value` access value with the resource, account, or membership represented by the same Application Users row.
* **Interpretation:** Okta reports this value on the Okta App User Password object returned for Application Users; it is interpreted at one Okta App User Password record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `application_users.credentials.userName`
User Name records username for the user in the target application. Often an email address. It is needed to attribute this Application Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Application Users row to the returned person or account and match the exact `userName` value where it recurs in Okta.
* **Interpretation:** Okta reports this value on the Okta App User Credentials object returned for Application Users; it is interpreted at one Okta App User Credentials record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `application_users.externalId`
External ID records external ID of the user in the target application, used for cross-system identity resolution. It is needed to refer to the same external across records without relying on display text.
* **Enables:** match `externalId` to external references carrying the same Okta-issued value in related Okta records.
* **Interpretation:** Okta reports this value on the Okta App User object returned for Application Users; it is an identifier, not a measured quantity.
Developer identifier: `application_users.id`
**ID.** Okta's identifier for the user assigned to the application.
* **Enables:** Connect each application membership to the member's Okta account through `application_users.id`.
* **Interpretation:** Okta reports this value in its user namespace. The same value repeats once for every application the member belongs to, so it does not identify a row on its own. A connector directive maps this field to account identity.
Developer identifier: `application_users.lastUpdated`
Last Updated records timestamp when the app user assignment was last modified. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Application Users records by `lastUpdated`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Okta reports this value on the Okta App User object returned for Application Users; it is interpreted at one Okta App User record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `application_users.membership_key`
**Membership Key.** Parable-generated SHA-1 digest of `app_id` and `id`, joined with `|`.
* **Enables:** Deduplicate each application membership on its own, so a member who belongs to several Okta applications keeps one row per application.
* **Interpretation:** Parable calculates `membership_key` at ingestion. It identifies one application-to-member relationship, not the member or the application by itself, and is not an Okta identifier. The connector explicitly marks this field as a transform deduplication key.
Developer identifier: `application_users.passwordChanged`
Password Changed records timestamp when the app user password was last changed. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `passwordChanged` access value with the resource, account, or membership represented by the same Application Users row.
* **Interpretation:** Okta reports this value on the Okta App User object returned for Application Users; it is interpreted at one Okta App User record per row; the schema uses the `Temporal.DateTime` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `application_users.profile`
Profile records application-specific profile attributes for the user. Schema varies by application configuration. It is needed to compare the exact profile configuration returned for this Okta App User record.
* **Enables:** compare the exact `profile` configuration returned for each Okta App User record and select records with the configuration under review.
* **Interpretation:** Okta reports this value on the Okta App User object returned for Application Users; it is interpreted at one Okta App User record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `application_users.scope`
Scope records scope of the assignment (USER or GROUP). Distinguishes direct vs group-based app assignments. It is needed to distinguish Application Users rows by the exact Okta-returned scope value.
* **Enables:** separate Application Users rows by the exact Okta-returned `scope` label when comparing scope.
* **Interpretation:** Okta reports this value on the Okta App User object returned for Application Users; it is interpreted at one Okta App User record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `application_users.status`
Status records status of the app user (e.g., ACTIVE, INACTIVE, DEPROVISIONED, PROVISIONED). It is needed to distinguish Application Users rows by the exact Okta-returned status value.
* **Enables:** separate Application Users rows by the exact Okta-returned `status` label when comparing status.
* **Interpretation:** Okta reports this value on the Okta App User object returned for Application Users; it is interpreted at one Okta App User record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `application_users.statusChanged`
Status Changed records timestamp when the app user status last changed. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Application Users records by `statusChanged`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Okta reports this value on the Okta App User object returned for Application Users; it is interpreted at one Okta App User record per row; the schema uses the `Temporal.DateTime` scalar; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `application_users.syncState`
Sync State records synchronization state of the app user (e.g., DISABLED, `OUT_OF_SYNC`, SYNCING, SYNCHRONIZED, ERROR). It is needed to distinguish Application Users rows by the exact Okta-returned sync state value.
* **Enables:** separate Application Users rows by the exact Okta-returned `syncState` label when comparing sync state.
* **Interpretation:** Okta reports this value on the Okta App User object returned for Application Users; it is interpreted at one Okta App User record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications`
Applications covers Okta org applications.
* **Enables:** inventory returned Okta applications and compare their provider-defined sign-on, visibility, credential, and application-link settings.
* **Scope:** Okta org applications; the connector reads `/api/v1/apps` as a snapshot stream in incremental mode. Object and event visibility follows the API token's Okta administrative permissions; inaccessible objects or events are not returned. This stream has no deletion signal, so a missing row does not establish that the Okta record was deleted.
Developer identifier: `applications._embedded`
Embedded records embedded resources related to the application. It is needed to preserve the exact Okta configuration or execution metadata attached to this Okta App record.
* **Enables:** inspect the keys in `_embedded` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is interpreted at one Okta App record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Okta response and can vary by resource type or configuration.
Developer identifier: `applications._links`
Links records HAL-style hypermedia links for the application. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `_links` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is link at one Okta App record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications._links.accessPolicy`
Access Policy records link to the access policy. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `accessPolicy` to examine the returned access policy details for the containing Okta App Links record.
* **Interpretation:** Okta reports this value on the Okta App Links object returned for Applications; it is link at one Okta App Links record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications._links.accessPolicy.hints`
Hints records hints about the link (e.g., allowed HTTP methods). It is needed to compare the exact hints configuration returned for this Okta App Link record.
* **Enables:** compare the exact `hints` configuration returned for each Okta App Link record and select records with the configuration under review.
* **Interpretation:** Okta reports this value on the Okta App Link object returned for Applications; it is interpreted at one Okta App Link record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `applications._links.accessPolicy.href`
Href records the URL of the linked resource. It is needed to distinguish repeated deliveries of the same Applications row using the declared ingestion key.
* **Enables:** use `href` as the declared ingestion deduplication key for Applications and match repeated rows carrying the same Okta identifier.
* **Interpretation:** Okta reports this value on the Okta App Link object returned for Applications; it is interpreted at one Okta App Link record per row; the connector declares it as an ingestion deduplication key; the schema uses the `Network.Url` scalar.
Developer identifier: `applications._links.accessPolicy.name`
Name records name of the link. It is needed to compare the returned name for individual Applications rows and select rows with a specific `name` value.
* **Enables:** locate Applications rows whose returned name exactly matches `name` and retain the Okta identifier for any cross-record match.
* **Interpretation:** Okta reports this value on the Okta App Link object returned for Applications; it is interpreted at one Okta App Link record per row.
Developer identifier: `applications._links.accessPolicy.type`
Type records media type of the linked resource. It is needed to distinguish Applications rows by the exact Okta-returned type value.
* **Enables:** separate Applications rows by the exact Okta-returned `type` label when comparing type.
* **Interpretation:** Okta reports this value on the Okta App Link object returned for Applications; it is interpreted at one Okta App Link record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications._links.activate`
Activate records link to activate the application. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `activate` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App Links object returned for Applications; it is link at one Okta App Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications._links.appLinks`
App Links records application launch links. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `appLinks` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App Links object returned for Applications; it is link at one Okta App Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications._links.deactivate`
Deactivate records link to deactivate the application. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `deactivate` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App Links object returned for Applications; it is link at one Okta App Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications._links.groups`
Groups records link to the groups assigned to this application. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `groups` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App Links object returned for Applications; it is link at one Okta App Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications._links.logo`
Logo records application logo links. It is needed to preserve the nested logo relationship or details on the parent Okta App Links record.
* **Enables:** expand `logo` to connect the containing Okta App Links row to its returned logo entries.
* **Interpretation:** Okta reports this value on the Okta App Links object returned for Applications; it is one returned collection per containing Okta App Links object.
Developer identifier: `applications._links.metadata`
Metadata records link to application metadata (e.g., SAML metadata). It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `metadata` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App Links object returned for Applications; it is link at one Okta App Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications._links.policies`
Policies records link to associated policies. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `policies` to examine the returned policies details for the containing Okta App Links record.
* **Interpretation:** Okta reports this value on the Okta App Links object returned for Applications; it is link at one Okta App Links record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications._links.profileEnrollment`
Profile Enrollment records link to profile enrollment policy. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `profileEnrollment` to examine the returned profile enrollment details for the containing Okta App Links record.
* **Interpretation:** Okta reports this value on the Okta App Links object returned for Applications; it is link at one Okta App Links record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications._links.self`
Self records self link for this application. It is needed to preserve the nested self relationship or details on the parent Okta App Links record.
* **Enables:** expand `self` to connect the containing Okta App Links row to its returned self entries.
* **Interpretation:** Okta reports this value on the Okta App Links object returned for Applications; it is one nested object per containing Okta App Links object when present.
Developer identifier: `applications._links.uploadLogo`
Upload Logo records link to upload a logo for the application. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `uploadLogo` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App Links object returned for Applications; it is link at one Okta App Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications._links.users`
Users records link to the users assigned to this application. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `users` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App Links object returned for Applications; it is link at one Okta App Links record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications.accessibility`
Accessibility records accessibility settings for the application. It is needed to preserve the nested accessibility relationship or details on the parent Okta App record.
* **Enables:** expand `accessibility` to connect the containing Okta App row to its returned accessibility entries.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is one nested object per containing Okta App object when present.
Developer identifier: `applications.accessibility.errorRedirectUrl`
Error Redirect URL records custom error redirect URL. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `errorRedirectUrl` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App Accessibility object returned for Applications; it is link at one Okta App Accessibility record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications.accessibility.loginRedirectUrl`
Login Redirect URL records custom login redirect URL. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `loginRedirectUrl` access value with the resource, account, or membership represented by the same Applications row.
* **Interpretation:** Okta reports this value on the Okta App Accessibility object returned for Applications; it is link at one Okta App Accessibility record per row; the schema uses the `Network.Url` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications.accessibility.selfService`
Self Service records whether users can request access to the app. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Applications rows with the exact `selfService` access-related value being investigated.
* **Interpretation:** Okta reports this value on the Okta App Accessibility object returned for Applications; it is interpreted at one Okta App Accessibility record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.activated`
Activated records timestamp when the application was activated. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Applications records by `activated`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is interpreted at one Okta App record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `applications.created`
Created records timestamp when the application was created. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Applications records by `created`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is interpreted at one Okta App record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `applications.credentials`
Credentials records credential settings for the application. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `credentials` to examine the returned credentials details for the containing Okta App record.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is one nested object per containing Okta App object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `applications.credentials.oauthClient`
OAuth Client records OAuth client credentials (for OIDC apps). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `oauthClient` to examine the returned o auth client details for the containing Okta App Credentials record.
* **Interpretation:** Okta reports this value on the Okta App Credentials object returned for Applications; it is one nested object per containing Okta App Credentials object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `applications.credentials.oauthClient.autoKeyRotation`
Auto Key Rotation records whether automatic key rotation is enabled. It is needed to distinguish Applications rows by the exact Okta-returned auto key rotation value.
* **Enables:** select Applications rows where `autoKeyRotation` is true or false when comparing the condition described by Auto Key Rotation.
* **Interpretation:** Okta reports this value on the Okta App OAuth Client object returned for Applications; it is interpreted at one Okta App OAuth Client record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.credentials.oauthClient.client_id`
Client ID records OAuth client ID. It is needed to refer to the same client across records without relying on display text.
* **Enables:** match `client_id` to client references carrying the same Okta-issued value in related Okta records.
* **Interpretation:** Okta reports this value on the Okta App OAuth Client object returned for Applications; it is an identifier, not a measured quantity.
Developer identifier: `applications.credentials.oauthClient.token_endpoint_auth_method`
Token Endpoint Auth Method records token endpoint authentication method (`client_secret_basic`, `client_secret_post`, `private_key_jwt`, none). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `token_endpoint_auth_method` access value with the resource, account, or membership represented by the same Applications row.
* **Interpretation:** Okta reports this value on the Okta App OAuth Client object returned for Applications; it is interpreted at one Okta App OAuth Client record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `applications.credentials.revealPassword`
Reveal Password records whether the password can be revealed to the user. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Applications rows with the exact `revealPassword` access-related value being investigated.
* **Interpretation:** Okta reports this value on the Okta App Credentials object returned for Applications; it is interpreted at one Okta App Credentials record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.credentials.scheme`
Scheme records authentication scheme (`EDIT_USERNAME_AND_PASSWORD`, `EDIT_PASSWORD_ONLY`, `EXTERNAL_PASSWORD_SYNC`, `SHARED_USERNAME_AND_PASSWORD`, `ADMIN_SETS_CREDENTIALS`). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `scheme` access value with the resource, account, or membership represented by the same Applications row.
* **Interpretation:** Okta reports this value on the Okta App Credentials object returned for Applications; it is interpreted at one Okta App Credentials record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `applications.credentials.signing`
Signing records signing credential configuration. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `signing` to examine the returned signing details for the containing Okta App Credentials record.
* **Interpretation:** Okta reports this value on the Okta App Credentials object returned for Applications; it is one nested object per containing Okta App Credentials object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `applications.credentials.signing.kid`
Kid records key ID of the signing key. It is needed to refer to the same kid across records without relying on display text.
* **Enables:** match `kid` to kid references carrying the same Okta-issued value in related Okta records.
* **Interpretation:** Okta reports this value on the Okta App Credentials Signing object returned for Applications; it is an identifier, not a measured quantity.
Developer identifier: `applications.credentials.signing.lastRotated`
Last Rotated records timestamp of the last key rotation. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Applications records by `lastRotated`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Okta reports this value on the Okta App Credentials Signing object returned for Applications; it is interpreted at one Okta App Credentials Signing record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `applications.credentials.signing.nextRotation`
Next Rotation records timestamp of the next scheduled key rotation. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Applications records by `nextRotation`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Okta reports this value on the Okta App Credentials Signing object returned for Applications; it is interpreted at one Okta App Credentials Signing record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `applications.credentials.signing.rotationMode`
Rotation Mode records key rotation mode (AUTO or MANUAL). It is needed to distinguish Applications rows by the exact Okta-returned rotation mode value.
* **Enables:** separate Applications rows by the exact Okta-returned `rotationMode` label when comparing rotation mode.
* **Interpretation:** Okta reports this value on the Okta App Credentials Signing object returned for Applications; it is interpreted at one Okta App Credentials Signing record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.credentials.signing.use`
Use records use of the key (sig). It is needed to inventory the exact Okta-reported configuration or classification represented by this field.
* **Enables:** compare `use` among Applications records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Okta reports this value on the Okta App Credentials Signing object returned for Applications; it is interpreted at one Okta App Credentials Signing record per row; the value is a Okta-returned or configured label at the Okta App Credentials Signing grain rather than a universal taxonomy.
Developer identifier: `applications.credentials.userNameTemplate`
User Name Template records template used to generate usernames for the app. It is needed to preserve the nested user name template relationship or details on the parent Okta App Credentials record.
* **Enables:** expand `userNameTemplate` to connect the containing Okta App Credentials row to its returned user name template entries.
* **Interpretation:** Okta reports this value on the Okta App Credentials object returned for Applications; it is one nested object per containing Okta App Credentials object when present.
Developer identifier: `applications.credentials.userNameTemplate.pushStatus`
Push Status records push status for the username template. It is needed to distinguish Applications rows by the exact Okta-returned push status value.
* **Enables:** separate Applications rows by the exact Okta-returned `pushStatus` label when comparing push status.
* **Interpretation:** Okta reports this value on the Okta App User Name Template object returned for Applications; it is interpreted at one Okta App User Name Template record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.credentials.userNameTemplate.suffix`
Suffix records suffix appended to the username. It is needed to attribute this Applications row to the returned person, account, or organization reference.
* **Enables:** attribute the Applications row to the returned person or account and match the exact `suffix` value where it recurs in Okta.
* **Interpretation:** Okta reports this value on the Okta App User Name Template object returned for Applications; it is interpreted at one Okta App User Name Template record per row.
Developer identifier: `applications.credentials.userNameTemplate.template`
Template records Okta Expression Language template string (e.g., \$(source.login)). It is needed to inspect the exact template text returned for this Okta App User Name Template record.
* **Enables:** attribute the template text in `template` to the containing Applications identifier, owner or author, status, and update time where returned.
* **Interpretation:** Okta reports this value on the Okta App User Name Template object returned for Applications; it is interpreted at one Okta App User Name Template record per row; this is only the template text included in the Okta response for this record.
Developer identifier: `applications.credentials.userNameTemplate.type`
Type records template type (`BUILT_IN`, CUSTOM, NONE). It is needed to distinguish Applications rows by the exact Okta-returned type value.
* **Enables:** separate Applications rows by the exact Okta-returned `type` label when comparing type.
* **Interpretation:** Okta reports this value on the Okta App User Name Template object returned for Applications; it is interpreted at one Okta App User Name Template record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.features`
Features records list of enabled features for the application. It is needed to preserve the nested features relationship or details on the parent Okta App record.
* **Enables:** expand `features` to connect the containing Okta App row to its returned features entries.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is one returned collection per containing Okta App object.
Developer identifier: `applications.id`
ID records unique identifier for the application. It is needed to distinguish repeated deliveries of the same Applications row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Applications and match repeated rows carrying the same Okta identifier.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `applications.label`
Label records human-readable display name of the application. It is needed to compare the returned label for individual Applications rows and select rows with a specific `label` value.
* **Enables:** locate Applications rows whose returned label exactly matches `label` and retain the Okta identifier for any cross-record match.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is interpreted at one Okta App record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `applications.lastUpdated`
Last Updated records timestamp when the application was last modified. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Applications records by `lastUpdated`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is interpreted at one Okta App record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `applications.name`
Name records internal name/template of the application (e.g., salesforce, bookmark, `oidc_client`). It is needed to compare the returned name for individual Applications rows and select rows with a specific `name` value.
* **Enables:** locate Applications rows whose returned name exactly matches `name` and retain the Okta identifier for any cross-record match.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is interpreted at one Okta App record per row.
Developer identifier: `applications.orn`
Orn records Okta Resource Name uniquely identifying the application across Okta (e.g., orn:okta:idp:`OKTA_ORG`:apps/0oab...). It is needed to preserve the exact Okta-reported business, directory, or identity attribute represented by this field.
* **Enables:** match or segment Applications records by `orn` only within the same Okta attribute contract.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is interpreted at one Okta App record per row; the value is a Okta-returned or configured label and is not a universal identity or business taxonomy.
Developer identifier: `applications.profile`
Profile records application profile attributes (varies by app type). It is needed to preserve the exact Okta configuration or execution metadata attached to this Okta App record.
* **Enables:** inspect the keys in `profile` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is interpreted at one Okta App record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Okta response and can vary by resource type or configuration.
Developer identifier: `applications.settings`
Settings records application-specific settings. It is needed to preserve the nested settings relationship or details on the parent Okta App record.
* **Enables:** expand `settings` to connect the containing Okta App row to its returned settings entries.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is one nested object per containing Okta App object when present.
Developer identifier: `applications.settings.app`
App records app-specific settings object (varies by application type). It is needed to compare the exact app configuration returned for this Okta App Settings record.
* **Enables:** compare the exact `app` configuration returned for each Okta App Settings record and select records with the configuration under review.
* **Interpretation:** Okta reports this value on the Okta App Settings object returned for Applications; it is interpreted at one Okta App Settings record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `applications.settings.implicitAssignment`
Implicit Assignment records whether implicit assignment is enabled. It is needed to distinguish Applications rows by the exact Okta-returned implicit assignment value.
* **Enables:** select Applications rows where `implicitAssignment` is true or false when comparing the condition described by Implicit Assignment.
* **Interpretation:** Okta reports this value on the Okta App Settings object returned for Applications; it is interpreted at one Okta App Settings record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.settings.manualProvisioning`
Manual Provisioning records whether manual provisioning is enabled. It is needed to distinguish Applications rows by the exact Okta-returned manual provisioning value.
* **Enables:** select Applications rows where `manualProvisioning` is true or false when comparing the condition described by Manual Provisioning.
* **Interpretation:** Okta reports this value on the Okta App Settings object returned for Applications; it is interpreted at one Okta App Settings record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.settings.notes`
Notes records admin and end-user notes for the application. It is needed to preserve the nested notes relationship or details on the parent Okta App Settings record.
* **Enables:** expand `notes` to connect the containing Okta App Settings row to its returned notes entries.
* **Interpretation:** Okta reports this value on the Okta App Settings object returned for Applications; it is one nested object per containing Okta App Settings object when present.
Developer identifier: `applications.settings.notes.admin`
Admin records admin notes for the application. It is needed to inventory the exact Okta-reported configuration or classification represented by this field.
* **Enables:** compare `admin` among Applications records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Okta reports this value on the Okta App Notes object returned for Applications; it is interpreted at one Okta App Notes record per row; the value is a Okta-returned or configured label at the Okta App Notes grain rather than a universal taxonomy.
Developer identifier: `applications.settings.notes.enduser`
Enduser records end-user notes displayed to users. It is needed to attribute this Applications row to the returned person, account, or organization reference.
* **Enables:** attribute the Applications row to the returned person or account and match the exact `enduser` value where it recurs in Okta.
* **Interpretation:** Okta reports this value on the Okta App Notes object returned for Applications; it is interpreted at one Okta App Notes record per row.
Developer identifier: `applications.settings.notifications`
Notifications records notification settings for the application. It is needed to preserve the nested notifications relationship or details on the parent Okta App Settings record.
* **Enables:** expand `notifications` to connect the containing Okta App Settings row to its returned notifications entries.
* **Interpretation:** Okta reports this value on the Okta App Settings object returned for Applications; it is one nested object per containing Okta App Settings object when present.
Developer identifier: `applications.settings.notifications.vpn`
Vpn records VPN notification settings. It is needed to preserve the nested vpn relationship or details on the parent Okta App Notifications record.
* **Enables:** expand `vpn` to connect the containing Okta App Notifications row to its returned vpn entries.
* **Interpretation:** Okta reports this value on the Okta App Notifications object returned for Applications; it is one nested object per containing Okta App Notifications object when present.
Developer identifier: `applications.settings.notifications.vpn.helpUrl`
Help URL records help URL for VPN notification. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `helpUrl` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App Vpn Notification object returned for Applications; it is link at one Okta App Vpn Notification record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications.settings.notifications.vpn.message`
Message records custom VPN notification message. It is needed to inspect the exact message text included with this record.
* **Enables:** inspect the message text returned in `message` and attribute it to the same record's parent record, owner, status, and update time where returned.
* **Interpretation:** Okta reports this value on the Okta App Vpn Notification object returned for Applications; it is message text at one Okta App Vpn Notification record per row; this is only the content included in the Okta response for this record.
Developer identifier: `applications.settings.notifications.vpn.network`
Network records network configuration for VPN notification. It is needed to preserve the nested network relationship or details on the parent Okta App Vpn Notification record.
* **Enables:** expand `network` to connect the containing Okta App Vpn Notification row to its returned network entries.
* **Interpretation:** Okta reports this value on the Okta App Vpn Notification object returned for Applications; it is one nested object per containing Okta App Vpn Notification object when present.
Developer identifier: `applications.settings.notifications.vpn.network.connection`
Connection records connection type (DISABLED, ANYWHERE, `ON_NETWORK`, `OFF_NETWORK`). It is needed to inventory the exact Okta-reported configuration or classification represented by this field.
* **Enables:** compare `connection` among Applications records when reconciling this specific configuration, source, or classification.
* **Interpretation:** Okta reports this value on the Okta App Vpn Network object returned for Applications; it is interpreted at one Okta App Vpn Network record per row; the value is a Okta-returned or configured label at the Okta App Vpn Network grain rather than a universal taxonomy.
Developer identifier: `applications.settings.notifications.vpn.network.exclude`
Exclude records list of excluded network zones. It is needed to preserve the nested exclude relationship or details on the parent Okta App Vpn Network record.
* **Enables:** expand `exclude` to connect the containing Okta App Vpn Network row to its returned exclude entries.
* **Interpretation:** Okta reports this value on the Okta App Vpn Network object returned for Applications; it is one returned collection per containing Okta App Vpn Network object.
Developer identifier: `applications.settings.notifications.vpn.network.include`
Include records list of included network zones. It is needed to preserve the nested include relationship or details on the parent Okta App Vpn Network record.
* **Enables:** expand `include` to connect the containing Okta App Vpn Network row to its returned include entries.
* **Interpretation:** Okta reports this value on the Okta App Vpn Network object returned for Applications; it is one returned collection per containing Okta App Vpn Network object.
Developer identifier: `applications.settings.oauthClient`
OAuth Client records OAuth/OIDC-specific settings. It is needed to preserve the nested o auth client relationship or details on the parent Okta App Settings record.
* **Enables:** expand `oauthClient` to connect the containing Okta App Settings row to its returned o auth client entries.
* **Interpretation:** Okta reports this value on the Okta App Settings object returned for Applications; it is one nested object per containing Okta App Settings object when present.
Developer identifier: `applications.settings.oauthClient.application_type`
Application Type records application type (web, native, service, browser). It is needed to distinguish Applications rows by the exact Okta-returned application type value.
* **Enables:** separate Applications rows by the exact Okta-returned `application_type` label when comparing application type.
* **Interpretation:** Okta reports this value on the Okta App OAuth Settings object returned for Applications; it is interpreted at one Okta App OAuth Settings record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.settings.oauthClient.client_uri`
Client URI records client URI. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `client_uri` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App OAuth Settings object returned for Applications; it is link at one Okta App OAuth Settings record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications.settings.oauthClient.consent_method`
Consent Method records consent method (REQUIRED, TRUSTED). It is needed to compare the exact consent method configuration returned for this Okta App OAuth Settings record.
* **Enables:** compare the exact `consent_method` configuration returned for each Okta App OAuth Settings record and select records with the configuration under review.
* **Interpretation:** Okta reports this value on the Okta App OAuth Settings object returned for Applications; it is interpreted at one Okta App OAuth Settings record per row.
Developer identifier: `applications.settings.oauthClient.grant_types`
Grant Types records allowed OAuth grant types. It is needed to preserve the nested grant types relationship or details on the parent Okta App OAuth Settings record.
* **Enables:** expand `grant_types` to connect the containing Okta App OAuth Settings row to its returned grant types entries.
* **Interpretation:** Okta reports this value on the Okta App OAuth Settings object returned for Applications; it is one returned collection per containing Okta App OAuth Settings object.
Developer identifier: `applications.settings.oauthClient.idp_initiated_login`
Idp Initiated Login records idP-initiated login configuration. It is needed to attribute this Applications row to the returned person, account, or organization reference.
* **Enables:** attribute the Applications row to the returned person or account and match the exact `idp_initiated_login` value where it recurs in Okta.
* **Interpretation:** Okta reports this value on the Okta App OAuth Settings object returned for Applications; it is interpreted at one Okta App OAuth Settings record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `applications.settings.oauthClient.initiate_login_uri`
Initiate Login URI records initiate login URI. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `initiate_login_uri` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App OAuth Settings object returned for Applications; it is link at one Okta App OAuth Settings record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications.settings.oauthClient.issuer_mode`
Issuer Mode records issuer mode (`ORG_URL`, `CUSTOM_URL`, DYNAMIC). It is needed to distinguish Applications rows by the exact Okta-returned issuer mode value.
* **Enables:** separate Applications rows by the exact Okta-returned `issuer_mode` label when comparing issuer mode.
* **Interpretation:** Okta reports this value on the Okta App OAuth Settings object returned for Applications; it is interpreted at one Okta App OAuth Settings record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.settings.oauthClient.logo_uri`
Logo URI records logo URI. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `logo_uri` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App OAuth Settings object returned for Applications; it is link at one Okta App OAuth Settings record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications.settings.oauthClient.post_logout_redirect_uris`
Post Logout Redirect URIs records list of post-logout redirect URIs. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `post_logout_redirect_uris` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App OAuth Settings object returned for Applications; it is link at one Okta App OAuth Settings record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications.settings.oauthClient.redirect_uris`
Redirect URIs records list of allowed redirect URIs. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `redirect_uris` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App OAuth Settings object returned for Applications; it is link at one Okta App OAuth Settings record per row; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications.settings.oauthClient.response_types`
Response Types records allowed OAuth response types. It is needed to preserve the nested response types relationship or details on the parent Okta App OAuth Settings record.
* **Enables:** expand `response_types` to connect the containing Okta App OAuth Settings row to its returned response types entries.
* **Interpretation:** Okta reports this value on the Okta App OAuth Settings object returned for Applications; it is one returned collection per containing Okta App OAuth Settings object.
Developer identifier: `applications.settings.oauthClient.wildcard_redirect`
Wildcard Redirect records wildcard redirect setting (DISABLED, SUBDOMAIN). It is needed to compare the exact wildcard redirect configuration returned for this Okta App OAuth Settings record.
* **Enables:** compare the exact `wildcard_redirect` configuration returned for each Okta App OAuth Settings record and select records with the configuration under review.
* **Interpretation:** Okta reports this value on the Okta App OAuth Settings object returned for Applications; it is interpreted at one Okta App OAuth Settings record per row.
Developer identifier: `applications.settings.signOn`
Sign On records sign-on settings (varies by signOnMode, e.g., SAML assertion details). It is needed to compare the exact sign on configuration returned for this Okta App Settings record.
* **Enables:** compare the exact `signOn` configuration returned for each Okta App Settings record and select records with the configuration under review.
* **Interpretation:** Okta reports this value on the Okta App Settings object returned for Applications; it is interpreted at one Okta App Settings record per row; the schema uses the `Generic.JSON` scalar.
Developer identifier: `applications.signOnMode`
Sign On Mode records sign-on mode for the application. It is needed to distinguish Applications rows by the exact Okta-returned sign on mode value.
* **Enables:** separate Applications rows by the exact Okta-returned `signOnMode` label when comparing sign on mode.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is interpreted at one Okta App record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.status`
Status records application status (ACTIVE, INACTIVE, DELETED). It is needed to distinguish Applications rows by the exact Okta-returned status value.
* **Enables:** separate Applications rows by the exact Okta-returned `status` label when comparing status.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is interpreted at one Okta App record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.universalLogout`
Universal Logout records universal Logout (CAEP / OIDC RP-Initiated Logout) status block for the application. It is needed to preserve the nested universal logout relationship or details on the parent Okta App record.
* **Enables:** expand `universalLogout` to connect the containing Okta App row to its returned universal logout entries.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is one nested object per containing Okta App object when present.
Developer identifier: `applications.universalLogout.status`
Status records universal Logout enablement status for the application (e.g., 'ENABLED', 'DISABLED', '`NOT_AVAILABLE`'). It is needed to distinguish Applications rows by the exact Okta-returned status value.
* **Enables:** separate Applications rows by the exact Okta-returned `status` label when comparing status.
* **Interpretation:** Okta reports this value on the Okta App Universal Logout object returned for Applications; it is interpreted at one Okta App Universal Logout record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.visibility`
Visibility records visibility settings for the application. It is needed to preserve the nested visibility relationship or details on the parent Okta App record.
* **Enables:** expand `visibility` to connect the containing Okta App row to its returned visibility entries.
* **Interpretation:** Okta reports this value on the Okta App object returned for Applications; it is one nested object per containing Okta App object when present.
Developer identifier: `applications.visibility.appLinks`
App Links records map of app link visibility settings (link name to boolean). It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `appLinks` while retaining the containing Applications record as provenance.
* **Interpretation:** Okta reports this value on the Okta App Visibility object returned for Applications; it is link at one Okta App Visibility record per row; the schema uses the `Generic.JSON` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `applications.visibility.autoLaunch`
Auto Launch records whether the app is auto-launched. It is needed to distinguish Applications rows by the exact Okta-returned auto launch value.
* **Enables:** select Applications rows where `autoLaunch` is true or false when comparing the condition described by Auto Launch.
* **Interpretation:** Okta reports this value on the Okta App Visibility object returned for Applications; it is interpreted at one Okta App Visibility record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.visibility.autoSubmitToolbar`
Auto Submit Toolbar records whether the sign-in form is auto-submitted. It is needed to distinguish Applications rows by the exact Okta-returned auto submit toolbar value.
* **Enables:** select Applications rows where `autoSubmitToolbar` is true or false when comparing the condition described by Auto Submit Toolbar.
* **Interpretation:** Okta reports this value on the Okta App Visibility object returned for Applications; it is interpreted at one Okta App Visibility record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.visibility.hide`
Hide records hide settings for the application. It is needed to preserve the nested hide relationship or details on the parent Okta App Visibility record.
* **Enables:** expand `hide` to connect the containing Okta App Visibility row to its returned hide entries.
* **Interpretation:** Okta reports this value on the Okta App Visibility object returned for Applications; it is one nested object per containing Okta App Visibility object when present.
Developer identifier: `applications.visibility.hide.iOS`
I OS records whether the app is hidden on iOS devices. It is needed to distinguish Applications rows by the exact Okta-returned i os value.
* **Enables:** select Applications rows where `iOS` is true or false when comparing the condition described by I OS.
* **Interpretation:** Okta reports this value on the Okta App Visibility Hide object returned for Applications; it is interpreted at one Okta App Visibility Hide record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `applications.visibility.hide.web`
Web records whether the app is hidden in the Okta web dashboard. It is needed to distinguish Applications rows by the exact Okta-returned web value.
* **Enables:** select Applications rows where `web` is true or false when comparing the condition described by Web.
* **Interpretation:** Okta reports this value on the Okta App Visibility Hide object returned for Applications; it is interpreted at one Okta App Visibility Hide record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs`
Audit Logs covers Okta System Log events.
* **Enables:** reconstruct an Audit Logs timeline and correlate each returned actor, target, action, and timestamp during an investigation.
* **Scope:** Okta System Log events; the connector reads `/api/v1/logs` as an event stream in incremental mode. Object and event visibility follows the API token's Okta administrative permissions; inaccessible objects or events are not returned. This stream has no deletion signal, so a missing row does not establish that the Okta record was deleted.
Developer identifier: `audit_logs.actor`
Actor records the entity (user, app, client) that performed the action. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `actor` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is one nested object per containing Okta Log object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.actor.alternateId`
Alternate ID records alternate identifier for the actor, usually email or login. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `alternateId` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Actor object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.actor.detailEntry`
Detail Entry records additional details about the actor as key-value pairs. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `detailEntry` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Actor object returned for Audit Logs; it is interpreted at one Okta Log Actor record per row; the schema uses the `Generic.JSON` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; keys and availability follow this Okta response and may vary by object type or Okta configuration.
Developer identifier: `audit_logs.actor.displayName`
Display Name records human-readable display name of the actor. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `displayName` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Actor object returned for Audit Logs; it is interpreted at one Okta Log Actor record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.actor.id`
ID records unique identifier of the actor. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `id` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Actor object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.actor.type`
Type records type of actor (e.g., User, SystemPrincipal, PublicClientApp). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `type` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log Actor object returned for Audit Logs; it is interpreted at one Okta Log Actor record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.authenticationContext`
Authentication Context records authentication context including step, protocol, and issuer. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `authenticationContext` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is one nested object per containing Okta Log object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.authenticationContext.authenticationProvider`
Authentication Provider records authentication provider type (e.g., `FACTOR_PROVIDER`, `OKTA_AUTHENTICATION_PROVIDER`, `ACTIVE_DIRECTORY`). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `authenticationProvider` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Authentication Context object returned for Audit Logs; it is interpreted at one Okta Log Authentication Context record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.authenticationContext.authenticationStep`
Authentication Step records step number in the authentication flow (0 for single-factor, higher for MFA steps). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `authenticationStep` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Authentication Context object returned for Audit Logs; it is interpreted at one Okta Log Authentication Context record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.authenticationContext.credentialProvider`
Credential Provider records credential provider (e.g., `OKTA_CREDENTIAL_PROVIDER`, RSA, DUO, GOOGLE). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `credentialProvider` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Authentication Context object returned for Audit Logs; it is interpreted at one Okta Log Authentication Context record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.authenticationContext.credentialType`
Credential Type records type of credential used (e.g., OTP, PASSWORD, ASSERTION, SMS, IWA). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `credentialType` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log Authentication Context object returned for Audit Logs; it is interpreted at one Okta Log Authentication Context record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.authenticationContext.externalSessionId`
External Session ID records external session identifier linking events in the same session. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `externalSessionId` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Authentication Context object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.authenticationContext.interface`
Interface records interface used for authentication. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `interface` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Authentication Context object returned for Audit Logs; it is interpreted at one Okta Log Authentication Context record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.authenticationContext.issuer`
Issuer records issuer of the authentication assertion, if applicable. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `issuer` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log Authentication Context object returned for Audit Logs; it is one nested object per containing Okta Log Authentication Context object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.authenticationContext.issuer.id`
ID records unique identifier of the issuer. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `id` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Issuer object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.authenticationContext.issuer.type`
Type records type of issuer. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `type` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log Issuer object returned for Audit Logs; it is interpreted at one Okta Log Issuer record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.authenticationContext.rootSessionId`
Root Session ID records root session identifier linking events across a chain of impersonated or delegated sessions. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `rootSessionId` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Authentication Context object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client`
Client records client information including IP, user agent, device, and zone. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** correlate `client` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is one nested object per containing Okta Log object when present; the value is configured or derived address and place context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client.device`
Device records type of device used (e.g., Computer, Mobile). It is needed to preserve the Okta-reported client device or software context for the same record.
* **Enables:** correlate `device` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Client object returned for Audit Logs; it is interpreted at one Okta Log Client record per row; the value is client device or software context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client.geographicalContext`
Geographical Context records geographical location derived from the client IP address. It is needed to preserve the Okta-reported network address context for the same record.
* **Enables:** correlate `geographicalContext` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Client object returned for Audit Logs; it is one nested object per containing Okta Log Client object when present; the value is network address context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client.geographicalContext.city`
City records city name. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** correlate `city` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Geographical Context object returned for Audit Logs; it is interpreted at one Okta Log Geographical Context record per row; the value is configured or derived address and place context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client.geographicalContext.country`
Country records country name. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** correlate `country` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Geographical Context object returned for Audit Logs; it is interpreted at one Okta Log Geographical Context record per row; the value is configured or derived address and place context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client.geographicalContext.geolocation`
Geolocation records latitude and longitude coordinates. It is needed to preserve the Okta-reported geographic coordinate context for the same record.
* **Enables:** correlate `geolocation` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Geographical Context object returned for Audit Logs; its unit or granularity is provider-reported geographic coordinates; the value is geographic coordinate context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client.geographicalContext.geolocation.lat`
Lat records latitude coordinate. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** correlate `lat` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Geolocation object returned for Audit Logs; its unit or granularity is provider-reported geographic coordinates; the value is configured or derived address and place context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client.geographicalContext.geolocation.lon`
Lon records longitude coordinate. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** correlate `lon` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Geolocation object returned for Audit Logs; its unit or granularity is provider-reported geographic coordinates; the value is configured or derived address and place context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client.geographicalContext.postalCode`
Postal Code records postal or ZIP code. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** correlate `postalCode` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Geographical Context object returned for Audit Logs; it is interpreted at one Okta Log Geographical Context record per row; the value is configured or derived address and place context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.client.geographicalContext.state`
State records state or province name. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** correlate `state` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Geographical Context object returned for Audit Logs; it is interpreted at one Okta Log Geographical Context record per row; the value is configured or derived address and place context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.client.id`
ID records unique identifier of the client, if available. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `id` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Client object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client.ipAddress`
IP Address records IP address of the client that triggered the event. It is needed to preserve the Okta-reported network address context for the same record.
* **Enables:** correlate `ipAddress` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Client object returned for Audit Logs; it is interpreted at one Okta Log Client record per row; the schema uses the `Network.IpAddress` scalar; the value is network address context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client.userAgent`
User Agent records user agent information from the client request. It is needed to preserve the Okta-reported client device or software context for the same record.
* **Enables:** correlate `userAgent` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Client object returned for Audit Logs; it is one nested object per containing Okta Log Client object when present; the value is client device or software context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client.userAgent.browser`
Browser records browser parsed from the user agent. It is needed to preserve the Okta-reported client device or software context for the same record.
* **Enables:** correlate `browser` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log User Agent object returned for Audit Logs; it is interpreted at one Okta Log User Agent record per row; the value is client device or software context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client.userAgent.os`
OS records operating system parsed from the user agent. It is needed to preserve the Okta-reported client device or software context for the same record.
* **Enables:** correlate `os` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log User Agent object returned for Audit Logs; it is interpreted at one Okta Log User Agent record per row; the value is client device or software context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client.userAgent.rawUserAgent`
Raw User Agent records raw user agent string from the HTTP request. It is needed to preserve the Okta-reported client device or software context for the same record.
* **Enables:** correlate `rawUserAgent` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log User Agent object returned for Audit Logs; it is interpreted at one Okta Log User Agent record per row; the value is client device or software context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.client.zone`
Zone records the network zone the client request originated from. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `zone` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Client object returned for Audit Logs; it is interpreted at one Okta Log Client record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.debugContext`
Debug Context records additional debug information for troubleshooting. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `debugContext` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is one nested object per containing Okta Log object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.debugContext.debugData`
Debug Data records key-value pairs with debug data such as requestUri, requestId, url, suspiciousActivity, etc. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `debugData` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Debug Context object returned for Audit Logs; it is one nested object per containing Okta Log Debug Context object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; keys and availability follow this Okta response and may vary by object type or Okta configuration.
Developer identifier: `audit_logs.debugContext.debugData.dtHash`
Dt Hash records hash representing the device token of the actor's device. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `dtHash` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Debug Data object returned for Audit Logs; it is interpreted at one Okta Log Debug Data record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.debugContext.debugData.requestId`
Request ID records unique identifier for the request that produced this log event. Useful for correlating with other Okta logs and external systems. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `requestId` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Debug Data object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.debugContext.debugData.requestUri`
Request URI records URI path of the request that produced the event. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `requestUri` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Debug Data object returned for Audit Logs; it is link at one Okta Log Debug Data record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `audit_logs.debugContext.debugData.suspiciousActivity`
Suspicious Activity records suspicious-activity classification, when set. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `suspiciousActivity` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Debug Data object returned for Audit Logs; it is interpreted at one Okta Log Debug Data record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.debugContext.debugData.url`
URL records the URL of the request that produced the event, when applicable. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `url` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Debug Data object returned for Audit Logs, at one Okta Log Debug Data record per row; it is usually a path relative to the Okta org (starting with `/`, with any query string) and is kept exactly as Okta sends it, without an added host; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; the returned link does not establish that the current credential can retrieve its target.
Developer identifier: `audit_logs.device`
Device records top-level device context returned by Okta System Log events. It is needed to preserve the Okta-reported client device or software context for the same record.
* **Enables:** correlate `device` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is interpreted at one Okta Log record per row; the schema uses the `Generic.JSON` scalar; the value is client device or software context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.displayMessage`
Display Message records human-readable description of the event. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `displayMessage` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is message text at one Okta Log record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; this is only the content included in the Okta response for this record.
Developer identifier: `audit_logs.eventType`
Event Type records type of event (e.g., user.session.start, app.`user_membership`.add). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `eventType` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is interpreted at one Okta Log record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.gatewayContext`
Gateway Context records network gateway context returned by Okta System Log events. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `gatewayContext` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is interpreted at one Okta Log record per row; the schema uses the `Generic.JSON` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.legacyEventType`
Legacy Event Type records legacy event type identifier for backward compatibility. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `legacyEventType` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.outcome`
Outcome records the outcome/result of the event. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `outcome` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is one nested object per containing Okta Log object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.outcome.reason`
Reason records reason for the outcome, especially useful for failures. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `reason` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log Outcome object returned for Audit Logs; it is interpreted at one Okta Log Outcome record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.outcome.result`
Result records result of the event. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `result` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log Outcome object returned for Audit Logs; it is interpreted at one Okta Log Outcome record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.published`
Published records timestamp when the event was published (ISO 8601). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `published` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is interpreted at one Okta Log record per row; the connector also declares it for record ordering; the schema assigns the `event_time` semantic role; the schema uses the `Temporal.DateTime` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.request`
Request records details about the HTTP request that triggered the event. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `request` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is one nested object per containing Okta Log object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.request.ipChain`
IP Chain records chain of IP addresses from the request, including proxies. It is needed to preserve the Okta-reported network address context for the same record.
* **Enables:** correlate `ipChain` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Request object returned for Audit Logs; it is one returned collection per containing Okta Log Request object; the value is network address context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.request.ipChain.geographicalContext`
Geographical Context records geographical context for this IP address. It is needed to preserve the Okta-reported network address context for the same record.
* **Enables:** correlate `geographicalContext` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Ip Chain Entry object returned for Audit Logs; it is one nested object per containing Okta Log Ip Chain Entry object when present; the value is network address context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.request.ipChain.ip`
IP records IP address at this hop. It is needed to preserve the Okta-reported network address context for the same record.
* **Enables:** correlate `ip` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Ip Chain Entry object returned for Audit Logs; it is interpreted at one Okta Log Ip Chain Entry record per row; the connector declares it as an ingestion deduplication key; the schema uses the `Network.IpAddress` scalar; the value is network address context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.request.ipChain.source`
Source records source of the IP information. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `source` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log Ip Chain Entry object returned for Audit Logs; it is interpreted at one Okta Log Ip Chain Entry record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.request.ipChain.version`
Version records IP version (V4 or V6). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `version` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Ip Chain Entry object returned for Audit Logs; it is interpreted at one Okta Log Ip Chain Entry record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.securityContext`
Security Context records security threat context including proxy and ISP information. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `securityContext` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is one nested object per containing Okta Log object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.securityContext.asNumber`
As Number records autonomous System Number of the client IP. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** correlate `asNumber` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Security Context object returned for Audit Logs; it is a Okta-reported count at one Okta Log Security Context record per row; the value is configured or derived address and place context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.securityContext.asOrg`
As Org records autonomous System Organization name. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `asOrg` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Security Context object returned for Audit Logs; it is interpreted at one Okta Log Security Context record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.securityContext.domain`
Domain records domain associated with the client IP. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** correlate `domain` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Security Context object returned for Audit Logs; it is interpreted at one Okta Log Security Context record per row; the value is configured or derived address and place context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.securityContext.isp`
Isp records internet Service Provider name. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `isp` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log Security Context object returned for Audit Logs; it is interpreted at one Okta Log Security Context record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.securityContext.isProxy`
Is Proxy records whether the client IP is a known proxy. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** correlate `isProxy` with the actor, request, or session on the same Okta event without treating it as proof of physical presence.
* **Interpretation:** Okta reports this value on the Okta Log Security Context object returned for Audit Logs; it is interpreted at one Okta Log Security Context record per row; the value is configured or derived address and place context; Okta attaches this context to a System Log event or request chain; it does not establish residency or verified physical location; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.securityContext.risk`
Risk records risk assessment for the event. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `risk` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log Security Context object returned for Audit Logs; it is one nested object per containing Okta Log Security Context object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.securityContext.risk.level`
Level records risk level (e.g. LOW, MEDIUM, HIGH). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `level` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Security Context object returned for Audit Logs; it is interpreted at one Okta Log Security Context record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.securityContext.risk.reasons`
Reasons records reasons contributing to the risk level. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `reasons` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Security Context object returned for Audit Logs; it is interpreted at one Okta Log Security Context record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.severity`
Severity records severity level of the event (DEBUG, INFO, WARN, ERROR). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `severity` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is interpreted at one Okta Log record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.target`
Target records array of target objects affected by the event. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `target` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is one returned collection per containing Okta Log object; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.target.alternateId`
Alternate ID records alternate identifier for the target, usually email or name. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `alternateId` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Target object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.target.changeDetails`
Change Details records before/after values describing configuration changes made to the target. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `changeDetails` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Target object returned for Audit Logs; it is interpreted at one Okta Log Target record per row; the schema uses the `Generic.JSON` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.target.detailEntry`
Detail Entry records additional details about the target as key-value pairs. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `detailEntry` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Target object returned for Audit Logs; it is interpreted at one Okta Log Target record per row; the schema uses the `Generic.JSON` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; keys and availability follow this Okta response and may vary by object type or Okta configuration.
Developer identifier: `audit_logs.target.displayName`
Display Name records human-readable display name of the target. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `displayName` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Target object returned for Audit Logs; it is interpreted at one Okta Log Target record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.target.id`
ID records unique identifier of the target. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `id` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Target object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.target.type`
Type records type of the target (e.g., User, AppInstance, AppUser, Group). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `type` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log Target object returned for Audit Logs; it is interpreted at one Okta Log Target record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.transaction`
Transaction records transaction details linking related events. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `transaction` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is one nested object per containing Okta Log object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.transaction.detail`
Detail records additional transaction details as key-value pairs. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `detail` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Transaction object returned for Audit Logs; it is interpreted at one Okta Log Transaction record per row; the schema uses the `Generic.JSON` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.transaction.id`
ID records unique transaction identifier. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `id` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log Transaction object returned for Audit Logs; it is an identifier, not a measured quantity; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.transaction.type`
Type records type of transaction (e.g., WEB, JOB). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Audit Logs investigation evidence with the exact `type` result, permission, or Okta classification being examined.
* **Interpretation:** Okta reports this value on the Okta Log Transaction object returned for Audit Logs; it is interpreted at one Okta Log Transaction record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `audit_logs.uuid`
UUID records unique identifier for the log event. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `uuid` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `audit_logs.version`
Version records versioning indicator for the log event schema. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate `version` with the returned actor, target, action, request, or session identifiers on the same Audit Logs evidence record.
* **Interpretation:** Okta reports this value on the Okta Log object returned for Audit Logs; it is interpreted at one Okta Log record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `users`
Users covers Okta org users.
* **Enables:** map the Okta accounts and memberships represented by Users records and trace a returned access assignment to its account or group.
* **Scope:** Okta org users; the connector reads `/api/v1/users` as a snapshot stream in incremental mode. Object and event visibility follows the API token's Okta administrative permissions; inaccessible objects or events are not returned. This stream has no deletion signal, so a missing row does not establish that the Okta record was deleted.
Provider-defined fields may also be returned for this data stream.
Developer identifier: `users._embedded`
Embedded records HAL-style embedded resources, if requested via expand parameter. It is needed to preserve the exact Okta configuration or execution metadata attached to this Okta User record.
* **Enables:** inspect the keys in `_embedded` when reproducing or investigating this record's configuration, parameters, or execution context.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is interpreted at one Okta User record per row; the schema uses the `Generic.JSON` scalar; metadata keys and availability follow the Okta response and can vary by resource type or configuration.
Developer identifier: `users._links`
Links records HAL-style hypermedia links for user actions and related resources. It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `_links` while retaining the containing Users record as provenance.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is link at one Okta User record per row; the schema uses the `Generic.JSON` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `users.activated`
Activated records timestamp when the user transitioned to ACTIVE status. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Users records by `activated`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is interpreted at one Okta User record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `users.created`
Created records timestamp when the user was created in Okta. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Users records by `created`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is interpreted at one Okta User record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `users.credentials`
Credentials records the user's credential information including provider and recovery question. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `credentials` to examine the returned credentials details for the containing Okta User record.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is one nested object per containing Okta User object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `users.credentials.emails`
Emails records array of email credential objects with verification status. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `emails` to examine the returned emails details for the containing User Credentials record.
* **Interpretation:** Okta reports this value on the User Credentials object returned for Users; it is one returned collection per containing User Credentials object; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `users.credentials.emails.status`
Status records verification status of the email (e.g., VERIFIED). It is needed to distinguish Users rows by the exact Okta-returned status value.
* **Enables:** separate Users rows by the exact Okta-returned `status` label when comparing status.
* **Interpretation:** Okta reports this value on the Credential Email object returned for Users; it is interpreted at one Credential Email record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `users.credentials.emails.type`
Type records type of email (e.g., PRIMARY). It is needed to distinguish Users rows by the exact Okta-returned type value.
* **Enables:** separate Users rows by the exact Okta-returned `type` label when comparing type.
* **Interpretation:** Okta reports this value on the Credential Email object returned for Users; it is interpreted at one Credential Email record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `users.credentials.emails.value`
Value records the email address. It is needed to distinguish repeated deliveries of the same Users row using the declared ingestion key.
* **Enables:** use `value` as the declared ingestion deduplication key for Users and match repeated rows carrying the same Okta identifier.
* **Interpretation:** Okta reports this value on the Credential Email object returned for Users; it is interpreted at one Credential Email record per row; the connector declares it as an ingestion deduplication key; the schema uses the `Contact.Email` scalar.
Developer identifier: `users.credentials.password`
Password records password credential metadata (hash details if present, never the actual password). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `password` access value with the resource, account, or membership represented by the same Users row.
* **Interpretation:** Okta reports this value on the User Credentials object returned for Users; it is interpreted at one User Credentials record per row; the schema uses the `Generic.JSON` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; the field describes credential metadata and never the actual password.
Developer identifier: `users.credentials.provider`
Provider records the credential provider that authenticated the user. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `provider` to examine the returned provider details for the containing User Credentials record.
* **Interpretation:** Okta reports this value on the User Credentials object returned for Users; it is one nested object per containing User Credentials object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `users.credentials.provider.name`
Name records name of the credential provider (e.g., OKTA, `ACTIVE_DIRECTORY`, LDAP, FEDERATION, SOCIAL, IMPORT). It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `name` access value with the resource, account, or membership represented by the same Users row.
* **Interpretation:** Okta reports this value on the Credential Provider object returned for Users; it is interpreted at one Credential Provider record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `users.credentials.provider.type`
Type records type of credential provider. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** select Users rows with the exact `type` access-related value being investigated.
* **Interpretation:** Okta reports this value on the Credential Provider object returned for Users; it is interpreted at one Credential Provider record per row; use it for investigation and evidence correlation; it does not prove that all activity or access is represented; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `users.credentials.recovery_question`
Recovery Question records recovery question for self-service password reset. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** expand `recovery_question` to examine the returned recovery question details for the containing User Credentials record.
* **Interpretation:** Okta reports this value on the User Credentials object returned for Users; it is one nested object per containing User Credentials object when present; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `users.credentials.recovery_question.question`
Question records the recovery question text. It is needed to inspect the exact recovery-question text returned for this Recovery Question record.
* **Enables:** attribute the recovery-question text in `question` to the containing Users identifier, owner or author, status, and update time where returned.
* **Interpretation:** Okta reports this value on the Recovery Question object returned for Users; it is interpreted at one Recovery Question record per row; this is only the recovery-question text included in the Okta response for this record.
Developer identifier: `users.id`
ID records unique identifier for the user. It is needed to distinguish repeated deliveries of the same Users row using the declared ingestion key.
* **Enables:** use `id` as the declared ingestion deduplication key for Users and match repeated rows carrying the same Okta identifier.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is an identifier, not a measured quantity; the connector declares it as an ingestion deduplication key.
Developer identifier: `users.lastLogin`
Last Login records timestamp of the user's most recent login. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Users records by `lastLogin`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is interpreted at one Okta User record per row; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `users.lastUpdated`
Last Updated records timestamp when the user record was last modified. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Users records by `lastUpdated`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is interpreted at one Okta User record per row; the connector also declares it for record ordering; the schema assigns the `metadata_timestamp` semantic role; the schema uses the `Temporal.DateTime` scalar.
Developer identifier: `users.passwordChanged`
Password Changed records timestamp when the user's password was last changed. It is needed to correlate the returned access or audit evidence with the subject and action represented by the same record.
* **Enables:** correlate the exact `passwordChanged` access value with the resource, account, or membership represented by the same Users row.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is interpreted at one Okta User record per row; the schema uses the `Temporal.DateTime` scalar; use it for investigation and evidence correlation; it does not prove that all activity or access is represented.
Developer identifier: `users.profile`
Profile records the user's profile attributes. It is needed to preserve the nested profile relationship or details on the parent Okta User record.
* **Enables:** expand `profile` to connect the containing Okta User row to its returned profile entries.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is one nested object per containing Okta User object when present.
Developer identifier: `users.profile.city`
City records city or locality of the user. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** compare the Okta-reported configured or derived address and place context in `city` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the value is configured or derived address and place context; this Okta-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `users.profile.costCenter`
Cost Center records cost center associated with the user. It is needed to preserve the exact Okta-reported business, directory, or identity attribute represented by this field.
* **Enables:** match or segment Users records by `costCenter` only within the same Okta attribute contract.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the value is a Okta-returned or configured label and is not a universal identity or business taxonomy.
Developer identifier: `users.profile.countryCode`
Country Code records ISO 3166-1 alpha-2 country code. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** compare the Okta-reported configured or derived address and place context in `countryCode` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the value is configured or derived address and place context; this Okta-reported or configured context does not establish residency or verified physical presence; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `users.profile.department`
Department records user's department. It is needed to compare the returned department for individual Users rows and select rows with a specific `department` value.
* **Enables:** trace the department relationship returned in `department` from the User Profile row to its named Okta context.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row.
Developer identifier: `users.profile.displayName`
Display Name records user's display name. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `displayName` value where it recurs in Okta.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `users.profile.division`
Division records division within the organization. It is needed to compare the returned division for individual Users rows and select rows with a specific `division` value.
* **Enables:** trace the division relationship returned in `division` from the User Profile row to its named Okta context.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row.
Developer identifier: `users.profile.email`
Email records user's primary email address. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `email` value where it recurs in Okta.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `users.profile.employeeNumber`
Employee Number records employee number from HR system. It is needed to refer to the same employee number across records without relying on display text.
* **Enables:** match `employeeNumber` to employee number references carrying the same Okta-issued value in related Okta records.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is an identifier, not a measured quantity.
Developer identifier: `users.profile.firstName`
First Name records user's first name. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `firstName` value where it recurs in Okta.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `users.profile.honorificPrefix`
Honorific Prefix records honorific prefix (e.g., Mr., Dr.). It is needed to preserve the exact Okta-reported business, directory, or identity attribute represented by this field.
* **Enables:** match or segment Users records by `honorificPrefix` only within the same Okta attribute contract.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the value is a Okta-returned or configured label and is not a universal identity or business taxonomy.
Developer identifier: `users.profile.honorificSuffix`
Honorific Suffix records honorific suffix (e.g., Jr., III). It is needed to preserve the exact Okta-reported business, directory, or identity attribute represented by this field.
* **Enables:** match or segment Users records by `honorificSuffix` only within the same Okta attribute contract.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the value is a Okta-returned or configured label and is not a universal identity or business taxonomy.
Developer identifier: `users.profile.lastName`
Last Name records user's last name. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `lastName` value where it recurs in Okta.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the schema uses the `Identity.Name` scalar.
Developer identifier: `users.profile.locale`
Locale records user's default location for date/time formatting (BCP 47). It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Users records by `locale`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the schema uses the `Localization.Locale` scalar.
Developer identifier: `users.profile.login`
Login records user's Okta login, typically an email address. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `login` value where it recurs in Okta.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `users.profile.manager`
Manager records user's manager (login or display name, depending on org config). It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `manager` value where it recurs in Okta.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row.
Developer identifier: `users.profile.managerId`
Manager ID records identifier for the user's manager. It is needed to refer to the same manager across records without relying on display text.
* **Enables:** match `managerId` to manager references carrying the same Okta-issued value in related Okta records.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is an identifier, not a measured quantity.
Developer identifier: `users.profile.middleName`
Middle Name records user's middle name. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `middleName` value where it recurs in Okta.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row.
Developer identifier: `users.profile.mobilePhone`
Mobile Phone records user's mobile phone number. It is needed to preserve the exact Okta-reported contact number for the person, company, or location represented by this row.
* **Enables:** match the exact contact number in `mobilePhone` to the same User Profile record without treating it as an account identifier.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the schema uses the `Contact.PhoneNumber` scalar.
Developer identifier: `users.profile.nickName`
Nick Name records user's casual or nickname. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `nickName` value where it recurs in Okta.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row.
Developer identifier: `users.profile.organization`
Organization records name of the user's organization. It is needed to compare the returned organization for individual Users rows and select rows with a specific `organization` value.
* **Enables:** trace the organization relationship returned in `organization` from the User Profile row to its named Okta context.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row.
Developer identifier: `users.profile.postalAddress`
Postal Address records mailing address of the user. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** compare the Okta-reported configured or derived address and place context in `postalAddress` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the value is configured or derived address and place context; this Okta-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `users.profile.preferredLanguage`
Preferred Language records user's preferred written or spoken language (RFC 7231). It is needed to preserve the Okta-reported language or locale preference for this identity.
* **Enables:** select identities by the exact `preferredLanguage` language or locale tag without inferring physical location.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; this Okta-reported setting or qualifier does not establish residency or verified physical presence.
Developer identifier: `users.profile.primaryPhone`
Primary Phone records user's primary phone number. It is needed to distinguish Users rows by the exact Okta-returned primary phone value.
* **Enables:** separate Users rows by the exact Okta-returned `primaryPhone` label when comparing primary phone.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the schema uses the `Contact.PhoneNumber` scalar; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `users.profile.profileUrl`
Profile URL records URL to the user's online profile (e.g., a web page). It is needed to inspect the exact link included with this record.
* **Enables:** open or correlate the exact Okta resource referenced by `profileUrl` while retaining the containing Users record as provenance.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is link at one User Profile record per row; the schema uses the `Network.Url` scalar; the returned link or template does not establish that the current credential can retrieve its target.
Developer identifier: `users.profile.secondEmail`
Second Email records user's secondary email address. It is needed to attribute this Users row to the returned person, account, or organization reference.
* **Enables:** attribute the Users row to the returned person or account and match the exact `secondEmail` value where it recurs in Okta.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the schema uses the `Contact.Email` scalar.
Developer identifier: `users.profile.state`
State records state or region of the user. It is needed to distinguish Users rows by the exact Okta-returned state value.
* **Enables:** separate Users rows by the exact Okta-returned `state` label when comparing state.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `users.profile.streetAddress`
Street Address records full street address of the user. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** compare the Okta-reported configured or derived address and place context in `streetAddress` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the value is configured or derived address and place context; this Okta-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `users.profile.team`
Team records user's team within the organization. It is needed to compare the returned team for individual Users rows and select rows with a specific `team` value.
* **Enables:** trace the team relationship returned in `team` from the User Profile row to its named Okta context.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row.
Developer identifier: `users.profile.timezone`
Timezone records user's time zone (IANA timezone identifier). It is needed to preserve the Okta-reported timezone or locale setting for the same record.
* **Enables:** compare the Okta-reported timezone or locale setting in `timezone` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is an identifier, not a measured quantity; the schema uses the `Temporal.TimeZone` scalar; the value is timezone or locale setting; this Okta-reported or configured context does not establish residency or verified physical presence.
Developer identifier: `users.profile.title`
Title records user's job title. It is needed to preserve the business or job title reported for the person represented by this row.
* **Enables:** select Users rows by the exact business or job title in `title` without treating the title as an authorization role.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row.
Developer identifier: `users.profile.userType`
User Type records used to describe the organization-to-user relationship (e.g., Employee, Contractor). It is needed to distinguish Users rows by the exact Okta-returned user type value.
* **Enables:** separate Users rows by the exact Okta-returned `userType` label when comparing user type.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `users.profile.zipCode`
Zip Code records zip code or postal code of the user. It is needed to preserve the Okta-reported configured or derived address and place context for the same record.
* **Enables:** compare the Okta-reported configured or derived address and place context in `zipCode` for individual Users rows without treating it as a verified physical location.
* **Interpretation:** Okta reports this value on the User Profile object returned for Users; it is interpreted at one User Profile record per row; the value is configured or derived address and place context; this Okta-reported or configured context does not establish residency or verified physical presence; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `users.realmId`
Realm ID records identifier of the realm the user belongs to. It is needed to refer to the same realm across records without relying on display text.
* **Enables:** match `realmId` to realm references carrying the same Okta-issued value in related Okta records.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is an identifier, not a measured quantity.
Developer identifier: `users.status`
Status records current lifecycle status of the user. It is needed to distinguish Users rows by the exact Okta-returned status value.
* **Enables:** separate Users rows by the exact Okta-returned `status` label when comparing status.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is interpreted at one Okta User record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `users.statusChanged`
Status Changed records timestamp when the user's status last changed. It is needed to place the record at the time or date reported for this event or state.
* **Enables:** bound Users records by `statusChanged`, order their returned events or state changes, and correlate records reported at the same time.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is interpreted at one Okta User record per row; the schema uses the `Temporal.DateTime` scalar; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `users.transitioningToStatus`
Transitioning To Status records target status of an in-progress asynchronous status transition, if any. It is needed to distinguish Users rows by the exact Okta-returned transitioning to status value.
* **Enables:** separate Users rows by the exact Okta-returned `transitioningToStatus` label when comparing transitioning to status.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is interpreted at one Okta User record per row; classification values are Okta-returned labels rather than a universal taxonomy.
Developer identifier: `users.type`
Type records the user type associated with this user. It is needed to preserve the nested type relationship or details on the parent Okta User record.
* **Enables:** expand `type` to connect the containing Okta User row to its returned type entries.
* **Interpretation:** Okta reports this value on the Okta User object returned for Users; it is one nested object per containing Okta User object when present.
Developer identifier: `users.type.id`
ID records unique identifier for the user type. It is needed to refer to the same user type across records without relying on display text.
* **Enables:** match `id` to user type references carrying the same Okta-issued value in related Okta records.
* **Interpretation:** Okta reports this value on the User Type object returned for Users; it is an identifier, not a measured quantity.
| Endpoint | Data |
| - | - |
| `/api/v1/users` | User profiles |
| `/api/v1/groups` | Groups and membership |
| `/api/v1/logs` | System audit logs |
| `/api/v1/apps` | Application assignments |
> **Tip:** **Rate Limits:** Okta enforces rate limits of **varies by endpoint; typically 100-1000 requests/minute**.
>
> If this occurs during syncing, Parable retries rate-limited requests with exponential backoff for a limited time, so large initial syncs may take longer. If the sync still fails, review the connection error before retrying. If this occurs during setup, wait briefly, then click **Save & test connection** again.
| Error | Meaning | Solution |
| - | - | - |
| `E0000011` | Invalid token | Verify token is correct |
| `E0000006` | Access denied | Verify token has required admin permissions |
| `E0000015` | Feature not enabled | Check required Okta features/licenses are active |
| `429` | Rate limit | If this occurs during setup, wait briefly, then click **Save & test connection** again. If this occurs during syncing, Parable retries automatically for a limited time. If the sync still fails, review the connection error before retrying. |
#### Common Issues
#### Token created by deactivated user
If the admin who created the token is deactivated, the token becomes invalid. Create a new token with an active admin account.
#### Can't access logs
System Log access requires Super Administrator or Report Administrator role.
**[Okta API](https://developer.okta.com/docs/reference/)** — Official API reference
**[Rate Limits](https://developer.okta.com/docs/reference/rate-limits/)** — Rate limit documentation
# Oracle Database
Source: https://docs.parable.work/plugins/provider-plugins/oracle
Sync data from Oracle Database instances
Sync data from Oracle Database instances.
Connect Parable to Oracle Financials Cloud (ERP) for financial and operational data.
#### Financials
General Ledger, Accounts Payable/Receivable
#### Users & Security
User profiles, roles, access
## Data streams
This Provider Plugin defines 0 data streams.
| Stream | Description | Sync |
| - | - | - |
| — | No customer-selectable data streams are declared. | — |
### Oracle Database
#### What You'll Need
| Credential | What it is |
| - | - |
| **Username** | Oracle Cloud username |
| **Password** | Oracle Cloud password |
| **Host** | Oracle Cloud host (e.g., `fa-abcd-saasfaprod1.fa.ocs.oraclecloud.com`) |
| **Port** | Database port (e.g., `1521`) |
| **Service Name** | Oracle service name (e.g., `ORCL`) |
| **Base URL** | Oracle REST API base URL |
> **Info:** **Setup access in Oracle Cloud.** These steps require **Administrator**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Oracle Cloud administrator.
* **Integration Specialist** or equivalent role
* REST API access enabled for your instance
* Understanding of Oracle Cloud data model
#### Step 1: Identify Your Instance URL
Your Oracle Cloud instance URL format:
```
https://server-instance.fa.us6.oraclecloud.com
```
Find this in your browser when logged into Oracle Cloud.
#### Step 2: Create Integration User
For best practices, create a dedicated integration user:
1. Navigate to **Security Console** → **Users**
2. Create a new user: `parable_integration`
3. Assign required roles (see permissions below)
#### Step 3: Assign Required Roles
The integration user needs these roles:
| Role | Purpose |
| - | - |
| `Financial Analyst` | Read financial data |
| `Integration Specialist` | API access |
| `Employee` | Basic data access |
> **Warning:** Grant only the minimum roles required for your use case.
#### Step 4: Note Your Credentials
| Credential | Value |
| - | - |
| Username | `parable_integration` |
| Password | (your secure password) |
| Instance URL | `https://your-instance.fa.us6.oraclecloud.com` |
#### Step 5: Enter values in the form
1. Enter **Username**, **Password**, **Host**, **Port**, **Service Name**, and **Base URL** in the Provider form.
2. Click **Save & test connection**.
This Provider Plugin does not declare any data streams.
| Service | Base Path |
| - | - |
| HCM | `/hcmRestApi/resources/` |
| Financials | `/fscmRestApi/resources/` |
| ERP Common | `/erpRestApi/resources/` |
> **Tip:** **Rate Limits:** Oracle Cloud enforces rate limits of **varies by service; monitor response headers**.
>
> Parable handles rate limiting automatically with exponential backoff, but initial syncs of large datasets may take longer due to these limits.
| Error | Meaning | Solution |
| - | - | - |
| `401 Unauthorized` | Invalid credentials | Verify username and password |
| `403 Forbidden` | Missing role | Add required role to user |
| `404 Not Found` | Wrong endpoint | Check API path and version |
| `500 Internal Server Error` | Server issue | Contact Oracle support |
#### Common Issues
#### User locked out
After multiple failed attempts, accounts may lock. Use Oracle Security Console to unlock.
#### API version mismatch
Oracle Cloud APIs have version-specific paths. Verify you're using the correct version for your instance.
**[Oracle REST API](https://docs.oracle.com/en/cloud/saas/financials/23a/farfa/)** — Financials REST API documentation
# Oracle Fusion Cloud
Source: https://docs.parable.work/plugins/provider-plugins/oraclefusioncloud
Sync audit history data from Oracle Fusion Cloud applications
Sync audit history data from Oracle Fusion Cloud applications.
Connect Parable to Oracle Fusion Cloud to sync Payables and General Ledger (Ledger) audit history events. Parable queries the Oracle Fusion Cloud Audit REST service incrementally using 7-day date-range windows (UTC).
> **Warning:** **Data sensitivity:** Audit payloads can include invoice and journal identifiers, internal IDs, user login names, and field-level attribute changes (amounts, vendors, accounts, and related financial metadata). Limit Parable access to users who are authorized to view Payables and General Ledger audit data in your organization.
#### Payables — Invoice Header
AP Invoice Header audit history (InvoiceHeaderVO) — creates, updates, and deletes
#### Payables — Invoice Line
AP Invoice Line audit history (InvoiceLineVO) — creates, updates, and deletes
#### Ledger — Journal Batch
GL Journal Batch audit history (JournalBatchVO) — creates, updates, and deletes
#### Ledger — Journal Header
GL Journal Header audit history (JournalHeaderVO) — creates, updates, and deletes
#### Ledger — Journal Line
GL Journal Line audit history (JournalLineVO) — creates, updates, and deletes
## Data streams
This Provider Plugin defines 5 data streams.
| Stream | Description | Sync |
| - | - | - |
| `audit_history_payables_invoice_header` | Retrieves Payables Invoice Header audit history events from Oracle Fusion Cloud. Captures create, update, and delete operations on AP Invoice Header objects (InvoiceHeaderVO). Syncs incrementally using 7-day date-range windows. | incremental |
| `audit_history_payables_invoice_line` | Retrieves Payables Invoice Line audit history events from Oracle Fusion Cloud. Captures create, update, and delete operations on AP Invoice Line objects (InvoiceLineVO). Syncs incrementally using 7-day date-range windows. | incremental |
| `audit_history_ledger_journal_batch` | Retrieves Ledger Journal Batch audit history events from Oracle Fusion Cloud. Captures create, update, and delete operations on GL Journal Batch objects (JournalBatchVO). Syncs incrementally using 7-day date-range windows. | incremental |
| `audit_history_ledger_journal_header` | Retrieves Ledger Journal Header audit history events from Oracle Fusion Cloud. Captures create, update, and delete operations on GL Journal Header objects (JournalHeaderVO). Syncs incrementally using 7-day date-range windows. | incremental |
| `audit_history_ledger_journal_line` | Retrieves Ledger Journal Line audit history events from Oracle Fusion Cloud. Captures create, update, and delete operations on GL Journal Line objects (JournalLineVO). Syncs incrementally using 7-day date-range windows. | incremental |
### Oracle Fusion Cloud
#### What You'll Need
| Credential | What it is |
| - | - |
| **Username** | Oracle Fusion Cloud username |
| **Password** | Oracle Fusion Cloud password |
| **Base URL** | Full base URL of your Oracle Fusion Cloud instance (e.g., `https://fa-exix-saasfaprod1.fa.ocs.oraclecloud.com`) |
> **Info:** **Setup access in Oracle Fusion Cloud.** These steps require **Administrator**, or a colleague with equivalent permissions who can create credentials for you.
>
> If that is not you, ask your Oracle Fusion Cloud administrator.
* Oracle Fusion Cloud user with access to the Financials Audit REST service
* The `Financial Auditor` or equivalent role that permits calling `/fscmRestApi/fndAuditRESTService/audittrail/getaudithistory`
* Audit trail enabled for the **Payables** and **Ledger** products in Oracle Fusion Cloud
#### Step 1: Enable Audit Trail for Payables and Ledger
In Oracle Fusion Cloud, navigate to **Setup and Maintenance** → **Manage Audit Policies**.
Enable audit for the **Payables** product and confirm the following business objects are checked:
| Business Object | Internal Name |
| - | - |
| Invoice (Header) | `InvoiceHeaderVO` |
| Invoice Line | `InvoiceLineVO` |
Enable audit for the **Ledger** product and confirm the following business objects are checked:
| Business Object | Internal Name |
| - | - |
| Journal Batch | `JournalBatchVO` |
| Journal Header | `JournalHeaderVO` |
| Journal Line | `JournalLineVO` |
> **Warning:** If these objects are not enabled, Parable will receive empty results and no data will sync for that tap.
#### Step 2: Identify Your Instance Hostname
Your Oracle Fusion Cloud instance hostname looks like:
```
fa-exix-saasfaprod1.fa.ocs.oraclecloud.com
```
Find this in your browser address bar when logged into Oracle Fusion Cloud (without the `https://` prefix).
#### Step 3: Create a Dedicated Integration User (Recommended)
For least-privilege access, create a dedicated integration user:
1. Navigate to **Security Console** → **Users**
2. Create a new user, e.g., `parable_integration`
3. Assign the **Financial Auditor** role (or a custom role granting read access to the Audit REST service)
> **Warning:** Grant only the minimum roles required. The integration user only needs read access to the Audit REST service.
#### Step 4: Enter credentials in Parable
Enter the following in the Provider form:
| Field | Value |
| - | - |
| **Username** | Your integration user username |
| **Password** | Your integration user password |
| **Base URL** | Full base URL of your instance (e.g., `https://fa-exix-saasfaprod1.fa.ocs.oraclecloud.com`) |
Click **Save & test connection**.
Developer identifier: `audit_history_ledger_journal_batch`
Audit History Ledger Journal Batch contains ledger Journal Batch audit history events from Oracle Fusion Cloud. Captures create, update, and delete operations on GL Journal Batch objects (`JournalBatchVO`). Syncs incrementally using 7-day date-range windows.
* **Enables:** trace create, update, and delete audit events for Oracle ledger journal batch objects across seven-day request windows.
* **Scope:** Reads provider changes through `POST /fscmRestApi/fndAuditRESTService/audittrail/getaudithistory` using the declared incremental request boundary. Results contain only audit rows returned for the named Oracle business object to the configured account; it is not a full transaction extract.
Developer identifier: `audit_history_ledger_journal_batch.attribute`
Attribute records display name of the attribute that was changed. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact attribute value attached to each audit history ledger journal batch record record.
* **Interpretation:** The provider supplies `attribute` at audit history ledger journal batch record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_batch.attributeDetails`
Attribute Details records array of attribute-level changes captured in the event. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded attribute details with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `attributeDetails` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_history_ledger_journal_batch.attributeInternalName`
Attribute Internal Name records internal name of the attribute that was changed. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact attribute internal name value attached to each audit history ledger journal batch record record.
* **Interpretation:** The provider supplies `attributeInternalName` at audit history ledger journal batch record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_batch.businessObject`
Business Object states business object affected by the event (e.g. Journal Batch). It preserves the provider's current classification of this record.
* **Enables:** separate audit history ledger journal batch records by the exact provider-reported business object value when describing their recorded state.
* **Interpretation:** The provider supplies `businessObject` per audit history ledger journal batch record record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_history_ledger_journal_batch.contextName1`
Context Name1 records display name of the first context attribute for the change (returned when `includeExtendedObjectIdentiferColumns` is true). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact context name1 value attached to each audit history ledger journal batch record record.
* **Interpretation:** The provider supplies `contextName1` at audit history ledger journal batch record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_batch.contextName2`
Context Name2 records display name of the second context attribute for the change. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact context name2 value attached to each audit history ledger journal batch record record.
* **Interpretation:** The provider supplies `contextName2` at audit history ledger journal batch record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_batch.contextName3`
Context Name3 records display name of the third context attribute for the change. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact context name3 value attached to each audit history ledger journal batch record record.
* **Interpretation:** The provider supplies `contextName3` at audit history ledger journal batch record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_batch.contextValue1`
Context Value1 records value of the first context attribute for the change. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded context value1 with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `contextValue1` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_history_ledger_journal_batch.contextValue2`
Context Value2 records value of the second context attribute for the change. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded context value2 with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `contextValue2` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_history_ledger_journal_batch.contextValue3`
Context Value3 records value of the third context attribute for the change. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded context value3 with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `contextValue3` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_history_ledger_journal_batch.date`
Date records the timestamp of the audit event (yyyy-MM-dd HH:mm:ss). It anchors the named event or boundary on the record's timeline.
* **Enables:** place audit history ledger journal batch records on a timeline by date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `date` per audit history ledger journal batch record record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `audit_history_ledger_journal_batch.description`
Description records human-readable description of the audit event. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each audit history ledger journal batch record record.
* **Interpretation:** The provider supplies `description` at audit history ledger journal batch record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_batch.descriptionInternal`
Description Internal identifies internal identifier of the affected object. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal batch records to provider records that carry the same description internal, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `descriptionInternal` as a record-level identifier on `AuditHistoryLedgerJournalBatchRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_batch.eventType`
Event Type states type of audit event (e.g. Create, Object Data Update, Delete). It preserves the provider's current classification of this record.
* **Enables:** separate audit history ledger journal batch records by the exact provider-reported event type value when describing their recorded state.
* **Interpretation:** The provider supplies `eventType` per audit history ledger journal batch record record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_history_ledger_journal_batch.id`
ID identifies synthetic primary key (SHA-1 hash of date, `userInternalName`, `qualifiedBusinessObject`, `eventType`, `descriptionInternal`, `attributeInternalName`, `newValueId`, `newValue`). It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same audit history ledger journal batch record source row before constructing its represented state.
* **Interpretation:** Parable generates `id` at one value per audit history ledger journal batch record record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `audit_history_ledger_journal_batch.impersonator`
Impersonator records name of the impersonator when the action was performed under impersonation (returned when `includeImpersonator` is true). It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the audit history ledger journal batch record record to the provider-reported person or account represented by impersonator.
* **Interpretation:** The provider supplies `impersonator` as identity or attribution context on each audit history ledger journal batch record record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `audit_history_ledger_journal_batch.newValue`
New Value records new value of the changed attribute. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded new value with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `newValue` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_history_ledger_journal_batch.newValueId`
New Value ID identifies internal ID of the new value, if the attribute references another object. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal batch records to provider records that carry the same new value ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `newValueId` as a record-level identifier on `AuditHistoryLedgerJournalBatchRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_batch.oldValue`
Old Value records prior value of the changed attribute before the audit event. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded old value with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `oldValue` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_history_ledger_journal_batch.oldValueId`
Old Value ID identifies internal ID of the prior value, if the attribute references another object. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal batch records to provider records that carry the same old value ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `oldValueId` as a record-level identifier on `AuditHistoryLedgerJournalBatchRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_batch.qualifiedBusinessObject`
Qualified Business Object states fully qualified view object name of the business object. It preserves the provider's current classification of this record.
* **Enables:** separate audit history ledger journal batch records by the exact provider-reported qualified business object value when describing their recorded state.
* **Interpretation:** The provider supplies `qualifiedBusinessObject` per audit history ledger journal batch record record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_history_ledger_journal_batch.userInternalName`
User Internal Name records internal login name of the user who performed the action. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the audit history ledger journal batch record record to the provider-reported actor represented by user internal name.
* **Interpretation:** The provider supplies `userInternalName` as identity or attribution context on each audit history ledger journal batch record record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `audit_history_ledger_journal_batch.userName`
User Name records display name of the user who performed the action. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the audit history ledger journal batch record record to the provider-reported actor represented by user name.
* **Interpretation:** The provider supplies `userName` as identity or attribution context on each audit history ledger journal batch record record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap`
Vo Foreign Key Map identifies map of view object foreign key values associated with the event. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal batch records to provider records that carry the same vo foreign key map, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `voForeignKeyMap` as a record-level identifier on `AuditHistoryLedgerJournalBatchRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.ChartOfAccountsId`
Chart Of Accounts ID carries the source identifier named Chart Of Accounts ID for each audit history ledger journal batch record row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal batch records to provider records that carry the same chart of accounts ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `ChartOfAccountsId` as a record-level identifier on `AuditHistoryLedgerJournalBatchRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.CodeCombinationId`
Code Combination ID carries the source identifier named Code Combination ID for each audit history ledger journal batch record row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal batch records to provider records that carry the same code combination ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `CodeCombinationId` as a record-level identifier on `AuditHistoryLedgerJournalBatchRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.CodeCombinationId1`
Code Combination Id1 carries the source configuration value named Code Combination Id1 for each audit history ledger journal batch record row. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact code combination id1 when validating the configuration or technical definition of a audit history ledger journal batch record record.
* **Interpretation:** The provider supplies `CodeCombinationId1` as configuration or technical metadata on `AuditHistoryLedgerJournalBatchRecord`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.ConversionType`
Conversion Type carries the source state or classification named Conversion Type for each audit history ledger journal batch record row. It preserves the provider's current classification of this record.
* **Enables:** separate audit history ledger journal batch records by the exact provider-reported conversion type value when describing their recorded state.
* **Interpretation:** The provider supplies `ConversionType` per audit history ledger journal batch record record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.CurrencyCode`
Currency Code carries the source currency code or label named Currency Code for each audit history ledger journal batch record row. It establishes the denomination used by companion financial amounts on the record.
* **Enables:** interpret companion financial amounts on each audit history ledger journal batch record record in the source denomination named by currency code.
* **Interpretation:** The source supplies `CurrencyCode` once per audit history ledger journal batch record record as its own currency code or label; Parable does not convert the associated amounts.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.CurrencyConversionType`
Currency Conversion Type carries the source state or classification named Currency Conversion Type for each audit history ledger journal batch record row. It preserves the provider's current classification of this record.
* **Enables:** separate audit history ledger journal batch records by the exact provider-reported currency conversion type value when describing their recorded state.
* **Interpretation:** The provider supplies `CurrencyConversionType` per audit history ledger journal batch record record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.EntityName`
Entity Name carries the source-authored value named Entity Name for each audit history ledger journal batch record row. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact entity name value attached to each audit history ledger journal batch record record.
* **Interpretation:** The provider supplies `EntityName` at audit history ledger journal batch record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.FunctionalCurrencyCode`
Functional Currency Code carries the source currency code or label named Functional Currency Code for each audit history ledger journal batch record row. It establishes the denomination used by companion financial amounts on the record.
* **Enables:** interpret companion financial amounts on each audit history ledger journal batch record record in the source denomination named by functional currency code.
* **Interpretation:** The source supplies `FunctionalCurrencyCode` once per audit history ledger journal batch record record as its own currency code or label; Parable does not convert the associated amounts.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.JeBatchId`
Je Batch ID carries the source identifier named Je Batch ID for each audit history ledger journal batch record row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal batch records to provider records that carry the same je batch ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `JeBatchId` as a record-level identifier on `AuditHistoryLedgerJournalBatchRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.JeCategory`
Je Category carries the source state or classification named Je Category for each audit history ledger journal batch record row. It preserves the provider's current classification of this record.
* **Enables:** separate audit history ledger journal batch records by the exact provider-reported je category value when describing their recorded state.
* **Interpretation:** The provider supplies `JeCategory` per audit history ledger journal batch record record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.LedgerId`
Ledger ID carries the source identifier named Ledger ID for each audit history ledger journal batch record row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal batch records to provider records that carry the same ledger ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `LedgerId` as a record-level identifier on `AuditHistoryLedgerJournalBatchRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.LedgersLedgerId`
Ledgers Ledger ID carries the source identifier named Ledgers Ledger ID for each audit history ledger journal batch record row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal batch records to provider records that carry the same ledgers ledger ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `LedgersLedgerId` as a record-level identifier on `AuditHistoryLedgerJournalBatchRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.LegalEntityId`
Legal Entity ID carries the source identifier named Legal Entity ID for each audit history ledger journal batch record row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal batch records to provider records that carry the same legal entity ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `LegalEntityId` as a record-level identifier on `AuditHistoryLedgerJournalBatchRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.ParentJeHeaderId`
Parent Je Header ID carries the source identifier named Parent Je Header ID for each audit history ledger journal batch record row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal batch records to provider records that carry the same parent je header ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `ParentJeHeaderId` as a record-level identifier on `AuditHistoryLedgerJournalBatchRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.PeriodName`
Period Name carries the source-authored value named Period Name for each audit history ledger journal batch record row. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact period name value attached to each audit history ledger journal batch record record.
* **Interpretation:** The provider supplies `PeriodName` at audit history ledger journal batch record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_batch.voForeignKeyMap.TaxStatusCode`
Tax Status Code carries the source state or classification named Tax Status Code for each audit history ledger journal batch record row. It preserves the provider's current classification of this record.
* **Enables:** separate audit history ledger journal batch records by the exact provider-reported tax status code value when describing their recorded state.
* **Interpretation:** The provider supplies `TaxStatusCode` per audit history ledger journal batch record record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_history_ledger_journal_header`
Audit History Ledger Journal Header contains ledger Journal Header audit history events from Oracle Fusion Cloud. Captures create, update, and delete operations on GL Journal Header objects (`JournalHeaderVO`). Syncs incrementally using 7-day date-range windows.
* **Enables:** trace create, update, and delete audit events for Oracle ledger journal header objects across seven-day request windows.
* **Scope:** Reads provider changes through `POST /fscmRestApi/fndAuditRESTService/audittrail/getaudithistory` using the declared incremental request boundary. Results contain only audit rows returned for the named Oracle business object to the configured account; it is not a full transaction extract.
Developer identifier: `audit_history_ledger_journal_header.attribute`
Attribute records display name of the attribute that was changed. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact attribute value attached to each audit history ledger journal header record record.
* **Interpretation:** The provider supplies `attribute` at audit history ledger journal header record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_header.attributeDetails`
Attribute Details records array of attribute-level changes captured in the event. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded attribute details with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `attributeDetails` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_history_ledger_journal_header.attributeInternalName`
Attribute Internal Name records internal name of the attribute that was changed. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact attribute internal name value attached to each audit history ledger journal header record record.
* **Interpretation:** The provider supplies `attributeInternalName` at audit history ledger journal header record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_header.businessObject`
Business Object states business object affected by the event (e.g. Journal Header). It preserves the provider's current classification of this record.
* **Enables:** separate audit history ledger journal header records by the exact provider-reported business object value when describing their recorded state.
* **Interpretation:** The provider supplies `businessObject` per audit history ledger journal header record record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_history_ledger_journal_header.contextName1`
Context Name1 records display name of the first context attribute for the change (returned when `includeExtendedObjectIdentiferColumns` is true). It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact context name1 value attached to each audit history ledger journal header record record.
* **Interpretation:** The provider supplies `contextName1` at audit history ledger journal header record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_header.contextName2`
Context Name2 records display name of the second context attribute for the change. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact context name2 value attached to each audit history ledger journal header record record.
* **Interpretation:** The provider supplies `contextName2` at audit history ledger journal header record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_header.contextName3`
Context Name3 records display name of the third context attribute for the change. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact context name3 value attached to each audit history ledger journal header record record.
* **Interpretation:** The provider supplies `contextName3` at audit history ledger journal header record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_header.contextValue1`
Context Value1 records value of the first context attribute for the change. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded context value1 with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `contextValue1` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_history_ledger_journal_header.contextValue2`
Context Value2 records value of the second context attribute for the change. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded context value2 with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `contextValue2` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_history_ledger_journal_header.contextValue3`
Context Value3 records value of the third context attribute for the change. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded context value3 with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `contextValue3` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_history_ledger_journal_header.date`
Date records the timestamp of the audit event (yyyy-MM-dd HH:mm:ss). It anchors the named event or boundary on the record's timeline.
* **Enables:** place audit history ledger journal header records on a timeline by date and select the records within an explicit reporting window.
* **Interpretation:** The provider supplies `date` per audit history ledger journal header record record as a timestamp at the precision returned by the provider; missing values mean the event or boundary was not reported.
Developer identifier: `audit_history_ledger_journal_header.description`
Description records human-readable description of the audit event. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact description value attached to each audit history ledger journal header record record.
* **Interpretation:** The provider supplies `description` at audit history ledger journal header record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_header.descriptionInternal`
Description Internal identifies internal identifier of the affected object. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal header records to provider records that carry the same description internal, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `descriptionInternal` as a record-level identifier on `AuditHistoryLedgerJournalHeaderRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_header.eventType`
Event Type states type of audit event (e.g. Create, Object Data Update, Delete). It preserves the provider's current classification of this record.
* **Enables:** separate audit history ledger journal header records by the exact provider-reported event type value when describing their recorded state.
* **Interpretation:** The provider supplies `eventType` per audit history ledger journal header record record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_history_ledger_journal_header.id`
ID identifies synthetic primary key (SHA-1 hash of date, `userInternalName`, `qualifiedBusinessObject`, `eventType`, `descriptionInternal`, `attributeInternalName`, `newValueId`, `newValue`). It supplies the declared record identity used when repeated ingestions represent the same source row.
* **Enables:** recognize repeated ingestions of the same audit history ledger journal header record source row before constructing its represented state.
* **Interpretation:** Parable generates `id` at one value per audit history ledger journal header record record, and `x-transformDedupKey` explicitly marks it as the record key.
Developer identifier: `audit_history_ledger_journal_header.impersonator`
Impersonator records name of the impersonator when the action was performed under impersonation (returned when `includeImpersonator` is true). It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the audit history ledger journal header record record to the provider-reported person or account represented by impersonator.
* **Interpretation:** The provider supplies `impersonator` as identity or attribution context on each audit history ledger journal header record record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `audit_history_ledger_journal_header.newValue`
New Value records new value of the changed attribute. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded new value with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `newValue` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_history_ledger_journal_header.newValueId`
New Value ID identifies internal ID of the new value, if the attribute references another object. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal header records to provider records that carry the same new value ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `newValueId` as a record-level identifier on `AuditHistoryLedgerJournalHeaderRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_header.oldValue`
Old Value records prior value of the changed attribute before the audit event. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded old value with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `oldValue` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_history_ledger_journal_header.oldValueId`
Old Value ID identifies internal ID of the prior value, if the attribute references another object. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal header records to provider records that carry the same old value ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `oldValueId` as a record-level identifier on `AuditHistoryLedgerJournalHeaderRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_header.qualifiedBusinessObject`
Qualified Business Object states fully qualified view object name of the business object. It preserves the provider's current classification of this record.
* **Enables:** separate audit history ledger journal header records by the exact provider-reported qualified business object value when describing their recorded state.
* **Interpretation:** The provider supplies `qualifiedBusinessObject` per audit history ledger journal header record record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_history_ledger_journal_header.userInternalName`
User Internal Name records internal login name of the user who performed the action. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the audit history ledger journal header record record to the provider-reported actor represented by user internal name.
* **Interpretation:** The provider supplies `userInternalName` as identity or attribution context on each audit history ledger journal header record record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `audit_history_ledger_journal_header.userName`
User Name records display name of the user who performed the action. It keeps the provider-reported person or account context attached to the record.
* **Enables:** attribute the audit history ledger journal header record record to the provider-reported actor represented by user name.
* **Interpretation:** The provider supplies `userName` as identity or attribution context on each audit history ledger journal header record record. Names and contact values can change and are not stable identifiers unless the provider documents them as such.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap`
Vo Foreign Key Map identifies map of view object foreign key values associated with the event. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal header records to provider records that carry the same vo foreign key map, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `voForeignKeyMap` as a record-level identifier on `AuditHistoryLedgerJournalHeaderRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.ChartOfAccountsId`
Chart Of Accounts ID carries the source identifier named Chart Of Accounts ID for each audit history ledger journal header record row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal header records to provider records that carry the same chart of accounts ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `ChartOfAccountsId` as a record-level identifier on `AuditHistoryLedgerJournalHeaderRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.CodeCombinationId`
Code Combination ID carries the source identifier named Code Combination ID for each audit history ledger journal header record row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal header records to provider records that carry the same code combination ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `CodeCombinationId` as a record-level identifier on `AuditHistoryLedgerJournalHeaderRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.CodeCombinationId1`
Code Combination Id1 carries the source configuration value named Code Combination Id1 for each audit history ledger journal header record row. It preserves the configuration or technical value needed to explain how the provider object is defined.
* **Enables:** inspect the exact code combination id1 when validating the configuration or technical definition of a audit history ledger journal header record record.
* **Interpretation:** The provider supplies `CodeCombinationId1` as configuration or technical metadata on `AuditHistoryLedgerJournalHeaderRecord`; consumers must preserve the exact syntax and documented vocabulary.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.ConversionType`
Conversion Type carries the source state or classification named Conversion Type for each audit history ledger journal header record row. It preserves the provider's current classification of this record.
* **Enables:** separate audit history ledger journal header records by the exact provider-reported conversion type value when describing their recorded state.
* **Interpretation:** The provider supplies `ConversionType` per audit history ledger journal header record record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.CurrencyCode`
Currency Code carries the source currency code or label named Currency Code for each audit history ledger journal header record row. It establishes the denomination used by companion financial amounts on the record.
* **Enables:** interpret companion financial amounts on each audit history ledger journal header record record in the source denomination named by currency code.
* **Interpretation:** The source supplies `CurrencyCode` once per audit history ledger journal header record record as its own currency code or label; Parable does not convert the associated amounts.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.CurrencyConversionType`
Currency Conversion Type carries the source state or classification named Currency Conversion Type for each audit history ledger journal header record row. It preserves the provider's current classification of this record.
* **Enables:** separate audit history ledger journal header records by the exact provider-reported currency conversion type value when describing their recorded state.
* **Interpretation:** The provider supplies `CurrencyConversionType` per audit history ledger journal header record record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.EntityName`
Entity Name carries the source-authored value named Entity Name for each audit history ledger journal header record row. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact entity name value attached to each audit history ledger journal header record record.
* **Interpretation:** The provider supplies `EntityName` at audit history ledger journal header record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.FunctionalCurrencyCode`
Functional Currency Code carries the source currency code or label named Functional Currency Code for each audit history ledger journal header record row. It establishes the denomination used by companion financial amounts on the record.
* **Enables:** interpret companion financial amounts on each audit history ledger journal header record record in the source denomination named by functional currency code.
* **Interpretation:** The source supplies `FunctionalCurrencyCode` once per audit history ledger journal header record record as its own currency code or label; Parable does not convert the associated amounts.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.JeBatchId`
Je Batch ID carries the source identifier named Je Batch ID for each audit history ledger journal header record row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal header records to provider records that carry the same je batch ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `JeBatchId` as a record-level identifier on `AuditHistoryLedgerJournalHeaderRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.JeCategory`
Je Category carries the source state or classification named Je Category for each audit history ledger journal header record row. It preserves the provider's current classification of this record.
* **Enables:** separate audit history ledger journal header records by the exact provider-reported je category value when describing their recorded state.
* **Interpretation:** The provider supplies `JeCategory` per audit history ledger journal header record record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.LedgerId`
Ledger ID carries the source identifier named Ledger ID for each audit history ledger journal header record row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal header records to provider records that carry the same ledger ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `LedgerId` as a record-level identifier on `AuditHistoryLedgerJournalHeaderRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.LedgersLedgerId`
Ledgers Ledger ID carries the source identifier named Ledgers Ledger ID for each audit history ledger journal header record row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal header records to provider records that carry the same ledgers ledger ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `LedgersLedgerId` as a record-level identifier on `AuditHistoryLedgerJournalHeaderRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.LegalEntityId`
Legal Entity ID carries the source identifier named Legal Entity ID for each audit history ledger journal header record row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal header records to provider records that carry the same legal entity ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `LegalEntityId` as a record-level identifier on `AuditHistoryLedgerJournalHeaderRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.ParentJeHeaderId`
Parent Je Header ID carries the source identifier named Parent Je Header ID for each audit history ledger journal header record row. It is needed to resolve references that repeat the same provider identifier.
* **Enables:** match audit history ledger journal header records to provider records that carry the same parent je header ID, without assuming that this field alone makes every row unique.
* **Interpretation:** The provider supplies `ParentJeHeaderId` as a record-level identifier on `AuditHistoryLedgerJournalHeaderRecord`. It is not a uniqueness guarantee unless a connector directive says so.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.PeriodName`
Period Name carries the source-authored value named Period Name for each audit history ledger journal header record row. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact period name value attached to each audit history ledger journal header record record.
* **Interpretation:** The provider supplies `PeriodName` at audit history ledger journal header record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_header.voForeignKeyMap.TaxStatusCode`
Tax Status Code carries the source state or classification named Tax Status Code for each audit history ledger journal header record row. It preserves the provider's current classification of this record.
* **Enables:** separate audit history ledger journal header records by the exact provider-reported tax status code value when describing their recorded state.
* **Interpretation:** The provider supplies `TaxStatusCode` per audit history ledger journal header record record using its own state vocabulary; unknown and missing values must remain distinct.
Developer identifier: `audit_history_ledger_journal_line`
Audit History Ledger Journal Line contains ledger Journal Line audit history events from Oracle Fusion Cloud. Captures create, update, and delete operations on GL Journal Line objects (`JournalLineVO`). Syncs incrementally using 7-day date-range windows.
* **Enables:** trace create, update, and delete audit events for Oracle ledger journal line objects across seven-day request windows.
* **Scope:** Reads provider changes through `POST /fscmRestApi/fndAuditRESTService/audittrail/getaudithistory` using the declared incremental request boundary. Results contain only audit rows returned for the named Oracle business object to the configured account; it is not a full transaction extract.
Developer identifier: `audit_history_ledger_journal_line.attribute`
Attribute records display name of the attribute that was changed. It keeps the exact text, label, or authored value needed to interpret the record.
* **Enables:** inspect the exact attribute value attached to each audit history ledger journal line record record.
* **Interpretation:** The provider supplies `attribute` at audit history ledger journal line record granularity in the format stated by its description; omitted or redacted content remains unknown.
Developer identifier: `audit_history_ledger_journal_line.attributeDetails`
Attribute Details records array of attribute-level changes captured in the event. It preserves the recorded before, after, or contextual value needed to explain a change event.
* **Enables:** compare the recorded attribute details with the corresponding changed attribute when explaining an audit or changelog event.
* **Interpretation:** The provider supplies `attributeDetails` on each change record in the changed attribute's own type or display format; it is not normalized into a common unit.
Developer identifier: `audit_history_ledger_journal_line.attributeInternalName`
Attribute Internal Name records internal name of the attr