SEOKeywords.getScorecardResults (Method)
Returns one row for each SEO keyword describing the keywords scorecard score for the specified month, relative to the previous month.
Returns:
SEOKeywords_GetScorecardResults_Results (query)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
Company | PlainText_NonNull_255 | The company name of the competitor. |
EstimatedImpressionsEnd | NonNegativeInteger | The estimated number of impressions this keyword received at the end of the specified time period. |
EstimatedImpressionsStart | NonNegativeInteger | The estimated number of impressions this keyword received at the start of the specified time period. |
Keyword | Any | The SEO keyword. |
PrevTopRank | NonNegativeInteger_EmptyString | The top ranking for the keyword for the previous time period. An empty string if no data exists. |
PrevTopScore | NonNegativeInteger_EmptyString | The scorecard score for the keyword for the previous time period. An empty string if no data exists. |
QueryDate | PastTimestamp_EmptyString | The latest timestamp the keyword was queried during the specified time period, or an empty string if the keyword was not queried in teh specified time frame. |
RankCount | NonNegativeInteger | The count of items ranked. |
TopRank | NonNegativeInteger_EmptyString | The top ranking for the keyword. An empty string if no data exists. |
TopRankChange | Integer_EmptyString | The change in ranking between the specified time periods. An empty string if no data exists. |
TopScore | NonNegativeInteger_EmptyString | The top scorecard score for the keyword. An empty string if no data exists. |
TopScoreChange | Integer_EmptyString | The change in score between the specified time periods. An empty string if no data exists. |
UsageCount | NonNegativeInteger | The count of pages/documents that target this SEO keyword. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
reportingGroupID | SEOReportingGroupID | Required | The unique ID of the SEO reporting group. |
searchEngineID | SearchEngineID | Required | The unique ID of the search engine to return results for. |
searchString | PlainText_255 | Optional. Defaults to an empty string. | An optional string to filter keywords by. |
showFilter | SEOKeywordShowFilter | Optional. Defaults to 'Just our stats'. | A valid SEOKeywordShowFilter enumeration value. Just our stats = Just our stats, no competitor stats; Top Competitor = Our stats plus the one top competitor's stats; All competitors = Ours stats and all competitor stats. |
grouping | SEOKeywordGrouping | Optional. Defaults to 'Our stats'. | A valid SEOKeywordGrouping enumeration value, which controls how the results are grouped. None = no grouping; Our Stats = Group by keyword and order by our stats; Any stats = Group by keyword and order by highest value stat. |
sortBy | SEOKeywordScorecardSortBy | Optional. Defaults to 'Keyword'. | The field to sort by, eg: 'TopRank', 'Keyword', 'Company', etc. |
sortDirection | SortDirection | Optional. Defaults to 'ASC'. | The direction to sort the results. Either ASC or DESC. |
startDate | PastDate | Optional. Defaults to '#DateFormat( DateAdd('d',-30,now()), 'yyyy-mm-dd' )#'. | The starting date for the time period. Defaults to 30 days prior to the current date. |
endDate | Date | Optional. Defaults to '#DateFormat( now(), 'yyyy-mm-dd' )#'. | The ending time period date. Defaults to the current date. |
Context:
License Requirements | SEO |
Permission Requirements | SEOReportingGroup:ViewReports |
Deny Context | (none) |
Require Context | Authoring |
Author Lock |
Error Codes:
None
Notes:
None