Subscriptions

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

Endpoints

GET
POST
GET
PATCH
DELETE
POST
GET
GET
GET
Next page →

List all subscriptions

Also available via the PostHog MCP server:

  • subscriptions-list — List subscriptions

Required API key scopes

subscription:read

Query parameters

  • created_by
    string
  • dashboard
    integer
  • dashboard_tiles
    integer
  • insight
    integer
  • insights
    string
  • limit
    integer
  • offset
    integer
  • ordering
    string
  • resource_type
    string
    One of: "ai_prompt""dashboard""insight"
  • search
    string
  • target_type
    string
    One of: "email""slack""teams"

Response


Example request

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

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": 0,
      "resource_type": "insight",
      "dashboard": 0,
      "insight": 0,
      "insight_short_id": "string",
      "resource_name": "string",
      "dashboard_export_insights": [
        0
      ],
      "prompt": "string",
      "ai_prompt_config": {
        "window": {
          "mode": "since_last_sent",
          "start_days_ago": 1,
          "end_days_ago": 365
        }
      },
      "contexts": [
        {
          "dashboard_id": 0,
          "dashboard_name": "string"
        }
      ],
      "ai_query_plan_status": "frozen",
      "target_type": "email",
      "target_value": "string",
      "frequency": "daily",
      "interval": 1,
      "byweekday": [
        "monday"
      ],
      "bysetpos": -2147483648,
      "count": -2147483648,
      "start_date": "2019-08-24T14:15:22Z",
      "until_date": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "deleted": true,
      "enabled": true,
      "title": "string",
      "summary": "string",
      "next_delivery_date": "2019-08-24T14:15:22Z",
      "integration_id": 0,
      "invite_message": "string",
      "send_test_now": true,
      "summary_enabled": true,
      "summary_prompt_guide": "string",
      "delivery_config": {
        "post_all_insights_in_main_message": false,
        "include_images": true,
        "include_feedback": true,
        "include_manage_link": true,
        "include_posthog_hint": true
      }
    }
  ]
}

List all subscriptions

Also available via the PostHog MCP server:

  • subscriptions-list — List subscriptions

Required API key scopes

subscription:read

Query parameters

  • created_by
    string
  • dashboard
    integer
  • dashboard_tiles
    integer
  • insight
    integer
  • insights
    string
  • limit
    integer
  • offset
    integer
  • ordering
    string
  • resource_type
    string
    One of: "ai_prompt""dashboard""insight"
  • search
    string
  • target_type
    string
    One of: "email""slack""teams"

Response


Example request

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

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": 0,
      "resource_type": "insight",
      "dashboard": 0,
      "insight": 0,
      "insight_short_id": "string",
      "resource_name": "string",
      "dashboard_export_insights": [
        0
      ],
      "prompt": "string",
      "ai_prompt_config": {
        "window": {
          "mode": "since_last_sent",
          "start_days_ago": 1,
          "end_days_ago": 365
        }
      },
      "contexts": [
        {
          "dashboard_id": 0,
          "dashboard_name": "string"
        }
      ],
      "ai_query_plan_status": "frozen",
      "target_type": "email",
      "target_value": "string",
      "frequency": "daily",
      "interval": 1,
      "byweekday": [
        "monday"
      ],
      "bysetpos": -2147483648,
      "count": -2147483648,
      "start_date": "2019-08-24T14:15:22Z",
      "until_date": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "deleted": true,
      "enabled": true,
      "title": "string",
      "summary": "string",
      "next_delivery_date": "2019-08-24T14:15:22Z",
      "integration_id": 0,
      "invite_message": "string",
      "send_test_now": true,
      "summary_enabled": true,
      "summary_prompt_guide": "string",
      "delivery_config": {
        "post_all_insights_in_main_message": false,
        "include_images": true,
        "include_feedback": true,
        "include_manage_link": true,
        "include_posthog_hint": true
      }
    }
  ]
}

Create subscriptions

Also available via the PostHog MCP server:

  • subscriptions-create — Create subscription

Required API key scopes

subscription:write

Request parameters

  • dashboard
    integer | null
  • insight
    integer | null
  • dashboard_export_insights
    array
  • prompt
    string | null
  • ai_prompt_config
  • contexts
    array
  • target_type
  • target_value
    string
  • frequency
  • interval
    integer
  • byweekday
    array | null
  • bysetpos
    integer | null
  • count
    integer | null
  • start_date
    string
  • until_date
    string | null
  • deleted
    boolean
  • enabled
    boolean
  • title
    string | null
  • integration_id
    integer | null
  • invite_message
    string | null
  • send_test_now
    boolean
  • summary_enabled
    boolean
  • summary_prompt_guide
    string
  • delivery_config

Response


Example request

POST /api/projects/:project_id/subscriptions
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/subscriptions/\
	-d target_type=undefined,\
	-d target_value="string",\
	-d frequency=undefined,\
	-d interval="integer",\
	-d start_date="string"

Example response

Status 201
RESPONSE
{
  "id": 0,
  "resource_type": "insight",
  "dashboard": 0,
  "insight": 0,
  "insight_short_id": "string",
  "resource_name": "string",
  "dashboard_export_insights": [
    0
  ],
  "prompt": "string",
  "ai_prompt_config": {
    "window": {
      "mode": "since_last_sent",
      "start_days_ago": 1,
      "end_days_ago": 365
    }
  },
  "contexts": [
    {
      "dashboard_id": 0,
      "dashboard_name": "string"
    }
  ],
  "ai_query_plan_status": "frozen",
  "target_type": "email",
  "target_value": "string",
  "frequency": "daily",
  "interval": 1,
  "byweekday": [
    "monday"
  ],
  "bysetpos": -2147483648,
  "count": -2147483648,
  "start_date": "2019-08-24T14:15:22Z",
  "until_date": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "deleted": true,
  "enabled": true,
  "title": "string",
  "summary": "string",
  "next_delivery_date": "2019-08-24T14:15:22Z",
  "integration_id": 0,
  "invite_message": "string",
  "send_test_now": true,
  "summary_enabled": true,
  "summary_prompt_guide": "string",
  "delivery_config": {
    "post_all_insights_in_main_message": false,
    "include_images": true,
    "include_feedback": true,
    "include_manage_link": true,
    "include_posthog_hint": true
  }
}

Create subscriptions

Also available via the PostHog MCP server:

  • subscriptions-create — Create subscription

Required API key scopes

subscription:write

Request parameters

  • dashboard
    integer | null
  • insight
    integer | null
  • dashboard_export_insights
    array
  • prompt
    string | null
  • ai_prompt_config
  • contexts
    array
  • target_type
  • target_value
    string
  • frequency
  • interval
    integer
  • byweekday
    array | null
  • bysetpos
    integer | null
  • count
    integer | null
  • start_date
    string
  • until_date
    string | null
  • deleted
    boolean
  • enabled
    boolean
  • title
    string | null
  • integration_id
    integer | null
  • invite_message
    string | null
  • send_test_now
    boolean
  • summary_enabled
    boolean
  • summary_prompt_guide
    string
  • delivery_config

Response


Example request

POST /api/projects/:project_id/subscriptions
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/subscriptions/\
	-d target_type=undefined,\
	-d target_value="string",\
	-d frequency=undefined,\
	-d interval="integer",\
	-d start_date="string"

Example response

