Document heatmap - Fluid Topics - Latest

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

This web service responds with a document's heatmap during a selected period.

Method Endpoint
POST /analytics/api/v2/documents/{id}/topics/views-heatmap
Path parameter Type Description
{id} String The ID of a structured document.

Heatmaps are not available for unstructured documents.

Request example

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

{
  "startDate": "2024-01-01",
  "endDate": "2024-05-01"
}
Field Type Required? Description
startDate String Yes The inclusive start date of the period. The start date is mandatory and must be in 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.

Response body

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

{
    "startDate": "2024-01-01",
    "endDate": "2024-05-01",
    "documentInformation": {
        "id": "urR3GmtWOfUR0JEdj1EM7g",
        "title": "Add a DITA-OT plugin",
        "type": "STRUCTURED_DOCUMENT",
        "displayCount": 187,
        "link": "https://doc.fluidtopics.com/reader/urR3GmtWOfUR0JEdj1EM7g/root",
        "metadata": [
            {
                "key": "audience",
                "label": "Audience",
                "values": [
                    "public"
                ]
            },
            {
                "key": "Category",
                "label": "Category",
                "values": [
                    "How To"
                ]
            },
            {
                "key": "Version_FT",
                "label": "Version",
                "values": [
                    "Latest"
                ]
            }
        ]
    },
    "results": [
        {
            "id": "eYpjq0pr_HR5nzozkAD5Og",
            "title": "Overview",
            "displayCount": 219,
            "children": []
        },
        {
            "id": "kQbXVmrLokCcENJh6a4SGQ",
            "title": "macOS procedure",
            "displayCount": 249,
            "children": []
        },
        {
            "id": "tl8eRQPtYQFWc9vham_SmA",
            "title": "Windows procedure",
            "displayCount": 145,
            "children": []
        },
        {
            "id": "STickvsazqP_p0msP9I1xw",
            "title": "Reset to default",
            "displayCount": 108,
            "children": []
        },
        {
            "id": "D9icEkXOGr7y9vCaja55bQ",
            "title": "Use case",
            "displayCount": 108,
            "children": [
                {
                    "id": "oS3DIXE_ari5F9A4ckTpag",
                    "title": "PlantUML diagrams plugin",
                    "displayCount": 125,
                    "children": []
                }
            ]
        }
    ]
}
Field Type Description
startDate String The inclusive start date of the period as defined in the request body.
endDate String The exclusive end date of the period as defined in the request body.
    displayCount Number The number of times the document has been accessed.
    id String The ID of the document.
    link String The document's URL in Fluid Topics.
        key String A unique name to identify the facet.
        label String The facet's localized name.
    title String The title of the document.
    type String The type of document, which is necessarily STRUCTURED_DOCUMENT.
results Array A section with analytics data for each of the document's topics.
    children Array The document's topics. The document's Table of Contents determines the order in which children are listed in the response body.
Return code Description
200 OK Returns 0 or more results.