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": "2023-04-29",
"endDate": "2023-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": "2023-04-29",
"endDate": "2023-05-01",
"documentInformation": {
"displayCount": 1234567890,
"id": "jlkhF8qsf78qsfdHK",
"link": "http://my.fluidtopics.com/r/How-To-Make-A-Documentation-Portal",
"metadata": [
{
"key": "version",
"label": "Version Number",
"values": [
"1.78",
"14.54.5"
]
}
],
"title": "How To Make A Documentation Portal",
"type": "STRUCTURED_DOCUMENT"
},
"results": [
{
"children": [
],
"displayCount": 1234567890,
"id": "jlkhF8qsf78qsfdHK",
"title": "How To Make A Documentation Portal"
}
]
}
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. |