Method
Returns raw data from a realtime dataset. Only Microsoft Teams datasets are supported currently due to data size constraints in realtime datasets.
REQUIRED |
KEY |
TYPE |
DESCRIPTION |
Yes |
datasetId |
str |
The unique ID associated with the dataset.
|
No |
checkPermissions |
bool |
If True, checks user permissions using session email.
|
No |
startTime |
str |
Start time filter (inclusive) for created_date_time_t in ISO 8601 format (e.g. 2025-05-13T08:25:11Z or 2025-05-13T08:25:11+00:00).
|
No |
endTime |
str |
End time filter (inclusive) for created_date_time_t in ISO 8601 format (e.g. 2025-05-13T08:25:11Z or 2025-05-13T08:25:11+00:00).
|
No |
columnFilter |
dict |
Dictionary mapping column names to filter values. Only rows matching all column filters will be returned.
|
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.
KEY |
TYPE |
DESCRIPTION |
success |
Boolean |
true if the call succeeded, false if there was an error |
count |
Number(Integer) |
|
columns |
List |
|
data |
List |
|
isUsingCustomDataserver |
Boolean |
|
limitedRowCount |
Number(Integer) |
|
removeLimits |
Boolean |
|
topTenValuesMap |
JSON Object |
|
errorDescription |
String |
|
warning |
String |
|
isSqlError |
Boolean |
|
TYPE |
WHEN |
DataNotFoundError |
`datasetId` is not found. |
InvalidParameterError |
If the dataset is not a realtime dataset or is not a Microsoft Teams dataset. |