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.
npm add @posthog/sdkyarn add @posthog/sdkPersonal 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.
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
});actionsCountRetrieveactionsCreateactionsDestroy- Hard delete of this model is not allowed. Use a patch API call to set "deleted" to trueactionsListactionsPartialUpdateactionsPeopleRetrieveactionsRetrieveactionsUpdate
activityLogBookmarkActivityNotificationCreateactivityLogImportantChangesRetrieve
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 trueannotationsList- 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.
appMetricsErrorDetailsRetrieveappMetricsHistoricalExportsRetrieveappMetricsHistoricalExportsRetrieve2appMetricsRetrieve
cohortsCreatecohortsDestroy- Hard delete of this model is not allowed. Use a patch API call to set "deleted" to truecohortsListcohortsPartialUpdatecohortsPersonsRetrievecohortsRetrievecohortsUpdate
dashboardTemplatesCreatedashboardTemplatesRepositoryRetrieve
dashboardsCreatedashboardsDestroy- Hard delete of this model is not allowed. Use a patch API call to set "deleted" to truedashboardsListdashboardsMoveTilePartialUpdatedashboardsPartialUpdatedashboardsRetrievedashboardsUpdate
domainsCreatedomainsDestroydomainsListdomainsPartialUpdatedomainsRetrievedomainsUpdatedomainsVerifyCreate
eventDefinitionsListeventDefinitionsPartialUpdateeventDefinitionsRetrieveeventDefinitionsUpdate
eventsRetrieveeventsValuesRetrieve
experimentsCreateexperimentsDestroyexperimentsListexperimentsPartialUpdateexperimentsRequiresFlagImplementationRetrieveexperimentsResultsRetrieveexperimentsRetrieveexperimentsSecondaryResultsRetrieveexperimentsUpdate
exportsContentRetrieveexportsCreateexportsRetrieve
featureFlagsActivityRetrieve- Create, read, update and delete feature flags. See docs for more information on feature flags.
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
featureFlagsActivityRetrieve2- Create, read, update and delete feature flags. See docs for more information on feature flags.
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
featureFlagsCreate- Create, read, update and delete feature flags. See docs for more information on feature flags.
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
featureFlagsDestroy- Hard delete of this model is not allowed. Use a patch API call to set "deleted" to truefeatureFlagsEvaluationReasonsRetrieve- Create, read, update and delete feature flags. See docs for more information on feature flags.
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
featureFlagsList- Create, read, update and delete feature flags. See docs for more information on feature flags.
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
featureFlagsLocalEvaluationRetrieve- Create, read, update and delete feature flags. See docs for more information on feature flags.
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
featureFlagsMyFlagsRetrieve- Create, read, update and delete feature flags. See docs for more information on feature flags.
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
featureFlagsPartialUpdate- Create, read, update and delete feature flags. See docs for more information on feature flags.
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
featureFlagsRetrieve- Create, read, update and delete feature flags. See docs for more information on feature flags.
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
featureFlagsRoleAccessCreatefeatureFlagsRoleAccessDestroyfeatureFlagsRoleAccessListfeatureFlagsRoleAccessRetrievefeatureFlagsUpdate- Create, read, update and delete feature flags. See docs for more information on feature flags.
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
featureFlagsUserBlastRadiusCreate- Create, read, update and delete feature flags. See docs for more information on feature flags.
If you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.
funnels
groupsFindRetrievegroupsListgroupsPropertyDefinitionsRetrievegroupsPropertyValuesRetrievegroupsRelatedRetrieve
groupsTypesListgroupsTypesUpdateMetadataPartialUpdate
hooksCreate- Retrieve, create, update or destroy REST hooks.hooksDestroy- Retrieve, create, update or destroy REST hooks.hooksList- Retrieve, create, update or destroy REST hooks.hooksPartialUpdate- Retrieve, create, update or destroy REST hooks.hooksRetrieve- Retrieve, create, update or destroy REST hooks.hooksUpdate- Retrieve, create, update or destroy REST hooks.
ingestionWarningsRetrieve
funnelstrendsinsightsActivityRetrieveinsightsActivityRetrieve2insightsCancelCreateinsightsCreateinsightsDestroy- Hard delete of this model is not allowed. Use a patch API call to set "deleted" to trueinsightsFunnelCorrelationCreateinsightsFunnelCorrelationRetrieveinsightsFunnelRetrieveinsightsListinsightsMyLastViewedRetrieve- Returns basic details about the last 5 insights viewed by this user. Most recently viewed first.insightsPartialUpdateinsightsPathCreateinsightsPathRetrieveinsightsRetentionRetrieveinsightsRetrieveinsightsTimingCreateinsightsTrendRetrieveinsightsUpdateinsightsViewedCreate
integrationsChannelsRetrieveintegrationsCreateintegrationsDestroyintegrationsListintegrationsRetrieve
invitesBulkCreateinvitesCreateinvitesDestroyinvitesList
isGeneratingDemoDataRetrieve- Projects for the current organization.
membersDestroymembersListmembersPartialUpdatemembersUpdate
domainsCreatedomainsDestroydomainsListdomainsPartialUpdatedomainsRetrievedomainsUpdatedomainsVerifyCreateinvitesBulkCreateinvitesCreateinvitesDestroyinvitesListmembersDestroymembersListmembersPartialUpdatemembersUpdatepluginsActivityRetrievepluginsCheckForUpdatesRetrievepluginsCreatepluginsDestroypluginsListpluginsPartialUpdatepluginsRepositoryRetrievepluginsRetrievepluginsSourceRetrievepluginsUpdatepluginsUpdateSourcePartialUpdatepluginsUpgradeCreateresourceAccessCreateresourceAccessDestroyresourceAccessListresourceAccessPartialUpdateresourceAccessRetrieveresourceAccessUpdaterolesCreaterolesDestroyrolesListrolesPartialUpdaterolesRetrieverolesRoleMembershipsCreaterolesRoleMembershipsDestroyrolesRoleMembershipsListrolesUpdate
performanceEventsListperformanceEventsRecentPageviewsRetrieve
personsActivityRetrieve- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsActivityRetrieve2- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsCohortsRetrieve- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsDeletePropertyCreate- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsDestroy- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsFunnelCorrelationCreate- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsFunnelCorrelationRetrieve- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsFunnelCreate- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsFunnelRetrieve- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsLifecycleRetrieve- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsPartialUpdate- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsPathCreate- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsPathRetrieve- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsPropertiesRetrieve- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsPropertiesTimelineRetrieve- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsRetentionRetrieve- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsRetrieve- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsSplitCreate- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsStickinessRetrieve- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsTrendsRetrieve- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsUpdate- Only for setting properties on the person. "properties" from the request data will be updated via a "$set" event. This means that only the properties listed will be updated, but other properties won't be removed nor updated. If you would like to remove a property use thedelete_propertyendpoint.personsUpdatePropertyCreate- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.personsValuesRetrieve- To create or update persons, use a PostHog library of your choice and use an identify call. This API endpoint is only for reading and deleting.
pluginConfigsCreatepluginConfigsDestroypluginConfigsFrontendRetrievepluginConfigsJobCreatepluginConfigsListpluginConfigsLogsListpluginConfigsPartialUpdatepluginConfigsRearrangePartialUpdatepluginConfigsRetrievepluginConfigsUpdate
pluginsActivityRetrievepluginsCheckForUpdatesRetrievepluginsCreatepluginsDestroypluginsListpluginsPartialUpdatepluginsRepositoryRetrievepluginsRetrievepluginsSourceRetrievepluginsUpdatepluginsUpdateSourcePartialUpdatepluginsUpgradeCreate
create- Projects for the current organization.destroy- Projects for the current organization.list- Projects for the current organization.partialUpdate- Projects for the current organization.retrieve- Projects for the current organization.update- Projects for the current organization.
promptsMyPromptsPartialUpdate- Create, read, update and delete prompt sequences state for a person.promptsMyPromptsPartialUpdate- Create, read, update and delete prompt sequences state for a person.
propertyDefinitionsListpropertyDefinitionsPartialUpdatepropertyDefinitionsRetrievepropertyDefinitionsUpdate
queryRetrieve
resetTokenPartialUpdate- Projects for the current organization.
resourceAccessCreateresourceAccessDestroyresourceAccessListresourceAccessPartialUpdateresourceAccessRetrieveresourceAccessUpdate
rolesCreaterolesDestroyrolesListrolesPartialUpdaterolesRetrieverolesRoleMembershipsCreaterolesRoleMembershipsDestroyrolesRoleMembershipsListrolesUpdate
sessionRecordingPlaylistsCreatesessionRecordingPlaylistsDestroy- Hard delete of this model is not allowed. Use a patch API call to set "deleted" to truesessionRecordingPlaylistsListsessionRecordingPlaylistsPartialUpdatesessionRecordingPlaylistsRecordingsCreatesessionRecordingPlaylistsRecordingsDestroysessionRecordingPlaylistsRecordingsRetrievesessionRecordingPlaylistsRetrievesessionRecordingPlaylistsUpdate
sessionRecordingsPropertiesRetrievesessionRecordingsRetrievesessionRecordingsRetrieve2sessionRecordingsSnapshotsRetrieve
subscriptionsCreatesubscriptionsDestroy- Hard delete of this model is not allowed. Use a patch API call to set "deleted" to truesubscriptionsListsubscriptionsPartialUpdatesubscriptionsRetrievesubscriptionsUpdate
tagsList
trends
-
uploadedMediaCreate- When object storage is available this API allows upload of media which can be used, for example, in text cards on dashboards.Uploaded media must have a content type beginning with 'image/' and be less than 4MB.