Skip to content

Files

Latest commit

github-actions[bot]github-actions[bot]
Update client to version 1.76.0 [skip ci]
Mar 20, 2025
ca4efd3 · Mar 20, 2025

History

History
283 lines (201 loc) · 9.13 KB

LongTailsApi.md

File metadata and controls

283 lines (201 loc) · 9.13 KB

wordlift_client.LongTailsApi

All URIs are relative to http://localhost

Method HTTP request Description
get2 GET /longtail Get entities
get3 GET /longtail/hook Get entities by rank (async)
get_v2 GET /longtail/v2 Get entities by rank

get2

LongtailResponse get2(q, ln, lc, sd, sc=sc, d=d)

Get entities

Query for long tail opportunities and receive entities.

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.longtail_response import LongtailResponse
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.LongTailsApi(api_client)
    q = 'q_example' # str | The Longtail query
    ln = 'London,England,United Kingdom' # str | A location name, origin of the search
    lc = 'en' # str | Language Code
    sd = 'google.co.uk, google.com.au, google.de, etc.' # str | Search Domain
    sc = 'sc_example' # str | Analysis Scope (optional)
    d = '10' # str | The maximum number of results to analyze (optional) (default to '10')

    try:
        # Get entities
        api_response = await api_instance.get2(q, ln, lc, sd, sc=sc, d=d)
        print("The response of LongTailsApi->get2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LongTailsApi->get2: %s\n" % e)

Parameters

Name Type Description Notes
q str The Longtail query
ln str A location name, origin of the search
lc str Language Code
sd str Search Domain
sc str Analysis Scope [optional]
d str The maximum number of results to analyze [optional] [default to '10']

Return type

LongtailResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 Found. -
401 Authentication Failure -
500 Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get3

get3(q, ln, lc, sd, hk, sc=sc, d=d)

Get entities by rank (async)

Query for long tail opportunities and receive entities along with their position in SERP.

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.LongTailsApi(api_client)
    q = 'q_example' # str | The Longtail query
    ln = 'London,England,United Kingdom' # str | A location name, origin of the search
    lc = 'en' # str | Language Code
    sd = 'google.co.uk, google.com.au, google.de, etc.' # str | Search Domain
    hk = 'hk_example' # str | Webhook URL
    sc = 'sc_example' # str | Analysis Scope (optional)
    d = '10' # str | The maximum number of results to analyze (optional) (default to '10')

    try:
        # Get entities by rank (async)
        await api_instance.get3(q, ln, lc, sd, hk, sc=sc, d=d)
    except Exception as e:
        print("Exception when calling LongTailsApi->get3: %s\n" % e)

Parameters

Name Type Description Notes
q str The Longtail query
ln str A location name, origin of the search
lc str Language Code
sd str Search Domain
hk str Webhook URL
sc str Analysis Scope [optional]
d str The maximum number of results to analyze [optional] [default to '10']

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Found. -
401 Authentication Failure -
500 Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_v2

List[RankEntities] get_v2(q, ln, lc, sd, sc=sc, d=d)

Get entities by rank

Query for long tail opportunities and receive entities along with their position in SERP.

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.rank_entities import RankEntities
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.LongTailsApi(api_client)
    q = 'q_example' # str | The Longtail query
    ln = 'London,England,United Kingdom' # str | A location name, origin of the search
    lc = 'en' # str | Language Code
    sd = 'google.co.uk, google.com.au, google.de, etc.' # str | Search Domain
    sc = 'sc_example' # str | Analysis Scope (optional)
    d = '10' # str | The maximum number of results to analyze (optional) (default to '10')

    try:
        # Get entities by rank
        api_response = await api_instance.get_v2(q, ln, lc, sd, sc=sc, d=d)
        print("The response of LongTailsApi->get_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LongTailsApi->get_v2: %s\n" % e)

Parameters

Name Type Description Notes
q str The Longtail query
ln str A location name, origin of the search
lc str Language Code
sd str Search Domain
sc str Analysis Scope [optional]
d str The maximum number of results to analyze [optional] [default to '10']

Return type

List[RankEntities]

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 Found. -
401 Authentication Failure -
500 Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]