Pricing

Variation Groups

Manage variation groups

Get variation groups of the campaign

get

Return the list of the variation groups of the campaign

Authorizations
Path parameters
account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

campaign_idstringRequired

The ID of the campaign

Query parameters
_pageintegerOptional

Index of the page

Example: 0
_max_per_pageintegerOptional

Number of items per page

Example: 10
Responses
200

Success

application/json
Responseall of
get
GET /v1/accounts/{account_id}/account_environments/{account_environment_id}/campaigns/{campaign_id}/variation_groups HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "current_item_count": 1,
  "current_page": 0,
  "total_count": 1,
  "items_per_page": 10,
  "last_page": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "variations": [
        {
          "id": "text",
          "name": "text",
          "reference": true,
          "allocation": 1,
          "modifications": {
            "type": "text",
            "value": {}
          }
        }
      ],
      "targeting": {
        "targeting_groups": [
          {
            "targetings": [
              {
                "key": "text",
                "operator": "EQUALS",
                "value": "text"
              }
            ]
          }
        ]
      },
      "allocation_config": {
        "start_date": "2025-09-08T13:23:36.044Z",
        "timezone": "text",
        "start_allocation": 1,
        "periodic_steps": {
          "allocation_step": 1,
          "step": 1,
          "step_type": "day"
        },
        "custom_steps": [
          {
            "allocation_step": 1,
            "step": 1,
            "step_type": "day"
          }
        ],
        "rollback_condition": {
          "goal": {
            "type": "transaction",
            "id": "text",
            "label": "text",
            "operator": "contains",
            "value": "text"
          },
          "operator": "GREATER_THAN",
          "value": 1,
          "min_visitors": 1
        }
      }
    }
  ]
}

Create a variation group

post

Create a variation group

Authorizations
Path parameters
account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

campaign_idstringRequired

The ID of the campaign

Body
idstringRead-onlyOptional

ID of the variation group

namestringOptional

Name of the variation group

Responses
201

Created

application/json
post
POST /v1/accounts/{account_id}/account_environments/{account_environment_id}/campaigns/{campaign_id}/variation_groups HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 614

{
  "name": "text",
  "variations": [
    {
      "name": "text",
      "reference": true,
      "allocation": 1,
      "modifications": {
        "type": "text",
        "value": {}
      }
    }
  ],
  "targeting": {
    "targeting_groups": [
      {
        "targetings": [
          {
            "key": "text",
            "operator": "EQUALS",
            "value": "text"
          }
        ]
      }
    ]
  },
  "allocation_config": {
    "start_date": "2025-09-08T13:23:36.044Z",
    "timezone": "text",
    "start_allocation": 1,
    "periodic_steps": {
      "allocation_step": 1,
      "step": 1,
      "step_type": "day"
    },
    "custom_steps": [
      {
        "allocation_step": 1,
        "step": 1,
        "step_type": "day"
      }
    ],
    "rollback_condition": {
      "goal": {
        "type": "transaction",
        "label": "text",
        "operator": "contains",
        "value": "text"
      },
      "operator": "GREATER_THAN",
      "value": 1,
      "min_visitors": 1
    }
  }
}
{
  "id": "text",
  "name": "text",
  "variations": [
    {
      "id": "text",
      "name": "text",
      "reference": true,
      "allocation": 1,
      "modifications": {
        "type": "text",
        "value": {}
      }
    }
  ],
  "targeting": {
    "targeting_groups": [
      {
        "targetings": [
          {
            "key": "text",
            "operator": "EQUALS",
            "value": "text"
          }
        ]
      }
    ]
  },
  "allocation_config": {
    "start_date": "2025-09-08T13:23:36.044Z",
    "timezone": "text",
    "start_allocation": 1,
    "periodic_steps": {
      "allocation_step": 1,
      "step": 1,
      "step_type": "day"
    },
    "custom_steps": [
      {
        "allocation_step": 1,
        "step": 1,
        "step_type": "day"
      }
    ],
    "rollback_condition": {
      "goal": {
        "type": "transaction",
        "id": "text",
        "label": "text",
        "operator": "contains",
        "value": "text"
      },
      "operator": "GREATER_THAN",
      "value": 1,
      "min_visitors": 1
    }
  }
}

Get one variation group

get

Return one variation group by its id

Authorizations
Path parameters
account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

campaign_idstringRequired

The ID of the campaign

variation_group_idstringRequired

The ID of the variation group

Responses
200

Success

