Get merge status for a draft revision

Runs the three-way merge between the draft and the current live version without applying it. Conflicts are granular: each conflicting field gets its own key, and rules conflict individually (rules.<ruleId>, plus rules.order for competing reorders). Pass the returned liveVersion as expectedLiveVersion when rebasing. Also reports rebaseRequired so callers can detect ahead of time whether the publish endpoint will block until the draft is rebased.

GET

features

{id}

revisions

{version}

merge-status

cURL

curl -X GET 'https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/merge-status' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/merge-status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/merge-status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/merge-status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/merge-status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/merge-status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "liveVersion": 123,
  "draftDateUpdated": "2023-11-07T05:31:56Z",
  "conflicts": [
    {
      "name": "<string>",
      "key": "<string>",
      "resolved": true,
      "base": "<string>",
      "live": "<string>",
      "revision": "<string>"
    }
  ],
  "rebaseRequired": true,
  "result": {
    "defaultValue": "<string>",
    "rules": [
      "<unknown>"
    ],
    "environmentsEnabled": {},
    "prerequisites": [
      {
        "id": "<string>",
        "condition": "<string>"
      }
    ],
    "archived": true,
    "metadata": {
      "releaseType": "<string>",
      "riskLevel": "<string>"
    },
    "holdout": {
      "id": "<string>",
      "value": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

If using Bearer auth, pass the Secret Key as the token:

curl https://api.growthbook.io/api/v1/features   -H "Authorization: Bearer secret_abc123DEF456"

Path Parameters

string

required

version

integer

required

Response

200 - application/json

Successful response

success

boolean

required

liveVersion

number

required

The current live version the merge was computed against. Echo this back as expectedLiveVersion when rebasing.

draftDateUpdated

string<date-time>

required

The draft's last-modified timestamp at merge time. Echo this back as expectedDraftDateUpdated when rebasing to guard against concurrent draft edits.

conflicts

object[]

required

Show child attributes

rebaseRequired

boolean

required

True when publishing this draft is blocked until it is rebased — either the merge has conflicts, or the draft is behind live (or its approval went stale) while the organization enforces rebase-before-publish. When true with no conflicts, callers with bypass-approval permission can still publish with mergeNow: true; others must rebase first.

result

object

Show child attributes

cURL

curl -X GET 'https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/merge-status' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/merge-status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/merge-status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/merge-status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/merge-status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/merge-status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "liveVersion": 123,
  "draftDateUpdated": "2023-11-07T05:31:56Z",
  "conflicts": [
    {
      "name": "<string>",
      "key": "<string>",
      "resolved": true,
      "base": "<string>",
      "live": "<string>",
      "revision": "<string>"
    }
  ],
  "rebaseRequired": true,
  "result": {
    "defaultValue": "<string>",
    "rules": [
      "<unknown>"
    ],
    "environmentsEnabled": {},
    "prerequisites": [
      {
        "id": "<string>",
        "condition": "<string>"
      }
    ],
    "archived": true,
    "metadata": {
      "releaseType": "<string>",
      "riskLevel": "<string>"
    },
    "holdout": {
      "id": "<string>",
      "value": "<string>"
    }
  }
}

Introduction

Endpoints

Models

Get merge status for a draft revision

Authorizations

Path Parameters

Response