Skip to content

backlinks_api.md

Latest commit

 

History

History
1559 lines (1097 loc) · 48.4 KB

backlinks_api.md

File metadata and controls

1559 lines (1097 loc) · 48.4 KB
Raw

BacklinksApi

All URIs are relative to https://api.dataforseo.com

Method HTTP request Description
backlinksIdList POST /v3/backlinks/id_list
backlinksErrors POST /v3/backlinks/errors
backlinksAvailableFilters GET /v3/backlinks/available_filters
index GET /v3/backlinks/index
summaryLive POST /v3/backlinks/summary/live
historyLive POST /v3/backlinks/history/live
backlinksLive POST /v3/backlinks/backlinks/live
anchorsLive POST /v3/backlinks/anchors/live
domainPagesLive POST /v3/backlinks/domain_pages/live
domainPagesSummaryLive POST /v3/backlinks/domain_pages_summary/live
referringDomainsLive POST /v3/backlinks/referring_domains/live
referringNetworksLive POST /v3/backlinks/referring_networks/live
competitorsLive POST /v3/backlinks/competitors/live
domainIntersectionLive POST /v3/backlinks/domain_intersection/live
pageIntersectionLive POST /v3/backlinks/page_intersection/live
timeseriesSummaryLive POST /v3/backlinks/timeseries_summary/live
timeseriesNewLostSummaryLive POST /v3/backlinks/timeseries_new_lost_summary/live
bulkRanksLive POST /v3/backlinks/bulk_ranks/live
bulkBacklinksLive POST /v3/backlinks/bulk_backlinks/live
bulkSpamScoreLive POST /v3/backlinks/bulk_spam_score/live
bulkReferringDomainsLive POST /v3/backlinks/bulk_referring_domains/live
bulkNewLostBacklinksLive POST /v3/backlinks/bulk_new_lost_backlinks/live
bulkNewLostReferringDomainsLive POST /v3/backlinks/bulk_new_lost_referring_domains/live
bulkPagesSummaryLive POST /v3/backlinks/bulk_pages_summary/live

backlinksIdList

