Groups types

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

Endpoints

GET
DELETE
GET
POST
GET
PATCH
DELETE
PATCH

List all groups types

Required API key scopes

group:read

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Example request

GET /api/projects/:project_id/groups_types
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups_types/

Example response

Status 200
RESPONSE
{
  "group_type": "string",
  "group_type_index": 0,
  "name_singular": "string",
  "name_plural": "string",
  "detail_dashboard": 0,
  "default_columns": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z"
}

Delete groups types

Required API key scopes

group:write

Path parameters

  • group_type_index
    integer
  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Example request

DELETE /api/projects/:project_id/groups_types/:group_type_index
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups_types/:group_type_index/

Example response

Status 204 No response body

List all groups types metrics

Required API key scopes

group:read

Path parameters

  • group_type_index
    integer
  • project_id
    string

    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

  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.

Response


Example request

GET /api/projects/:project_id/groups_types/:group_type_index/metrics
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups_types/:group_type_index/metrics/

Example response

Status 200
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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "format": "numeric",
      "interval": -2147483648,
      "display": "number",
      "filters": null
    }
  ]
}

Create groups types metrics

Required API key scopes

group:write

Path parameters

  • group_type_index
    integer
  • project_id
    string

    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

  • name
    string
  • format
  • interval
    integer

    In days

  • display
  • filters

Response


Example request

POST /api/projects/:project_id/groups_types/:group_type_index/metrics
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups_types/:group_type_index/metrics/\
	-d name="string",\
	-d filters=undefined

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "format": "numeric",
  "interval": -2147483648,
  "display": "number",
  "filters": null
}

Retrieve groups types metrics

Required API key scopes

group:read

Path parameters

  • group_type_index
    integer
  • id
    string

    A UUID string identifying this group usage metric.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response


Example request

GET /api/projects/:project_id/groups_types/:group_type_index/metrics/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups_types/:group_type_index/metrics/:id/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "format": "numeric",
  "interval": -2147483648,
  "display": "number",
  "filters": null
}

Update groups types metrics

Required API key scopes

group:write

Path parameters

  • group_type_index
    integer
  • id
    string

    A UUID string identifying this group usage metric.

  • project_id
    string

    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

  • name
    string
  • format
  • interval
    integer

    In days

  • display
  • filters

Response


Example request

PATCH /api/projects/:project_id/groups_types/:group_type_index/metrics/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups_types/:group_type_index/metrics/:id/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "format": "numeric",
  "interval": -2147483648,
  "display": "number",
  "filters": null
}

Delete groups types metrics

Required API key scopes

group:write

Path parameters

  • group_type_index
    integer
  • id
    string

    A UUID string identifying this group usage metric.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Example request

DELETE /api/projects/:project_id/groups_types/:group_type_index/metrics/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups_types/:group_type_index/metrics/:id/

Example response

Status 204 No response body

Update groups types update metadata

Path parameters

  • project_id
    string

    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

  • name_singular
    string
  • name_plural
    string
  • detail_dashboard
    integer
  • default_columns
    array
  • created_at
    string

Example request

PATCH /api/projects/:project_id/groups_types/update_metadata
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups_types/update_metadata/\
	-d group_type="string"

Example response

Status 200 No response body

Community questions

Questions about this page? or post a community question.