SEOKeywords.getRankedObjects (Method)
Returns a list of objects which are ranked for a keyword.
Returns:
SEOKeywords_GetRankedObjects_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| CompetitorID | SEOCompetitorID_0 | The unique id of SEO competitor, or 0. |
| CompetitorName | PlainText_255 | The name of SEO competitor or empty string. |
| FileName | FileName_ValidURL_EmptyString | The filename of the page, or empty string. |
| ID | PageID_0 | The object's ID, or 0. |
| Link | FileName_ValidURL | The page's URL. |
| Rank | NonNegativeInteger | The ranking for the keyword. |
| RankChange | Integer | The number of positions increased or decrease in ranking for the keyword over the specified time period. |
| RankDate | Date | The date when this page was ranked. |
| SubsiteID | SubsiteID_0 | The ID of the subsite or empty string. |
| SubsiteURL | SubsiteURL_EmptyString | The server relative subsite URL, or empty string. |
| Title | PlainText | The internal CommonSpot title of the results page or empty string. |
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 | PlainText_NonNull | Required | The keyword against which pages where ranked. |
| competition | Boolean | Optional. Defaults to '0'. | Boolean flag to indicate if competition will be returned. |
| 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. |
| orderBy | SQLOrderByClause | Optional. Defaults to 'Rank DESC'. | The SQL 'order by' clause, which indicates the order in which results are returned. |
Context:
| License Requirements | SEO |
| Permission Requirements | ContributorOrServerCode |
| Deny Context | (none) |
| Require Context | Authoring |
| Author Lock |
Error Codes:
None
Notes:
None