SEOKeywords.getRankingHistory (Method)
Returns zero or more records describing the specified keyword's ranking at a specific date.
Returns:
SEOKeywords_GetRankingHistory_Results (query)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
Filename | Filename_EmptyString | The filename of an internal page. |
PrevRank | NonNegativeInteger_EmptyString | The previous rank, or an empty string if not ranked. |
PrevRankDate | PastTimestamp_EmptyString | The date of the previous rank, or an empty string if not ranked. |
RankChange | Integer_EmptyString | The change in rank, or an empty string if no previous rank to compare against. |
RankCount | NonNegativeInteger | The count of objects ranked by the search engine. |
RankDate | PastTimestamp | The timestamp of the ranking. |
SiteRank | NonNegativeInteger_EmptyString | The top ranking returned by the search engine, or an empty string if not ranked. |
SubsiteURL | SubsiteURL_EmptyString | The subsite URL of an internal page. |
TopObjectID | NonNegativeInteger | The ID of the top ranked object or 0 if not ranked. |
TopObjectURL | FullyQualifiedURL_EmptyString | The URL of the top ranked object, or an empty string if not ranked. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
reportingGroupID | SEOReportingGroupID | Required | The unique ID of the SEO reporting group to return results for. |
searchEngineID | SearchEngineID | Required | The ID of the search engine to return ranking information for. |
keyword | SEOKeyword | Required | The SEO keyword against which pages where ranked. |
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. |
rankedOnly | Boolean | Optional. Defaults to '0'. | A boolean flag when set to true will only return events that ranked. |
Context:
License Requirements | SEO |
Permission Requirements | ContributorOrServerCode |
Deny Context | (none) |
Require Context | Authoring |
Author Lock | (not required) |
Transaction Logging | Transaction logging is disabled for this method |
Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None