dashboard_templates

get/api/projects/{project_id}/dashboard_templates/

Request

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

is_featuredboolean

Omit for all templates. When set, filter by featured flag; parsed with str_to_bool (same as other API query booleans).

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

ordering'-created_at' | '-template_name' | 'created_at' | 'template_name'

Optional. When not using search, results are sorted with featured templates first (is_featured=true), then by template_name (case-insensitive A–Z; -template_name for Z–A) or by created_at (-created_at for newest first). When search is set, order is featured first, then relevance rank, then case-insensitive name for ties.

scope'feature_flag' | 'global' | 'organization' | 'team'

Optional. global: official templates only. team: this project's saved templates only (scope=team rows for the current project). organization: templates shared across all projects in this organization. feature_flag: feature-flag dashboard templates only. Omit for official, organization, and this project's templates (default dashboard template picker behavior).

searchstring

Optional. Full-text search across template name, tags, and description, ranked by relevance. Use it to find templates for a topic (e.g. retention, revenue, product analytics).

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

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