BacklinksIdListResponseInfo backlinksIdList()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_id_list_request_info import List[Optional[BacklinksIdListRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.backlinks_id_list([BacklinksIdListRequestInfo(
                limit=10,
                include_metadata=True,
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksIdListRequestInfo]]>**](List[Optional[BacklinksIdListRequestInfo]].md)|  | [optional] |

Return type

BacklinksIdListResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

backlinksErrors

BacklinksErrorsResponseInfo backlinksErrors()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_errors_request_info import List[Optional[BacklinksErrorsRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.backlinks_errors([BacklinksErrorsRequestInfo(
                limit=10,
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksErrorsRequestInfo]]>**](List[Optional[BacklinksErrorsRequestInfo]].md)|  | [optional] |

Return type

BacklinksErrorsResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

backlinksAvailableFilters

BacklinksAvailableFiltersResponseInfo backlinksAvailableFilters()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.backlinks_available_filters()
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

    This endpoint does not need any parameter.

Return type

BacklinksAvailableFiltersResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

index

BacklinksIndexResponseInfo index()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.index()
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

    This endpoint does not need any parameter.

Return type

BacklinksIndexResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

summaryLive

BacklinksSummaryLiveResponseInfo summaryLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_summary_live_request_info import List[Optional[BacklinksSummaryLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.summary_live([BacklinksSummaryLiveRequestInfo(
                target="explodingtopics.com",
                internal_list_limit=10,
                include_subdomains=True,
                backlinks_filters=[
                    "dofollow",
                    "=",
                    True,
                    ],
                backlinks_status_type="all",
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksSummaryLiveRequestInfo]]>**](List[Optional[BacklinksSummaryLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksSummaryLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

historyLive

BacklinksHistoryLiveResponseInfo historyLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_history_live_request_info import List[Optional[BacklinksHistoryLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.history_live([BacklinksHistoryLiveRequestInfo(
                target="cnn.com",
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksHistoryLiveRequestInfo]]>**](List[Optional[BacklinksHistoryLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksHistoryLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

backlinksLive

BacklinksBacklinksLiveResponseInfo backlinksLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_backlinks_live_request_info import List[Optional[BacklinksBacklinksLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.backlinks_live([BacklinksBacklinksLiveRequestInfo(
                target="forbes.com",
                mode="as_is",
                filters=[
                    "dofollow",
                    "=",
                    True,
                    ],
                limit=5,
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksBacklinksLiveRequestInfo]]>**](List[Optional[BacklinksBacklinksLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksBacklinksLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

anchorsLive

BacklinksAnchorsLiveResponseInfo anchorsLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_anchors_live_request_info import List[Optional[BacklinksAnchorsLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.anchors_live([BacklinksAnchorsLiveRequestInfo(
                target="forbes.com",
                limit=4,
                order_by=[
                    "backlinks,desc",
                    ],
                filters=[
                    "anchor",
                    "like",
                    "%news%",
                    ],
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksAnchorsLiveRequestInfo]]>**](List[Optional[BacklinksAnchorsLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksAnchorsLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

domainPagesLive

BacklinksDomainPagesLiveResponseInfo domainPagesLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_domain_pages_live_request_info import List[Optional[BacklinksDomainPagesLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.domain_pages_live([BacklinksDomainPagesLiveRequestInfo(
                target="forbes.com",
                limit=5,
                filters=[
                    ,
                    "and",
                    ,
                    ],
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksDomainPagesLiveRequestInfo]]>**](List[Optional[BacklinksDomainPagesLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksDomainPagesLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

domainPagesSummaryLive

BacklinksDomainPagesSummaryLiveResponseInfo domainPagesSummaryLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_domain_pages_summary_live_request_info import List[Optional[BacklinksDomainPagesSummaryLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.domain_pages_summary_live([BacklinksDomainPagesSummaryLiveRequestInfo(
                target="forbes.com",
                limit=4,
                order_by=[
                    "backlinks,desc",
                    ],
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksDomainPagesSummaryLiveRequestInfo]]>**](List[Optional[BacklinksDomainPagesSummaryLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksDomainPagesSummaryLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

referringDomainsLive

BacklinksReferringDomainsLiveResponseInfo referringDomainsLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_referring_domains_live_request_info import List[Optional[BacklinksReferringDomainsLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.referring_domains_live([BacklinksReferringDomainsLiveRequestInfo(
                target="backlinko.com",
                limit=5,
                order_by=[
                    "rank,desc",
                    ],
                exclude_internal_backlinks=True,
                backlinks_filters=[
                    "dofollow",
                    "=",
                    True,
                    ],
                filters=[
                    "backlinks",
                    ">",
                    100,
                    ],
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksReferringDomainsLiveRequestInfo]]>**](List[Optional[BacklinksReferringDomainsLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksReferringDomainsLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

referringNetworksLive

BacklinksReferringNetworksLiveResponseInfo referringNetworksLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_referring_networks_live_request_info import List[Optional[BacklinksReferringNetworksLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.referring_networks_live([BacklinksReferringNetworksLiveRequestInfo(
                target="backlinko.com",
                network_address_type="subnet",
                limit=5,
                order_by=[
                    "rank,desc",
                    ],
                exclude_internal_backlinks=True,
                backlinks_filters=[
                    "dofollow",
                    "=",
                    True,
                    ],
                filters=[
                    "backlinks",
                    ">",
                    100,
                    ],
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksReferringNetworksLiveRequestInfo]]>**](List[Optional[BacklinksReferringNetworksLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksReferringNetworksLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

competitorsLive

BacklinksCompetitorsLiveResponseInfo competitorsLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_competitors_live_request_info import List[Optional[BacklinksCompetitorsLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.competitors_live([BacklinksCompetitorsLiveRequestInfo(
                target="dataforseo.com",
                filters=[
                    "rank",
                    ">",
                    100,
                    ],
                order_by=[
                    "rank,desc",
                    ],
                limit=5,
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksCompetitorsLiveRequestInfo]]>**](List[Optional[BacklinksCompetitorsLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksCompetitorsLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

domainIntersectionLive

BacklinksDomainIntersectionLiveResponseInfo domainIntersectionLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_domain_intersection_live_request_info import List[Optional[BacklinksDomainIntersectionLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.domain_intersection_live([BacklinksDomainIntersectionLiveRequestInfo(
                targets={
                    },
                include_subdomains=False,
                exclude_targets=[
                    "semrush.com",
                    ],
                limit=5,
                order_by=[
                    "1.backlinks,desc",
                    ],
                exclude_internal_backlinks=True,
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksDomainIntersectionLiveRequestInfo]]>**](List[Optional[BacklinksDomainIntersectionLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksDomainIntersectionLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

pageIntersectionLive

BacklinksPageIntersectionLiveResponseInfo pageIntersectionLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_page_intersection_live_request_info import List[Optional[BacklinksPageIntersectionLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.page_intersection_live([BacklinksPageIntersectionLiveRequestInfo(
                targets={
                    },
                exclude_targets=[
                    "skysports.com",
                    ],
                limit=5,
                order_by=[
                    "1.rank,desc",
                    ],
                filters=[
                    ,
                    "and",
                    ,
                    ],
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksPageIntersectionLiveRequestInfo]]>**](List[Optional[BacklinksPageIntersectionLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksPageIntersectionLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

timeseriesSummaryLive

BacklinksTimeseriesSummaryLiveResponseInfo timeseriesSummaryLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_timeseries_summary_live_request_info import List[Optional[BacklinksTimeseriesSummaryLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.timeseries_summary_live([BacklinksTimeseriesSummaryLiveRequestInfo(
                target="dataforseo.com",
                group_range="month",
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksTimeseriesSummaryLiveRequestInfo]]>**](List[Optional[BacklinksTimeseriesSummaryLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksTimeseriesSummaryLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

timeseriesNewLostSummaryLive

BacklinksTimeseriesNewLostSummaryLiveResponseInfo timeseriesNewLostSummaryLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_timeseries_new_lost_summary_live_request_info import List[Optional[BacklinksTimeseriesNewLostSummaryLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.timeseries_new_lost_summary_live([BacklinksTimeseriesNewLostSummaryLiveRequestInfo(
                target="dataforseo.com",
                group_range="month",
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksTimeseriesNewLostSummaryLiveRequestInfo]]>**](List[Optional[BacklinksTimeseriesNewLostSummaryLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksTimeseriesNewLostSummaryLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

bulkRanksLive

BacklinksBulkRanksLiveResponseInfo bulkRanksLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_bulk_ranks_live_request_info import List[Optional[BacklinksBulkRanksLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.bulk_ranks_live([BacklinksBulkRanksLiveRequestInfo(
                targets=[
                    "forbes.com",
                    "cnn.com",
                    "bbc.com",
                    "yelp.com",
                    "https://www.apple.com/iphone/",
                    "https://ahrefs.com/blog/",
                    "ibm.com",
                    "https://variety.com/",
                    "https://stackoverflow.com/",
                    "www.trustpilot.com",
                    ],
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksBulkRanksLiveRequestInfo]]>**](List[Optional[BacklinksBulkRanksLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksBulkRanksLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

bulkBacklinksLive

BacklinksBulkBacklinksLiveResponseInfo bulkBacklinksLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_bulk_backlinks_live_request_info import List[Optional[BacklinksBulkBacklinksLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.bulk_backlinks_live([BacklinksBulkBacklinksLiveRequestInfo(
                targets=[
                    "forbes.com",
                    "cnn.com",
                    "bbc.com",
                    "yelp.com",
                    "https://www.apple.com/iphone/",
                    "https://ahrefs.com/blog/",
                    "ibm.com",
                    "https://variety.com/",
                    "https://stackoverflow.com/",
                    "www.trustpilot.com",
                    ],
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksBulkBacklinksLiveRequestInfo]]>**](List[Optional[BacklinksBulkBacklinksLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksBulkBacklinksLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

bulkSpamScoreLive

BacklinksBulkSpamScoreLiveResponseInfo bulkSpamScoreLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_bulk_spam_score_live_request_info import List[Optional[BacklinksBulkSpamScoreLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.bulk_spam_score_live([BacklinksBulkSpamScoreLiveRequestInfo(
                targets=[
                    "forbes.com",
                    "cnn.com",
                    "bbc.com",
                    "yelp.com",
                    "https://www.apple.com/iphone/",
                    "https://ahrefs.com/blog/",
                    "ibm.com",
                    "https://variety.com/",
                    "https://stackoverflow.com/",
                    "www.trustpilot.com",
                    ],
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksBulkSpamScoreLiveRequestInfo]]>**](List[Optional[BacklinksBulkSpamScoreLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksBulkSpamScoreLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

bulkReferringDomainsLive

BacklinksBulkReferringDomainsLiveResponseInfo bulkReferringDomainsLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_bulk_referring_domains_live_request_info import List[Optional[BacklinksBulkReferringDomainsLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.bulk_referring_domains_live([BacklinksBulkReferringDomainsLiveRequestInfo(
                targets=[
                    "forbes.com",
                    "cnn.com",
                    "bbc.com",
                    "yelp.com",
                    "https://www.apple.com/iphone/",
                    "https://ahrefs.com/blog/",
                    "ibm.com",
                    "https://variety.com/",
                    "https://stackoverflow.com/",
                    "www.trustpilot.com",
                    ],
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksBulkReferringDomainsLiveRequestInfo]]>**](List[Optional[BacklinksBulkReferringDomainsLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksBulkReferringDomainsLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

bulkNewLostBacklinksLive

BacklinksBulkNewLostBacklinksLiveResponseInfo bulkNewLostBacklinksLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_bulk_new_lost_backlinks_live_request_info import List[Optional[BacklinksBulkNewLostBacklinksLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.bulk_new_lost_backlinks_live([BacklinksBulkNewLostBacklinksLiveRequestInfo(
                targets=[
                    "forbes.com",
                    "cnn.com",
                    "bbc.com",
                    "yelp.com",
                    "https://www.apple.com/iphone/",
                    "https://ahrefs.com/blog/",
                    "ibm.com",
                    "https://variety.com/",
                    "https://stackoverflow.com/",
                    "www.trustpilot.com",
                    ],
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksBulkNewLostBacklinksLiveRequestInfo]]>**](List[Optional[BacklinksBulkNewLostBacklinksLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksBulkNewLostBacklinksLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

bulkNewLostReferringDomainsLive

BacklinksBulkNewLostReferringDomainsLiveResponseInfo bulkNewLostReferringDomainsLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_bulk_new_lost_referring_domains_live_request_info import List[Optional[BacklinksBulkNewLostReferringDomainsLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.bulk_new_lost_referring_domains_live([BacklinksBulkNewLostReferringDomainsLiveRequestInfo(
                targets=[
                    "forbes.com",
                    "cnn.com",
                    "bbc.com",
                    "yelp.com",
                    "https://www.apple.com/iphone/",
                    "https://ahrefs.com/blog/",
                    "ibm.com",
                    "https://variety.com/",
                    "https://stackoverflow.com/",
                    "www.trustpilot.com",
                    ],
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksBulkNewLostReferringDomainsLiveRequestInfo]]>**](List[Optional[BacklinksBulkNewLostReferringDomainsLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksBulkNewLostReferringDomainsLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

bulkPagesSummaryLive

BacklinksBulkPagesSummaryLiveResponseInfo bulkPagesSummaryLive()

Example

from dataforseo_client import configuration as dfs_config, api_client as dfs_api_provider
from dataforseo_client.api.backlinks_api import BacklinksApi
from dataforseo_client.rest import ApiException
from dataforseo_client.models.list_optional_backlinks_bulk_pages_summary_live_request_info import List[Optional[BacklinksBulkPagesSummaryLiveRequestInfo]]

from pprint import pprint
try:
    # Configure HTTP basic authorization: basicAuth
    configuration = dfs_config.Configuration(username='USERNAME',password='PASSWORD')



    with dfs_api_provider.ApiClient(configuration) as api_client:
        # Create an instance of the API class
        backlinks_api = BacklinksApi(api_client)

        response = backlinks_api.bulk_pages_summary_live([BacklinksBulkPagesSummaryLiveRequestInfo(
                targets=[
                    "https://dataforseo.com/solutions",
                    "https://dataforseo.com/about-us",
                    ],
        )]
        )
except ApiException as e:
    print("Exception: %s\n" % e)

Parameters

| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **** | [**List<List[Optional[BacklinksBulkPagesSummaryLiveRequestInfo]]>**](List[Optional[BacklinksBulkPagesSummaryLiveRequestInfo]].md)|  | [optional] |

Return type

BacklinksBulkPagesSummaryLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -