saved

List saved heatmaps for the project. A saved heatmap pins a page URL and a set of viewport widths, and (for type 'screenshot') renders the page so heatmap data can be overlaid on it.

get/api/projects/{project_id}/saved/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/saved/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

created_byinteger

Filter by the creating user's ID.

limitinteger

Maximum saved heatmaps to return.

offsetinteger

Number to skip, for pagination.

orderstring

Field to order by, e.g. '-updated_at' (default) or 'created_at'.

searchstring

Case-insensitive substring match on URL or name.

statusstring

Filter by generation status: 'processing', 'completed', or 'failed'.

typestring

Filter by render mode: 'screenshot', 'iframe', or 'recording'.

Response

countinteger required

Total number of saved heatmaps matching the filters.

Changes

No recorded changes to this operation across all 1 revision of this API.