Status 201
RESPONSE
{
  "id": 0,
  "resource_type": "insight",
  "dashboard": 0,
  "insight": 0,
  "insight_short_id": "string",
  "resource_name": "string",
  "dashboard_export_insights": [
    0
  ],
  "prompt": "string",
  "ai_prompt_config": {
    "window": {
      "mode": "since_last_sent",
      "start_days_ago": 1,
      "end_days_ago": 365
    }
  },
  "contexts": [
    {
      "dashboard_id": 0,
      "dashboard_name": "string"
    }
  ],
  "ai_query_plan_status": "frozen",
  "target_type": "email",
  "target_value": "string",
  "frequency": "daily",
  "interval": 1,
  "byweekday": [
    "monday"
  ],
  "bysetpos": -2147483648,
  "count": -2147483648,
  "start_date": "2019-08-24T14:15:22Z",
  "until_date": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "deleted": true,
  "enabled": true,
  "title": "string",
  "summary": "string",
  "next_delivery_date": "2019-08-24T14:15:22Z",
  "integration_id": 0,
  "invite_message": "string",
  "send_test_now": true,
  "summary_enabled": true,
  "summary_prompt_guide": "string",
  "delivery_config": {
    "post_all_insights_in_main_message": false,
    "include_images": true,
    "include_feedback": true,
    "include_manage_link": true,
    "include_posthog_hint": true
  }
}

Retrieve subscriptions

Also available via the PostHog MCP server:

  • subscriptions-retrieve — Get subscription

Required API key scopes

subscription:read

Path parameters

  • id
    integer

Response


Example request

GET /api/projects/:project_id/subscriptions/: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/subscriptions/:id/

Example response

Status 200
RESPONSE
{
  "id": 0,
  "resource_type": "insight",
  "dashboard": 0,
  "insight": 0,
  "insight_short_id": "string",
  "resource_name": "string",
  "dashboard_export_insights": [
    0
  ],
  "prompt": "string",
  "ai_prompt_config": {
    "window": {
      "mode": "since_last_sent",
      "start_days_ago": 1,
      "end_days_ago": 365
    }
  },
  "contexts": [
    {
      "dashboard_id": 0,
      "dashboard_name": "string"
    }
  ],
  "ai_query_plan_status": "frozen",
  "target_type": "email",
  "target_value": "string",
  "frequency": "daily",
  "interval": 1,
  "byweekday": [
    "monday"
  ],
  "bysetpos": -2147483648,
  "count": -2147483648,
  "start_date": "2019-08-24T14:15:22Z",
  "until_date": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "deleted": true,
  "enabled": true,
  "title": "string",
  "summary": "string",
  "next_delivery_date": "2019-08-24T14:15:22Z",
  "integration_id": 0,
  "invite_message": "string",
  "send_test_now": true,
  "summary_enabled": true,
  "summary_prompt_guide": "string",
  "delivery_config": {
    "post_all_insights_in_main_message": false,
    "include_images": true,
    "include_feedback": true,
    "include_manage_link": true,
    "include_posthog_hint": true
  }
}

Retrieve subscriptions

Also available via the PostHog MCP server:

  • subscriptions-retrieve — Get subscription

Required API key scopes

subscription:read

Path parameters

  • id
    integer

Response


Example request

GET /api/projects/:project_id/subscriptions/: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/subscriptions/:id/

Example response

Status 200
RESPONSE
{
  "id": 0,
  "resource_type": "insight",
  "dashboard": 0,
  "insight": 0,
  "insight_short_id": "string",
  "resource_name": "string",
  "dashboard_export_insights": [
    0
  ],
  "prompt": "string",
  "ai_prompt_config": {
    "window": {
      "mode": "since_last_sent",
      "start_days_ago": 1,
      "end_days_ago": 365
    }
  },
  "contexts": [
    {
      "dashboard_id": 0,
      "dashboard_name": "string"
    }
  ],
  "ai_query_plan_status": "frozen",
  "target_type": "email",
  "target_value": "string",
  "frequency": "daily",
  "interval": 1,
  "byweekday": [
    "monday"
  ],
  "bysetpos": -2147483648,
  "count": -2147483648,
  "start_date": "2019-08-24T14:15:22Z",
  "until_date": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "deleted": true,
  "enabled": true,
  "title": "string",
  "summary": "string",
  "next_delivery_date": "2019-08-24T14:15:22Z",
  "integration_id": 0,
  "invite_message": "string",
  "send_test_now": true,
  "summary_enabled": true,
  "summary_prompt_guide": "string",
  "delivery_config": {
    "post_all_insights_in_main_message": false,
    "include_images": true,
    "include_feedback": true,
    "include_manage_link": true,
    "include_posthog_hint": true
  }
}

