{
"status": false,
"message": "You do not have permission to view the rows of data source 'task'.",
"failedCode": "sys-035",
"error": {
"code": "data_source_forbidden",
"message": "You do not have permission to view the rows of data source 'task'."
}
}
{
"status": false,
"message": "Too Many Attempts.",
"failedCode": "sys-036"
}
Dashboard
Get sample rows
Returns up to 20 sample rows of one query spec, newest first on the spec’s timeField, so the widget composer can show the records behind a card. The preview limits rows, not columns: the columns are every available column of the source (previewColumns of the catalog), never chosen by the client. Task (all): flow, status, hub, label, created from, created / start / end / done / updated time, travel duration, then id, flow id, hub id, title, content, assignee, assigned by, created by, done by, done coordinate and ref id (emails included); Task - : the same without flow, then the flow’s other reserved keys, its page done times and every offered flow component (photo, signature, voice, video, bill and list never); Data - : every available data type field, then created / updated time and created / updated by. Columns hidden for a role are shown too: the index decides the columns. User has no Sample rows (422 preview_not_supported). A Data source reads all records you can see, whatever timeRange says. Rows follow the same visibility as the card’s numbers (organization, hub scope unless the data type is shared by every hub, soft delete, the flow of a Task - source, the per-user restriction of a data type) and, for a role whose task access is only its own tasks, only the caller’s own tasks. The caller needs view/dashboard and the source’s viewPermission (view/task for the Task family, view/data for a Data source). The spec is validated like Run analytics query (same codes, including time_grouping_needs_range and time_grouping_date_only, here as 422); its measures and dimensions are not aggregated here. Rate-limited to 30 requests per minute per user, counted separately from Run analytics query.
{
"status": false,
"message": "You do not have permission to view the rows of data source 'task'.",
"failedCode": "sys-035",
"error": {
"code": "data_source_forbidden",
"message": "You do not have permission to view the rows of data source 'task'."
}
}
One query spec, exactly as an item spec of Run analytics query. Only the keys specVersion, timeRange, hubIds, utcOffset and spec are allowed at the top level (422 unknown_key); a missing or non-object spec is 422 query_spec_missing.
Either preset, or both from and to as calendar dates YYYY-MM-DD (anything else, including 2026-02-30, relative words and datetimes, is 422 time_range_invalid), widened to whole days on the batch utcOffset. Maximum 31 days, inclusive.
Narrow to these hubs: a list of 24-character hex hub ids (anything else is 422 hub_ids_invalid), each one of the caller's hubs (otherwise 403 hub_not_allowed). Omitted or [] = every hub the caller belongs to; a caller with no hub sees no rows.
Optional. The UTC offset (±HH:MM) day boundaries, dateHistogram buckets and the hourOfDay/dayOfWeek buckets are cut on. Absent = the organization calendar (Asia/Jakarta, +07:00). Anything else is 422 utc_offset_invalid.
Pattern: ^[+-]\d{2}:\d{2}$
Example:
"+07:00"
Response
Success - columns in previewColumns order, rows as positional arrays (at most 20). A missing value is null; several values are joined with ", "; a geolocation column is the raw text "lat, lng" (for example "-6.2, 106.817"); dates are epoch milliseconds; numbers are decimals (travelDuration in minutes, unit: duration).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Docs","colors":{"primary":"#02A8F3","light":"#02A8F3","dark":"#028FCF"},"logo":{"light":"https://mintcdn.com/mileappv4/4-4k1mCQWAH9iJzs/logo/light.svg?fit=max\u0026auto=format\u0026n=4-4k1mCQWAH9iJzs\u0026q=85\u0026s=636f1871edce2e036c3f9a3d7f1ba1de","dark":"https://mintcdn.com/mileappv4/4-4k1mCQWAH9iJzs/logo/dark.svg?fit=max\u0026auto=format\u0026n=4-4k1mCQWAH9iJzs\u0026q=85\u0026s=16cfbd7d24ceab76dfa46101769b2861"},"favicon":"https://mintcdn.com/mileappv4/peiftEpaYwfPKwMQ/favicon.ico?fit=max\u0026auto=format\u0026n=peiftEpaYwfPKwMQ\u0026q=85\u0026s=99d5623b726ff23fdbdd38c1ff12d38f","api":{"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"}}},"navbar":{"links":[{"href":"https://paket.freshdesk.com/support/home","label":"Support"}]},"search":{},"seo":{"metatags":{"robots":"noindex, nofollow"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mileappv4","hasAudioNarration":false,"actualSubdomain":"mileappv4","customDomains":["docsv4.mile.app"],"gitSource":{"type":"gitlab","owner":"paketid","repo":"mileapp-docs","deployBranch":"v4","contentDirectory":"","isPrivate":true,"projectId":76553900,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae301f42d5c14663455538c","collectionId":"505a8e27-b94f-4f21-b6d3-137f182a2e09","liveDeploymentHistoryId":"6ae301f42d5c14663455538c","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae7d6817332ca5a804fdcf0","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":370},{"language":"default","tag":"Guides","count":202},{"language":"default","tag":"Workflow","count":141},{"language":"default","tag":"Settings","count":118},{"language":"default","tag":"Planning","count":97},{"language":"default","tag":"Routing","count":84},{"language":"default","tag":"Activities","count":75},{"language":"default","tag":"Task","count":75},{"language":"default","tag":"Flow","count":51},{"language":"default","tag":"Analytics","count":45}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"a[href=\"/\"]>img,header>a:first-child img,img[src*=\"/logo/\"],nav>a:first-child img{width:150px!important;height:auto!important;max-width:150px!important}"}],"page":{"pagePath":"api-reference/analytics/dashboard/get-sample-rows","slug":"/api-reference/analytics/dashboard/get-sample-rows","pageMetadata":{"title":"Get sample rows","description":"Returns up to 20 sample rows of one query spec, newest first on the spec's `timeField`, so the widget composer can show the records behind a card. The preview limits rows, not columns: the columns are every available column of the source (`previewColumns` of the catalog), never chosen by the client. Task (all): flow, status, hub, label, created from, created / start / end / done / updated time, travel duration, then id, flow id, hub id, title, content, assignee, assigned by, created by, done by, done coordinate and ref id (emails included); Task - {Flow}: the same without flow, then the flow's other reserved keys, its page done times and every offered flow component (photo, signature, voice, video, bill and list never); Data - {name}: every available data type field, then created / updated time and created / updated by. Columns hidden for a role are shown too: the index decides the columns. User has no Sample rows (`422 preview_not_supported`). A Data source reads all records you can see, whatever `timeRange` says. Rows follow the same visibility as the card's numbers (organization, hub scope unless the data type is shared by every hub, soft delete, the flow of a Task - {Flow} source, the per-user restriction of a data type) and, for a role whose task access is only its own tasks, only the caller's own tasks. The caller needs `view/dashboard` and the source's `viewPermission` (`view/task` for the Task family, `view/data` for a Data source). The spec is validated like Run analytics query (same codes, including `time_grouping_needs_range` and `time_grouping_date_only`, here as 422); its measures and dimensions are not aggregated here. Rate-limited to 30 requests per minute per user, counted separately from Run analytics query.","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /analytics/preview","href":"/api-reference/analytics/dashboard/get-sample-rows","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns up to 20 sample rows of one query spec, newest first on the spec’s \", _jsx(_components.code, {\n children: \"timeField\"\n }), \", so the widget composer can show the records behind a card. The preview limits rows, not columns: the columns are every available column of the source (\", _jsx(_components.code, {\n children: \"previewColumns\"\n }), \" of the catalog), never chosen by the client. Task (all): flow, status, hub, label, created from, created / start / end / done / updated time, travel duration, then id, flow id, hub id, title, content, assignee, assigned by, created by, done by, done coordinate and ref id (emails included); Task - \", \": the same without flow, then the flow’s other reserved keys, its page done times and every offered flow component (photo, signature, voice, video, bill and list never); Data - \", \": every available data type field, then created / updated time and created / updated by. Columns hidden for a role are shown too: the index decides the columns. User has no Sample rows (\", _jsx(_components.code, {\n children: \"422 preview_not_supported\"\n }), \"). A Data source reads all records you can see, whatever \", _jsx(_components.code, {\n children: \"timeRange\"\n }), \" says. Rows follow the same visibility as the card’s numbers (organization, hub scope unless the data type is shared by every hub, soft delete, the flow of a Task - \", \" source, the per-user restriction of a data type) and, for a role whose task access is only its own tasks, only the caller’s own tasks. The caller needs \", _jsx(_components.code, {\n children: \"view/dashboard\"\n }), \" and the source’s \", _jsx(_components.code, {\n children: \"viewPermission\"\n }), \" (\", _jsx(_components.code, {\n children: \"view/task\"\n }), \" for the Task family, \", _jsx(_components.code, {\n children: \"view/data\"\n }), \" for a Data source). The spec is validated like Run analytics query (same codes, including \", _jsx(_components.code, {\n children: \"time_grouping_needs_range\"\n }), \" and \", _jsx(_components.code, {\n children: \"time_grouping_date_only\"\n }), \", here as 422); its measures and dimensions are not aggregated here. Rate-limited to 30 requests per minute per user, counted separately from Run analytics query.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get sample rows","description":"Returns up to 20 sample rows of one query spec, newest first on the spec's `timeField`, so the widget composer can show the records behind a card. The preview limits rows, not columns: the columns are every available column of the source (`previewColumns` of the catalog), never chosen by the client. Task (all): flow, status, hub, label, created from, created / start / end / done / updated time, travel duration, then id, flow id, hub id, title, content, assignee, assigned by, created by, done by, done coordinate and ref id (emails included); Task - {Flow}: the same without flow, then the flow's other reserved keys, its page done times and every offered flow component (photo, signature, voice, video, bill and list never); Data - {name}: every available data type field, then created / updated time and created / updated by. Columns hidden for a role are shown too: the index decides the columns. User has no Sample rows (`422 preview_not_supported`). A Data source reads all records you can see, whatever `timeRange` says. Rows follow the same visibility as the card's numbers (organization, hub scope unless the data type is shared by every hub, soft delete, the flow of a Task - {Flow} source, the per-user restriction of a data type) and, for a role whose task access is only its own tasks, only the caller's own tasks. The caller needs `view/dashboard` and the source's `viewPermission` (`view/task` for the Task family, `view/data` for a Data source). The spec is validated like Run analytics query (same codes, including `time_grouping_needs_range` and `time_grouping_date_only`, here as 422); its measures and dimensions are not aggregated here. Rate-limited to 30 requests per minute per user, counted separately from Run analytics query.","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /analytics/preview","href":"/api-reference/analytics/dashboard/get-sample-rows","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/mileappv4/32cd6bdfb5a1fe0c/scripts/build-openapi.js","/_mintlify/custom/mileappv4/bbd4ec23fcfb0c2b/scripts/check-schema.js","/_mintlify/custom/mileappv4/4154158bbff482b1/scripts/generate-tag-overviews.js"],"openApiReferenceData":{"operation":{"tags":["Dashboard"],"summary":"Get sample rows","operationId":"previewAnalyticsRows","description":"Returns up to 20 sample rows of one query spec, newest first on the spec's `timeField`, so the widget composer can show the records behind a card. The preview limits rows, not columns: the columns are every available column of the source (`previewColumns` of the catalog), never chosen by the client. Task (all): flow, status, hub, label, created from, created / start / end / done / updated time, travel duration, then id, flow id, hub id, title, content, assignee, assigned by, created by, done by, done coordinate and ref id (emails included); Task - {Flow}: the same without flow, then the flow's other reserved keys, its page done times and every offered flow component (photo, signature, voice, video, bill and list never); Data - {name}: every available data type field, then created / updated time and created / updated by. Columns hidden for a role are shown too: the index decides the columns. User has no Sample rows (`422 preview_not_supported`). A Data source reads all records you can see, whatever `timeRange` says. Rows follow the same visibility as the card's numbers (organization, hub scope unless the data type is shared by every hub, soft delete, the flow of a Task - {Flow} source, the per-user restriction of a data type) and, for a role whose task access is only its own tasks, only the caller's own tasks. The caller needs `view/dashboard` and the source's `viewPermission` (`view/task` for the Task family, `view/data` for a Data source). The spec is validated like Run analytics query (same codes, including `time_grouping_needs_range` and `time_grouping_date_only`, here as 422); its measures and dimensions are not aggregated here. Rate-limited to 30 requests per minute per user, counted separately from Run analytics query.","security":["99b935a4-37ac-40e1-bd09-ae08d31f664a"],"requestBody":"da31c9dd-0b22-4945-a238-f546c2f687bf","responses":{"200":"1e801e97-5624-493c-8a5e-97128cfd3ef6","401":"71604161-809e-4c2d-99ad-015c78fe377f","403":"a871f033-05ae-41ea-b4a0-5e2bf503928e","422":"2ff56f6b-a5cd-4d38-b4d2-e538184c01d6","429":"8622a60c-c352-4eec-814f-e335bde58f0f"},"method":"post","type":"path","servers":["3c2e55eb-6ab2-44a6-b55d-cf2ca2326b05"],"path":"/analytics/preview","baseUrlOptions":["https://apiweb.mile.app/api/v3"],"title":"Get sample rows","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["spec"],"properties":{"spec":{"type":"object","description":"One query spec, exactly as an item `spec` of Run analytics query. Only the keys `specVersion`, `timeRange`, `hubIds`, `utcOffset` and `spec` are allowed at the top level (`422 unknown_key`); a missing or non-object `spec` is `422 query_spec_missing`.","additionalProperties":true,"isRequired":true,"uniqueKey":"spec","typeLabel":"object"},"specVersion":{"type":"integer","description":"Accepted at batch level; the spec-level value is the one validated","uniqueKey":"specVersion","typeLabel":"integer"},"timeRange":{"type":"object","description":"Either `preset`, or both `from` and `to` as calendar dates `YYYY-MM-DD` (anything else, including `2026-02-30`, relative words and datetimes, is `422 time_range_invalid`), widened to whole days on the batch `utcOffset`. Maximum 31 days, inclusive.","properties":{"preset":{"type":"string","enum":["today","yesterday","last_7d","last_30d"],"uniqueKey":"timeRange.preset","typeLabel":"enum\u003cstring>"},"from":{"type":"string","uniqueKey":"timeRange.from","typeLabel":"string"},"to":{"type":"string","uniqueKey":"timeRange.to","typeLabel":"string"}},"uniqueKey":"timeRange","typeLabel":"object"},"hubIds":{"type":"array","items":{"type":"string","uniqueKey":"hubIds.items.[INDEX]","typeLabel":"string"},"description":"Narrow to these hubs: a list of 24-character hex hub ids (anything else is `422 hub_ids_invalid`), each one of the caller's hubs (otherwise `403 hub_not_allowed`). Omitted or `[]` = every hub the caller belongs to; a caller with no hub sees no rows.","uniqueKey":"hubIds","typeLabel":"string[]"},"utcOffset":{"type":"string","pattern":"^[+-]\\d{2}:\\d{2}$","example":"+07:00","description":"Optional. The UTC offset (`±HH:MM`) day boundaries, `dateHistogram` buckets and the `hourOfDay`/`dayOfWeek` buckets are cut on. Absent = the organization calendar (`Asia/Jakarta`, +07:00). Anything else is `422 utc_offset_invalid`.","uniqueKey":"utcOffset","typeLabel":"string"}},"example":{"specVersion":1,"timeRange":{"preset":"last7Days"},"spec":{"specVersion":1,"dataSourceId":"task","timeField":"startTime","measures":[{"id":"m1","fn":"count"}],"filters":[{"field":"status","op":"eq","value":"DONE"}]}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"specVersion":1,"timeRange":{"preset":"last7Days"},"spec":{"specVersion":1,"dataSourceId":"task","timeField":"startTime","measures":[{"id":"m1","fn":"count"}],"filters":[{"field":"status","op":"eq","value":"DONE"}]}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"1e801e97-5624-493c-8a5e-97128cfd3ef6":{"description":"Success - `columns` in `previewColumns` order, `rows` as positional arrays (at most 20). A missing value is `null`; several values are joined with \", \"; a geolocation column is the raw text \"lat, lng\" (for example \"-6.2, 106.817\"); dates are epoch milliseconds; numbers are decimals (`travelDuration` in minutes, `unit: duration`).","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":true,"uniqueKey":"status","typeLabel":"boolean"},"specVersion":{"type":"integer","example":1,"uniqueKey":"specVersion","typeLabel":"integer"},"resolvedTimeRange":{"type":"object","properties":{"from":{"type":"string","format":"date-time","uniqueKey":"resolvedTimeRange.from","typeLabel":"string\u003cdate-time>"},"to":{"type":"string","format":"date-time","uniqueKey":"resolvedTimeRange.to","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","uniqueKey":"resolvedTimeRange.timezone","typeLabel":"string"},"preset":{"type":"string","description":"`null` for an absolute range","uniqueKey":"resolvedTimeRange.preset","typeLabel":"string"}},"uniqueKey":"resolvedTimeRange","typeLabel":"object"},"columns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The logical field name","uniqueKey":"columns.items.[INDEX].id","typeLabel":"string"},"field":{"type":"string","description":"The logical field name","uniqueKey":"columns.items.[INDEX].field","typeLabel":"string"},"unit":{"type":"string","description":"`duration` for `travelDuration`, otherwise `null`","uniqueKey":"columns.items.[INDEX].unit","typeLabel":"string"},"label":{"type":"string","description":"The i18n key of the column title for a core field (e.g. `field.task.flow`, `field.data.createdTime`); the field title, shown as is, for a flow component or a data type field","uniqueKey":"columns.items.[INDEX].label","typeLabel":"string"}},"description":"Every column is `{id, field, type, unit, label}`; `type` is the platform type (`option`, `text`, `date`, `dateTime`, `number`, `geolocation`). (`type` is left out of the schema on this page because the docs build rewrites keys named `type`; the API does return it.)","uniqueKey":"columns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"columns","typeLabel":"object[]"},"rows":{"type":"array","items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"rows.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"rows.items.[INDEX]","typeLabel":"object[]"},"description":"At most 20 rows. A row never carries a storage path; the task id (`_id`), `refId` and email columns (e.g. `assignee`, `createdBy`) are shown.","uniqueKey":"rows","typeLabel":"object[][]"},"meta":{"type":"object","properties":{"limit":{"type":"integer","example":20,"uniqueKey":"meta.limit","typeLabel":"integer"},"returned":{"type":"integer","uniqueKey":"meta.returned","typeLabel":"integer"},"sort":{"type":"object","properties":{"field":{"type":"string","description":"The spec `timeField`","uniqueKey":"meta.sort.field","typeLabel":"string"},"direction":{"type":"string","enum":["desc"],"uniqueKey":"meta.sort.direction","typeLabel":"enum\u003cstring>"}},"uniqueKey":"meta.sort","typeLabel":"object"}},"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"response":{"title":"response","value":{"status":true,"specVersion":1,"resolvedTimeRange":{"from":"2026-10-21T00:00:00+07:00","to":"2026-10-27T23:59:59+07:00","timezone":"Asia/Jakarta","preset":"last7Days"},"columns":[{"id":"flow","field":"flow","unit":null,"label":"field.task.flow"},{"id":"status","field":"status","unit":null,"label":"field.task.status"},{"id":"startTime","field":"startTime","unit":null,"label":"field.task.startTime"}],"rows":[["Delivery","DONE",1761616200000]],"meta":{"limit":20,"returned":1,"sort":{"field":"startTime","direction":"desc"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"71604161-809e-4c2d-99ad-015c78fe377f":{"description":"Unauthorized - no valid token (`auth-034`), or an authenticated user with no organization","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false,"uniqueKey":"status","typeLabel":"boolean"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"field":{"type":"string","uniqueKey":"error.field","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":false,"message":"\u003cstring>","error":{"code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"a871f033-05ae-41ea-b4a0-5e2bf503928e":{"description":"Forbidden - `data_source_forbidden` with top-level `failedCode` `sys-035` when the role lacks the source's `viewPermission` (`view/task` for the Task family, `view/data` for a `data:\u003cdataTypeId>` source); `data_source_not_licensed` for a Big Data source (Task - {Flow}) in an organization without Big Data; `hub_not_allowed` when `hubIds` names a hub the caller does not belong to. A role without `view/dashboard` gets `sys-035`. No rows are returned.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false,"uniqueKey":"status","typeLabel":"boolean"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"failedCode":{"type":"string","uniqueKey":"failedCode","typeLabel":"string"},"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"response":{"title":"response","value":{"status":false,"message":"You do not have permission to view the rows of data source 'task'.","failedCode":"sys-035","error":{"code":"data_source_forbidden","message":"You do not have permission to view the rows of data source 'task'."}}}},"exampleType":"examples"}},"exampleType":"examples"},"2ff56f6b-a5cd-4d38-b4d2-e538184c01d6":{"description":"Unprocessable - nothing ran. `error.code`: `unknown_key`, `query_spec_missing`, `data_source_id_invalid` (including a bare 24-hex id), `preview_not_supported` (User), `data_source_unavailable` (the source does not resolve for this organization or is unavailable, e.g. a deleted data type), `field_unavailable` / `source_columns_unchecked` (Task - {Flow} or Data column gone / not checked; `field_unavailable` also for a retired Task field such as `organizationName`), `time_grouping_needs_range` (an hourly grouping on a Data `dateTime` field without a `range` filter on it of at most 31 days), `time_grouping_date_only` (an hourly grouping on a `date` field), `time_range_exceeded` and the other cost codes, any spec validation code of Run analytics query, or `engine_error` (generic message).","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false,"uniqueKey":"status","typeLabel":"boolean"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"field":{"type":"string","uniqueKey":"error.field","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":false,"message":"\u003cstring>","error":{"code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"8622a60c-c352-4eec-814f-e335bde58f0f":{"description":"Too Many Requests - more than 30 sample-row requests in a minute (counted separately from Run analytics query)","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","example":false,"uniqueKey":"status","typeLabel":"boolean"},"message":{"type":"string","description":"Human-readable reason","uniqueKey":"message","typeLabel":"string"},"failedCode":{"type":"string","description":"Structured error code, see Status Codes","uniqueKey":"failedCode","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"response":{"title":"response","value":{"status":false,"message":"Too Many Attempts.","failedCode":"sys-036"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"99b935a4-37ac-40e1-bd09-ae08d31f664a":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a valid Bearer token to authenticate.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"3c2e55eb-6ab2-44a6-b55d-cf2ca2326b05":{"url":"https://apiweb.mile.app/api/v3"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a valid Bearer token to authenticate.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use a valid Bearer token to authenticate.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/public/openapi-analytics.json"},"subdomain":"mileappv4","siteName":"Docs","title":"Get sample rows - Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T00:18:33.692Z","originalFileLocation":"api-reference/analytics/dashboard/get-sample-rows.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns up to 20 sample rows of one query spec, newest first on the spec\u0026#x27;s timeField, so the widget composer can show the records behind a card. The preview limits rows, not columns: the columns are every available column of the source (previewColumns of the catalog), never chosen by the client. Task (all): flow, status, hub, label, created from, created / start / end / done / updated time, travel duration, then id, flow id, hub id, title, content, assignee, assigned by, created by, done by, done coordinate and ref id (emails included); Task - {Flow}: the same without flow, then the flow\u0026#x27;s other reserved keys, its page done times and every offered flow component (photo, signature, voice, video, bill and list never); Data - {name}: every available data type field, then created / updated time and created / updated by. Columns hidden for a role are shown too: the index decides the columns. User has no Sample rows (422 preview_not_supported). A Data source reads all records you can see, whatever timeRange says. Rows follow the same visibility as the card\u0026#x27;s numbers (organization, hub scope unless the data type is shared by every hub, soft delete, the flow of a Task - {Flow} source, the per-user restriction of a data type) and, for a role whose task access is only its own tasks, only the caller\u0026#x27;s own tasks. The caller needs view/dashboard and the source\u0026#x27;s viewPermission (view/task for the Task family, view/data for a Data source). The spec is validated like Run analytics query (same codes, including time_grouping_needs_range and time_grouping_date_only, here as 422); its measures and dimensions are not aggregated here. Rate-limited to 30 requests per minute per user, counted separately from Run analytics query.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex, nofollow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mileappv4/StpLAiWQ5_0ov0MJ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/mileappv4/StpLAiWQ5_0ov0MJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mileappv4/StpLAiWQ5_0ov0MJ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/mileappv4/StpLAiWQ5_0ov0MJ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/mileappv4/StpLAiWQ5_0ov0MJ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mileappv4/StpLAiWQ5_0ov0MJ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mileappv4/StpLAiWQ5_0ov0MJ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/mileappv4/StpLAiWQ5_0ov0MJ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/mileappv4/StpLAiWQ5_0ov0MJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get sample rows - Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns up to 20 sample rows of one query spec, newest first on the spec\u0026#x27;s timeField, so the widget composer can show the records behind a card. The preview limits rows, not columns: the columns are every available column of the source (previewColumns of the catalog), never chosen by the client. Task (all): flow, status, hub, label, created from, created / start / end / done / updated time, travel duration, then id, flow id, hub id, title, content, assignee, assigned by, created by, done by, done coordinate and ref id (emails included); Task - {Flow}: the same without flow, then the flow\u0026#x27;s other reserved keys, its page done times and every offered flow component (photo, signature, voice, video, bill and list never); Data - {name}: every available data type field, then created / updated time and created / updated by. Columns hidden for a role are shown too: the index decides the columns. User has no Sample rows (422 preview_not_supported). A Data source reads all records you can see, whatever timeRange says. Rows follow the same visibility as the card\u0026#x27;s numbers (organization, hub scope unless the data type is shared by every hub, soft delete, the flow of a Task - {Flow} source, the per-user restriction of a data type) and, for a role whose task access is only its own tasks, only the caller\u0026#x27;s own tasks. The caller needs view/dashboard and the source\u0026#x27;s viewPermission (view/task for the Task family, view/data for a Data source). The spec is validated like Run analytics query (same codes, including time_grouping_needs_range and time_grouping_date_only, here as 422); its measures and dimensions are not aggregated here. Rate-limited to 30 requests per minute per user, counted separately from Run analytics query.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docsv4.mile.app/api-reference/analytics/dashboard/get-sample-rows\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mileappv4.mintlify.app/_mintlify/api/og/v2?division=Dashboard\u0026amp;title=Get+sample+rows\u0026amp;description=Returns+up+to+20+sample+rows+of+one+query+spec%2C+newest+first+on+the+spec%27s+%60timeField%60%2C+so+the+widget+composer+can+show+the+records+behind+a+card.+The+preview+l\u0026amp;theme=5473ae08a183dc4861f5419f\u0026amp;signature=86fbb214d2845d30fb5495d961eb6c0c3e480079956332cf3b0f7e68155e5563\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get sample rows - Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns up to 20 sample rows of one query spec, newest first on the spec\u0026#x27;s timeField, so the widget composer can show the records behind a card. The preview limits rows, not columns: the columns are every available column of the source (previewColumns of the catalog), never chosen by the client. Task (all): flow, status, hub, label, created from, created / start / end / done / updated time, travel duration, then id, flow id, hub id, title, content, assignee, assigned by, created by, done by, done coordinate and ref id (emails included); Task - {Flow}: the same without flow, then the flow\u0026#x27;s other reserved keys, its page done times and every offered flow component (photo, signature, voice, video, bill and list never); Data - {name}: every available data type field, then created / updated time and created / updated by. Columns hidden for a role are shown too: the index decides the columns. User has no Sample rows (422 preview_not_supported). A Data source reads all records you can see, whatever timeRange says. Rows follow the same visibility as the card\u0026#x27;s numbers (organization, hub scope unless the data type is shared by every hub, soft delete, the flow of a Task - {Flow} source, the per-user restriction of a data type) and, for a role whose task access is only its own tasks, only the caller\u0026#x27;s own tasks. The caller needs view/dashboard and the source\u0026#x27;s viewPermission (view/task for the Task family, view/data for a Data source). The spec is validated like Run analytics query (same codes, including time_grouping_needs_range and time_grouping_date_only, here as 422); its measures and dimensions are not aggregated here. Rate-limited to 30 requests per minute per user, counted separately from Run analytics query.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mileappv4.mintlify.app/_mintlify/api/og/v2?division=Dashboard\u0026amp;title=Get+sample+rows\u0026amp;description=Returns+up+to+20+sample+rows+of+one+query+spec%2C+newest+first+on+the+spec%27s+%60timeField%60%2C+so+the+widget+composer+can+show+the+records+behind+a+card.+The+preview+l\u0026amp;theme=5473ae08a183dc4861f5419f\u0026amp;signature=86fbb214d2845d30fb5495d961eb6c0c3e480079956332cf3b0f7e68155e5563\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/mileappv4/StpLAiWQ5_0ov0MJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#02A8F3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docsv4.mile.app/api-reference/analytics/dashboard/get-sample-rows\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/analytics/dashboard/get-sample-rows.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docsv4.mile.app/#organization\",\"name\":\"Docs\",\"url\":\"https://docsv4.mile.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/mileappv4/4-4k1mCQWAH9iJzs/logo/light.svg?fit=max\u0026auto=format\u0026n=4-4k1mCQWAH9iJzs\u0026q=85\u0026s=636f1871edce2e036c3f9a3d7f1ba1de\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docsv4.mile.app#website\",\"name\":\"Docs\",\"url\":\"https://docsv4.mile.app\",\"publisher\":{\"@id\":\"https://docsv4.mile.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docsv4.mile.app/api-reference/analytics/dashboard/get-sample-rows#webpage\",\"url\":\"https://docsv4.mile.app/api-reference/analytics/dashboard/get-sample-rows\",\"name\":\"Get sample rows\",\"description\":\"Returns up to 20 sample rows of one query spec, newest first on the spec's timeField, so the widget composer can show the records behind a card. The preview limits rows, not columns: the columns are every available column of the source (previewColumns of the catalog), never chosen by the client. Task (all): flow, status, hub, label, created from, created / start / end / done / updated time, travel duration, then id, flow id, hub id, title, content, assignee, assigned by, created by, done by, done coordinate and ref id (emails included); Task - {Flow}: the same without flow, then the flow's other reserved keys, its page done times and every offered flow component (photo, signature, voice, video, bill and list never); Data - {name}: every available data type field, then created / updated time and created / updated by. Columns hidden for a role are shown too: the index decides the columns. User has no Sample rows (422 preview_not_supported). A Data source reads all records you can see, whatever timeRange says. Rows follow the same visibility as the card's numbers (organization, hub scope unless the data type is shared by every hub, soft delete, the flow of a Task - {Flow} source, the per-user restriction of a data type) and, for a role whose task access is only its own tasks, only the caller's own tasks. The caller needs view/dashboard and the source's viewPermission (view/task for the Task family, view/data for a Data source). The spec is validated like Run analytics query (same codes, including time_grouping_needs_range and time_grouping_date_only, here as 422); its measures and dimensions are not aggregated here. Rate-limited to 30 requests per minute per user, counted separately from Run analytics query.\",\"dateModified\":\"2026-11-02T00:18:33.692Z\",\"isPartOf\":{\"@id\":\"https://docsv4.mile.app#website\"},\"breadcrumb\":{\"@id\":\"https://docsv4.mile.app/api-reference/analytics/dashboard/get-sample-rows#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docsv4.mile.app/api-reference/analytics/dashboard/get-sample-rows#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Analytics\",\"item\":\"https://docsv4.mile.app/api-reference/analytics/dashboard-overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Dashboard\",\"item\":\"https://docsv4.mile.app/api-reference/analytics/dashboard-overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get sample rows\",\"item\":\"https://docsv4.mile.app/api-reference/analytics/dashboard/get-sample-rows\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docsv4.mile.app/api-reference/analytics/dashboard/get-sample-rows#apireference\",\"headline\":\"Get sample rows\",\"name\":\"Get sample rows\",\"description\":\"Returns up to 20 sample rows of one query spec, newest first on the spec's timeField, so the widget composer can show the records behind a card. The preview limits rows, not columns: the columns are every available column of the source (previewColumns of the catalog), never chosen by the client. Task (all): flow, status, hub, label, created from, created / start / end / done / updated time, travel duration, then id, flow id, hub id, title, content, assignee, assigned by, created by, done by, done coordinate and ref id (emails included); Task - {Flow}: the same without flow, then the flow's other reserved keys, its page done times and every offered flow component (photo, signature, voice, video, bill and list never); Data - {name}: every available data type field, then created / updated time and created / updated by. Columns hidden for a role are shown too: the index decides the columns. User has no Sample rows (422 preview_not_supported). A Data source reads all records you can see, whatever timeRange says. Rows follow the same visibility as the card's numbers (organization, hub scope unless the data type is shared by every hub, soft delete, the flow of a Task - {Flow} source, the per-user restriction of a data type) and, for a role whose task access is only its own tasks, only the caller's own tasks. The caller needs view/dashboard and the source's viewPermission (view/task for the Task family, view/data for a Data source). The spec is validated like Run analytics query (same codes, including time_grouping_needs_range and time_grouping_date_only, here as 422); its measures and dimensions are not aggregated here. Rate-limited to 30 requests per minute per user, counted separately from Run analytics query.\",\"url\":\"https://docsv4.mile.app/api-reference/analytics/dashboard/get-sample-rows\",\"mainEntityOfPage\":{\"@id\":\"https://docsv4.mile.app/api-reference/analytics/dashboard/get-sample-rows#webpage\"},\"dateModified\":\"2026-11-02T00:18:33.692Z\",\"publisher\":{\"@id\":\"https://docsv4.mile.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docsv4.mile.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/pages/getting-started/introduction"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Data Formats","href":"/api-reference/data-formats"},{"title":"Status Codes","href":"/api-reference/status-codes"}]},{"group":"Analytics","pages":[{"group":"Dashboard","pages":[{"title":"Dashboard","href":"/api-reference/analytics/dashboard-overview"},{"title":"Read dashboards","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /dynamic-dashboards","href":"/api-reference/analytics/dashboard/read-dashboards"},{"title":"Create dashboard","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /dynamic-dashboard","href":"/api-reference/analytics/dashboard/create-dashboard"},{"title":"Read dashboard by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /dynamic-dashboard/{id}","href":"/api-reference/analytics/dashboard/read-dashboard-by-id"},{"title":"Update partially dashboard by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json patch /dynamic-dashboard/{id}","href":"/api-reference/analytics/dashboard/update-partially-dashboard-by-id"},{"title":"Delete dashboard by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json delete /dynamic-dashboard/{id}","href":"/api-reference/analytics/dashboard/delete-dashboard-by-id"},{"title":"Duplicate dashboard by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /dynamic-dashboard/{id}/duplicate","href":"/api-reference/analytics/dashboard/duplicate-dashboard-by-id"},{"title":"Save dashboard as template","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /dynamic-dashboard/{id}/save-as-template","href":"/api-reference/analytics/dashboard/save-dashboard-as-template"},{"title":"Read dashboard templates","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /dynamic-dashboard-templates","href":"/api-reference/analytics/dashboard/read-dashboard-templates"},{"title":"Delete dashboard template by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json delete /dynamic-dashboard-template/{id}","href":"/api-reference/analytics/dashboard/delete-dashboard-template-by-id"},{"title":"Read widgets","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /dynamic-dashboard-widgets","href":"/api-reference/analytics/dashboard/read-widgets"},{"title":"Create custom widget","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /dynamic-dashboard-widget","href":"/api-reference/analytics/dashboard/create-custom-widget"},{"title":"Update partially custom widget by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json patch /dynamic-dashboard-widget/{id}","href":"/api-reference/analytics/dashboard/update-partially-custom-widget-by-id"},{"title":"Delete custom widget by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json delete /dynamic-dashboard-widget/{id}","href":"/api-reference/analytics/dashboard/delete-custom-widget-by-id"},{"title":"Run analytics query","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /analytics/query","href":"/api-reference/analytics/dashboard/run-analytics-query"},{"title":"Read analytics catalog","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /analytics/catalog","href":"/api-reference/analytics/dashboard/read-analytics-catalog"},{"title":"Read analytics field metadata","description":"Retrieves the catalog fields of one data source, each compared with what the search index actually stores (`storage.status`). If the index cannot be reached, the call still succeeds with `verified: false`.","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /analytics/field-metadata","href":"/api-reference/analytics/dashboard/read-analytics-field-metadata"},{"title":"Get sample rows","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /analytics/preview","href":"/api-reference/analytics/dashboard/get-sample-rows"},{"title":"Save card as widget template","description":"View-mode route. Copies one card of a dashboard the caller can see into a new widget template of the caller's organization: the card's `viz`, `spec` and `defaultLayout` are copied, `name` and `description` come from the body, and the server sets `isCustom: true` and `category: custom`. The card and the dashboard are not changed. Only a custom query card can be saved. The stored `spec` keeps its Flow unchanged, so the Flow is not checked again. In edit mode the app sends the draft card's content to Create custom widget (POST /dynamic-dashboard-widget) instead, without saving the dashboard.","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /dynamic-dashboard/{id}/card/{cardId}/save-as-widget-template","href":"/api-reference/analytics/dashboard/save-card-as-widget-template"}]},{"group":"Report","pages":[{"title":"Report","href":"/api-reference/analytics/report-overview"},{"title":"Read reports","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /reports","href":"/api-reference/analytics/report/read-reports"},{"title":"Create report","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /report","href":"/api-reference/analytics/report/create-report"},{"title":"Read report by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /report/{id}","href":"/api-reference/analytics/report/read-report-by-id"},{"title":"Update report","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json patch /report/{id}","href":"/api-reference/analytics/report/update-report"},{"title":"Delete report","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json delete /report/{id}","href":"/api-reference/analytics/report/delete-report"}]},{"group":"Insight","pages":[{"title":"Insight","href":"/api-reference/analytics/insight-report-overview"},{"title":"Read insight context","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /ai-insight/context/{objectId}","href":"/api-reference/analytics/insight-report/read-insight-context"},{"title":"Update insight context","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json put /ai-insight/context/{objectId}","href":"/api-reference/analytics/insight-report/update-insight-context"},{"title":"Regenerate insight context","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /ai-insight/context/{objectId}/regenerate","href":"/api-reference/analytics/insight-report/regenerate-insight-context"},{"title":"Generate insight report","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /ai-insight/generate","href":"/api-reference/analytics/insight-report/generate-insight-report"},{"title":"Read insight reports","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /ai-insight/results","href":"/api-reference/analytics/insight-report/read-insight-reports"},{"title":"Read insight report by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /ai-insight/results/{id}","href":"/api-reference/analytics/insight-report/read-insight-report-by-id"},{"title":"Delete insight report","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json delete /ai-insight/results/{id}","href":"/api-reference/analytics/insight-report/delete-insight-report"},{"title":"Retry insight report","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /ai-insight/results/{id}/retry","href":"/api-reference/analytics/insight-report/retry-insight-report"}]}]},{"group":"Planning","pages":[{"group":"Routing","pages":[{"group":"Routing","pages":[{"title":"Routing","href":"/api-reference/routing/overview"},{"title":"Read routing results","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /results","href":"/api-reference/routing/routing/read-routing-results"},{"title":"Read routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /result/{resultId}","href":"/api-reference/routing/routing/read-routing-result-by-id"},{"title":"Update routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /result/{resultId}","href":"/api-reference/routing/routing/update-routing-result-by-id"},{"title":"Update partially routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json patch /result/{resultId}","href":"/api-reference/routing/routing/update-partially-routing-result-by-id"},{"title":"Delete routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /result/{resultId}","href":"/api-reference/routing/routing/delete-routing-result-by-id"},{"title":"Route optimize","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /routing","href":"/api-reference/routing/routing/route-optimize"},{"title":"Dispatch routing result","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /dispatch","href":"/api-reference/routing/routing/dispatch-routing-result"},{"title":"Reorder visits","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /reorder-visits","href":"/api-reference/routing/routing/reorder-visits"},{"title":"Read routing result history by result ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /result/{resultId}/history","href":"/api-reference/routing/routing/read-routing-result-history-by-result-id"},{"title":"Switch visits between vehicles","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /result/switch-visit","href":"/api-reference/routing/routing/switch-visits-between-vehicles"},{"title":"Restore routing result version","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /result/{resultId}/restore/{version}","href":"/api-reference/routing/routing/restore-routing-result-version"},{"title":"Reset routing result","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /result/{resultId}/reset","href":"/api-reference/routing/routing/reset-routing-result"},{"title":"Read dispatch of a routing result","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /dispatch/{resultId}","href":"/api-reference/routing/routing/read-dispatch-of-a-routing-result"},{"title":"Delete dispatch of a routing result","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /dispatch/{resultId}","href":"/api-reference/routing/routing/delete-dispatch-of-a-routing-result"}]},{"group":"Vehicle","pages":[{"title":"Vehicle","href":"/api-reference/routing/vehicle-overview"},{"title":"Read vehicle","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /vehicles","href":"/api-reference/routing/vehicle/read-vehicle"},{"title":"Read vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/read-vehicle-by-id"},{"title":"Update vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/update-vehicle-by-id"},{"title":"Update partially vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json patch /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/update-partially-vehicle-by-id"},{"title":"Delete vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/delete-vehicle-by-id"},{"title":"Create vehicle","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /vehicle","href":"/api-reference/routing/vehicle/create-vehicle"},{"title":"Bulk create vehicle","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /vehicles/","href":"/api-reference/routing/vehicle/bulk-create-vehicle"},{"title":"Delete vehicle by Hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /vehicles/{hubId}/hub","href":"/api-reference/routing/vehicle/delete-vehicle-by-hub"}]},{"group":"Configuration","pages":[{"title":"Configuration","href":"/api-reference/routing/configuration-overview"},{"title":"Read routing configurations","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /configurations","href":"/api-reference/routing/configuration/read-routing-configurations"},{"title":"Create routing configuration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /configuration","href":"/api-reference/routing/configuration/create-routing-configuration"},{"title":"Read routing configuration by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /configuration/{configurationId}","href":"/api-reference/routing/configuration/read-routing-configuration-by-id"},{"title":"Update routing configuration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /configuration/{configurationId}","href":"/api-reference/routing/configuration/update-routing-configuration"},{"title":"Delete routing configuration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /configuration/{configurationId}","href":"/api-reference/routing/configuration/delete-routing-configuration"},{"title":"Read default routing configuration of a hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /configuration/hub/{hubId}","href":"/api-reference/routing/configuration/read-default-routing-configuration-of-a-hub"},{"title":"Update routing configurations of a hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json patch /configurations/hub/{hubId}","href":"/api-reference/routing/configuration/update-routing-configurations-of-a-hub"},{"title":"Read capacity constraints","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /capacity-constraints","href":"/api-reference/routing/capacity-constraint/read-capacity-constraints"},{"title":"Read capacity constraint","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /capacity-constraint","href":"/api-reference/routing/capacity-constraint/read-capacity-constraint"},{"title":"Create capacity constraint","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /capacity-constraint","href":"/api-reference/routing/capacity-constraint/create-capacity-constraint"},{"title":"Read capacity constraint by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /capacity-constraint/{capacityConstraintId}","href":"/api-reference/routing/capacity-constraint/read-capacity-constraint-by-id"},{"title":"Update capacity constraint","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /capacity-constraint/{capacityConstraintId}","href":"/api-reference/routing/capacity-constraint/update-capacity-constraint"},{"title":"Delete capacity constraint","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /capacity-constraint/{capacityConstraintId}","href":"/api-reference/routing/capacity-constraint/delete-capacity-constraint"},{"title":"Read capacity constraint of a hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /capacity-constraint/hub/{hubId}","href":"/api-reference/routing/capacity-constraint/read-capacity-constraint-of-a-hub"},{"title":"Read geotagging zones","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /geotagging","href":"/api-reference/routing/geotagging/read-geotagging-zones"},{"title":"Create geotagging zone","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /geotagging","href":"/api-reference/routing/geotagging/create-geotagging-zone"},{"title":"Update geotagging zone","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json patch /geotagging/{geotaggingId}","href":"/api-reference/routing/geotagging/update-geotagging-zone"},{"title":"Delete geotagging zone","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /geotagging/{geotaggingId}","href":"/api-reference/routing/geotagging/delete-geotagging-zone"}]}]},{"group":"Schedule","pages":[{"group":"Task Schedule","pages":[{"title":"Task Schedule","href":"/api-reference/task/task-schedule-overview"},{"title":"Read task schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/schedules","href":"/api-reference/task/task-schedule/read-task-schedule"},{"title":"Read task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/schedule/{id}","href":"/api-reference/task/task-schedule/read-task-schedule-by-id"},{"title":"Create task schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/schedule","href":"/api-reference/task/task-schedule/create-task-schedule"},{"title":"Bulk create task schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/schedules/bulk","href":"/api-reference/task/task-schedule/bulk-create-task-schedule"},{"title":"Update task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/schedule/{scheduleId}","href":"/api-reference/task/task-schedule/update-task-schedule-by-id"},{"title":"Update partially task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /task/schedule/{scheduleId}","href":"/api-reference/task/task-schedule/update-partially-task-schedule-by-id"},{"title":"Delete task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /task/schedule/{scheduleId}","href":"/api-reference/task/task-schedule/delete-task-schedule-by-id"}]},{"group":"Routing Schedule","pages":[{"title":"Routing Schedule","href":"/api-reference/routing/routing-schedule-overview"},{"title":"Create routing schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /routing/schedule","href":"/api-reference/routing/routing-schedule/create-routing-schedule"},{"title":"Read routing schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /routing/schedules","href":"/api-reference/routing/routing-schedule/read-routing-schedule"},{"title":"Read routing schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /routing/schedule/{scheduleId}","href":"/api-reference/routing/routing-schedule/read-routing-schedule-by-id"},{"title":"Update routing schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /routing/schedule/{scheduleId}","href":"/api-reference/routing/routing-schedule/update-routing-schedule-by-id"},{"title":"Update partially routing schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json patch /routing/schedule/{scheduleId}","href":"/api-reference/routing/routing-schedule/update-partially-routing-schedule-by-id"},{"title":"Delete routing schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /routing/schedule/{scheduleId}","href":"/api-reference/routing/routing-schedule/delete-routing-schedule-by-id"}]}]}]},{"group":"Monitoring","pages":[{"group":"Alert","pages":[{"title":"Alert","href":"/api-reference/monitoring/overview"},{"title":"Read alerts","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json get /alerts","href":"/api-reference/monitoring/alert/read-alerts"},{"title":"Read alert summary","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json get /alerts/summary","href":"/api-reference/monitoring/alert/read-alert-summary"},{"title":"Resolve alert","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json post /alert/{id}/resolve","href":"/api-reference/monitoring/alert/resolve-alert"},{"title":"Unresolve alert","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json delete /alert/{id}/resolve","href":"/api-reference/monitoring/alert/unresolve-alert"}]}]},{"group":"Activities","pages":[{"group":"Task","pages":[{"group":"Task","pages":[{"title":"Task","href":"/api-reference/task/overview"},{"title":"Send OTP","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/{taskId}/otp/send","href":"/api-reference/task/task/send-otp"},{"title":"Verify OTP","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/{taskId}/otp/verify","href":"/api-reference/task/task/verify-otp"},{"title":"Read tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /tasks","href":"/api-reference/task/task/read-tasks"},{"title":"Read tasks gallery","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /tasks-gallery","href":"/api-reference/task/task/read-tasks-gallery"},{"title":"Read task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/{task_id}","href":"/api-reference/task/task/read-task-by-id"},{"title":"Read public task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/public/{task_id}","href":"/api-reference/task/task/read-public-task-by-id"},{"title":"Read task tracking","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /tasks/tracking","href":"/api-reference/task/task/read-task-tracking"},{"title":"Create task","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task","href":"/api-reference/task/task/create-task"},{"title":"Create multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /tasks/bulk/","href":"/api-reference/task/task/create-multiple-tasks"},{"title":"Upload image for task","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/photo/{forRenameFile}","href":"/api-reference/task/task/upload-image-for-task"},{"title":"Upload video for task","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/video/{forRenameFile}","href":"/api-reference/task/task/upload-video-for-task"},{"title":"Update task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/{taskid}","href":"/api-reference/task/task/update-task-by-id"},{"title":"Move task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/{taskId}/move","href":"/api-reference/task/task/move-task-by-id"},{"title":"Assign task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/{taskId}/assign","href":"/api-reference/task/task/assign-task-by-id"},{"title":"Move multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /tasks/bulk/move","href":"/api-reference/task/task/move-multiple-tasks"},{"title":"Assign multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /tasks/bulk/assign","href":"/api-reference/task/task/assign-multiple-tasks"},{"title":"Partially update task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /task/{taskId}","href":"/api-reference/task/task/partially-update-task-by-id"},{"title":"Partial update multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /tasks/bulk","href":"/api-reference/task/task/partial-update-multiple-tasks"},{"title":"Delete multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /tasks/bulk","href":"/api-reference/task/task/delete-multiple-tasks"},{"title":"Update multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /tasks/bulk","href":"/api-reference/task/task/update-multiple-tasks"},{"title":"Delete task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /task/{id}","href":"/api-reference/task/task/delete-task-by-id"},{"title":"Upload task photo","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/photo","href":"/api-reference/task/task/upload-task-photo"},{"title":"Upload task photo with file name","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/photo/{fileName}","href":"/api-reference/task/task/upload-task-photo-with-file-name"},{"title":"Upload task video","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/video","href":"/api-reference/task/task/upload-task-video"},{"title":"Upload task video with file name","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/video/{fileName}","href":"/api-reference/task/task/upload-task-video-with-file-name"}]},{"group":"Location History","pages":[{"title":"Location History","href":"/api-reference/task/location-history-overview"},{"title":"Read location history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /location-histories","href":"/api-reference/task/location-history/read-location-history"},{"title":"Read location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /location-history/{id}","href":"/api-reference/task/location-history/read-location-history-by-id"},{"title":"Read location history by token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /location-history/tracking/{token}","href":"/api-reference/task/location-history/read-location-history-by-token"},{"title":"Create location history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /location-history","href":"/api-reference/task/location-history/create-location-history"},{"title":"Bulk create location history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /location-history/bulk","href":"/api-reference/task/location-history/bulk-create-location-history"},{"title":"Generate location history token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /location-history/generate-token","href":"/api-reference/task/location-history/generate-location-history-token"},{"title":"Update location history by email \u0026 createdTime","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /location-history/","href":"/api-reference/task/location-history/update-location-history-by-email-\u0026-createdtime"},{"title":"Update location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /location-history/{loc_history_id}","href":"/api-reference/task/location-history/update-location-history-by-id"},{"title":"Update partially location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /location-history/{loc_history_id}","href":"/api-reference/task/location-history/update-partially-location-history-by-id"},{"title":"Delete location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /location-history/{loc_history_id}","href":"/api-reference/task/location-history/delete-location-history-by-id"}]}]},{"group":"Order","pages":[{"title":"Order","href":"/api-reference/order/overview"},{"title":"Read orders","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json get /orders","href":"/api-reference/order/order/read-orders"},{"title":"Create order","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json post /order","href":"/api-reference/order/order/create-order"},{"title":"Read order by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json get /order/{id}","href":"/api-reference/order/order/read-order-by-id"},{"title":"Update order","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json put /order/{id}","href":"/api-reference/order/order/update-order"},{"title":"Delete order","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json delete /order/{id}","href":"/api-reference/order/order/delete-order"},{"title":"Cancel order","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json put /order/{id}/cancel","href":"/api-reference/order/order/cancel-order"},{"title":"Change order status","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json put /order/{id}/status","href":"/api-reference/order/order/change-order-status"},{"title":"Read order history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json get /order/{id}/history","href":"/api-reference/order/order/read-order-history"},{"title":"Read order step log","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json get /order/{id}/step-log","href":"/api-reference/order/order/read-order-step-log"},{"title":"Resolve order attention","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json post /order/{id}/attention/resolve","href":"/api-reference/order/order/resolve-order-attention"},{"title":"Retry order attention","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json post /order/{id}/attention/retry","href":"/api-reference/order/order/retry-order-attention"},{"title":"Create orders in bulk","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json post /orders/bulk","href":"/api-reference/order/order/create-orders-in-bulk"},{"title":"Export orders","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json post /orders/export","href":"/api-reference/order/order/export-orders"},{"title":"Read order export","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json get /orders/export/{exportId}","href":"/api-reference/order/order/read-order-export"},{"title":"Validate order import","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json post /orders/import/validate","href":"/api-reference/order/order/validate-order-import"},{"title":"Commit order import","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json post /orders/import/commit","href":"/api-reference/order/order/commit-order-import"},{"title":"Read order import","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json get /orders/import/{importId}","href":"/api-reference/order/order/read-order-import"},{"title":"Read active step options","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json get /order-type/{id}/active-step-options","href":"/api-reference/order/order/read-active-step-options"}]}]},{"group":"Workflow","pages":[{"group":"Data Type","pages":[{"title":"Data","href":"/api-reference/data/overview"},{"title":"Data Type","href":"/api-reference/data/data-type-overview"},{"title":"Read data type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data-types","href":"/api-reference/data/data-type/read-data-type"},{"title":"Read data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data-type/{dataTypeId}/","href":"/api-reference/data/data-type/read-data-type-by-id"},{"title":"Create data type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data-type","href":"/api-reference/data/data-type/create-data-type"},{"title":"Update data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json put /data-type/{dataTypeId}","href":"/api-reference/data/data-type/update-data-type-by-id"},{"title":"Update partially data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json patch /data-type/{dataTypeId}","href":"/api-reference/data/data-type/update-partially-data-type-by-id"},{"title":"Delete data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /data-type/{dataTypeId}","href":"/api-reference/data/data-type/delete-data-type-by-id"},{"title":"Create data types in bulk","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data-type/bulk","href":"/api-reference/data/data-type/create-data-types-in-bulk"},{"title":"Count data types","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data-types/count","href":"/api-reference/data/data-type/count-data-types"},{"title":"Copy v3 data type to v4","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data-type/{dataTypeId}/copy","href":"/api-reference/data/data-type/copy-v3-data-type-to-v4"},{"title":"Move v3 data type to v4","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data-type/{dataTypeId}/move","href":"/api-reference/data/data-type/move-v3-data-type-to-v4"},{"title":"Resume data type migration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data-type/{dataTypeId}/migration/resume","href":"/api-reference/data/data-type/resume-data-type-migration"}]},{"group":"Data Source","pages":[{"title":"Data Source","href":"/api-reference/data/data-source-overview"},{"title":"Read data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data","href":"/api-reference/data/data-source/read-data-source"},{"title":"Create data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data","href":"/api-reference/data/data-source/create-data-source"},{"title":"Read data source by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data/{dataId}","href":"/api-reference/data/data-source/read-data-source-by-id"},{"title":"Read data source by dataTypeName and dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data/type/{dataTypeName}/{dataId}","href":"/api-reference/data/data-source/read-data-source-by-datatypename-and-dataid"},{"title":"Read data source by hubId, dataTypeName, dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data/hub/{hubId}/type/{dataTypeName}/{data_id}","href":"/api-reference/data/data-source/read-data-source-by-hubid-datatypename-dataid"},{"title":"Bulk create data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data/bulk","href":"/api-reference/data/data-source/bulk-create-data-source"},{"title":"Bulk create or update data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data/bulk/upsert","href":"/api-reference/data/data-source/bulk-create-or-update-data-source"},{"title":"Update data source by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json put /data/{_id}","href":"/api-reference/data/data-source/update-data-source-by-id"},{"title":"Update data source by hubId, dataTypeName, dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json put /data/hub/{hub_id}/type/{dataTypeName}/{dataId}","href":"/api-reference/data/data-source/update-data-source-by-hubid-datatypename-dataid"},{"title":"Update partially data source by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json patch /data/{data_id}","href":"/api-reference/data/data-source/update-partially-data-source-by-id"},{"title":"Delete data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /data/{data_id}/","href":"/api-reference/data/data-source/delete-data-source"},{"title":"Delete data source by hubId, dataTypeName, dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /data/hub/{hubId}/type/{dataTypeName}/{dataId}","href":"/api-reference/data/data-source/delete-data-source-by-hubid-datatypename-dataid"},{"title":"Bulk patch data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json patch /datas/bulk","href":"/api-reference/data/data-source/bulk-patch-data-source"},{"title":"Bulk delete data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /datas/bulk","href":"/api-reference/data/data-source/bulk-delete-data-source"}]},{"group":"Flow","pages":[{"title":"Flow","href":"/api-reference/flow/overview"},{"title":"Read flows","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flows","href":"/api-reference/flow/flow/read-flows"},{"title":"Read flow by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow/{flowId}","href":"/api-reference/flow/flow/read-flow-by-id"},{"title":"Read flow fields","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow-fields","href":"/api-reference/flow/flow/read-flow-fields"},{"title":"Read flow components","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow-components","href":"/api-reference/flow/flow/read-flow-components"},{"title":"Read flow component by flow name","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow/{flowName}/fields","href":"/api-reference/flow/flow/read-flow-component-by-flow-name"},{"title":"Generate example","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow/{flowName}/task","href":"/api-reference/flow/flow/generate-example"},{"title":"Read flow histories","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow-logs","href":"/api-reference/flow/flow/read-flow-histories"},{"title":"Create flow","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /flow","href":"/api-reference/flow/flow/create-flow"},{"title":"Read flow versions","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /flows/check-version","href":"/api-reference/flow/flow/read-flow-versions"},{"title":"Re-order flow","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /flow-reorder","href":"/api-reference/flow/flow/re-order-flow"},{"title":"Update flow by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /flow/{flow_id}","href":"/api-reference/flow/flow/update-flow-by-id"},{"title":"Delete flow by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json delete /flow/{flow_id}","href":"/api-reference/flow/flow/delete-flow-by-id"},{"title":"Restore flow by flow log ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /flow/{flowId}/restore/{flowLogId}","href":"/api-reference/flow/flow/restore-flow-by-flow-log-id"}]},{"group":"Order Type","pages":[{"title":"Order Type","href":"/api-reference/flow/order-type-overview"},{"title":"Read order types","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /order-types","href":"/api-reference/flow/order-type/read-order-types"},{"title":"Create order type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /order-type","href":"/api-reference/flow/order-type/create-order-type"},{"title":"Read order type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /order-type/{id}","href":"/api-reference/flow/order-type/read-order-type-by-id"},{"title":"Update order type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /order-type/{id}","href":"/api-reference/flow/order-type/update-order-type"},{"title":"Delete order type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json delete /order-type/{id}","href":"/api-reference/flow/order-type/delete-order-type"},{"title":"Publish order type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json patch /order-type/{id}/publish","href":"/api-reference/flow/order-type/publish-order-type"},{"title":"Restore order type version","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /order-type/{id}/restore/{version}","href":"/api-reference/flow/order-type/restore-order-type-version"},{"title":"Simulate order type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /order-type/{id}/simulate","href":"/api-reference/flow/order-type/simulate-order-type"},{"title":"Read order type versions","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /order-type-logs","href":"/api-reference/flow/order-type/read-order-type-versions"},{"title":"Validate order type draft","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /order-type-validate","href":"/api-reference/flow/order-type/validate-order-type-draft"}]},{"group":"Automation","pages":[{"title":"Automation","href":"/api-reference/flow/automation-overview"},{"title":"Read automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /automations","href":"/api-reference/flow/automation/read-automation"},{"title":"Read log automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /automation-log","href":"/api-reference/flow/automation/read-log-automation"},{"title":"Read automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /automation/{automationId}","href":"/api-reference/flow/automation/read-automation-by-id"},{"title":"Create automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /automation","href":"/api-reference/flow/automation/create-automation"},{"title":"Retry bulk automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /automation-retries","href":"/api-reference/flow/automation/retry-bulk-automation"},{"title":"Update automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /automation/{automation_id}","href":"/api-reference/flow/automation/update-automation-by-id"},{"title":"Update partially automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json patch /automation/{automation_id}","href":"/api-reference/flow/automation/update-partially-automation-by-id"},{"title":"Retry automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json patch /automation-retry/{log_id}","href":"/api-reference/flow/automation/retry-automation-by-id"},{"title":"Delete automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json delete /automation/{automation_id}/","href":"/api-reference/flow/automation/delete-automation-by-id"},{"title":"Read log automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /automation-log/{logId}","href":"/api-reference/flow/automation/read-log-automation-by-id"}]}]},{"group":"Export \u0026 Import","pages":[{"group":"Export","pages":[{"title":"Export \u0026 Import","href":"/api-reference/importexport/overview"},{"title":"Export Task","href":"/api-reference/importexport/export-task-overview"},{"title":"Export Config","href":"/api-reference/importexport/export-config-overview"},{"title":"Get export log history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /tasks/export-log","href":"/api-reference/importexport/export-task/get-export-log-history"},{"title":"Export tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /tasks/export","href":"/api-reference/importexport/export-task/export-tasks"},{"title":"Export data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /data/export","href":"/api-reference/importexport/export-task/export-data-source"},{"title":"Read export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /export-configs","href":"/api-reference/importexport/export-config/read-export-config"},{"title":"Read export config by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /export-config/{exportConfigId}","href":"/api-reference/importexport/export-config/read-export-config-by-id"},{"title":"Create export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /export-config","href":"/api-reference/importexport/export-config/create-export-config"},{"title":"Update export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json put /export-config/{exportConfigId}/","href":"/api-reference/importexport/export-config/update-export-config"},{"title":"Delete export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json delete /export-config/{exportConfigId}/","href":"/api-reference/importexport/export-config/delete-export-config"}]},{"group":"Import","pages":[{"title":"Data Import","href":"/api-reference/importexport/data-import-overview"},{"title":"Import Config","href":"/api-reference/importexport/import-config-overview"},{"title":"Import data source from file","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /data/import","href":"/api-reference/importexport/data-import/import-data-source-from-file"},{"title":"Read import monitoring records","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-monitoring","href":"/api-reference/importexport/data-import/read-import-monitoring-records"},{"title":"Read import monitoring record by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-monitoring/{id}","href":"/api-reference/importexport/data-import/read-import-monitoring-record-by-id"},{"title":"Read import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-configs","href":"/api-reference/importexport/import-config/read-import-config"},{"title":"Create import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /import-configs","href":"/api-reference/importexport/import-config/create-import-config"},{"title":"Read import config by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-configs/{importConfigId}","href":"/api-reference/importexport/import-config/read-import-config-by-id"},{"title":"Update import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json put /import-configs/{importConfigId}","href":"/api-reference/importexport/import-config/update-import-config"},{"title":"Delete import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json delete /import-configs/{importConfigId}","href":"/api-reference/importexport/import-config/delete-import-config"},{"title":"Import tasks from file","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /tasks/import","href":"/api-reference/importexport/data-import/import-tasks-from-file"},{"title":"Read task import records","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /tasks/import-monitoring","href":"/api-reference/importexport/data-import/read-task-import-records"}]}]},{"group":"Settings","pages":[{"title":"Settings","href":"/api-reference/setting/overview"},{"group":"Users \u0026 Access","pages":[{"group":"User","pages":[{"title":"User","href":"/api-reference/setting/user-overview"},{"title":"Read user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /users","href":"/api-reference/setting/user/read-user"},{"title":"Read mine","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /user","href":"/api-reference/setting/user/read-mine"},{"title":"Update partially user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json patch /user","href":"/api-reference/setting/user/update-partially-user"},{"title":"Read user by email","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /user/email/{email}","href":"/api-reference/setting/user/read-user-by-email"},{"title":"Read user by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /user/{userId}","href":"/api-reference/setting/user/read-user-by-id"},{"title":"Update user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /user/{userId}","href":"/api-reference/setting/user/update-user"},{"title":"Read locked user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /members/locked","href":"/api-reference/setting/user/read-locked-user"},{"title":"Unlock locked user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /member/unlock","href":"/api-reference/setting/user/unlock-locked-user"},{"title":"Reset password user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /member/reset-password","href":"/api-reference/setting/user/reset-password-user"},{"title":"Delete user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /member/{userId}","href":"/api-reference/setting/user/delete-user"},{"title":"Update member","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /member/{userId}","href":"/api-reference/setting/user/update-member"},{"title":"Search users","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /user/search","href":"/api-reference/setting/user/search-users"}]},{"group":"Team","pages":[{"title":"Team","href":"/api-reference/setting/team-overview"},{"title":"Read team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /teams","href":"/api-reference/setting/team/read-team"},{"title":"Read team by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /team/{teamId}","href":"/api-reference/setting/team/read-team-by-id"},{"title":"Create team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /team","href":"/api-reference/setting/team/create-team"},{"title":"Update team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /team/{teamId}/","href":"/api-reference/setting/team/update-team"},{"title":"Delete team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /team/{teamId}/","href":"/api-reference/setting/team/delete-team"}]},{"group":"Permission","pages":[{"title":"Role","href":"/api-reference/setting/role-overview"},{"title":"Read role","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /roles","href":"/api-reference/setting/role/read-role"},{"title":"Read role by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /role/{roleId}","href":"/api-reference/setting/role/read-role-by-id"},{"title":"Read my role","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /role","href":"/api-reference/setting/role/read-my-role"},{"title":"Read permissions","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /permissions","href":"/api-reference/setting/role/read-permissions"}]}]},{"group":"Workspace","pages":[{"group":"Organization","pages":[{"title":"Organization","href":"/api-reference/setting/organization-overview"},{"title":"Update organization","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /organization","href":"/api-reference/setting/organization/update-organization"}]},{"group":"Hub","pages":[{"title":"Hub","href":"/api-reference/setting/hub-overview"},{"title":"Read hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /hubs","href":"/api-reference/setting/hub/read-hub"},{"title":"Read hub by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /hub/{hubId}/","href":"/api-reference/setting/hub/read-hub-by-id"},{"title":"Create hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /hub","href":"/api-reference/setting/hub/create-hub"},{"title":"Update hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /hub/{hubId}","href":"/api-reference/setting/hub/update-hub"},{"title":"Delete hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /hub/{hubId}","href":"/api-reference/setting/hub/delete-hub"}]}]},{"group":"Security","pages":[{"group":"Password Policy","pages":[{"title":"Password Policy","href":"/api-reference/setting/password-policy-overview"},{"title":"Read password policies","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /password-policies","href":"/api-reference/setting/password-policy/read-password-policies"},{"title":"Create password policy","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /password-policy","href":"/api-reference/setting/password-policy/create-password-policy"},{"title":"Read password policy by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /password-policy/{id}","href":"/api-reference/setting/password-policy/read-password-policy-by-id"},{"title":"Update password policy","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /password-policy/{id}","href":"/api-reference/setting/password-policy/update-password-policy"},{"title":"Update password policy (PATCH)","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json patch /password-policy/{id}","href":"/api-reference/setting/password-policy/update-password-policy-patch"},{"title":"Delete password policy","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /password-policy/{id}","href":"/api-reference/setting/password-policy/delete-password-policy"}]}]},{"group":"Monitoring","pages":[{"group":"Geofence","pages":[{"title":"Geofence","href":"/api-reference/monitoring/geofence-overview"},{"title":"Read geofences","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json get /geofence","href":"/api-reference/monitoring/geofence/read-geofences"},{"title":"Create geofence","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json post /geofence","href":"/api-reference/monitoring/geofence/create-geofence"},{"title":"Read geofence by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json get /geofence/{id}","href":"/api-reference/monitoring/geofence/read-geofence-by-id"},{"title":"Update geofence","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json put /geofence/{id}","href":"/api-reference/monitoring/geofence/update-geofence"},{"title":"Update geofence status","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json patch /geofence/{id}","href":"/api-reference/monitoring/geofence/update-geofence-status"},{"title":"Delete geofence","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json delete /geofence/{id}","href":"/api-reference/monitoring/geofence/delete-geofence"},{"title":"Read geofence groups","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json get /geofence-group","href":"/api-reference/monitoring/geofence-group/read-geofence-groups"},{"title":"Create geofence group","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json post /geofence-group","href":"/api-reference/monitoring/geofence-group/create-geofence-group"},{"title":"Update geofence group","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json put /geofence-group/{id}","href":"/api-reference/monitoring/geofence-group/update-geofence-group"},{"title":"Delete geofence group","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json delete /geofence-group/{id}","href":"/api-reference/monitoring/geofence-group/delete-geofence-group"}]},{"group":"Alert Setting","pages":[{"title":"Alert Setting","href":"/api-reference/monitoring/alert-setting-overview"},{"title":"Read alert setting","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json get /alert-setting","href":"/api-reference/monitoring/alert-setting/read-alert-setting"},{"title":"Update alert setting","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json put /alert-setting","href":"/api-reference/monitoring/alert-setting/update-alert-setting"}]}]},{"group":"Extensions","pages":[{"group":"Add-ons","pages":[{"title":"Add-on","href":"/api-reference/setting/addon-overview"},{"title":"Create add-on","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /addon","href":"/api-reference/setting/addon/create-add-on"},{"title":"Get add-on details","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /addon/{id}","href":"/api-reference/setting/addon/get-add-on-details"},{"title":"Update add-on","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /addon/{id}","href":"/api-reference/setting/addon/update-add-on"},{"title":"Update add-on partially","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json patch /addon/{id}","href":"/api-reference/setting/addon/update-add-on-partially"},{"title":"Delete add-on","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /addon/{id}","href":"/api-reference/setting/addon/delete-add-on"},{"title":"List add-ons","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /addons","href":"/api-reference/setting/addon/list-add-ons"}]},{"group":"Integration","pages":[{"title":"App Integration","href":"/api-reference/setting/app-integration-overview"},{"title":"Read App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /app-integrations","href":"/api-reference/setting/app-integration/read-app-integration"},{"title":"Read App Integration by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /app-integration/{appIntegrationId}","href":"/api-reference/setting/app-integration/read-app-integration-by-id"},{"title":"Delete App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /app-integration/{appIntegrationId}","href":"/api-reference/setting/app-integration/delete-app-integration"},{"title":"Create App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /app-integration","href":"/api-reference/setting/app-integration/create-app-integration"},{"title":"Update App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /app-integration-update/{appIntegrationId}","href":"/api-reference/setting/app-integration/update-app-integration"},{"title":"Read SMS gateway","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /sms-gateway","href":"/api-reference/setting/app-integration/read-sms-gateway"},{"title":"Create SMS gateway","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /sms-gateway","href":"/api-reference/setting/app-integration/create-sms-gateway"},{"title":"Update SMS gateway","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /sms-gateway/{id}","href":"/api-reference/setting/app-integration/update-sms-gateway"},{"title":"Delete SMS gateway","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /sms-gateway/{id}","href":"/api-reference/setting/app-integration/delete-sms-gateway"},{"title":"Test SMS gateway","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /sms-gateway/test","href":"/api-reference/setting/app-integration/test-sms-gateway"},{"title":"Read Accurate connection status","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /integration/accurate/status","href":"/api-reference/setting/app-integration/read-accurate-connection-status"},{"title":"Start Accurate connection","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /integration/accurate/connect-start","href":"/api-reference/setting/app-integration/start-accurate-connection"},{"title":"Disconnect Accurate","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /integration/accurate/disconnect","href":"/api-reference/setting/app-integration/disconnect-accurate"},{"title":"Read Accurate modules","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /integration/accurate/modules","href":"/api-reference/setting/app-integration/read-accurate-modules"},{"title":"Read Accurate module options","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /integration/accurate/module-options","href":"/api-reference/setting/app-integration/read-accurate-module-options"},{"title":"Read Accurate business data","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /integration/accurate/business-data","href":"/api-reference/setting/app-integration/read-accurate-business-data"},{"title":"Read Accurate flow usage","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /integration/accurate/flow-usage","href":"/api-reference/setting/app-integration/read-accurate-flow-usage"},{"title":"Read Accurate webhook log","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /integration/accurate/webhook-log","href":"/api-reference/setting/app-integration/read-accurate-webhook-log"},{"title":"Read Accurate sync rules","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /integration/accurate/rules","href":"/api-reference/setting/app-integration/read-accurate-sync-rules"},{"title":"Create Accurate sync rule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /integration/accurate/rules","href":"/api-reference/setting/app-integration/create-accurate-sync-rule"},{"title":"Update Accurate sync rule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /integration/accurate/rules/{id}","href":"/api-reference/setting/app-integration/update-accurate-sync-rule"},{"title":"Delete Accurate sync rule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /integration/accurate/rules/{id}","href":"/api-reference/setting/app-integration/delete-accurate-sync-rule"},{"title":"Turn Accurate sync rule on or off","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /integration/accurate/rules/{id}/toggle","href":"/api-reference/setting/app-integration/turn-accurate-sync-rule-on-or-off"},{"title":"Repair Accurate sync rule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /integration/accurate/rules/{id}/repair","href":"/api-reference/setting/app-integration/repair-accurate-sync-rule"}]},{"group":"Custom Module","pages":[{"title":"Custom Module","href":"/api-reference/setting/custom-module-overview"},{"title":"Read custom modules","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /custom-modules","href":"/api-reference/setting/custom-module/read-custom-modules"},{"title":"Create custom module","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /custom-module","href":"/api-reference/setting/custom-module/create-custom-module"},{"title":"Read custom module by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /custom-module/{id}","href":"/api-reference/setting/custom-module/read-custom-module-by-id"},{"title":"Update custom module","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /custom-module/{id}","href":"/api-reference/setting/custom-module/update-custom-module"},{"title":"Delete custom module","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /custom-module/{id}","href":"/api-reference/setting/custom-module/delete-custom-module"}]}]},{"group":"Other","pages":[{"group":"Trash","pages":[{"title":"Trash","href":"/api-reference/setting/trash-overview"},{"title":"Read trash","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /trash","href":"/api-reference/setting/trash/read-trash"}]}]}]},{"group":"Account","pages":[{"group":"Switching Organization","pages":[{"title":"Multi-Organization","href":"/api-reference/auth/multi-organization-overview"},{"title":"Get User Organizations","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-auth.json get /organizations","href":"/api-reference/auth/multi-organization/get-user-organizations"},{"title":"Switch Organization","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-auth.json post /organization/switch","href":"/api-reference/auth/multi-organization/switch-organization"},{"title":"Create Organization","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-auth.json post /organization","href":"/api-reference/auth/multi-organization/create-organization"}]},{"group":"Short Token","pages":[{"title":"Generate Short Token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-tools.json post /short-token/generate","href":"/api-reference/tools/short-token/generate-short-token"},{"title":"Resolve Short Token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-tools.json post /short-token/resolve","href":"/api-reference/tools/short-token/resolve-short-token"}]}]},{"group":"Webhook","pages":[{"title":"How does it works","href":"/api-reference/webhooks/how-it-works"},{"title":"Delivery Attempts and Retries","href":"/api-reference/webhooks/delivery-attempts"},{"title":"Quick Response Requirement","href":"/api-reference/webhooks/quick-response"},{"title":"Failure Monitoring and Notification Process","href":"/api-reference/webhooks/failure-monitoring"},{"group":"Webhook","pages":[{"title":"Task events","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook task-events","href":"/api-reference/webhooks/webhook/task-events"},{"title":"On data source created","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook data-source-created","href":"/api-reference/webhooks/webhook/on-data-source-created"},{"title":"Routing events","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook routing-events","href":"/api-reference/webhooks/webhook/routing-events"},{"title":"Trip events","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook trip-events","href":"/api-reference/webhooks/webhook/trip-events"}]}]},{"group":"File","pages":[{"title":"Overview","href":"/api-reference/file/overview"},{"group":"File","pages":[{"title":"View file","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-file.json get /file/view","href":"/api-reference/file/file/view-file"}]}]},{"group":"Objects","pages":[{"title":"Task object","href":"/api-reference/objects/task-object"},{"title":"Location history object","href":"/api-reference/objects/location-history-object"},{"title":"Alert object","href":"/api-reference/objects/alert-object"},{"title":"Export Config object","href":"/api-reference/objects/export-config-object"},{"title":"Task Schedule object","href":"/api-reference/objects/task-schedule-object"},{"title":"Vehicle object","href":"/api-reference/objects/vehicle-object"},{"title":"Routing object","href":"/api-reference/objects/routing-object"},{"title":"Flow object","href":"/api-reference/objects/flow-object"},{"title":"Automation object","href":"/api-reference/objects/automation-object"},{"title":"Data source object","href":"/api-reference/objects/data-source-object"},{"title":"Data type object","href":"/api-reference/objects/data-type-object"},{"title":"User object","href":"/api-reference/objects/user-object"},{"title":"Role object","href":"/api-reference/objects/role-object"},{"title":"Hub object","href":"/api-reference/objects/hub-object"},{"title":"Team object","href":"/api-reference/objects/team-object"},{"title":"Add-on object","href":"/api-reference/objects/addon-object"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/pages/changelog"}]},{"tab":"Internal API","hidden":true,"pages":[{"title":"Internal API","href":"/api-reference-internal/introduction"}]}]},"basePath":"","title":"Get sample rows - Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}