> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-graphql-api/tracking/api-reference/state/streams.md).

# State streams

Reference for the tracking subscriptions: full asset or device state pushed on every report, delivered in batches with opening-snapshot markers and removal signals.

{% hint style="warning" %}
**Navixy GraphQL API is a work in progress.** This documentation is published for preview purposes only and doesn't reflect a stable release. Structure, field names, and behaviors are subject to change.
{% endhint %}

Subscriptions that push the full state of followed assets or devices on every report, with the batch, change and removal types they emit.

## Subscriptions

### trackingAssetStates

Full state of each followed asset, re-emitted whenever any of its devices reports.

Every message carries the whole state rather than a delta, so a client holds no state machine and a reconnect needs no reconciliation. The emission is a batch — see `TrackingAssetStateBatch` — which is what carries the opening-snapshot markers and lets an asset report that it has left the subscription.

```graphql
trackingAssetStates(
    input: TrackingAssetStateSubscriptionInput!
  ): TrackingAssetStateBatch!
```

**Arguments**

| Name    | Type                                   | Description                                            |
| ------- | -------------------------------------- | ------------------------------------------------------ |
| `input` | `TrackingAssetStateSubscriptionInput!` | What to follow, and how much of each state to deliver. |

**Input types:**

<details>

<summary>TrackingAssetStateSubscriptionInput</summary>

| Field                 | Type                                                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| --------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `workspaceId`         | `ID!`                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `assetIds`            | `[ID!]`                                                                | Assets to follow. Null means every asset visible to the caller in the workspace, up to a server-side ceiling on how many one subscription may follow; over it the subscription is refused with `VALIDATION_ERROR` rather than silently truncated. The query side paginates the same data, and a stream has no cursor to paginate with, so the ceiling is where that bound goes. The set is live in both directions. An asset that becomes visible after the subscription opened — created, linked, or access granted — joins it, and its first appearance is an ordinary change carrying its full `state`; there is no separate "added" marker, because a state a client has not seen before is that marker. Growing past the ceiling this way closes the stream with `VALIDATION_ERROR`, the same answer the same size gets at open. An explicit id the caller cannot see at open is not refused: it emits nothing until it becomes visible, symmetric to `ACCESS_REVOKED` on the way out. |
| `readingCodes`        | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | Narrow the delivered readings to these codes. Must be a subset of `TrackingQuery.hotFieldCodes` — see the note above this input for why a cold code cannot be honoured on a stream.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `eventCodes`          | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | Deliver only these event codes. Empty list — the default — delivers none; null delivers all, which a stuck level alarm turns into a repeated object in every batch. The emitted snapshot type carries no arguments, so this input is the only place the filter can live.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `includeInitialState` | `Boolean`                                                              | Emit the current state of everything followed before live updates begin, so a client does not have to query and subscribe separately and race between the two. Delivered in the same batches as live updates, not as one frame — a workspace-wide subscription would otherwise serialise its entire fleet into a single message.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `batchWindowMs`       | `Int`                                                                  | Coalescing window in milliseconds. Updates for the same asset within one window collapse into one message, and messages are delivered as a batch — nvx3's `state_batch` broadcaster, made explicit. 0 disables batching.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |

</details>

**Output types:**

<details>

<summary>TrackingAssetStateBatch</summary>

One emission on an asset-state stream.

An empty `changes` is legitimate and carries meaning: a subscription that matches nothing still receives one batch with `initialSnapshotComplete: true`, so a client's loading state always ends.

