Content usage heatmap - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service responds with a heatmap of content usage during a selected period. The heatmap is categorized by metadata.

Method Endpoint
POST 
/analytics/api/v2/khub/views-heatmap

Request example

The following lines show an example of a JSON request body:

{
  "startDate": "2024-01-01",
  "endDate": "2024-05-01",
  "levels": [
    {
      "metadataKey": "Category",
      "metadataValues": ["How To", "Reference Guides"]
    },
    {
      "metadataKey": "Audience",
      "metadataValues": []
    }
  ]
}
Field Type Required? Description
startDate String Yes The inclusive start date of the period. The start date is mandatory. It must be within the past year.
endDate String Yes The exclusive end date of the period. The end date is mandatory and must be later than the start date.
levels Array Yes A mandatory parameter describing the metadata keys and values to filter with. The first set of metadata is the first level, the second set is the second level, and so on.
It is only possible to select a metadata key which is in the Document metadata menu.
    metadataKey String Yes A unique name to identify the facet. It is necessary to define at least one metadata key. This field is case sensitive.
    metadataValues Array Yes An optional parameter defining the targeted values among all those that exist for the key. When empty, all values apply. This field is case sensitive.

Response body

The following lines show an example of a JSON response body:

{
    "startDate": "2024-01-01",
    "endDate": "2024-05-01",
    "totalDisplayCount": 20134,
    "results": [
        {
            "metadataKey": "Category",
            "metadataLabel": "Category",
            "metadataValue": "Reference Guides",
            "displayCount": 17233,
            "children": [
                {
                    "metadataKey": "audience",
                    "metadataLabel": "Audience",
                    "metadataValue": "public",
                    "displayCount": 16829,
                    "children": []
                },
                {
                    "metadataKey": "audience",
                    "metadataLabel": "Audience",
                    "metadataValue": "internal",
                    "displayCount": 273,
                    "children": []
                },
                {
                    "metadataKey": "audience",
                    "metadataLabel": "Audience",
                    "metadataValue": "onprem",
                    "displayCount": 111,
                    "children": []
                },
                {
                    "metadataKey": "audience",
                    "metadataLabel": "Audience",
                    "metadataValue": "premium",
                    "displayCount": 20,
                    "children": []
                }
            ]
        },
        {
            "metadataKey": "Category",
            "metadataLabel": "Category",
            "metadataValue": "How To",
            "displayCount": 2901,
            "children": [
                {
                    "metadataKey": "audience",
                    "metadataLabel": "Audience",
                    "metadataValue": "public",
                    "displayCount": 1889,
                    "children": []
                },
                {
                    "metadataKey": "audience",
                    "metadataLabel": "Audience",
                    "metadataValue": "internal",
                    "displayCount": 1010,
                    "children": []
                },
                {
                    "metadataKey": "audience",
                    "metadataLabel": "Audience",
                    "metadataValue": "released",
                    "displayCount": 2,
                    "children": []
                }
            ]
        }
    ]
}
Field Type Description
startDate String The inclusive start date of the period as defined in the input.
endDate String The exclusive end date of the period as defined in the input.
totalDisplayCount Number An integer representing how many times users accessed documents with all the selected metadata.
results Array A section with different levels of nodes.
    metadataKey String A unique name to identify the facet.
    metadataLabel String The facet's localized name.
    metadataValues Array Indicates the targeted values among all those that exist for the key.
    children Array Collections of documents that have the metadata specified for the node.
    displayCount Number The number of times users have accessed the collection of documents with the specified metadata.
Return code Description
200 OK Returns 0 or more results.