{"openapi":"3.1.0","info":{"title":"POST /api/v1/dashboards/{dashboard_id}/schedule","version":"1.0.0","description":"Create a refresh schedule"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/dashboards/{dashboard_id}/schedule":{"post":{"tags":["dashboards"],"summary":"Create a refresh schedule","description":"Schedule a recurring background refresh of this dashboard's widget sources. A dashboard may have at most one schedule — returns 400 if one already exists (PATCH it instead).\n\nThe refresh runs as **you**: at each run the scheduler re-resolves your current role and permissions and executes the widget sources under them. If your access to this business later lapses, the refresh fails closed rather than continuing as a standing grant.","operationId":"create_dashboard_schedule_api_v1_dashboards__dashboard_id__schedule_post","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","title":"Dashboard Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardRefreshScheduleRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_DashboardRefreshScheduleResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"detail":"Invalid request parameters"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"DashboardRefreshScheduleRequest":{"properties":{"frequency":{"type":"string","enum":["hourly","daily","weekly","monthly"],"title":"Frequency","default":"daily"},"day_of_week":{"anyOf":[{"type":"integer","maximum":6.0,"minimum":0.0},{"type":"null"}],"title":"Day Of Week"},"day_of_month":{"anyOf":[{"type":"integer","maximum":31.0,"minimum":1.0},{"type":"null"}],"title":"Day Of Month"},"hour_utc":{"type":"integer","maximum":23.0,"minimum":0.0,"title":"Hour Utc","default":6},"timezone":{"type":"string","maxLength":50,"title":"Timezone","default":"UTC"},"is_enabled":{"type":"boolean","title":"Is Enabled","default":true}},"additionalProperties":false,"type":"object","title":"DashboardRefreshScheduleRequest","description":"Body for ``POST /dashboards/{dashboard_id}/schedule``.\n\n``hour_utc`` is interpreted in ``timezone``, not in UTC, despite the name\n(kept for symmetry with ``scheduled_reports``). It is ignored entirely\nwhen ``frequency`` is ``hourly``."},"DashboardRefreshScheduleResponse":{"properties":{"id":{"type":"string","title":"Id"},"dashboard_id":{"type":"string","title":"Dashboard Id"},"frequency":{"type":"string","enum":["hourly","daily","weekly","monthly"],"title":"Frequency"},"day_of_week":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Day Of Week"},"day_of_month":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Day Of Month"},"hour_utc":{"type":"integer","title":"Hour Utc"},"timezone":{"type":"string","title":"Timezone"},"is_enabled":{"type":"boolean","title":"Is Enabled"},"last_run_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Run At"},"next_run_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Run At"},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Error"},"created_by_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By User Id"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},"additionalProperties":false,"type":"object","required":["id","dashboard_id","frequency","hour_utc","timezone","is_enabled"],"title":"DashboardRefreshScheduleResponse","description":"A dashboard's refresh schedule plus its run bookkeeping."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SuccessEnvelope_DashboardRefreshScheduleResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/DashboardRefreshScheduleResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[DashboardRefreshScheduleResponse]"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}