Sync Tools

Overview

Sync tools kick off background updates that refresh your stored data. They run in the background — after triggering a sync, use the corresponding stored metrics tool to check results once the job completes. Your plan determines how often syncs run automatically.

sync-keyword-rankings

Refreshes ranking positions for all tracked keywords on a site. Results appear in get-keyword-ranking-history.

Parameters

ParameterTypeRequiredDescription
site_idintegerYesThe site to sync rankings for

sync-keyword-metrics

Refreshes search volume, difficulty, and CPC data for all tracked keywords. Results appear in get-keyword-metrics.

Parameters

ParameterTypeRequiredDescription
site_idintegerYesThe site to refresh metrics for

sync-site-audit

Starts a full site crawl audit. Results appear in get-site-audit-history and get-site-audit-pages.

Parameters

ParameterTypeRequiredDescription
site_idintegerYesThe site to audit

Refreshes the stored backlink snapshot. Results appear in get-backlink-history.

ParameterTypeRequiredDescription
site_idintegerYesThe site to sync backlinks for

sync-competitors

Refreshes competitor data. Results appear in get-competitor-history.

Parameters

ParameterTypeRequiredDescription
site_idintegerYesThe site to sync competitors for

sync-llm-mentions

Refreshes AI/LLM mention data for tracked keywords. Results appear in get-llm-mention-history.

Parameters

ParameterTypeRequiredDescription
site_idintegerYesThe site to sync LLM mentions for

sync-domain-overview

Refreshes the domain overview snapshot (organic traffic, keyword counts, domain rank). Results appear in get-domain-overview-history.

Parameters

ParameterTypeRequiredDescription
site_idintegerYesThe site to sync

sync-search-console

Pulls latest data from Google Search Console. Requires Search Console integration. Results appear in get-search-console-data.

Parameters

ParameterTypeRequiredDescription
site_idintegerYesThe site to sync
start_datestringNoStart date (YYYY-MM-DD)
end_datestringNoEnd date (YYYY-MM-DD)

sync-analytics

Pulls latest data from Google Analytics. Requires Analytics integration. Results appear in get-analytics-data.

Parameters

ParameterTypeRequiredDescription
site_idintegerYesThe site to sync
start_datestringNoStart date (YYYY-MM-DD)
end_datestringNoEnd date (YYYY-MM-DD)

sync-business-profile

Pulls latest data from Google Business Profile. Requires GBP integration. Results appear in get-business-profile-data.

Parameters

ParameterTypeRequiredDescription
site_idintegerYesThe site to sync
start_datestringNoStart date (YYYY-MM-DD)
end_datestringNoEnd date (YYYY-MM-DD)

sync-local-maps-ranking

Refreshes Google Maps ranking positions for tracked keywords. Requires a CID in Google Business Profile settings. Results appear in get-local-maps-ranking-history.

Parameters

ParameterTypeRequiredDescription
site_idintegerYesThe site to sync

sync-local-listing-audit

Refreshes the listing completeness audit for a tracked site. Requires a CID in GBP settings. Results appear in get-local-listing-audit-history.

Parameters

ParameterTypeRequiredDescription
site_idintegerYesThe site to sync

Tips

  • Syncs run automatically on your plan's schedule (daily for Pro/Agency, weekly/monthly for Starter). Trigger them manually when you need fresh data immediately.
  • Syncs run in the background — they start a background update. Allow a few minutes for large syncs (site audits can take several minutes depending on site size).
  • Stored metrics tools are free to read — they don't consume credits since the data is already in your database.