Dailyrun and zones

9. DailyRun API¶

The DailyRun API controls and monitors the nightly ETL pipeline that refreshes your org's lake. It is accessed at api.{orgname}.{region-domain}/superset.

Note — The DailyRun enabled flag only controls the scheduled nightly kickoff. You can always trigger a manual run via POST /dailyRun/start_execution regardless of the flag.

9.1 GET /dailyRun/dailyRun_enabled¶

Returns whether the scheduled nightly ETL run is enabled for this org.

Required scope: dailyrun:enabled:read

Request¶

GET https://api.{orgname}.{region-domain}/superset/dailyRun/dailyRun_enabled
Authorization: Bearer {access_token}

Responses¶

200 example

{ "dailyRun": true }

9.2 POST /dailyRun/dailyRun_enabled¶

Enables or disables the scheduled nightly ETL run.

Required scope: dailyrun:enabled:write

Request¶

POST https://api.{orgname}.{region-domain}/superset/dailyRun/dailyRun_enabled
Authorization: Bearer {access_token}
Content-Type: application/json

Example request body

{ "dailyRun": true }

Responses¶

200 example

{ "dailyRun": true }

9.3 GET /dailyRun/execution_status¶

Returns execution records for this org's nightly pipeline.

Required scope: dailyrun:execution:read

Request¶

GET https://api.{orgname}.{region-domain}/superset/dailyRun/execution_status
Authorization: Bearer {access_token}

Query parameters¶

mode values¶

Execution object fields¶

Responses¶

200 — mode=list

{
  "executions": [
    {
      "name": "DailyScheduledETL_<org>_20250401T020000Z",
      "status": "SUCCEEDED",
      "startDate": "2025-04-01T02:00:00.000000+00:00",
      "stopDate":  "2025-04-01T02:14:37.000000+00:00"
    }
  ]
}

200 — mode=latest

{
  "name": "DailyScheduledETL_<org>_20250401T020000Z",
  "status": "SUCCEEDED",
  "startDate": "2025-04-01T02:00:00.000000+00:00",
  "stopDate":  "2025-04-01T02:14:37.000000+00:00"
}

(Returns null body when no executions exist.)

200 — mode=last_successful (none found)

{ "message": "No successful Daily ETL executions found." }

400 — invalid mode

{
  "message": "mode is not valid, mode should be one of: list, latest, last_successful"
}

9.4 POST /dailyRun/start_execution¶

Manually starts a new pipeline execution for this org. The pipeline input is constructed automatically from your org's configuration — you do not supply it.

Required scope: dailyrun:execution:write

Request¶

POST https://api.{orgname}.{region-domain}/superset/dailyRun/start_execution
Authorization: Bearer {access_token}

No request body required.

Responses¶

200 success body

{
  "message": "Daily ETL pipeline execution started.",
  "started": true,
  "executionArn": "arn:aws:states:eu-west-1:...:execution:DailyETLPipeline:DailyScheduledETL_<org>_20250401T020000Z",
  "startDate": "2025-04-01T02:00:00.000000+00:00",
  "executionName": "DailyScheduledETL_<org>_20250401T020000Z",
  "stateMachineArn": "arn:aws:states:eu-west-1:...:stateMachine:DailyETLPipeline"
}

executionArn and stateMachineArn are included for reference; treat them as opaque strings. They are not needed for normal polling — use GET /dailyRun/execution_status?mode=latest to track progress.

409 conflict body

{
  "message": "Daily ETL pipeline is already running for this client; no execution started.",
  "started": false,
  "executionName": null,
  "runningExecution": {
    "name": "DailyScheduledETL_<org>_20250401T020000Z",
    "status": "RUNNING",
    "startDate": "2025-04-01T02:00:00.000000+00:00"
  },
  "stateMachineArn": "arn:aws:states:eu-west-1:...:stateMachine:DailyETLPipeline"
}

Typical polling flow¶

POST /dailyRun/start_execution
  → 200 { "executionName": "DailyScheduledETL_<org>_..." }

Loop:
  GET /dailyRun/execution_status?mode=latest
    → { "status": "RUNNING", ... }   ← keep polling
    → { "status": "SUCCEEDED", ... } ← done
    → { "status": "FAILED", ... }    ← check logs

10. Zone API¶

A zone is a separate data area inside your org with its own lake, its own AWS account, and its own API host. The Zone API has the same query and load endpoints as the Org API, but with the following differences.

10.1 Host¶

https://{zonename}.{orgname}.api.{region-domain}/v2/

Example: https://<zone>.<org>.api.comodash.io/v2/

10.2 Audience and scopes¶

Zone scopes follow the pattern {zonename}:{action}. Examples for a zone named <zone>:

You must request a token with the correct audience (dash_api_<zone>) and scope against the same ComoAuth realm (https://auth.comotion.us/auth/realms/{orgname}).

10.3 Available endpoints¶

The Zone API exposes only query and load endpoints:

10.4 Base path¶

The Zone API base path is /v2 (not /v1 as on the Org API).

11. Error reference¶

All error responses use the shape:

{ "message": "Human-readable description" }

HTTP status codes¶

Load error types (recap)¶