Documentation > Reporting API > Rank Data Methods

Brand Cannibalization API

The Brand Cannibalization API method returns the brand domains with rank position, URL, a number of results above the primary domain, and the search volume of the keywords that are being cannibalized by the family domains. If no brand family domain cannibalization takes place then no results will be returned

Refer to the Rank Ranger API Overview page for information on how to obtain API access, obtain an API Key, and a full list of API methods and error codes.

Parameters

key	string	The unique API key assigned to your account
campaign_id	string	Campaign ID number
se_id	string	Search Engine ID number (optional: if not included, then data for all search engines tracked in the campaign will be provided) Run the Search Engine List API for a full list of ID numbers.
domains	string	A list of brand family domains separated by a comma with no space in between.
output	string	Output format options: &output=xml (this is the default format) &output=json Either of these parameters can be added to the json output parameter: &output=json&json_strict=true (forces the results to come back as an array instead of objects) &output=json&json_arr=true (causes the entire json to be wrapped as array)

Examples

Construct & test API requests in the API Console or follow this example:

https://www.rankranger.com/api/v2/?get_brand_cannibalization&key=YOURAPIKEY&campaign_id=123456&se_id=SE ID&domains=yourdomain.com,yourdomain.co.uk,yourdomain.co.au&output=json

The default output is in XML format, if you would like the output to be JSON you will need to add "&output=json” at the end of the string

Response

<tracking-data provider="rankranger" date="04/03/2022" time="11:15:28" status="ok" total_results="6">
    <result>
        <keyword>purple blackberry spice candle</keyword>
        <brand_family_domain>yourdomain.co.uk</brand_family_domain>
        <rank>1</rank>
        <url>https://www.yourdomain.co.uk/products/candles/purple-blackberry-spice</url>
        <market>non-local market</market>
        <res_above_primary>1</res_above_primary>
        <search_volume>10</search_volume>
    </result>
    <result>
        <keyword>candles uk</keyword>
        <brand_family_domain>yourdomain.co.uk</brand_family_domain>
        <rank>1</rank>
        <url>https://www.yourdomain.co.uk/products/candles</url>
        <market>non-local market</market>
        <res_above_primary>2</res_above_primary>
        <search_volume>10</search_volume>
    </result>
    <result>
        <keyword>candles uk</keyword>
        <brand_family_domain>yourdomain.co.uk</brand_family_domain>
        <rank>2</rank>
        <url>https://www.yourdomain.co.uk/</url>
        <market>non-local market</market>
        <res_above_primary>2</res_above_primary>
        <search_volume>10</search_volume>
    </result>
    <result>
        <keyword>candles uk</keyword>
        <brand_family_domain>yourdomain.com.au</brand_family_domain>
        <rank>6</rank>
        <url>https://www.yourdomain.com.au/faqs/candles-faqs/</url>
        <market>local market</market>
        <res_above_primary>2</res_above_primary>
        <search_volume>10</search_volume>
    </result>
    <result>
        <keyword>white vanilla bean candle</keyword>
        <brand_family_domain>yourdomain.co.uk</brand_family_domain>
        <rank>1</rank>
        <url>https://www.yourdomain.co.uk/products/candles/white-vanilla-bean</url>
        <market>non-local market</market>
        <res_above_primary>1</res_above_primary>
        <search_volume>10</search_volume>
    </result>
    <result>
        <keyword>vanilla bean candle</keyword>
        <brand_family_domain>yourdomain.co.uk</brand_family_domain>
        <rank>3</rank>
        <url>https://www.yourdomain.co.uk/products/candles/white-vanilla-bean</url>
        <market>non-local market</market>
        <res_above_primary>1</res_above_primary>
        <search_volume>10</search_volume>
    </result>
</tracking-data>

Get the ultimate SEO tools with the Rank Ranger Software
Learn More About Rank Ranger

Featured SEO Tools

SEO Dashboard Rank Tracker Social Analytics Link Manager White Label SEO

Marketing Dashboard Keyword Finder Insight Graph API

Resources

Top 100 Websites Rank Risk Index Google Algorithm Updates Google SERP Features Tool Mobile SERP Features Tool Visual Guide to SERP Features SEO Glossary

Rank Ranger

Pricing Contact us Blog Help Center Documentation Brand Ambassadors

Search our Knowledge Base
	Search