Rollout
Represents information about an rollout on a shop.
Anchor to FieldsFields
- archivedAt (DateTime)
- concludedAt (DateTime)
- creationDate (DateTime!)
- effectiveTrafficAllocation (Float!)
- id (ID!)
- lastEditDate (DateTime!)
- name (String!)
- rolloutTrafficAllocation (Int!)
- scheduleActiveAt (DateTime)
- scheduleConcludeAt (DateTime)
- startedAt (DateTime)
- status (RolloutStatus!)
- treatments ([RolloutTreatment!])
- Anchor to archivedAtarchived•Date
At Time The date and time at which the rollout was archived.
- Anchor to concludedAtconcluded•Date
At Time The date and time at which the rollout ended or is scheduled to end.
- Anchor to creationDatecreation•Date
Date Time! non-null The date and time at which the rollout was created.
- Anchor to effectiveTrafficAllocationeffective•Float!
Traffic Allocation non-null The effective percentage of total traffic this rollout receives for new buyer assignments, accounting for mutex group constraints with other active rollouts.
- •ID!non-null
The ID of the rollout.
- Anchor to lastEditDatelast•Date
Edit Date Time! non-null The date and time at which the rollout was last modified.
- Anchor to namename•String!non-null
The name of the rollout.
- Anchor to rolloutTrafficAllocationrollout•Int!
Traffic Allocation non-null The percentage of buyer traffic that the rollout is configured to receive. This is the configured allocation before other active rollouts on the same resources are taken into account, so it isn't the share of buyers that a treatment reaches.
- Anchor to scheduleActiveAtschedule•Date
Active At Time The date and time at which the rollout is scheduled to start.
- Anchor to scheduleConcludeAtschedule•Date
Conclude At Time The date and time at which the rollout is scheduled to conclude.
- Anchor to startedAtstarted•Date
At Time The date and time at which the rollout started or is scheduled to start.
- Anchor to statusstatus•Rollout
Status! non-null The status of the rollout.
Show enum values
- Anchor to treatmentstreatments•[Rollout
Treatment!] The treatments of the rollout.
Show fields
Anchor to QueriesQueries
- rollout (Rollout)
- rollouts (RolloutConnection!)
- •query
A rollout on a shop.
Show fields
- •ID!required
The ID of the rollout.
Arguments
- •ID!
- •query
Returns the list of rollouts in the shop.
Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Show filters
- Anchor to name•string
Filter by rollout name. Matches rollouts whose name contains the search value.
- Anchor to status•string
Filter by rollout status. Values are case-insensitive; unknown values match no rollouts.
DRAFTSCHEDULEDPAUSEDACTIVECONCLUDEDARCHIVEDstatus:ACTIVEstatus:ACTIVE,DRAFT
Valid values:
Example:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Rollout
Key Sort Keys Default:ID Sort the underlying list by the given key.
Show enum values
Arguments