Schedulers
getScheduler
API
My Account
- Overview
- GETGetAuthenticatedUser
- POSTRegisterUser
- PUTCreateEmailOneTimePasscode
- GETGetEmailVerificationStatus
- GETListMyAvailableOrganizations
- POSTJoinOrganization
- DELDeleteMe
- GETcreateWarehouseCredentials
- POSTupdateWarehouseCredentials
- DELdeleteWarehouseCredentials
- PATCHupdateWarehouseCredentials
- GETgetLoginOptions
- PATCHRotate personal access token
Organizations
- Overview
- GETGetMyOrganization
- PUTCreateOrganization
- PATCHUpdateMyOrganization
- DELDeleteMyOrganization
- GETListOrganizationProjects
- GETListOrganizationMembers
- GETGetOrganizationMemberByUuid
- DELDeleteOrganizationMember
- GETListOrganizationEmailDomains
- PATCHUpdateOrganizationEmailDomains
- GETListGroupsInOrganization
- POSTCreateGroupInOrganization
Projects
- Overview
- GETGetExplores
- PUTSetExplores
- GETGetExplore
- POSTCompileQuery
- POSTDownloadCsvFromExplore
- GETGetProject
- GETListChartsInProject
- GETListChartSummariesInProject `Deprecated`
- GETListSpacesInProject
- GETGetProjectAccessList
- POSTCalculateTotalFromQuery
- GETgetUserWarehouseCredentialsPreference
- PATCHupdateUserWarehouseCredentialsPreference
- GETgetCustomMetrics
- PATCHupdateProjectMetadata
- DELdeleteProjectSemanticLayerConnection
- PATCHupdateProjectSemanticLayerConnection
- GETgetDashboards
- POSTcreateDashboard
- PATCHupdateDashboards
- POSTcreatePreview
- PATCHPatch apiv1projects schedulersettings
- GETgetTags
- POSTcreateTag
- DELdeleteTag
- PATCHupdateTag
- GETgetChartsAsCode
- GETgetDashboardsAsCode
- POSTupsertChartAsCode
- POSTupsertDashboardAsCode
- GETGetLatestValidationResults
- POSTValidateProject
- DELDeleteValidationDismiss
Roles & Permissions
- PATCHUpdateOrganizationMember
- POSTCreateSpaceInProject
- GETGet apiv1projects access
- POSTGetProjectAccessList
- GETGetProjectMemberAccess
- DELRevokeProjectAccessForUser
- PATCHGrantProjectAccessToUser
- PATCHUpdateSpace
- POSTAddSpaceUserAccess
- DELRevokeSpaceAccessForUser
- POSTAddSpaceGroupAccess
- DELRevokeGroupSpaceAccess
Catalog
- GETgetCatalog
- GETgetMetadata
- GETgetAnalytics
- GETgetAnalyticsField
- GETgetMetricsCatalog
- GETgetMetric
- GETgetMetricsWithTimeDimensions
- GETgetSegmentDimensions
- POSTaddCategoryToCatalogItem
- DELremoveCategoryFromCatalogItem
- PATCHupdateCatalogItemIcon
- GETgetMetricsTree
- POSTcreateMetricsTreeEdge
- DELdeleteMetricsTreeEdge
Exports
Git Integration
User Groups
Metrics Explorer
Notifications
Charts
Schedulers
Share links
SSH Keypairs
Schedulers
getScheduler
Get a scheduler
GET
/
api
/
v1
/
schedulers
/
{schedulerUuid}
{
"results": {
"includeLinks": true,
"notificationFrequency": "always",
"enabled": true,
"thresholds": [
{
"value": 123,
"fieldId": "<string>",
"operator": "greaterThan"
}
],
"options": {
"limit": 123,
"formatted": true
},
"dashboardUuid": null,
"savedChartUuid": "<string>",
"timezone": "<string>",
"cron": "<string>",
"format": "csv",
"createdBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"message": "<string>",
"name": "<string>",
"schedulerUuid": "<string>",
"targets": [
{
"channel": "<string>",
"schedulerUuid": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"schedulerSlackTargetUuid": "<string>"
}
]
},
"status": "ok"
}
Path Parameters
The uuid of the scheduler to update
Response
200
application/json
Success
Available options:
csv
, image
, gsheets
Available options:
always
, once
Available options:
ok
{
"results": {
"includeLinks": true,
"notificationFrequency": "always",
"enabled": true,
"thresholds": [
{
"value": 123,
"fieldId": "<string>",
"operator": "greaterThan"
}
],
"options": {
"limit": 123,
"formatted": true
},
"dashboardUuid": null,
"savedChartUuid": "<string>",
"timezone": "<string>",
"cron": "<string>",
"format": "csv",
"createdBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"message": "<string>",
"name": "<string>",
"schedulerUuid": "<string>",
"targets": [
{
"channel": "<string>",
"schedulerUuid": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"schedulerSlackTargetUuid": "<string>"
}
]
},
"status": "ok"
}