metrics

Status of one of the user's dashboard imports. Poll it until the status is not 'running'.

get/api/projects/{project_id}/metrics/dashboard_imports/{id}/

Request

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

Path parameters

idstring required
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 nullable required

Id to poll for the status. Null when the import finished in the request, with no agent.

source'grafana' | 'screenshot' required
  • grafana - Grafana
  • screenshot - Screenshot
status'running' | 'completed' | 'failed' required
  • running - Running
  • completed - Completed
  • failed - Failed
dashboard_namestring required

Name of the new dashboard.

layout_roundsinteger nullable required

How many pictures of the dashboard the import compares with the screenshot, at most. Null when the import does not check the layout.

layout_roundinteger nullable required

The comparison that runs, from 1, while the phase is 'checking_layout'.

dashboard_idinteger nullable required

Id of the new dashboard, when it exists.

errorstring nullable required

Why the import failed, when it failed.

Changes

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