admin_keyword

Provide aggregate keyword usage and overlap data for mod_admin_keyword.

Keywords are resources in the keyword category or one of its descendants. Usage means a resource has an outgoing subject edge to the keyword. The dashboard can restrict both keyword and content category subtrees, and can filter on the resource publication flag.

The overlap data contains three complementary measures:

  • intersection: number of resources using both keywords;
  • jaccard: intersection divided by the union of both keyword resource sets;
  • overlap: intersection divided by the smaller keyword resource set.

The Jaccard percentage is useful for general similarity. Smaller-set overlap is useful for finding a narrow keyword that is nearly contained in a broader one.

The use permission for mod_admin_keyword grants access to aggregate counts over all matching resources. Individual content titles are not returned by this model.

Available Model API Paths

MethodPath patternDescription
get/dashboardReturn the analyzed resource count, usage, overlap matrix, ranked pairs, normalized filters, and truncation metadata. Accepts keyword_category, content_category, publication, minimum, matrix_limit, and metric in the payload.

Edit on GitHub