Update subscriptions

Also available via the PostHog MCP server:

  • subscriptions-partial-update — Update subscription

Required API key scopes

subscription:write

Path parameters

  • id
    integer

Request parameters

  • dashboard
    integer | null
  • insight
    integer | null
  • dashboard_export_insights
    array
  • prompt
    string | null
  • ai_prompt_config
  • contexts
    array
  • target_type
  • target_value
    string
  • frequency
  • interval
    integer
  • byweekday
    array | null
  • bysetpos
    integer | null
  • count
    integer | null
  • start_date
    string
  • until_date
    string | null
  • deleted
    boolean
  • enabled
    boolean
  • title
    string | null
  • integration_id
    integer | null
  • invite_message
    string | null
  • send_test_now
    boolean
  • summary_enabled
    boolean
  • summary_prompt_guide
    string
  • delivery_config

Response


Example request

PATCH /api/projects/:project_id/subscriptions/: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/subscriptions/:id/\
	-d resource_type=undefined

Example response

Status 200
RESPONSE
{
  "id": 0,
  "resource_type": "insight",
  "dashboard": 0,
  "insight": 0,
  "insight_short_id": "string",
  "resource_name": "string",
  "dashboard_export_insights": [
    0
  ],
  "prompt": "string",
  "ai_prompt_config": {
    "window": {
      "mode": "since_last_sent",
      "start_days_ago": 1,
      "end_days_ago": 365
    }
  },
  "contexts": [
    {
      "dashboard_id": 0,
      "dashboard_name": "string"
    }
  ],
  "ai_query_plan_status": "frozen",
  "target_type": "email",
  "target_value": "string",
  "frequency": "daily",
  "interval": 1,
  "byweekday": [
    "monday"
  ],
  "bysetpos": -2147483648,
  "count": -2147483648,
  "start_date": "2019-08-24T14:15:22Z",
  "until_date": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "deleted": true,
  "enabled": true,
  "title": "string",
  "summary": "string",
  "next_delivery_date": "2019-08-24T14:15:22Z",
  "integration_id": 0,
  "invite_message": "string",
  "send_test_now": true,
  "summary_enabled": true,
  "summary_prompt_guide": "string",
  "delivery_config": {
    "post_all_insights_in_main_message": false,
    "include_images": true,
    "include_feedback": true,
    "include_manage_link": true,
    "include_posthog_hint": true
  }
}

Update subscriptions

Also available via the PostHog MCP server:

  • subscriptions-partial-update — Update subscription

Required API key scopes

subscription:write

Path parameters

  • id
    integer

Request parameters

  • dashboard
    integer | null
  • insight
    integer | null
  • dashboard_export_insights
    array
  • prompt
    string | null
  • ai_prompt_config
  • contexts
    array
  • target_type
  • target_value
    string
  • frequency
  • interval
    integer
  • byweekday
    array | null
  • bysetpos
    integer | null
  • count
    integer | null
  • start_date
    string
  • until_date
    string | null
  • deleted
    boolean
  • enabled
    boolean
  • title
    string | null
  • integration_id
    integer | null
  • invite_message
    string | null
  • send_test_now
    boolean
  • summary_enabled
    boolean
  • summary_prompt_guide
    string
  • delivery_config

Response


Example request

PATCH /api/projects/:project_id/subscriptions/: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/subscriptions/:id/\
	-d resource_type=undefined

Example response

