Skip to content

LinkGroupsApi.md

Latest commit

 

History

History
93 lines (63 loc) · 2.85 KB

LinkGroupsApi.md

File metadata and controls

93 lines (63 loc) · 2.85 KB

wordlift_client.LinkGroupsApi

All URIs are relative to https://api.wordlift.io

Method HTTP request Description
get_link_groups GET /accounts/{id}/link-groups Get

get_link_groups

LinkGroupResponse get_link_groups(id, url, link_group=link_group)

Get

Get Link Groups

Example

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

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

# 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.LinkGroupsApi(api_client)
    id = 56 # int | Graph id
    url = ['url_example'] # List[str] | One or more URLs.
    link_group = ['link_group_example'] # List[str] | Zero or more Link Group identifiers. (optional)

    try:
        # Get
        api_response = await api_instance.get_link_groups(id, url, link_group=link_group)
        print("The response of LinkGroupsApi->get_link_groups:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LinkGroupsApi->get_link_groups: %s\n" % e)

Parameters

Name Type Description Notes
id int Graph id
url List[str] One or more URLs.
link_group List[str] Zero or more Link Group identifiers. [optional]

Return type

LinkGroupResponse

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
401 Authentication Failure -

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