Skip to content

ContentVerificationApi.md

Latest commit

 

History

History
186 lines (130 loc) · 6.49 KB

ContentVerificationApi.md

File metadata and controls

186 lines (130 loc) · 6.49 KB

rankvectors.ContentVerificationApi

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

Method HTTP request Description
get_page_changes GET /api/projects/{projectId}/changes Get page changes
verify_content POST /api/projects/{projectId}/verify-content Verify page content

get_page_changes

GetPageChanges200Response get_page_changes(project_id, status=status, page_id=page_id, limit=limit)

Get page changes

Get change history for pages in a project

Example

  • Api Key Authentication (ApiKeyAuth):
import rankvectors
from rankvectors.models.get_page_changes200_response import GetPageChanges200Response
from rankvectors.rest import ApiException
from pprint import pprint

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

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with rankvectors.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rankvectors.ContentVerificationApi(api_client)
    project_id = 'proj-123' # str | Unique identifier for the project
    status = 'status_example' # str | Filter by change status (optional)
    page_id = 'page_id_example' # str | Filter by page ID (optional)
    limit = 50 # int | Results per page (optional) (default to 50)

    try:
        # Get page changes
        api_response = api_instance.get_page_changes(project_id, status=status, page_id=page_id, limit=limit)
        print("The response of ContentVerificationApi->get_page_changes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentVerificationApi->get_page_changes: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Unique identifier for the project
status str Filter by change status [optional]
page_id str Filter by page ID [optional]
limit int Results per page [optional] [default to 50]

Return type

GetPageChanges200Response

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Page changes -
401 Unauthorized - missing or invalid API key -
403 Forbidden - access denied to resource -
404 Not found - resource doesn't exist -
500 Internal server error -

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

verify_content

VerifyContent200Response verify_content(project_id, verify_content_request)

Verify page content

Check if page content has changed since last crawl

Example

  • Api Key Authentication (ApiKeyAuth):
import rankvectors
from rankvectors.models.verify_content200_response import VerifyContent200Response
from rankvectors.models.verify_content_request import VerifyContentRequest
from rankvectors.rest import ApiException
from pprint import pprint

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

# 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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with rankvectors.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rankvectors.ContentVerificationApi(api_client)
    project_id = 'proj-123' # str | Unique identifier for the project
    verify_content_request = rankvectors.VerifyContentRequest() # VerifyContentRequest | 

    try:
        # Verify page content
        api_response = api_instance.verify_content(project_id, verify_content_request)
        print("The response of ContentVerificationApi->verify_content:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentVerificationApi->verify_content: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Unique identifier for the project
verify_content_request VerifyContentRequest

Return type

VerifyContent200Response

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Content verification result -
400 Bad request - invalid parameters -
401 Unauthorized - missing or invalid API key -
403 Forbidden - access denied to resource -
404 Not found - resource doesn't exist -
500 Internal server error -

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