OMomni
Schedules

Get schedule

Changed on

Retrieve the details of a single schedule, including its delivery destinations, recurrence configuration, and current status. A schedule can deliver a dashboard or a workbook.

get/v1/schedules/{scheduleId}

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/schedules/{scheduleId}
  • Auth
    HTTP bearer

Path parameters

scheduleIdstring uuid required

The ID of the schedule. To find a schedule's ID:

  1. Navigate to the dashboard or workbook.
  2. Click File > Deliveries & Alerts.
  3. Next to a schedule, click Edit.

The schedule's ID is in the page's URL, after /schedules/. For example, the schedule ID in this URL is 123e4567-e89b-12d3-a456-426614174000:

https://blobsrus.omniapp.co/dashboards/e23ebaa0/schedules/123e4567-e89b-12d3-a456-426614174000

Query parameters

userIdstring uuid

Membership ID of the user whose permissions should be checked (Organization API keys only). When provided, the endpoint verifies the user can view and schedule the associated dashboard or workbook before returning the schedule.

Response

Schedule retrieved successfully

idstring uuid required

Schedule UUID

namestring required

Schedule name

organizationIdstring uuid required

Organization UUID

entity'dashboard' | 'workbook' required

What the schedule delivers: the dashboard, or a tab of the workbook.

documentIdentifierstring required

Identifier of the document the schedule delivers. Shared by the document's dashboard and workbook.

entityIdstring uuid required

Deprecated. Use documentIdentifier instead. Internal ID of the dashboard, or of the document for a workbook delivery. For dashboards, this value changes when the dashboard is published.

ownerIdstring uuid required

The user ID of the schedule owner, as returned by the List users endpoint.

In the rare case the owner has no membership in the organization at all (for example, an embed user removed through a hard delete), this falls back to the owner's raw user ID instead.

schedulestring required

AWS EventBridge cron expression (minute hour day-of-month month day-of-week year)

timezonestring required

IANA timezone identifier

fanOutboolean required

When true, each recipient receives a personalized delivery. The value returned reflects the organization's delivery personalization setting: if set to Never, this will always be false; if set to Always, this reflects the forced-personalization state. See Personalizing email deliveries for more information.

Note: Personalized deliveries aren't supported for connections that use OAuth sign-in. In this case, the delivery will fail.

killJobsOnFailureboolean required

If true, stops the entire job if any queries included in the task fail.

filterConfigScheduleFilterConfig

Dashboard deliveries only. An object specifying the filter conditions to apply to the task. The filter key specified must already exist in the dashboard.

Use the Get dashboard filters and controls endpoint to retrieve filter configuration objects.

Note: Filter keys are case-sensitive and must match exactly.

metadataobject nullable

Format options and other delivery settings

conditionQueryMapKeystring required

Required if conditionType is provided. The ID of the query to monitor for triggering an alert. Must reference a valid query in the document. For a workbook delivery, this must be a tab of the published workbook.

In responses, null for standard schedules.

conditionTypestring required

Required if conditionType is provided. The ID of the query to monitor for triggering an alert. Must reference a valid query in the document. For a workbook delivery, this must be a tab of the published workbook.

In responses, null for standard schedules.

disabledAtstring date-time nullable required

Timestamp when the schedule was manually paused. null if active.

systemDisabledAtstring date-time required

Timestamp when the system disabled the schedule

systemDisabledReason'contentRemoved' | 'credentialMissing' | 'destinationDisabled' | 'missingQuery' | 'noAccess' | 'orphanedFilterConfigKeys' | 'ownerRevoked' nullable required

Reason for the system disabling the schdule.

createdAtstring date-time required

ISO 8601 creation timestamp

deletedAtstring date-time nullable required

Always null; a schedule in the trash returns 404 from this endpoint. To find a deleted schedule, use the includeDeleted parameter on List schedules.

updatedAtstring date-time required

ISO 8601 last-updated timestamp

Example response

{
  "schedule": "0 9 ? * MON *",
  "timezone": "America/New_York",
  "filterConfig": {
    "status": [
      "active",
      "pending"
    ]
  },
  "conditionQueryMapKey": "Jmn2r3KV",
  "conditionType": "Jmn2r3KV",
  "destinations": [
    {
      "format": "pdf"
    }
  ]
}

Changes

  • 43290040f88fRevision changes
    • info

      api operation id getSchedule removed and replaced with schedulesGet

    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      added the new optional query request parameter userId

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status