Dashboards API Reference

Docs
API
Dashboards

Dashboards

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

`GET`	`/api/projects/:project_id/dashboards/`
`POST`	`/api/projects/:project_id/dashboards/`
`GET`	`/api/projects/:project_id/dashboards/:id/`
`PATCH`	`/api/projects/:project_id/dashboards/:id/`
`DELETE`	`/api/projects/:project_id/dashboards/:id/`
`PATCH`	`/api/projects/:project_id/dashboards/:id/move_tile/`

List all dashboards

Path Parameters

project_id
string

Query Parameters

limit
integer
offset
integer

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

RESPONSE

{
  "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",
      "items": "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_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

Path Parameters

project_id
string

Request Parameters

name
string
description
string
pinned
boolean
deleted
boolean
use_template
string
use_dashboard
integer
delete_insights
boolean
filters
object
tags
array
restriction_level
integer
One 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

RESPONSE

{
  "id": 0,
  "name": "string",
  "description": "string",
  "items": "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_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

id
integer
project_id
string

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

RESPONSE

{
  "id": 0,
  "name": "string",
  "description": "string",
  "items": "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_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

id
integer
project_id
string

Request Parameters

name
string
description
string
pinned
boolean
deleted
boolean
use_template
string
use_dashboard
integer
delete_insights
boolean
filters
object
tags
array
restriction_level
integer
One 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

RESPONSE

{
  "id": 0,
  "name": "string",
  "description": "string",
  "items": "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_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

id
integer
project_id
string

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

No response

Update dashboards move tile

Path Parameters

id
integer
project_id
string

Request Parameters

name
string
description
string
pinned
boolean
deleted
boolean
use_template
string
use_dashboard
integer
delete_insights
boolean
filters
object
tags
array
restriction_level
integer
One 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

RESPONSE

{
  "id": 0,
  "name": "string",
  "description": "string",
  "items": "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_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
}

Dashboards

Endpoints

List all dashboards

Path Parameters

Query Parameters

Response

Request

Response

Create dashboards

Path Parameters

Request Parameters

Response

Request

Response

Retrieve dashboards

Path Parameters

Response

Request

Response

Update dashboards

Path Parameters

Request Parameters

Response

Request

Response

Delete dashboards

Path Parameters

Request

Response

Update dashboards move tile

Path Parameters

Request Parameters

Response

Request

Response

Questions?

Was this page useful?