SEORule.getList (Method)

Retrieves information regarding the specified SEO rule, or all SEO rules.

Returns:

SEORule_GetList_Result (query)

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

Field Name Type Description
AppliesTo SEOAppliesToList The type of data that the SEO rule applies to.
Description PlainText_2000 The description of the rule.
IsActive Boolean A boolean flag which when set to true indicates that the rule definition is active.
MaxDeficientScore Integer_0_to_10 An integer between 0 and 10 that defines the maximum score considered to be deficient.
RuleDefinitionID SEORuleDefinitionID The unique ID of the rule definition from which this rule is built.
RuleDefinitionName PlainText_NonNull_100 The name of the rule definition from which this rule is built.
RuleID SEORuleID The unique id of this rule.
RuleTitle PlainText_NonNull_100 The title of this rule.
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
reportingGroupID SEOReportingGroupID Required The unique ID of the SEO reporting group to return results for.
ruleID SEORuleID_0 Required The unique identifier of the desired SEO rule to retrieve, or 0 to retrieve all rows.

Context:

License Requirements SEO
Permission Requirements ContributorOrServerCode
Deny Context None
Require Context (none)
Author Lock  

Error Codes:

None

Notes:

None