Content

Content Topic Cluster

Get topics that are related to an input topic. This can be useful for creating topic rollups, and provide initial suggestions as to which topics might best comprise a rollup.

The options for direction, penalty and threshold are currently adjustable. As we determine which values produce the most useful clusters, we can set better defaults for them.

get/api/content/topic/cluster/{topicId}

Request

  • Base URL
    https://api.lytics.io
  • URL
    https://api.lytics.io/api/content/topic/cluster/{topicId}
  • Auth
    API key in header Authorization

Path parameters

topicIdstring required

public topic label in the taxonomy

Query parameters

account_idstring

Your Lytics account ID.

directionstring

direction to follow topic dependencies, either "in" or "out"

penaltystring

penalty to apply as traversal depth increases, where a lower value introduces a higher penalty

thresholdstring

threshold at which neighbor topics are determined, where a lower value introduces a more lenient rule

Response

OK

messagestring
statusnumber

Example response

{
  "data": {
    "clusters": [
      [
        "Baking",
        "Cakes",
        "Cupakes",
        "Cookies"
      ],
      [
        "Grilling",
        "Beef",
        "Chicken",
        "Steak"
      ]
    ],
    "coverage": 0.2062
  },
  "message": "success",
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.