Skip to content

Commit ba70fdd

Browse files
authored
DOCS-3509: More updates to data automation (#3979)
1 parent 512a52b commit ba70fdd

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

static/include/app/apis/generated/data-table.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
| [`GetLatestTabularData`](/dev/reference/apis/data-client/#getlatesttabulardata) | Gets the most recent tabular data captured from the specified data source, as long as it was synced within the last year. |
55
| [`ExportTabularData`](/dev/reference/apis/data-client/#exporttabulardata) | Obtain unified tabular data and metadata from the specified data source. |
66
| [`TabularDataByFilter`](/dev/reference/apis/data-client/#tabulardatabyfilter) | Retrieve optionally filtered tabular data from the Viam app. |
7-
| [`TabularDataBySQL`](/dev/reference/apis/data-client/#tabulardatabysql) | Obtain unified tabular data and metadata, queried with SQL. |
7+
| [`TabularDataBySQL`](/dev/reference/apis/data-client/#tabulardatabysql) | Obtain unified tabular data and metadata, queried with SQL. Make sure your API key has permissions at the organization level in order to use this. |
88
| [`TabularDataByMQL`](/dev/reference/apis/data-client/#tabulardatabymql) | Obtain unified tabular data and metadata, queried with MQL. |
99
| [`BinaryDataByFilter`](/dev/reference/apis/data-client/#binarydatabyfilter) | Retrieve optionally filtered binary data from the Viam app. |
1010
| [`BinaryDataByIDs`](/dev/reference/apis/data-client/#binarydatabyids) | Retrieve binary data from the Viam app by `BinaryID`. |

static/include/app/apis/generated/data.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ For more information, see the [Python SDK Docs](https://python.viam.dev/autoapi/
126126

127127
### TabularDataBySQL
128128

129-
Obtain unified tabular data and metadata, queried with SQL.
129+
Obtain unified tabular data and metadata, queried with SQL. Make sure your API key has permissions at the organization level in order to use this.
130130

131131
{{< tabs >}}
132132
{{% tab name="Python" %}}
@@ -164,7 +164,7 @@ Obtain unified tabular data and metadata, queried with MQL.
164164
**Parameters:**
165165

166166
- `organization_id` ([str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str)) (required): The ID of the organization that owns the data. You can obtain your organization ID from the Viam app’s organization settings page.
167-
- `query` (List[[bytes](https://docs.python.org/3/library/stdtypes.html#bytes-objects)] | List[Dict[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]]) (required): The MQL query to run as a list of BSON queries. Note: Support for bytes will be removed in the future, so using a dictionary is preferred.
167+
- `query` (List[[bytes](https://docs.python.org/3/library/stdtypes.html#bytes-objects)] | List[Dict[[str](https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str), Any]]) (required): The MQL query to run, as a list of MongoDB aggregation pipeline stages. Note: Each stage can be provided as either a dictionary or raw BSON bytes, but support for bytes will be removed in the future, so using a dictionary is preferred.
168168

169169
**Returns:**
170170

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Obtain unified tabular data and metadata, queried with SQL.
1+
Obtain unified tabular data and metadata, queried with SQL. Make sure your API key has permissions at the organization level in order to use this.

0 commit comments

Comments
 (0)