| Field                     | Type                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `changes`                 | \[[TrackingAssetStateChange](#trackingassetstatechange)!]! |                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `fromInitialSnapshot`     | `Boolean!`                                                 | True while the opening snapshot is being delivered, false for every batch after it. The opening snapshot may span several batches; the client learns it is done from `initialSnapshotComplete`, not from this turning false. Always false on a subscription opened with `includeInitialState: false` — there is no opening snapshot for a batch to belong to.                                                                                                            |
| `initialSnapshotComplete` | `Boolean!`                                                 | True on the last batch of the opening snapshot and on that batch only. Clear a loading state here. Never true again for the life of the subscription — a reconnect opens a new one. With `includeInitialState: false` the stream still opens with one empty batch carrying this true, for the same reason a subscription matching nothing does: a client ends its loading state on this flag alone, and should not have to special-case how the subscription was opened. |

</details>

***

### trackingDeviceStates

Full state of each followed device, re-emitted whenever it reports.

```graphql
trackingDeviceStates(
    input: TrackingDeviceStateSubscriptionInput!
  ): TrackingDeviceStateBatch!
```

**Arguments**

| Name    | Type                                    | Description                                            |
| ------- | --------------------------------------- | ------------------------------------------------------ |
| `input` | `TrackingDeviceStateSubscriptionInput!` | What to follow, and how much of each state to deliver. |

**Input types:**

<details>

<summary>TrackingDeviceStateSubscriptionInput</summary>

| Field                 | Type                                                                   | Description                                                                                                                                                                                                    |
| --------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `workspaceId`         | `ID!`                                                                  |                                                                                                                                                                                                                |
| `deviceIds`           | `[ID!]`                                                                | Devices to follow. Null means all visible ones, under the same ceiling as the asset stream, and the set is live on the same terms as `TrackingAssetStateSubscriptionInput.assetIds`.                           |
| `readingCodes`        | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | Narrow the delivered readings to these codes. Must be a subset of `TrackingQuery.hotFieldCodes` — see the note above `TrackingAssetStateSubscriptionInput` for why a cold code cannot be honoured on a stream. |
| `eventCodes`          | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | Deliver only these event codes. Empty list — the default — delivers none; null delivers all.                                                                                                                   |
| `includeInitialState` | `Boolean`                                                              | Emit the current state of everything followed before live updates begin, delivered in the same batches as live updates.                                                                                        |
| `batchWindowMs`       | `Int`                                                                  | Coalescing window in milliseconds. Updates for the same device within one window collapse into one message. 0 disables batching.                                                                               |

</details>

**Output types:**

<details>

<summary>TrackingDeviceStateBatch</summary>

The same, for a device-state stream.

| Field                     | Type                                                         | Description                                            |
| ------------------------- | ------------------------------------------------------------ | ------------------------------------------------------ |
| `changes`                 | \[[TrackingDeviceStateChange](#trackingdevicestatechange)!]! |                                                        |
| `fromInitialSnapshot`     | `Boolean!`                                                   | See `TrackingAssetStateBatch.fromInitialSnapshot`.     |
| `initialSnapshotComplete` | `Boolean!`                                                   | See `TrackingAssetStateBatch.initialSnapshotComplete`. |

</details>

***

## Objects

### TrackingDeviceStateSnapshot

What a subscription emits for one device. Field for field the same state as `TrackingDeviceState`; the only difference is that nothing here takes arguments — what a caller would have narrowed per field is narrowed once, in the subscription input.

A separate type, not the query one, because the restriction "no cold codes on a stream" has to be expressible in the schema. `TrackingDeviceState.readings(codes:, maxAge:)` is an ordinary field with arguments; if a stream emitted that type, a subscriber could ask for `readings(codes: ["obd_vin"])` in its selection set and get an archive lookup per device per message — exactly what the input-level restriction forbids, reached by a path the input never sees. Two types cost some duplication; a rule that only one of the two ways in respects costs an outage.

`device: Device!` stays a full BDR object rather than a bare id, deliberately: the stream is what a map renders from, and re-fetching titles over a second channel for every asset defeats that. The cost is that `Device`'s own collection fields (`inventoryHistory`, and `groups`/`customFields` on `Asset`) are reachable from a subscription's selection set, where they execute per emission — and the gateway's complexity limit cannot see it, being computed from the document alone. The per-emission budget is therefore part of the subscription implementation, not of the query limits.

| Field          | Type                                                                                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| -------------- | ------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `device`       | [Device](/docs/navixy-graphql-api/business-data-repository/api-reference/devices.md#device)!           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `carrier`      | [Device](/docs/navixy-graphql-api/business-data-repository/api-reference/devices.md#device)            | See `TrackingDeviceState.carrier`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `updatedAt`    | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime)                             | Event time of the most recent message. Null for a device that has never reported.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `connectivity` | [TrackingConnectivity](/docs/navixy-graphql-api/tracking/api-reference/state.md#trackingconnectivity)! |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `position`     | [TrackingPosition](/docs/navixy-graphql-api/tracking/api-reference/state.md#trackingposition)          | Selected on the same terms as `TrackingDeviceState.position`; its age is `position.at`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `motion`       | [TrackingMotion](/docs/navixy-graphql-api/tracking/api-reference/state.md#trackingmotion)              |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `readings`     | \[[TrackingReading](/docs/navixy-graphql-api/tracking/api-reference/readings.md#trackingreading)!]!    | The hot set, narrowed by the subscription's `readingCodes`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `lastEvents`   | \[[TrackingEvent](/docs/navixy-graphql-api/tracking/api-reference/state.md#trackingevent)!]!           | Same content and same retention as `TrackingDeviceState.lastEvents`, narrowed by the subscription's `eventCodes`. Not "the events of the message that triggered this emission": under `batchWindowMs` several messages collapse into one emission, so that message is not well-defined, and an emission caused by a heartbeat would clear an SOS the client may not have rendered yet. Whether a one-shot event is new is read from `code` and `occurredAt` against what the client last showed. A held alarm is the same object across emissions — identified by `code` and `since`, with `occurredAt` advancing on every repeat — so a changed `occurredAt` on it means a repeat, not a new event. The initial snapshot carries the same list, so a client reconnecting after an alarm sees it before the next repeat — "a reconnect needs no reconciliation" is why full state was chosen over deltas. The limit of full state applies here too: two one-shot events in one coalescing window leave only the later message's in the emission. A consumer that must see every event needs an event stream, which this contract does not declare. |

***

### TrackingAssetStateSnapshot

What a subscription emits for one asset: every device's snapshot, unmerged, on the same terms as `TrackingAssetState`.

| Field           | Type                                                                                      | Description                                                                                      |
| --------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `asset`         | [Asset](/docs/navixy-graphql-api/business-data-repository/api-reference/assets.md#asset)! | Full BDR object, on the same terms and at the same cost as `TrackingDeviceStateSnapshot.device`. |
| `updatedAt`     | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime)                | Newest `updatedAt` across the asset's devices.                                                   |
| `devices`       | \[[TrackingDeviceStateSnapshot](#trackingdevicestatesnapshot)!]!                          |                                                                                                  |
| `primaryDevice` | [TrackingDeviceStateSnapshot](#trackingdevicestatesnapshot)                               | Snapshot of `Asset.primaryDevice`; the same object also appears in `devices`.                    |

***

### TrackingAssetStateBatch

One emission on an asset-state stream.

An empty `changes` is legitimate and carries meaning: a subscription that matches nothing still receives one batch with `initialSnapshotComplete: true`, so a client's loading state always ends.

| Field                     | Type                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `changes`                 | \[[TrackingAssetStateChange](#trackingassetstatechange)!]! |                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `fromInitialSnapshot`     | `Boolean!`                                                 | True while the opening snapshot is being delivered, false for every batch after it. The opening snapshot may span several batches; the client learns it is done from `initialSnapshotComplete`, not from this turning false. Always false on a subscription opened with `includeInitialState: false` — there is no opening snapshot for a batch to belong to.                                                                                                            |
| `initialSnapshotComplete` | `Boolean!`                                                 | True on the last batch of the opening snapshot and on that batch only. Clear a loading state here. Never true again for the life of the subscription — a reconnect opens a new one. With `includeInitialState: false` the stream still opens with one empty batch carrying this true, for the same reason a subscription matching nothing does: a client ends its loading state on this flag alone, and should not have to special-case how the subscription was opened. |

***

### TrackingAssetStateChange

What happened to one asset in a batch: either its current full state, or the news that it is gone.

Exactly one of `state` and `removal` is non-null. `assetId` is present in both cases, because a client removing an entity from a view needs its id and no longer has a state to read it from.

A pair of nullable fields rather than a `TrackingAssetStateSnapshot | TrackingStreamRemoval` union, for handling: the id sits in one place for both outcomes, and a client reads two fields instead of switching on `__typename` across fragments. Not for extensibility — a third outcome would leave both fields null on a client built against this version, which the sentence above forbids, so it is a breaking change of the same kind as a new union member (§9).

| Field     | Type                                                      | Description                                                                 |
| --------- | --------------------------------------------------------- | --------------------------------------------------------------------------- |
| `assetId` | `ID!`                                                     |                                                                             |
| `state`   | [TrackingAssetStateSnapshot](#trackingassetstatesnapshot) | Full state as of this emission. Null when, and only when, `removal` is set. |
| `removal` | [TrackingStreamRemoval](#trackingstreamremoval)           | Why the asset stopped being followed. Null while it is still followed.      |

***

### TrackingDeviceStateBatch

The same, for a device-state stream.

| Field                     | Type                                                         | Description                                            |
| ------------------------- | ------------------------------------------------------------ | ------------------------------------------------------ |
| `changes`                 | \[[TrackingDeviceStateChange](#trackingdevicestatechange)!]! |                                                        |
| `fromInitialSnapshot`     | `Boolean!`                                                   | See `TrackingAssetStateBatch.fromInitialSnapshot`.     |
| `initialSnapshotComplete` | `Boolean!`                                                   | See `TrackingAssetStateBatch.initialSnapshotComplete`. |

***

### TrackingDeviceStateChange

Exactly one of `state` and `removal` is non-null, as in `TrackingAssetStateChange`.

| Field      | Type                                                        | Description |
| ---------- | ----------------------------------------------------------- | ----------- |
| `deviceId` | `ID!`                                                       |             |
| `state`    | [TrackingDeviceStateSnapshot](#trackingdevicestatesnapshot) |             |
| `removal`  | [TrackingStreamRemoval](#trackingstreamremoval)             |             |

***

### TrackingStreamRemoval

Why an entity left a subscription. Without this a client cannot tell "gone" from "quiet": an entity that stops being emitted looks exactly like one that simply has not reported.

| Field    | Type                                                                        | Description                           |
| -------- | --------------------------------------------------------------------------- | ------------------------------------- |
| `reason` | [TrackingStreamRemovalReason](#trackingstreamremovalreason)!                |                                       |
| `at`     | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime)! | When the server stopped following it. |

***

## Inputs

### TrackingAssetStateSubscriptionInput

| Field                 | Type                                                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| --------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `workspaceId`         | `ID!`                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `assetIds`            | `[ID!]`                                                                | Assets to follow. Null means every asset visible to the caller in the workspace, up to a server-side ceiling on how many one subscription may follow; over it the subscription is refused with `VALIDATION_ERROR` rather than silently truncated. The query side paginates the same data, and a stream has no cursor to paginate with, so the ceiling is where that bound goes. The set is live in both directions. An asset that becomes visible after the subscription opened — created, linked, or access granted — joins it, and its first appearance is an ordinary change carrying its full `state`; there is no separate "added" marker, because a state a client has not seen before is that marker. Growing past the ceiling this way closes the stream with `VALIDATION_ERROR`, the same answer the same size gets at open. An explicit id the caller cannot see at open is not refused: it emits nothing until it becomes visible, symmetric to `ACCESS_REVOKED` on the way out. |
| `readingCodes`        | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | Narrow the delivered readings to these codes. Must be a subset of `TrackingQuery.hotFieldCodes` — see the note above this input for why a cold code cannot be honoured on a stream.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `eventCodes`          | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | Deliver only these event codes. Empty list — the default — delivers none; null delivers all, which a stuck level alarm turns into a repeated object in every batch. The emitted snapshot type carries no arguments, so this input is the only place the filter can live.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `includeInitialState` | `Boolean`                                                              | Emit the current state of everything followed before live updates begin, so a client does not have to query and subscribe separately and race between the two. Delivered in the same batches as live updates, not as one frame — a workspace-wide subscription would otherwise serialise its entire fleet into a single message.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `batchWindowMs`       | `Int`                                                                  | Coalescing window in milliseconds. Updates for the same asset within one window collapse into one message, and messages are delivered as a batch — nvx3's `state_batch` broadcaster, made explicit. 0 disables batching.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |

***

### TrackingDeviceStateSubscriptionInput

| Field                 | Type                                                                   | Description                                                                                                                                                                                                    |
| --------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `workspaceId`         | `ID!`                                                                  |                                                                                                                                                                                                                |
| `deviceIds`           | `[ID!]`                                                                | Devices to follow. Null means all visible ones, under the same ceiling as the asset stream, and the set is live on the same terms as `TrackingAssetStateSubscriptionInput.assetIds`.                           |
| `readingCodes`        | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | Narrow the delivered readings to these codes. Must be a subset of `TrackingQuery.hotFieldCodes` — see the note above `TrackingAssetStateSubscriptionInput` for why a cold code cannot be honoured on a stream. |
| `eventCodes`          | \[[Code](/docs/navixy-graphql-api/core-api-reference/common.md#code)!] | Deliver only these event codes. Empty list — the default — delivers none; null delivers all.                                                                                                                   |
| `includeInitialState` | `Boolean`                                                              | Emit the current state of everything followed before live updates begin, delivered in the same batches as live updates.                                                                                        |
| `batchWindowMs`       | `Int`                                                                  | Coalescing window in milliseconds. Updates for the same device within one window collapse into one message. 0 disables batching.                                                                               |

***

## Enums

### TrackingStreamRemovalReason

A client must treat an unrecognised value as a plain removal and drop the entity — the list will grow, and the safe default is the one every member already shares. Do not switch exhaustively over it without that fallback.

| Value            | Description                                                     |
| ---------------- | --------------------------------------------------------------- |
| `ACCESS_REVOKED` | The subscriber lost the right to see it.                        |
| `DELETED`        | The asset or device was deleted.                                |
| `FILTERED_OUT`   | It no longer satisfies the subscription's filter.               |
| `UNLINKED`       | The device was unlinked from the asset it was followed through. |

***

## See also

* [Pagination](/docs/navixy-graphql-api/pagination.md)
* [Filtering and sorting](/docs/navixy-graphql-api/filtering-and-sorting.md)
* [Error handling](/docs/navixy-graphql-api/error-handling.md)
* [Optimistic locking](/docs/navixy-graphql-api/optimistic-locking.md)
* [Limits](/docs/navixy-graphql-api/limits.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-graphql-api/tracking/api-reference/state/streams.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.