Change quix.ai to quix.io

README.md

@@ -5,7 +5,7 @@
 
 This repository is the source content for the Quix documentation that is published on the web at https://quix.io/docs. The source files for the documentation are in GitHub-flavoured Markdown, with the additions supported by our tooling, [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
 
-To get a free Quix account, [sign up](https://portal.platform.quix.ai/self-sign-up).
+To get a free Quix account, [sign up](https://portal.platform.quix.io/self-sign-up).
 
 ## Docs releases
 

docs/apis/portal-api/http-requests.md

@@ -29,13 +29,13 @@ Read the documentation on how to obtain your environment ID.
 The API endpoint URL has the following format:
 
 ```
-https://<api-name>-<environment-id>.platform.quix.ai/<action>
+https://<api-name>-<environment-id>.platform.quix.io/<action>
 ```
 
 So, for example, the endpoint URL for the streaming writer might resemble the following:
 
 ```
-https://writer-acme-weather.platform.quix.ai/<action>
+https://writer-acme-weather.platform.quix.io/<action>
 ```
 
 The API is `writer`, and the environment ID is `acme-weather`.
@@ -81,5 +81,5 @@ You should structure most of your requests to the API around this pattern:
 curl -H "Authorization: bearer ${token}" \
      -H "Content-Type: application/json" \
      -d "@data.json" \
-     https://${api-name}-${environment-id}.platform.quix.ai/<action>
+     https://${api-name}-${environment-id}.platform.quix.io/<action>
 ```

docs/apis/portal-api/setup.md

@@ -2,7 +2,7 @@
 
 To use the APIs you'll typically need the following:
 
-1. [Sign up to Quix](https://portal.platform.quix.ai/self-sign-up).
+1. [Sign up to Quix](https://portal.platform.quix.io/self-sign-up).
 
 2. Obtain a Personal Access Token - you need this to authenticate requests.
 
@@ -42,19 +42,19 @@ In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to gener
 
 When using APIs you’ll need to obtain an ID based on a specific environment. For example, endpoints for the [Query API](../../apis/query-api/overview.md) use a domain with the following pattern:
 
-    https://telemetry-query-${environment-id}.platform.quix.ai/
+    https://telemetry-query-${environment-id}.platform.quix.io/
 
 The environment ID is a combination of your organization and environment names, converted to URL friendly values. 
 
 ### Obtain your environment ID from the URL
 
-1.  Go to the [Portal home](https://portal.platform.quix.ai/){target=_blank}.
+1.  Go to the [Portal home](https://portal.platform.quix.io/){target=_blank}.
 
 2.  Locate the environment you’re interested in and open it.
 
 3.  At this point, take note of the URL. It will be in the form:
 
-    https://portal.platform.quix.ai/home?workspace={environment-id}
+    https://portal.platform.quix.io/home?workspace={environment-id}
 
 ### Obtain environment ID from settings
 
@@ -67,7 +67,7 @@ You can also get the environment ID from Settings. Click `Settings` in the botto
 Given the following URL for the environment:
 
 ```
-https://portal.platform.quix.ai/pipeline?workspace=joeengland-apitests-testing
+https://portal.platform.quix.io/pipeline?workspace=joeengland-apitests-testing
 ```
 
 The environment ID is:
@@ -86,7 +86,7 @@ Copy the value for `environment-id` and use it wherever you need an environment
 
 !!! note
 
-    The `workspace=` parameter in the URL `https://portal.platform.quix.ai/home?workspace={environment-id}` is there for legacy reasons, and does in fact indicate an environment.
+    The `workspace=` parameter in the URL `https://portal.platform.quix.io/home?workspace={environment-id}` is there for legacy reasons, and does in fact indicate an environment.
 
 ## API reference documentation
 
@@ -96,10 +96,10 @@ The URLs for the API references are specific to your environment, so you can eas
 
 | API | API reference URL (Swagger documentation)|
 |---|---|
-| Streaming Writer | https://writer-`<environment-id>`.platform.quix.ai/swagger |
+| Streaming Writer | https://writer-`<environment-id>`.platform.quix.io/swagger |
 | Streaming Reader | No HTTP/REST interface - SignalR (WebSockets or Long Polling)|
-| Portal | https://portal-api.platform.quix.ai/swagger |
-| Query | https://telemetry-query-`<environment-id>`.platform.quix.ai/swagger |
+| Portal | https://portal-api.platform.quix.io/swagger |
+| Query | https://telemetry-query-`<environment-id>`.platform.quix.io/swagger |
 
 Replace `<environment-id>` with your environment ID.
 

docs/apis/query-api/filter-tags.md

@@ -66,7 +66,7 @@ Each object in the `tagFilters` array can support the following `operator` value
 `Like` and `NotLike` perform a regular expression match, so you can search by pattern. For example, to get the Speed parameter values tagged with a LapNumber which is either 2 or 4, you can use the expression `^\[24\]\\.` to match values 2.0 and 4.0:
 
 ```bash
-curl "https://telemetry-query-testing-quickstart.platform.quix.ai/parameters/data" \
+curl "https://telemetry-query-testing-quickstart.platform.quix.io/parameters/data" \
      -H "Authorization: bearer ${token}" \
      -H "Content-Type: application/json" \
      -d '{

docs/apis/query-api/http-requests.md

@@ -27,13 +27,13 @@ APIs are available on a per-environment basis (with the exception of the Portal
 The API endpoint URL has the following format:
 
 ```
-https://<api-name>-<environment-id>.platform.quix.ai/<action>
+https://<api-name>-<environment-id>.platform.quix.io/<action>
 ```
 
 So, for example, the endpoint URL for the streaming writer might resemble the following:
 
 ```
-https://writer-acme-weather.platform.quix.ai/<action>
+https://writer-acme-weather.platform.quix.io/<action>
 ```
 
 The API is `writer`, and the environment ID is `acme-weather`.
@@ -79,5 +79,5 @@ You should structure most of your requests to the API around this pattern:
 curl -H "Authorization: bearer ${token}" \
      -H "Content-Type: application/json" \
      -d "@data.json" \
-     https://${api-name}-${environment-id}.platform.quix.ai/<action>
+     https://${api-name}-${environment-id}.platform.quix.io/<action>
 ```

docs/apis/query-api/raw-data.md

@@ -25,7 +25,7 @@ In this example, we’re requesting a single numeric parameter, `Speed`. Each ar
 ### Example
 
 ```bash
-curl "https://${domain}.platform.quix.ai/parameters/data" \
+curl "https://${domain}.platform.quix.io/parameters/data" \
     -H "accept: text/plain" \
     -H "Authorization: bearer <token>" \
     -H "Content-Type: application/json" \

docs/apis/query-api/setup.md

@@ -2,7 +2,7 @@
 
 To use the APIs you'll typically need the following:
 
-1. [Sign up to Quix](https://portal.platform.quix.ai/self-sign-up).
+1. [Sign up to Quix](https://portal.platform.quix.io/self-sign-up).
 
 2. Obtain a Personal Access Token - you need this to authenticate requests.
 
@@ -42,19 +42,19 @@ In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to gener
 
 When using APIs you’ll need to obtain an ID based on a specific environment. For example, endpoints for the Query API use a domain with the following pattern:
 
-    https://telemetry-query-${environment-id}.platform.quix.ai/
+    https://telemetry-query-${environment-id}.platform.quix.io/
 
 The environment ID is a combination of your organization and environment names, converted to URL friendly values. 
 
 ### Obtain your environment ID from the URL
 
-1.  Go to the [Portal home](https://portal.platform.quix.ai/){target=_blank}.
+1.  Go to the [Portal home](https://portal.platform.quix.io/){target=_blank}.
 
 2.  Locate the environment you’re interested in and open it.
 
 3.  At this point, take note of the URL. It will be in the form:
 
-    https://portal.platform.quix.ai/home?workspace={environment-id}
+    https://portal.platform.quix.io/home?workspace={environment-id}
 
 ### Obtain environment ID from settings
 
@@ -67,7 +67,7 @@ You can also get the environment ID from Settings. Click `Settings` in the botto
 Given the following URL for the environment:
 
 ```
-https://portal.platform.quix.ai/pipeline?workspace=joeengland-apitests-testing
+https://portal.platform.quix.io/pipeline?workspace=joeengland-apitests-testing
 ```
 
 The environment ID is:
@@ -86,7 +86,7 @@ Copy the value for `environment-id` and use it wherever you need an environment
 
 !!! note
 
-    The `workspace=` parameter in the URL `https://portal.platform.quix.ai/home?workspace={environment-id}` is there for legacy reasons, and does in fact indicate an environment.
+    The `workspace=` parameter in the URL `https://portal.platform.quix.io/home?workspace={environment-id}` is there for legacy reasons, and does in fact indicate an environment.
 
 ## API reference documentation
 
@@ -96,10 +96,10 @@ The URLs for the API references are specific to your environment, so you can eas
 
 | API | API reference URL (Swagger documentation)|
 |---|---|
-| Streaming Writer | https://writer-`<environment-id>`.platform.quix.ai/swagger |
+| Streaming Writer | https://writer-`<environment-id>`.platform.quix.io/swagger |
 | Streaming Reader | No HTTP/REST interface - SignalR (WebSockets or Long Polling)|
-| Portal | https://portal-api.platform.quix.ai/swagger |
-| Query | https://telemetry-query-`<environment-id>`.platform.quix.ai/swagger |
+| Portal | https://portal-api.platform.quix.io/swagger |
+| Query | https://telemetry-query-`<environment-id>`.platform.quix.io/swagger |
 
 Replace `<environment-id>` with your environment ID.
 

docs/apis/query-api/streams-filtered.md

@@ -7,7 +7,7 @@ To fetch specific streams, you can include various filters with your request to
 The most basic filter matches against a stream’s ID:
 
 ```bash
-curl "https://${domain}.platform.quix.ai/streams" \
+curl "https://${domain}.platform.quix.io/streams" \
      -H "Authorization: bearer ${token}" \
      -H "Content-Type: application/json" \
      -d '{"streamIds": ["302b1de3-2338-43cb-8148-3f0d6e8c0b8a"]}'
@@ -20,7 +20,7 @@ Note that you can supply multiple IDs in the `streamIds` array to match multiple
 The **location** of a stream defines its position in a hierarchy. A stream location looks just like a filesystem path. You can filter streams based on the start of this path, so you can easily find streams contained within any point in the hierarchy. For example, this query will find streams with a location of `/one` but it will also find streams with a `/one/two` location:
 
 ```bash
-curl "https://${domain}.platform.quix.ai/streams" \
+curl "https://${domain}.platform.quix.io/streams" \
      -H "Authorization: bearer ${token}" \
      -H "Content-Type: application/json" \
      -d '{"location": "/one"}'
@@ -37,7 +37,7 @@ curl "https://${domain}.platform.quix.ai/streams" \
 You can filter streams based on their use of a given **parameter** with the `parameterIds` property. For example, to find all streams that contain at least one single occurence of `Gear` data:
 
 ```bash
-curl "https://${domain}.platform.quix.ai/streams" \
+curl "https://${domain}.platform.quix.io/streams" \
      -H "Authorization: bearer ${token}" \
      -H "Content-Type: application/json" \
      -d '{"parameterIds": [ "Gear"] }'
@@ -46,7 +46,7 @@ curl "https://${domain}.platform.quix.ai/streams" \
 You can filter based on the presence or absence of a certain stream **status**, for example, if the stream is `Open` or was `Interrupted`. The `includeStatuses` and `excludeStatuses` properties each take an array of values to act on. So to get all streams that aren’t Interrupted or Closed, use this query:
 
 ```bash
-curl "https://${domain}.platform.quix.ai/streams" \
+curl "https://${domain}.platform.quix.io/streams" \
      -H "Authorization: bearer ${token}" \
      -H "Content-Type: application/json" \
      -d '{"excludeStatuses": [ "Interrupted", "Closed" ]}'
@@ -108,7 +108,7 @@ Calls to the `/streams` endpoint can include an `ordering` property in the paylo
 For example, to sort all streams in ascending order by topic:
 
 ```bash
-curl "https://${domain}.platform.quix.ai/streams" \
+curl "https://${domain}.platform.quix.io/streams" \
      -H "Authorization: bearer ${token}" \
      -H "Content-Type: application/json" \
      -d '{"ordering": [{ "by": "topic", "direction": "asc" }]}'

docs/apis/query-api/streams-models.md

@@ -11,7 +11,7 @@ The `/streams/models` endpoint will return data in the same structure as [the `/
 The payload requirements are the same as those for `/streams`. You can fetch model information across all streams with an empty payload:
 
 ```shell
-curl "https://${domain}.platform.quix.ai/streams/models" \
+curl "https://${domain}.platform.quix.io/streams/models" \
      -H "Authorization: bearer ${token}" \
      -H "Content-Type: application/json" \
      -d "{}"

docs/apis/query-api/streams-paged.md

@@ -13,7 +13,7 @@ The `/streams` endpoint provides read access to all streams within the environme
 ### Example request
 
 ```shell
-curl "https://${domain}.platform.quix.ai/streams" \
+curl "https://${domain}.platform.quix.io/streams" \
      -H "Authorization: bearer ${token}" \
      -H "Content-Type: application/json" \
      -d "{}"
@@ -61,7 +61,7 @@ For example, to group all streams in pages of 10 and receive the 2nd page, use t
 ### Example request
 
 ```shell
-curl "https://${domain}.platform.quix.ai/streams" \
+curl "https://${domain}.platform.quix.io/streams" \
      -H "Authorization: bearer ${token}" \
      -H "Content-Type: application/json" \
      -d '{"paging":{"index": 1,"length": 10}}'

docs/apis/streaming-reader-api/reading-data.md

@@ -27,7 +27,7 @@ const options = {
 };
 
 const connection = new signalR.HubConnectionBuilder()
-    .withUrl("https://reader-YOUR_ENVIRONMENT_ID.platform.quix.ai/hub", options)
+    .withUrl("https://reader-YOUR_ENVIRONMENT_ID.platform.quix.io/hub", options)
     .build();
 
 // Establish connection (1)
@@ -57,5 +57,5 @@ connection.start().then(() => {
 Note that SignalR will confirm its connection method, with logging such as the following:
 
 ``` shell
-[2023-10-09T15:23:27.993Z] Information: WebSocket connected to wss://reader-joeengland-apitests-testing.platform.quix.ai/hub?id=ABC9Ctg5zdQ7aAzXYX.
+[2023-10-09T15:23:27.993Z] Information: WebSocket connected to wss://reader-joeengland-apitests-testing.platform.quix.io/hub?id=ABC9Ctg5zdQ7aAzXYX.
 ```

docs/apis/streaming-reader-api/setup.md

@@ -2,7 +2,7 @@
 
 To use the APIs you'll typically need the following:
 
-1. [Sign up to Quix](https://portal.platform.quix.ai/self-sign-up).
+1. [Sign up to Quix](https://portal.platform.quix.io/self-sign-up).
 
 2. Obtain a Personal Access Token - you need this to authenticate requests.
 
@@ -42,19 +42,19 @@ In the `APIs and tokens` dialog, you can click `Personal Access Tokens` to gener
 
 When using APIs you’ll need to obtain an ID based on a specific environment. For example, endpoints for the Query API use a domain with the following pattern:
 
-    https://telemetry-query-${environment-id}.platform.quix.ai/
+    https://telemetry-query-${environment-id}.platform.quix.io/
 
 The environment ID is a combination of your organization and environment names, converted to URL friendly values. 
 
 ### Obtain your environment ID from the URL
 
-1.  Go to the [Portal home](https://portal.platform.quix.ai/){target=_blank}.
+1.  Go to the [Portal home](https://portal.platform.quix.io/){target=_blank}.
 
 2.  Locate the environment you’re interested in and open it.
 
 3.  At this point, take note of the URL. It will be in the form:
 
-    https://portal.platform.quix.ai/home?workspace={environment-id}
+    https://portal.platform.quix.io/home?workspace={environment-id}
 
 ### Obtain environment ID from settings
 
@@ -67,7 +67,7 @@ You can also get the environment ID from Settings. Click `Settings` in the botto
 Given the following URL for the environment:
 
 ```
-https://portal.platform.quix.ai/pipeline?workspace=joeengland-apitests-testing
+https://portal.platform.quix.io/pipeline?workspace=joeengland-apitests-testing
 ```
 
 The environment ID is:
@@ -86,7 +86,7 @@ Copy the value for `environment-id` and use it wherever you need an environment
 
 !!! note
 
-    The `workspace=` parameter in the URL `https://portal.platform.quix.ai/home?workspace={environment-id}` is there for legacy reasons, and does in fact indicate an environment.
+    The `workspace=` parameter in the URL `https://portal.platform.quix.io/home?workspace={environment-id}` is there for legacy reasons, and does in fact indicate an environment.
 
 ## API reference documentation
 
@@ -96,10 +96,10 @@ The URLs for the API references are specific to your environment, so you can eas
 
 | API | API reference URL (Swagger documentation)|
 |---|---|
-| Streaming Writer | https://writer-`<environment-id>`.platform.quix.ai/swagger |
+| Streaming Writer | https://writer-`<environment-id>`.platform.quix.io/swagger |
 | Streaming Reader | No HTTP/REST interface - SignalR (WebSockets or Long Polling)|
-| Portal | https://portal-api.platform.quix.ai/swagger |
-| Query | https://telemetry-query-`<environment-id>`.platform.quix.ai/swagger |
+| Portal | https://portal-api.platform.quix.io/swagger |
+| Query | https://telemetry-query-`<environment-id>`.platform.quix.io/swagger |
 
 Replace `<environment-id>` with your environment ID.
 
@@ -162,7 +162,7 @@ You should also replace `YOUR_ENVIRONMENT_ID` with your environment ID.
     };
 
     const connection = new signalR.HubConnectionBuilder()
-        .withUrl("https://writer-" + environmentId + ".platform.quix.ai/hub", options)
+        .withUrl("https://writer-" + environmentId + ".platform.quix.io/hub", options)
         .build();
 
     connection.start().then(() => console.log("SignalR connected."));
@@ -178,7 +178,7 @@ You should also replace `YOUR_ENVIRONMENT_ID` with your environment ID.
       };
 
       const connection = new signalR.HubConnectionBuilder()
-          .withUrl("https://reader-YOUR_ENVIRONMNENT_ID.platform.quix.ai/hub", options)
+          .withUrl("https://reader-YOUR_ENVIRONMNENT_ID.platform.quix.io/hub", options)
           .build();
 
       connection.start().then(() => console.log("SignalR connected."));