List Reload Schedules

Lists Warehouse Native experiments, gates or holdouts that have a scheduled reload hour, one entityType per request, sorted by id . Each item shows its sched…

Lists Warehouse Native experiments, gates or holdouts that have a scheduled reload hour, one entityType per request, sorted by id. Each item shows its schedule and whether the scheduler selects it.

eligible is true when the scheduler's rules select the entity. It doesn't guarantee a reload runs. The scheduler can still skip an eligible entity at run time, and skipReasons doesn't report these skips: a scheduled reload already ran that UTC day, scheduled reloads are paused for the project, a gate rule is at 0% or 100%, or a gate rule is inside its real-time auto-reload window.

To change many schedules, collect every id first, then send the PATCH requests. Changing schedules while you page can skip rows, because each change moves entities in or out of the filtered list.

List requests don't count toward the Console API write limit. Each PATCH does: by default, 1,800 writes per 15 minutes and 30 writes per 10 seconds per project, shared by every key and every Console API write.

gethttps://statsigapi.net/console/v1/reload_schedules

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Query parameters

limitinteger

Results per page

Example:10
Constraints:stringnumber
pageinteger

Page number

Example:1
Constraints:stringnumber
entityTypestringrequired

Type of entity to list. Each request lists one type.

Allowed values:experimentgateholdout
Example:experiment
eligiblestring

When true, returns only entities the scheduler selects (eligible: true). When omitted or false, returns every entity with a scheduled reload hour.

Allowed values:truefalse
hourinteger

Returns only entities scheduled at this UTC hour, from 0 to 23.

Example:0

Response

application/json
200· List reload schedules response
messagestringrequired

A simple string explaining the result of the operation.

dataobject[]required
Show child attributes
entityTypestringrequired

Type of the entity, matching the entityType you requested.

Allowed values:experimentgateholdout
idstringrequired

ID to use with /console/v1/experiments/{id}, /console/v1/gates/{id} or /console/v1/holdouts/{id}.

namestringrequired

Display name.

scheduledReloadHourintegerrequired

UTC hour, from 0 to 23, at which scheduled reloads start.

Constraints:format: int64
scheduledReloadDaysinteger[]required

Days of the week with scheduled reloads, from 0 to 6, where 0 is Sunday. null means every day. An empty list means no day, so the entity never reloads (no_days).

Constraints:nullable
scheduledReloadTypestringrequired

Reload type for scheduled reloads. An unset type reads as incremental.

Allowed values:fullincremental
turboModebooleanrequired

Whether scheduled reloads use Turbo mode. null means unset, so scheduled reloads keep the latest reload's setting. For experiments, an organization that enforces Turbo mode overrides this value.

Constraints:nullable
eligiblebooleanrequired

true when the scheduler's rules select this entity, so skipReasons is empty. The scheduler can still skip it at run time.

skipReasonsstring[]required

Each scheduler rule this entity fails. Every type: no_days (scheduledReloadDays is an empty list). Gates and holdouts: disabled, archived, no_partial_rollout (no rule passes between 0% and 100%). Experiments: not_started, launched, analysis_ended (the analysis end time has passed), cloud_results (Statsig Cloud computes this experiment's results), incremental_with_secondary_id (incremental reloads don't support a secondary ID type; send scheduledReloadType: "full").

paginationobjectrequired

Pagination metadata for checking if there is next page for example.

Show child attributes
itemsPerPagenumberrequired
Constraints:format: double
pageNumbernumberrequired
Constraints:format: double
nextPagestringrequired
Constraints:nullable
previousPagestringrequired
Constraints:nullable
totalItemsnumber
Constraints:format: double
allstring
400· Invalid query parameters, or the project doesn't use Warehouse Native
statusintegerrequired
Allowed values:400
messagestringrequired
401· This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx
statusintegerrequired
Allowed values:401
messagestringrequired

Was this helpful?

For AI agents: a documentation index is available at /llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.