Status 200
RESPONSE
{
  "id": 0,
  "resource_type": "insight",
  "dashboard": 0,
  "insight": 0,
  "insight_short_id": "string",
  "resource_name": "string",
  "dashboard_export_insights": [
    0
  ],
  "prompt": "string",
  "ai_prompt_config": {
    "window": {
      "mode": "since_last_sent",
      "start_days_ago": 1,
      "end_days_ago": 365
    }
  },
  "contexts": [
    {
      "dashboard_id": 0,
      "dashboard_name": "string"
    }
  ],
  "ai_query_plan_status": "frozen",
  "target_type": "email",
  "target_value": "string",
  "frequency": "daily",
  "interval": 1,
  "byweekday": [
    "monday"
  ],
  "bysetpos": -2147483648,
  "count": -2147483648,
  "start_date": "2019-08-24T14:15:22Z",
  "until_date": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "deleted": true,
  "enabled": true,
  "title": "string",
  "summary": "string",
  "next_delivery_date": "2019-08-24T14:15:22Z",
  "integration_id": 0,
  "invite_message": "string",
  "send_test_now": true,
  "summary_enabled": true,
  "summary_prompt_guide": "string",
  "delivery_config": {
    "post_all_insights_in_main_message": false,
    "include_images": true,
    "include_feedback": true,
    "include_manage_link": true,
    "include_posthog_hint": true
  }
}

Delete subscriptions

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

subscription:write

Path parameters

  • id
    integer

Example request

DELETE /api/projects/:project_id/subscriptions/: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/subscriptions/:id/

Example response

Status 405 No response body

Delete subscriptions

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

subscription:write

Path parameters

  • id
    integer

Example request

DELETE /api/projects/:project_id/subscriptions/: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/subscriptions/:id/

Example response

Status 405 No response body

Create subscriptions test delivery

Also available via the PostHog MCP server:

  • subscriptions-test-delivery-create — Send test delivery

Required API key scopes

subscription:write

Path parameters

  • id
    integer

Example request

POST /api/projects/:project_id/subscriptions/:id/test-delivery
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/subscriptions/:id/test-delivery/

Example response

Status 202 Test delivery workflow started

Create subscriptions test delivery

Also available via the PostHog MCP server:

  • subscriptions-test-delivery-create — Send test delivery

Required API key scopes

subscription:write

Path parameters

  • id
    integer

Example request

POST /api/projects/:project_id/subscriptions/:id/test-delivery
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/subscriptions/:id/test-delivery/

Example response

Status 202 Test delivery workflow started

List all subscriptions deliveries

Also available via the PostHog MCP server:

  • subscriptions-deliveries-list — List subscription deliveries

Paginated delivery history for a subscription. Requires premium subscriptions.

Required API key scopes

subscription:read

Path parameters

  • subscription_id
    integer

Query parameters

  • cursor
    string
  • status
    string
    One of: "completed""failed""skipped""starting"

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "subscription": 0,
      "temporal_workflow_id": "string",
      "idempotency_key": "string",
      "trigger_type": "string",
      "scheduled_at": "2019-08-24T14:15:22Z",
      "target_type": "string",
      "target_value": "string",
      "exported_asset_ids": [
        -2147483648
      ],
      "content_snapshot": null,
      "recipient_results": null,
      "status": "starting",
      "error": null,
      "created_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "change_summary": "string",
      "ai_report": "string",
      "ai_report_diagnostics": [
        {
          "description": "string",
          "hogql": "string",
          "ok": true,
          "error_type": "string",
          "error_code": "string",
          "human_readable_error": "string"
        }
      ],
      "ai_report_charts": [
        {
          "export_asset_id": 0,
          "title": "string",
          "step_index": 0
        }
      ],
      "ai_report_prompt": "string",
      "ai_query_plan_status": "frozen"
    }
  ]
}

List all subscriptions deliveries

Also available via the PostHog MCP server:

  • subscriptions-deliveries-list — List subscription deliveries

Paginated delivery history for a subscription. Requires premium subscriptions.

Required API key scopes

subscription:read

Path parameters

  • subscription_id
    integer

Query parameters

  • cursor
    string
  • status
    string
    One of: "completed""failed""skipped""starting"

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "subscription": 0,
      "temporal_workflow_id": "string",
      "idempotency_key": "string",
      "trigger_type": "string",
      "scheduled_at": "2019-08-24T14:15:22Z",
      "target_type": "string",
      "target_value": "string",
      "exported_asset_ids": [
        -2147483648
      ],
      "content_snapshot": null,
      "recipient_results": null,
      "status": "starting",
      "error": null,
      "created_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "change_summary": "string",
      "ai_report": "string",
      "ai_report_diagnostics": [
        {
          "description": "string",
          "hogql": "string",
          "ok": true,
          "error_type": "string",
          "error_code": "string",
          "human_readable_error": "string"
        }
      ],
      "ai_report_charts": [
        {
          "export_asset_id": 0,
          "title": "string",
          "step_index": 0
        }
      ],
      "ai_report_prompt": "string",
      "ai_query_plan_status": "frozen"
    }
  ]
}

