# Keyword Ranking


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

------------------------------------------------------------------------

<a
href="https://github.com/abdelkareemkobo/seo_rat/blob/main/seo_rat/keyword_ranking.py#L54"
target="_blank" style="float:right; font-size:smaller">source</a>

### get_keyword_rankings

``` python

def get_keyword_rankings(
    session, # Active database session
    site_url:str, # GSC property URL
    keywords:list, # Keywords to look up
    range_type:str='last_7_days', # Date range type
    country:str | None=None, # ISO 3166-1 alpha-3 country code
)->list:

```

*Get aggregated ranking metrics for keywords with period-over-period
position change.*

------------------------------------------------------------------------

<a
href="https://github.com/abdelkareemkobo/seo_rat/blob/main/seo_rat/keyword_ranking.py#L17"
target="_blank" style="float:right; font-size:smaller">source</a>

### get_previous_period

``` python

def get_previous_period(
    start:str, # Start date (YYYY-MM-DD)
    end:str, # End date (YYYY-MM-DD)
)->tuple:

```

*Return the date range immediately preceding the given range with equal
duration.*

------------------------------------------------------------------------

<a
href="https://github.com/abdelkareemkobo/seo_rat/blob/main/seo_rat/keyword_ranking.py#L84"
target="_blank" style="float:right; font-size:smaller">source</a>

### get_keyword_rankings_daily

``` python

def get_keyword_rankings_daily(
    session, # Active database session
    site_url:str, # GSC property URL
    keywords:list, # Keywords to look up
    range_type:str='last_7_days', # Date range type
    days:NoneType=None, months:NoneType=None, country:str | None=None, # ISO 3166-1 alpha-3 country code
)->list:

```

*Fetch daily ranking metrics per keyword for trend charts.*

------------------------------------------------------------------------

<a
href="https://github.com/abdelkareemkobo/seo_rat/blob/main/seo_rat/keyword_ranking.py#L98"
target="_blank" style="float:right; font-size:smaller">source</a>

### plot_keyword_rankings

``` python

def plot_keyword_rankings(
    results:list, # Output of [`get_keyword_rankings_daily`](https://abdelkareemkobo.github.io/seo_rat/keyword_ranking.html#get_keyword_rankings_daily)
)->VConcatChart:

```

*Plot keyword position and clicks over time as a two-panel chart.*
