Internal navigation - Fluid Topics - Latest

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

This web service responds with information about how users navigate from one page to another within a portal during a period of time. Source and target pages are grouped by page types.

Method Endpoint
POST /analytics/api/v2/traffic/internal-navigation

Request example

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

{
    "startDate":"2023-08-01",
    "endDate":"2023-11-01",
    "filters":{
        "pageId":["2b93cf18-2aa3-4fa2-a800-c5dd47e15df7","ft/home","ft/search","ft/reader"],
        "language":"en-US",
        "authenticated":"true"
    }
}
Field Type Required? Description
startDate String Yes The inclusive start date of the period. Must be within the past year.
endDate String Yes The exclusive end date of the period. Must be within the past year.
filters Array No An array containing the ids, locale, and sessionType fields.
    pageId Array No Filter on page IDs. ft/home corresponds to the classic Homepage, ft/reader corresponds to the classic Reader page, etc. Designed pages have a random ID which can be found in the URL of the page in the Fluid Topics Designer. The ID is also accessible by using the Page views web service.
    language String No Filter on the UI Locale (for example, en-US or fr-FR)
    authenticated Boolean No The type of session when viewing the page. Can be true for authenticated sessions or false for unauthenticated sessions. If undefined, the web service returns page views for both authenticated and unauthenticated users.

Response body

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

{
    "startDate":"2023-08-01",
    "endDate":"2023-11-01",
    "results":[
        {"source":"designedPage","target":"homePage","count":14},
        {"source":"designedPage","target":"searchPage","count":8},
        {"source":"designedPage","target":"designedPage","count":3},
        {"source":"homePage","target":"searchPage","count":1980},
        {"source":"homePage","target":"readerPage","count":982},
        {"source":"homePage","target":"homePage","count":271},
        {"source":"homePage","target":"designedPage","count":73}
    ]
}
Response value Type Description
startDate String The inclusive start date of the period as defined in the request.
endDate String The exclusive end date of the period as defined in the request.
results Array An array containing the source, target, and count fields.
    source String The page from which the user navigated.
    target String The page to which the user navigated.
    count Number The number of times a user navigated from the source page to the target page within the selected period.
Return code Description
200 OK The request is valid and returns data.
401 UNAUTHORIZED The authorization header was not provided or is invalid.
403 FORBIDDEN The user or API key does not have the ADMIN or ANALYTICS_USER role.