3分で読めます

GET /heatmaps/:websiteId/pages

Retrieve pages that have heatmap data available. Returns page URLs with total interaction counts sorted by engagement, useful for identifying which pages have the most user interaction data.

GET/api/external/v1/heatmaps/:websiteId/pages

List pages with heatmap data

Authentication

All requests require an API key passed via the X-API-Key header. Alternatively, you can use the Authorization: Bearer YOUR_API_KEY header.

AuthenticationBash

curl -X GET 'https://api.zenovay.com/api/external/v1/heatmaps/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pages?limit=10' \
-H 'X-API-Key: YOUR_API_KEY'

Parameters

Name	Type	Required	Default	Description
`websiteId`	string (path)	Yes	-	The UUID of the website
`limit`	integer (query)	No	`20`	Number of pages to return (max: 100)

This endpoint does not accept a range query parameter. It returns all-time heatmap data sorted by interaction count.

Response

Response (200 OK)JSON

{
"success": true,
"data": {
  "pages": [
    {
      "url": "/",
      "total_interactions": 12543,
      "last_updated": "2026-02-07T14:30:00.000Z"
    },
    {
      "url": "/pricing",
      "total_interactions": 8765,
      "last_updated": "2026-02-07T14:25:00.000Z"
    },
    {
      "url": "/features",
      "total_interactions": 5432,
      "last_updated": "2026-02-07T13:45:00.000Z"
    },
    {
      "url": "/signup",
      "total_interactions": 3210,
      "last_updated": "2026-02-07T12:15:00.000Z"
    }
  ]
},
"timestamp": "2026-02-07T12:00:00.000Z"
}

Response Fields

Field	Type	Description
`pages`	array	List of pages with heatmap data sorted by interactions descending
`pages[].url`	string	Page URL path
`pages[].total_interactions`	number	Total number of user interactions recorded
`pages[].last_updated`	string	ISO 8601 timestamp of the most recent heatmap data

TypeScript Interface

HeatmapPagesResponseTypeScript

interface HeatmapPage {
url: string;
total_interactions: number;
last_updated: string;
}

interface HeatmapPagesResponse {
success: true;
data: {
  pages: HeatmapPage[];
};
timestamp: string;
}

HTTP Status Codes

Status Code	Description
200	Success
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing API key
403	Forbidden - API key does not have access to this website
404	Not Found - Website not found
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

Code Examples

cURLBash

curl -X GET 'https://api.zenovay.com/api/external/v1/heatmaps/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pages?limit=10' \
-H 'X-API-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json'

Error Handling

Error Response (500 Internal Server Error)JSON

{
"success": false,
"error": {
  "message": "Failed to fetch heatmap data",
  "code": "GENERIC_ERROR",
  "timestamp": "2026-02-07T12:00:00.000Z"
}
}