PostHog Typescript SDK

The PostHog API allows you to perform any action as if you were an authenticated user utilizing the PostHog UI. It is mostly used for getting data out of PostHog, as well as other private actions such as creating a feature flag.

SDK Installation

NPM

npm add @posthog/sdk

Yarn

yarn add @posthog/sdk

Authentication

Personal API keys allow full access to your account, just like e-mail address and password, but you can create any number of them and each one can invalidated individually at any moment. This makes for greater control for you and improved security of stored data.

How to obtain a personal API key
Click on your name/avatar on the top right.
Click the gear next to your name to access 'Account settings'.
Navigate to the 'Personal API Keys' section.
Click "+ Create a Personal API Key".
Give your new key a label – it's just for you, usually to describe the key's purpose.
Click 'Create Key'.

There you go! At the top of the list you should now be seeing your brand new key. Immediately copy its value, as you'll never see it again after refreshing the page. But don't worry if you forget to copy it – you can delete and create keys as much as you want.

SDK Example Usage

import {
  ActionsCountRetrieveRequest,
  ActionsCountRetrieveResponse 
} from "@posthog/sdk/dist/sdk/models/operations";

import { AxiosError } from "axios";
import { Posthog } from "@posthog/sdk";


const sdk = new Posthog();
    
const req: ActionsCountRetrieveRequest = {
  pathParams: {
    id: 548814,
    projectId: "deserunt",
  },
  queryParams: {
    format: "undefined",
  },
};

sdk.actions.actionsCountRetrieve(req).then((res: ActionsCountRetrieveResponse | AxiosError) => {
   // handle response
});

SDK Available Operations

actions

actionsCountRetrieve
actionsCreate
actionsDestroy - Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
actionsList
actionsPartialUpdate
actionsPeopleRetrieve
actionsRetrieve
actionsUpdate

activityLog

activityLogBookmarkActivityNotificationCreate
activityLogImportantChangesRetrieve

annotations

annotationsCreate - Create, Read, Update and Delete annotations. See docs for more information on annotations.
annotationsDestroy - Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
annotationsList - Create, Read, Update and Delete annotations. See docs for more information on annotations.
annotationsPartialUpdate - Create, Read, Update and Delete annotations. See docs for more information on annotations.
annotationsRetrieve - Create, Read, Update and Delete annotations. See docs for more information on annotations.
annotationsUpdate - Create, Read, Update and Delete annotations. See docs for more information on annotations.

appMetrics

appMetricsErrorDetailsRetrieve
appMetricsHistoricalExportsRetrieve
appMetricsHistoricalExportsRetrieve2
appMetricsRetrieve

cohorts

cohortsCreate
cohortsDestroy - Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
cohortsList
cohortsPartialUpdate
cohortsPersonsRetrieve
cohortsRetrieve
cohortsUpdate

dashboardTemplates

dashboardTemplatesCreate
dashboardTemplatesRepositoryRetrieve

dashboards

dashboardsCreate
dashboardsDestroy - Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
dashboardsList
dashboardsMoveTilePartialUpdate
dashboardsPartialUpdate
dashboardsRetrieve
dashboardsUpdate

domains

domainsCreate
domainsDestroy
domainsList
domainsPartialUpdate
domainsRetrieve
domainsUpdate
domainsVerifyCreate

eventDefinitions

eventDefinitionsList
eventDefinitionsPartialUpdate
eventDefinitionsRetrieve
eventDefinitionsUpdate

events

eventsRetrieve
eventsValuesRetrieve

experiments

experimentsCreate
experimentsDestroy
experimentsList
experimentsPartialUpdate
experimentsRequiresFlagImplementationRetrieve
experimentsResultsRetrieve
experimentsRetrieve
experimentsSecondaryResultsRetrieve
experimentsUpdate