application/json
get
GET /v1/accounts/{account_id}/account_environments/{account_environment_id}/campaigns/{campaign_id}/variation_groups/{variation_group_id} HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "name": "text",
  "variations": [
    {
      "id": "text",
      "name": "text",
      "reference": true,
      "allocation": 1,
      "modifications": {
        "type": "text",
        "value": {}
      }
    }
  ],
  "targeting": {
    "targeting_groups": [
      {
        "targetings": [
          {
            "key": "text",
            "operator": "EQUALS",
            "value": "text"
          }
        ]
      }
    ]
  },
  "allocation_config": {
    "start_date": "2025-09-08T13:23:36.044Z",
    "timezone": "text",
    "start_allocation": 1,
    "periodic_steps": {
      "allocation_step": 1,
      "step": 1,
      "step_type": "day"
    },
    "custom_steps": [
      {
        "allocation_step": 1,
        "step": 1,
        "step_type": "day"
      }
    ],
    "rollback_condition": {
      "goal": {
        "type": "transaction",
        "id": "text",
        "label": "text",
        "operator": "contains",
        "value": "text"
      },
      "operator": "GREATER_THAN",
      "value": 1,
      "min_visitors": 1
    }
  }
}

Delete a variation group

delete

Delete a variation group by its id.

Authorizations
Path parameters
account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

campaign_idstringRequired

The ID of the campaign

variation_group_idstringRequired

The ID of the variation group

Responses
204

Deleted

No content
delete
DELETE /v1/accounts/{account_id}/account_environments/{account_environment_id}/campaigns/{campaign_id}/variation_groups/{variation_group_id} HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Accept: */*

No content

Update a variation group

patch

Update variation group informations - You can set only the properies you want to update in the request body.

Authorizations
Path parameters
account_idstringRequired

The ID of the account

account_environment_idstringRequired

The ID of the environment

campaign_idstringRequired

The ID of the campaign

variation_group_idstringRequired

The ID of the variation group

Body
idstringRead-onlyOptional

ID of the variation group

namestringOptional

Name of the variation group

Responses
200

Updated

application/json
patch
PATCH /v1/accounts/{account_id}/account_environments/{account_environment_id}/campaigns/{campaign_id}/variation_groups/{variation_group_id} HTTP/1.1
Host: api.flagship.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 614

{
  "name": "text",
  "variations": [
    {
      "name": "text",
      "reference": true,
      "allocation": 1,
      "modifications": {
        "type": "text",
        "value": {}
      }
    }
  ],
  "targeting": {
    "targeting_groups": [
      {
        "targetings": [
          {
            "key": "text",
            "operator": "EQUALS",
            "value": "text"
          }
        ]
      }
    ]
  },
  "allocation_config": {
    "start_date": "2025-09-08T13:23:36.044Z",
    "timezone": "text",
    "start_allocation": 1,
    "periodic_steps": {
      "allocation_step": 1,
      "step": 1,
      "step_type": "day"
    },
    "custom_steps": [
      {
        "allocation_step": 1,
        "step": 1,
        "step_type": "day"
      }
    ],
    "rollback_condition": {
      "goal": {
        "type": "transaction",
        "label": "text",
        "operator": "contains",
        "value": "text"
      },
      "operator": "GREATER_THAN",
      "value": 1,
      "min_visitors": 1
    }
  }
}
{
  "id": "text",
  "name": "text",
  "variations": [
    {
      "id": "text",
      "name": "text",
      "reference": true,
      "allocation": 1,
      "modifications": {
        "type": "text",
        "value": {}
      }
    }
  ],
  "targeting": {
    "targeting_groups": [
      {
        "targetings": [
          {
            "key": "text",
            "operator": "EQUALS",
            "value": "text"
          }
        ]
      }
    ]
  },
  "allocation_config": {
    "start_date": "2025-09-08T13:23:36.044Z",
    "timezone": "text",
    "start_allocation": 1,
    "periodic_steps": {
      "allocation_step": 1,
      "step": 1,
      "step_type": "day"
    },
    "custom_steps": [
      {
        "allocation_step": 1,
        "step": 1,
        "step_type": "day"
      }
    ],
    "rollback_condition": {
      "goal": {
        "type": "transaction",
        "id": "text",
        "label": "text",
        "operator": "contains",
        "value": "text"
      },
      "operator": "GREATER_THAN",
      "value": 1,
      "min_visitors": 1
    }
  }
}
PreviousCampaignsNextVariations

Was this helpful?