Analytics

SEO opportunity

One SEO opportunity from the opportunities list, with the brief the SEO page shows: what to do, the page and query it targets, what to change and check, why now, the facts behind it with where each comes from, and any blockers. Pass the same window as the list, if any.

get/sites/{site}/seo-opportunities/{opportunity_id}

Request

  • Base URL: https://api.onelence.com/v1
  • URL: https://api.onelence.com/v1/sites/{site}/seo-opportunities/{opportunity_id}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api.onelence.com/oauth/authorize, token URL https://api.onelence.com/oauth/token, scopes: analytics:read)
    • HTTP bearer

Path parameters

sitestring required

Site domain (e.g. example.com) or site id. Defaults to the workspace's newest active site.

opportunity_idstring required

The opportunity id from the SEO opportunities list.

Query parameters

startstring

Window start: a date (YYYY-MM-DD) or ISO 8601 date-time. Defaults to 30 days before end.

endstring

Window end, inclusive for a date. Defaults to now.

Response

Success.

object'seo_opportunity' required
idstring required
kindstring required
pagestring nullable required
querystring nullable required
topicstring nullable required
lane'grow_proven_pages' | 'recover_visibility' | 'fix_search_leakage' | 'create_new_coverage' | 'needs_evidence' required
search_potential'high' | 'medium' | 'low' | 'missing' required
page_value'high' | 'medium' | 'low' | 'missing' required
confidence'high' | 'medium' | 'low' | 'missing' required
urgency'high' | 'medium' | 'low' | 'missing' required
effortstring nullable required
page_visitorsnumber nullable required
page_conversionsnumber nullable required
titlestring required
whystring nullable required
next_stepstring nullable required
focus_queriesstring[] required
conflictsstring[] required
disposition'ready_to_plan' | 'check_first' | 'explore_only' | 'in_work' | 'excluded' required
primary_reasonstring required
candidate_fingerprintstring required
action_state'opportunity' | 'evaluation' | 'work' | 'none' | 'unavailable' required

Changes

No recorded changes to this operation across all 1 revision of this API.