metrics

Dashboards from the metrics dashboard bank that suit the metrics this project sends, best fit first.

get/api/projects/{project_id}/metrics/suggested_dashboards/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/metrics/suggested_dashboards/
  • 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/.

Response

idstring uuid required

Suggestion id.

template_idstring uuid required

The bank dashboard that the suggestion is for.

namestring required

Dashboard name.

descriptionstring required

What the dashboard shows.

reasonstring required

Why the dashboard suits this project. Can be empty.

panel_countinteger required

Number of charts on the dashboard.

matched_metric_countinteger required

Number of the project's metrics that the dashboard uses.

coveragenumber double required

Share of the dashboard's charts that have data in this project.

dashboard_idinteger nullable required

The dashboard that someone in the project created from this suggestion.

Changes