API calls heatmap - Fluid Topics - Latest

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

This web service responds with information about the most popular web services over a selected period.

It is necessary to define header parameters when calling a Fluid Topics web service in order for Fluid Topics to log API calls.

Method Endpoint
POST 
/analytics/api/v2/traffic/api-calls-heatmap

Request example

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

{
  "startDate": "2023-04-01",
  "endDate": "2023-10-01",
  "callingApps": [
    "undefined (default)"
  ]
}
Field Type Required? Description
startDate String Yes The inclusive start date of the period. The start date must be in the past year.
endDate String Yes The exclusive end date of the period. The end date must be later than the start date.
callingApps Array Yes Accepts one or more calling apps.

Response body

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

{
  "startDate": "2023-09-01",
  "endDate": "2023-09-19",
  "callingApps": [
    "undefined (default)"
  ],
  "results": [
    {
      "id": "CONTENT",
      "label": "CONTENT",
      "callCount": 253905,
      "subcategories": [
        {
          "id": "CONTENT/STRUCTURED_DOC",
          "label": "STRUCTURED DOC",
          "callCount": 253863,
          "endpoints": [
            {
              "path": "/tenant/api/khub/maps/{mapId}/topics/{contentId}/content",
              "callCount": 157914
            },
            {
              "path": "/tenant/api/khub/maps/{mapId}/topics/{contentId}",
              "callCount": 79336
            },
            {
              "path": "/tenant/api/khub/maps/{mapId}",
              "callCount": 6650
            },
            {
              "path": "/tenant/api/khub/maps/{mapId}/topics",
              "callCount": 5657
            },
            {
              "path": "/tenant/api/khub/maps/{mapId}/toc",
              "callCount": 4282
            },
            {
              "path": "/tenant/api/khub/maps",
              "callCount": 23
            },
            {
              "path": "/tenant/api/khub/maps/{mapId}/pages",
              "callCount": 1
            }
          ]
        },
        {
          "id": "CONTENT/LOCALE",
          "label": "LOCALE",
          "callCount": 33,
          "endpoints": [
            {
              "path": "/tenant/api/khub/locales",
              "callCount": 33
            }
          ]
        },
        {
          "id": "CONTENT/OTHER",
          "label": "OTHER",
          "callCount": 6,
          "endpoints": [
            {
              "path": "/tenant/api/khub/maps/{mapId}/rating",
              "callCount": 6
            }
          ]
        },
        {
          "id": "CONTENT/UNSTRUCTURED_DOC",
          "label": "UNSTRUCTURED DOC",
          "callCount": 3,
          "endpoints": [
            {
              "path": "/tenant/api/khub/documents/{documentId}/content",
              "callCount": 3
            }
          ]
        }
      ]
    },
    {
      "id": "SEARCH",
      "label": "SEARCH",
      "callCount": 26,
      "subcategories": [
        {
          "id": "SEARCH/SUGGEST",
          "label": "SUGGEST",
          "callCount": 17,
          "endpoints": [
            {
              "path": "/tenant/api/khub/suggest",
              "callCount": 17
            }
          ]
        },
        {
          "id": "SEARCH/SEARCH",
          "label": "SEARCH",
          "callCount": 8,
          "endpoints": [
            {
              "path": "/tenant/api/khub/clustered-search",
              "callCount": 6
            },
            {
              "path": "/tenant/api/khub/documents/search",
              "callCount": 2
            }
          ]
        },
        {
          "id": "SEARCH/OPENSEARCH",
          "label": "OPENSEARCH",
          "callCount": 1,
          "endpoints": [
            {
              "path": "/tenant/api/opensearch",
              "callCount": 1
            }
          ]
        }
      ]
    },
    {
      "id": "OTHER",
      "callCount": 22,
      "endpoints": [
        {
          "path": "/tenant/api/**",
          "callCount": 14
        },
        {
          "path": "/tenant/api/stylesheets/fonts.css",
          "callCount": 5
        },
        {
          "path": "/tenant/api/stylesheets/content/topic.css",
          "callCount": 1
        },
        {
          "path": "/tenant/api/stylesheets/theme.css",
          "callCount": 1
        },
        {
          "path": "/tenant/api/stylesheets/content/title.css",
          "callCount": 1
        }
      ]
    },
    {
      "id": "KHUB",
      "label": "KHUB",
      "callCount": 7,
      "subcategories": [
        {
          "id": "KHUB/CONTENT",
          "label": "CONTENT",
          "callCount": 5,
          "endpoints": [
            {
              "path": "/tenant/api/admin/khub/publications",
              "callCount": 5
            }
          ]
        },
        {
          "id": "KHUB/CONTENT_PACKAGER",
          "label": "CONTENT PACKAGER",
          "callCount": 1,
          "endpoints": [
            {
              "path": "/tenant/api/khub/packages/{packageId}/result.zip",
              "callCount": 1
            }
          ]
        },
        {
          "id": "KHUB/PROCESS",
          "label": "PROCESS",
          "callCount": 1,
          "endpoints": [
            {
              "path": "/tenant/api/admin/khub/sources/{sourceId}/upload",
              "callCount": 1
            }
          ]
        }
      ]
    },
    {
      "id": "ADMIN",
      "label": "ADMIN",
      "callCount": 4,
      "subcategories": [
        {
          "id": "ADMIN/USER",
          "label": "USER",
          "callCount": 4,
          "endpoints": [
            {
              "path": "/tenant/api/users",
              "callCount": 4
            }
          ]
        }
      ]
    }
  ]
}

The response lists all calling apps whether they generated API calls or not during the selected period.

Field Type Description
startDate String The inclusive start date of the total period as defined in the request body.
endDate String The exclusive end date of the total period as defined in the request body.
callCount Number The number of calls sent by the calling apps during the period (by category or subcategory).
id String The ID of the category or subcategory.
label String The label of the category or subcategory.
Return code Description
200 OK Returns results