Retrieve subscriptions deliveries

Also available via the PostHog MCP server:

  • subscriptions-deliveries-retrieve — Get subscription delivery

Fetch one delivery row by id.

Required API key scopes

subscription:read

Path parameters

  • id
    string
  • subscription_id
    integer

Response


Example request

GET /api/projects/:project_id/subscriptions/:subscription_id/deliveries/: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/subscriptions/:subscription_id/deliveries/:id/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "subscription": 0,
  "temporal_workflow_id": "string",
  "idempotency_key": "string",
  "trigger_type": "string",
  "scheduled_at": "2019-08-24T14:15:22Z",
  "target_type": "string",
  "target_value": "string",
  "exported_asset_ids": [
    -2147483648
  ],
  "content_snapshot": null,
  "recipient_results": null,
  "status": "starting",
  "error": null,
  "created_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z",
  "change_summary": "string",
  "ai_report": "string",
  "ai_report_diagnostics": [
    {
      "description": "string",
      "hogql": "string",
      "ok": true,
      "error_type": "string",
      "error_code": "string",
      "human_readable_error": "string"
    }
  ],
  "ai_report_charts": [
    {
      "export_asset_id": 0,
      "title": "string",
      "step_index": 0
    }
  ],
  "ai_report_prompt": "string",
  "ai_query_plan_status": "frozen"
}

Retrieve subscriptions deliveries

Also available via the PostHog MCP server:

  • subscriptions-deliveries-retrieve — Get subscription delivery

Fetch one delivery row by id.

Required API key scopes

subscription:read

Path parameters

  • id
    string
  • subscription_id
    integer

Response


Example request

GET /api/projects/:project_id/subscriptions/:subscription_id/deliveries/: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/subscriptions/:subscription_id/deliveries/:id/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "subscription": 0,
  "temporal_workflow_id": "string",
  "idempotency_key": "string",
  "trigger_type": "string",
  "scheduled_at": "2019-08-24T14:15:22Z",
  "target_type": "string",
  "target_value": "string",
  "exported_asset_ids": [
    -2147483648
  ],
  "content_snapshot": null,
  "recipient_results": null,
  "status": "starting",
  "error": null,
  "created_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z",
  "change_summary": "string",
  "ai_report": "string",
  "ai_report_diagnostics": [
    {
      "description": "string",
      "hogql": "string",
      "ok": true,
      "error_type": "string",
      "error_code": "string",
      "human_readable_error": "string"
    }
  ],
  "ai_report_charts": [
    {
      "export_asset_id": 0,
      "title": "string",
      "step_index": 0
    }
  ],
  "ai_report_prompt": "string",
  "ai_query_plan_status": "frozen"
}

List all subscriptions summaries

Completed deliveries that include an AI summary, across every active subscription on one insight or dashboard, newest first. Requires viewer access to the insight or dashboard.

Required API key scopes

subscription:read

Query parameters

  • cursor
    string
  • dashboard
    integer
  • insight
    integer

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "subscription": 0,
      "subscription_title": "string",
      "target_type": "string",
      "change_summary": "string",
      "period_start": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

List all subscriptions summaries

Completed deliveries that include an AI summary, across every active subscription on one insight or dashboard, newest first. Requires viewer access to the insight or dashboard.

Required API key scopes

subscription:read

Query parameters

  • cursor
    string
  • dashboard
    integer
  • insight
    integer

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "subscription": 0,
      "subscription_title": "string",
      "target_type": "string",
      "change_summary": "string",
      "period_start": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}
Next page →