Dashboards
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
List all dashboards
Path Parameters
- project_idstring
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
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Request
GET
/api /projects /:project_id /dashboards
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/dashboards/
Response
Status 200
{"count": 123,"next": "http://api.example.org/accounts/?offset=400&limit=100","previous": "http://api.example.org/accounts/?offset=200&limit=100","results": [{"id": 0,"name": "string","description": "string","pinned": true,"created_at": "2019-08-24T14:15:22Z","created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com","is_email_verified": true},"is_shared": true,"deleted": true,"creation_mode": "default","tags": [null],"restriction_level": 21,"effective_restriction_level": 21,"effective_privilege_level": 21}]}
Create dashboards
Path Parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request Parameters
- namestring
- descriptionstring
- pinnedboolean
- deletedboolean
- use_templatestring
- use_dashboardinteger
- delete_insightsboolean
- filtersobject
- tagsarray
- restriction_levelintegerOne of:
"21"
"37"
Response
Request
POST
/api /projects /:project_id /dashboards
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl-H 'Content-Type: application/json'\-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/dashboards/\-d name="string"
Response
Status 201
{"id": 0,"name": "string","description": "string","pinned": true,"created_at": "2019-08-24T14:15:22Z","created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com","is_email_verified": true},"is_shared": true,"deleted": true,"creation_mode": "default","use_template": "string","use_dashboard": 0,"delete_insights": false,"filters": {"property1": null,"property2": null},"tags": [null],"tiles": "string","restriction_level": 21,"effective_restriction_level": 21,"effective_privilege_level": 21}
Retrieve dashboards
Path Parameters
- idinteger
A unique integer value identifying this dashboard.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Request
GET
/api /projects /:project_id /dashboards /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/dashboards/:id/
Response
Status 200
{"id": 0,"name": "string","description": "string","pinned": true,"created_at": "2019-08-24T14:15:22Z","created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com","is_email_verified": true},"is_shared": true,"deleted": true,"creation_mode": "default","use_template": "string","use_dashboard": 0,"delete_insights": false,"filters": {"property1": null,"property2": null},"tags": [null],"tiles": "string","restriction_level": 21,"effective_restriction_level": 21,"effective_privilege_level": 21}
Update dashboards
Path Parameters
- idinteger
A unique integer value identifying this dashboard.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request Parameters
- namestring
- descriptionstring
- pinnedboolean
- deletedboolean
- use_templatestring
- use_dashboardinteger
- delete_insightsboolean
- filtersobject
- tagsarray
- restriction_levelintegerOne of:
"21"
"37"
Response
Request
PATCH
/api /projects /:project_id /dashboards /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/dashboards/:id/\-d name="string"
Response
Status 200
{"id": 0,"name": "string","description": "string","pinned": true,"created_at": "2019-08-24T14:15:22Z","created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com","is_email_verified": true},"is_shared": true,"deleted": true,"creation_mode": "default","use_template": "string","use_dashboard": 0,"delete_insights": false,"filters": {"property1": null,"property2": null},"tags": [null],"tiles": "string","restriction_level": 21,"effective_restriction_level": 21,"effective_privilege_level": 21}
Delete dashboards
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Path Parameters
- idinteger
A unique integer value identifying this dashboard.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request
DELETE
/api /projects /:project_id /dashboards /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X DELETE \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/dashboards/:id/
Response
Status 405 No response body
Update dashboards move tile
Path Parameters
- idinteger
A unique integer value identifying this dashboard.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request Parameters
- namestring
- descriptionstring
- pinnedboolean
- deletedboolean
- use_templatestring
- use_dashboardinteger
- delete_insightsboolean
- filtersobject
- tagsarray
- restriction_levelintegerOne of:
"21"
"37"
Response
Request
PATCH
/api /projects /:project_id /dashboards /:id /move_tile
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/dashboards/:id/move_tile/\-d name="string"
Response
Status 200
{"id": 0,"name": "string","description": "string","pinned": true,"created_at": "2019-08-24T14:15:22Z","created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com","is_email_verified": true},"is_shared": true,"deleted": true,"creation_mode": "default","use_template": "string","use_dashboard": 0,"delete_insights": false,"filters": {"property1": null,"property2": null},"tags": [null],"tiles": "string","restriction_level": 21,"effective_restriction_level": 21,"effective_privilege_level": 21}
Create dashboards create from template json
Path Parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request Parameters
- namestring
- descriptionstring
- pinnedboolean
- deletedboolean
- use_templatestring
- use_dashboardinteger
- delete_insightsboolean
- filtersobject
- tagsarray
- restriction_levelintegerOne of:
"21"
"37"
Response
Request
POST
/api /projects /:project_id /dashboards /create_from_template_json
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl-H 'Content-Type: application/json'\-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/dashboards/create_from_template_json/\-d name="string"
Response
Status 200
{"id": 0,"name": "string","description": "string","pinned": true,"created_at": "2019-08-24T14:15:22Z","created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com","is_email_verified": true},"is_shared": true,"deleted": true,"creation_mode": "default","use_template": "string","use_dashboard": 0,"delete_insights": false,"filters": {"property1": null,"property2": null},"tags": [null],"tiles": "string","restriction_level": 21,"effective_restriction_level": 21,"effective_privilege_level": 21}