GetRelatedSites New Beta

Status

Command status: Beta - subject to modification and/or removal
Supported by OpenApps API: Yes
Supported by Internal/Reseller API: Yes
Possibly queued processing: No

Purpose

Returns co-citations, domains mentioned around the backlinks to your query. Useful for finding related or similar domains.

These are calculated by gathering the top backlinks available with your subscription, and looking at the external links within the context.

Resources consumed

Resource Description

AnalysisResUnits

5000 AnalysisResUnits are consumed for each use.

RetrievalResUnits

This resource will be decreased by actual number of rows of data retrieved (returned) by this command.

Parameters

Parameter Description

cmd

Required: must be set to: GetRelatedSites

datasource

Required: this command currently only works against the "fresh" index, so this must be set to "fresh".

item

Required: The URL, domain or subdomain for which the related sites will be returned.

Sample queries and response

XML response

<?xml version="1.0" encoding="utf-8"?>
<Result Code="OK" ErrorMessage="" FullError="">
  <GlobalVars IndexBuildDate="2019-11-19 20:05:10" IndexType="1" ServerBuild="2019-11-20 15:08:33" ServerName="KNUTSCHR" ServerVersion="1.0.7263.27256" UniqueIndexID="20191119200510-FRESH"/>
  <DataTables Count="1">
    <DataTable Name="Domains" RowsCount="3" Headers="Domain|Title|TrustFlow|CitationFlow|Instances|UniqueContexts|PrimaryTopicName|PrimaryTopicValue" AvailableLines="100" Count="3" From="0" Item="originalpattymen.com" ItemType="RootDomain" OrigItem="originalpattymen.com" TotalLines="103">
      <Row>digbethdiningclub.com|Digbeth Dining Club || Where the Midlands come to eat.|14|25|5|4|Sports/Equestrian|13</Row>
      <Row>buddhabellystreetfood.co.uk|Thai Street Food || Weddings || Markets || Birmingham || Manchester|7|14|4|4|Recreation/Travel|6</Row>
      <Row>kilderbar.co.uk|KILDER - CRAFT BEER BAR BIRMINGHAM|2|6|5|3|Reference/Education|2</Row>
    </DataTable>
  </DataTables>
</Result>

JSON response

{
  "Code": "OK",
  "ErrorMessage": "",
  "FullError": "",
  "IndexBuildDate": "2019-11-19 20:05:10",
  "IndexType": 1,
  "ServerBuild": "2019-11-20 15:08:33",
  "ServerName": "KNUTSCHR",
  "ServerVersion": "1.0.7263.27256",
  "UniqueIndexID": "20191119200510-FRESH",
  "DataTables": {
    "Domains": {
      "Headers": {
        "AvailableLines": 100,
        "Count": 3,
        "From": 0,
        "Item": "originalpattymen.com",
        "ItemType": "RootDomain",
        "OrigItem": "originalpattymen.com",
        "TotalLines": 103
      },
      "Data": [
        {
          "Domain": "digbethdiningclub.com",
          "Title": "Digbeth Dining Club | Where the Midlands come to eat.",
          "TrustFlow": "14",
          "CitationFlow": "25",
          "Instances": 5,
          "UniqueContexts": 4,
          "PrimaryTopicName": "Sports/Equestrian",
          "PrimaryTopicValue": "13"
        },
        {
          "Domain": "buddhabellystreetfood.co.uk",
          "Title": "Thai Street Food | Weddings | Markets | Birmingham | Manchester",
          "TrustFlow": "7",
          "CitationFlow": "14",
          "Instances": 4,
          "UniqueContexts": 4,
          "PrimaryTopicName": "Recreation/Travel",
          "PrimaryTopicValue": "6"
        },
        {
          "Domain": "kilderbar.co.uk",
          "Title": "KILDER - CRAFT BEER BAR BIRMINGHAM",
          "TrustFlow": "2",
          "CitationFlow": "6",
          "Instances": 5,
          "UniqueContexts": 3,
          "PrimaryTopicName": "Reference/Education",
          "PrimaryTopicValue": "2"
        }
      ]
    }
  }
}

Returned values

Returned value Description
Global variables
Code Code indicating whether this command succeeded.
ErrorMessage A message explaining the error. This will be blank if the code is "OK".
FullError Verbose explanation of error.
IndexBuildDate Date/time the index that was queried was last updated.
IndexType Boolean indicating if the index queried was Historical (0) or Fresh (1).
ServerBuild Date/time of the server build when this command was executed.
ServerName Name of the server queried when this command was executed.
ServerVersion Version of the server queried.
UniqueIndexID Unique identifier for the index queried when this command was executed.
Domains Headers
AvailableLines Internal metric.
Count Number of items returned by this command.
From The first result which this command returns.
Item Item this command was called on.
ItemType Type of item this command was called on. This can be a URL, subdomain or domain.
OrigItem Item as passed to this command.
TotalLines Internal metric.
Data
Domain The related site domain
Title Title of the homepage of the domain.
TrustFlow Trust Flow value for this item.
CitationFlow Citation Flow value for this item.
Instances Number of times this domain appears nearby a backlink to the queried item. Calculated from the "top backlinks" available from your subscription.
UniqueContexts Number of times this domain appears nearby a backlink to the queried item, within a unique context. Calculated from the "top backlinks" available from your subscription.
PrimaryTopicName Highest Topical Trust Flow category of the domain.
PrimaryTopicValue Highest Topical Trust Flow value of the domain.