XOVI

XOVI

This connector reads the XOVI Suite API (developers.xovi.net), the German SEO toolbox: API credit balance, the weekly domain analysis (visibility index OVI, ranking keywords, ranking value, keyword history and search results) and the daily keyword monitoring of your projects. It is read-only and calls https://suite.xovi.net/api directly.

Setup

1. The API needs a XOVI Pro, Business or Enterprise account.
2. In the XOVI Suite open Account > API Dashboard, create your personal API key and paste it into XOVI_API_KEY. It is sent as the key parameter on every call.
3. Install and run xovi_get_credit_state, which costs no credits, to check the key.

Credits: most calls are paid from the account's API credit budget (per call or per block of rows, see each function in the XOVI reference); calls that only read your own account data are free. Check the balance with xovi_get_credit_state and xovi_get_limits before large exports, keep limit small, and do not loop over many domains without the user's go-ahead. Monitoring keyword slots are counted separately: xovi_get_monitoring_keyword_limits.

Workflow

• Domain analysis (weekly crawl): pick the search engine host with xovi_list_search_engines (default weekly, e.g. google.de), then xovi_get_ovi_trend for visibility over time, xovi_list_ranking_keywords for what a domain ranks for, xovi_get_ranking_value, xovi_get_ranking_trend, xovi_get_keyword_trend for one keyword, xovi_get_keyword_serp for the results page of a keyword. urlpattern takes a host (www.example.com), all subdomains (example.com/*) or a directory (www.example.com/blog/*). Data of a week is published on Sunday; date is that Sunday.
• Monitoring (daily crawl): xovi_list_projects (project hash), xovi_list_labels, xovi_list_search_engines with interval daily (numeric sengineid), then xovi_list_monitoring_domains, xovi_list_monitoring_keywords, xovi_get_monitoring_keyword_trend, xovi_get_monitoring_serp and xovi_get_monitoring_ovi_trend.

Paging: limit is at most 1000 rows; skip counts pages of limit rows (skip 1 with limit 100 returns rows 101 to 200). Results carry resultCount for the unfiltered total.

Errors: XOVI answers HTTP 200 with apiErrorCode and apiErrorMessage; this connector turns them into errors. param invalid on key means a wrong or deleted API key; no permission means the key or plan may not use that function; cost error means the credit budget is used up until the next refill; param missing or param invalid on another field names the field to fix. result empty is a successful call without data (e.g. a domain without rankings).