SEORule.getResultsForObject (Method)

Returns a query with zero or more rows describing the rules and their associated scores for the specified object.

Returns:

SEORule_GetResultsForObject_Results (query)

Each row of the returned query results has the following fields:

Field Name Type Description
AppliesTo SEOAppliesTo The type of data on which this rule applies to.
Fields PlainText Comma delimited list of field names.
Keyword PlainText_255 The SEO keyword.
MaxDeficientScore Integer_0_to_10 An integer between 0 and 10 that defines the maximum score considered to be deficient.
RuleID SEORuleID The unique ID of the SEO Rule.
RuleTitle PlainText_NonNull_100 The title of the rule.
Score SEOScore The score based on the rule.
Suggestion PlainText_255 The suggestion to improve the score.
Type SEORuleType The type of SEO Rule which can be 'Keyword' or 'Generic'.
Weight PositiveInteger An integer specifying the weighting factor multiplier for the rule.

Arguments:

Name Type Required Description
objectID RealPageID_UploadedDocID_NonBaseTemplate Required The unique ID of the Page or Uploaded couemnt for which to retrieve the grades.
seoKeyword SEOKeyword Required The SEO keyword to get the results for.
appliesToFilter SEOAppliesToFilter Optional. Defaults to 'All'. A comma delimited list of one or more SEOAppliesTo values ('StandardMetadata', 'URL' or 'Content') to filters the results by or 'All' for no filter.
versionState PublishedWIP Optional. Defaults to 'Published'. The version state of the page i.e. 'Publised' or 'WIP'.

Context:

License Requirements SEO
Permission Requirements ContributorOrServerCode
Deny Context None
Require Context Authoring
Author Lock  

Error Codes:

None

Notes:

None