Searches with no results - Fluid Topics - Latest

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

This web service responds with information about which search terms returned no results in a selected period.

Method Endpoint
POST /analytics/api/v2/searches/no-results-top

Request example

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

{
  "startDate": "2024-01-01",
  "endDate": "2024-05-01",
  "paging": {
    "page": 1,
    "perPage": 10
  },
  "contentLocale": "en-US"
}
Field Name Type Required? Description
startDate String Yes Inclusive start date of the period. Must be within the past year.
endDate String Yes Exclusive end date of the period. Must be later than the start date.
contentLocale String Yes Combination of ISO 639-1 language code and ISO 3166-1 country code.
paging Object Yes Element containing page and perPage elements.
page Number Yes Current page number. Starts at 1.
perPage Number Yes Number of results per page.

All elements described above are mandatory.

Response body

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

{
    "startDate": "2024-01-01",
    "endDate": "2024-05-01",
    "paging": {
        "page": 1,
        "perPage": 10,
        "totalCount": 330,
        "lastPage": false
    },
    "results": [
        {
            "terms": "zendesk",
            "facets": [],
            "queryCount": 11
        },
        {
            "terms": "mermaid",
            "facets": [
                {
                    "key": "Version_FT",
                    "label": "Version",
                    "values": [
                        "Latest"
                    ]
                }
            ],
            "queryCount": 9
        },
        {
            "terms": "search",
            "facets": [
                {
                    "key": "Category",
                    "label": "Category",
                    "values": [
                        "Technical Notes"
                    ]
                },
                {
                    "key": "Version_FT",
                    "label": "Version",
                    "values": [
                        "3.7"
                    ]
                }
            ],
            "queryCount": 7
        },
        {
            "terms": "",
            "facets": [
                {
                    "key": "Version_FT",
                    "label": "Version",
                    "values": [
                        "4.0"
                    ]
                }
            ],
            "queryCount": 4
        }
    ]
}
Field Type Description
startDate String Inclusive start date of the period as defined in the request body.
endDate String Exclusive end date of the period as defined in the request body.
lastPage Boolean Boolean operator indicating whether the page is the last page.
page Number Current page number.
perPage Number Number of results per page.
totalCount Number Total number of available results.
terms Array Keywords that were typed in the search box.
key String Unique name to identify the facet.
label String Localized name of the facet.
values Array Values of the facets.
queryCount Number Number of queries containing the terms that were submitted.
Return code Description
200 OK Returns 0 or more results.