Topic views - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

This web service lists topics by the number of times users viewed each topic. It is possible to add a date range and metadata to retrieve information about a subset of topics.

Method Endpoint
POST /analytics/api/v1/topics/views-top

Request example

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

{
  "startDate": "2022-03-29",
  "endDate": "2022-04-29",
  "filters": {
    "document": {
      "metadata": [
        {
          "key": "Product",
          "values": [
            "Fluid Topics"
          ]
        }
      ],
      "titleContains": "Pretty URL"
    },
    "titleContains": "templates"
  },
  "sortOrder": "topFirst",
  "paging": {
    "page": 2,
    "perPage": 10
  }
}
Field Type Required? Description
startDate String Yes The inclusive start date of the period. The start date is mandatory and must be within the past year.
endDate String Yes The exclusive end date of the period. The end date is mandatory and must be after the start date.
filters Object No An optional element to only return results that have certain metadata.
    document Object No An optional element to only return topics that belong to documents with certain metadata.
        metadata Array No An element that must be present when using the document element. It contains the key and values elements.
            key String No A unique name to identify the metadata.
            values Array No The values of the metadata.
        titleContains No String A string that must be present in the title of all returned documents. It is not case-sensitive.
    titleContains String No A string that must be present in the title of all returned topics. It is not case-sensitive.
sortOrder String No Sorts topics by either most to least viewed (topFirst) or least to most viewed (bottomFirst).
paging Object No A mandatory element that contains page and perPage.
    page Number Yes Indicates the current page, starts at 1 (mandatory).
    perPage Number Yes The number of results per page (mandatory).

If using facets, it is necessary to enter the exact key and at least one value for each key.

Response body

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

{
  "startDate": "2022-03-29",
  "endDate": "2022-04-29",
  "paging": {
    "lastPage": true,
    "page": 2,
    "perPage": 10,
    "totalCount": 1328
  },
  "results": [
    {
      "displayCount": 14,
      "document": {
        "id": "57STK3r810OrYm1OaEhBeA",
        "metadata": [
          {
            "key": "audience",
            "label": "Audience",
            "values": [
              "public"
            ]
          },
          {
            "key": "Updated_category",
            "label": "Category",
            "values": [
              "How To"
            ]
          },
          {
            "key": "Product",
            "label": "Product",
            "values": [
              "Fluid Topics"
            ]
          },
        ],
        "title": "How to Manage Latest Versions with Pretty URLs",
        "type": "STRUCTURED_DOCUMENT",
      },
      "id": "hsu07ToOSelEDX~jbW5sGA",
      "link": "https://doc.antidot.net/reader/57STK3r810OrYm1OaEhBeA/hsu07ToOSelEDX~jbW5sGA",
      "title": "Manage Templates"
    }
  ]
}
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.
paging Object An element that contains the lastPage, page, perPage, and totalCount elements.
    lastPage Boolean A Boolean operator indicating whether the page is the last page (true or false).
    page Number The current page.
    perPage Number The number of results per page.
    totalCount Number The total number of available results.
    displayCount Number The number of times the document has been accessed.
    document Object The document to which the topic belongs.
        id String The document's ID.
        title String The document's title.
        metadata Array The document's metadata.
            key String A unique name to identify the facet.
            label String The facet's localized name.
        type String The document's type (STRUCTURED_DOCUMENT, UNSTRUCTURED_DOCUMENT, SHARED_PERSONAL_BOOK, MAP_ATTACHMENT, or RESOURCE).
    id String The topic's ID.
    link String The topic's URL in Fluid Topics.
    title String The topic's title.
Return code Description
200 OK Returns 0 or more results.