Trend
For instructions on how to authenticate to use this endpoint, see API overview.
Adds an "access_controls" action to the viewset that handles access control for the given resource
Why a mixin? We want to easily add this to any existing resource, including providing easy helpers for adding access control info such as the current users access level to any response.
Endpoints
POST | /api/environments/:project_id/insights/trend/ |
POST | /api/projects/:project_id/insights/trend/ |
Create
Required API key scopes
insight:read
Path parameters
- project_idstring
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
- formatstringOne of:
"csv"
"json"
Request parameters
- eventsarray
Events to filter on. One of
events
oractions
is required. - actionsarray
Actions to filter on. One of
events
oractions
is required. - properties
Filter events by event property, person property, cohort, groups and more.
- filter_test_accountsboolean
Whether to filter out internal and test accounts. See "project settings" in your PostHog account for the filters.
- date_fromstringDefault:
-7d
What date to filter the results from. Can either be a date
2021-01-01
, or a relative date, like-7d
for last seven days,-1m
for last month,mStart
for start of the month oryStart
for the start of the year. - date_tostringDefault:
-7d
What date to filter the results to. Can either be a date
2021-01-01
, or a relative date, like-7d
for last seven days,-1m
for last month,mStart
for start of the month oryStart
for the start of the year. - breakdownstring
A property or cohort to break down on. You can select the type of the property with breakdown_type.
event
(default): a property keyperson
: a person property keycohort
: an array of cohort IDs (ie[9581,5812]
)
- breakdown_typeDefault:
event
Type of property to break down on.
event
- eventperson
- personcohort
- cohortgroup
- groupsession
- sessionhogql
- hogql
- compareboolean
To compare or not
- compare_tostring
What to compare to
- displayDefault:
ActionsLineGraph
How to display the data. Will change how the data is returned.
ActionsLineGraph
- ActionsLineGraphActionsLineGraphCumulative
- ActionsLineGraphCumulativeActionsTable
- ActionsTableActionsPie
- ActionsPieActionsBar
- ActionsBarActionsBarValue
- ActionsBarValueWorldMap
- WorldMapBoldNumber
- BoldNumber
- formulastring
Combine the result of events or actions into a single number. For example
A + B
or(A-B)/B
. The letters correspond to the order of theevents
oractions
lists.
Response
Request
POST
/api/environments/:project_id/insights/trend
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/environments/:project_id/insights/trend/\-d events=[{"id":"$pageview"}]
Response
Status 200
{"is_cached": true,"last_refresh": "2019-08-24T14:15:22Z","timezone": "UTC","result": [{"data": [0],"days": ["2019-08-24"],"labels": ["string"],"filter": {"events": [{"id": "string","properties": [{"type": "AND","values": [{"key": "string","value": "string","operator": "exact","type": "event"}]}],"math": "total"}],"actions": [{"id": "string","properties": [{"type": "AND","values": [{"key": "string","value": "string","operator": "exact","type": "event"}]}],"math": "total"}],"properties": {"type": "AND","values": [{"key": "string","value": "string","operator": "exact","type": "event"}]},"filter_test_accounts": false,"date_from": "-7d","date_to": "-7d"},"label": "string"}]}
Create trends
Required API key scopes
insight:read
Path parameters
- project_idstring
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
- formatstringOne of:
"csv"
"json"
Request parameters
- eventsarray
Events to filter on. One of
events
oractions
is required. - actionsarray
Actions to filter on. One of
events
oractions
is required. - properties
Filter events by event property, person property, cohort, groups and more.
- filter_test_accountsboolean
Whether to filter out internal and test accounts. See "project settings" in your PostHog account for the filters.
- date_fromstringDefault:
-7d
What date to filter the results from. Can either be a date
2021-01-01
, or a relative date, like-7d
for last seven days,-1m
for last month,mStart
for start of the month oryStart
for the start of the year. - date_tostringDefault:
-7d
What date to filter the results to. Can either be a date
2021-01-01
, or a relative date, like-7d
for last seven days,-1m
for last month,mStart
for start of the month oryStart
for the start of the year. - breakdownstring
A property or cohort to break down on. You can select the type of the property with breakdown_type.
event
(default): a property keyperson
: a person property keycohort
: an array of cohort IDs (ie[9581,5812]
)
- breakdown_typeDefault:
event
Type of property to break down on.
event
- eventperson
- personcohort
- cohortgroup
- groupsession
- sessionhogql
- hogql
- compareboolean
To compare or not
- compare_tostring
What to compare to
- displayDefault:
ActionsLineGraph
How to display the data. Will change how the data is returned.
ActionsLineGraph
- ActionsLineGraphActionsLineGraphCumulative
- ActionsLineGraphCumulativeActionsTable
- ActionsTableActionsPie
- ActionsPieActionsBar
- ActionsBarActionsBarValue
- ActionsBarValueWorldMap
- WorldMapBoldNumber
- BoldNumber
- formulastring
Combine the result of events or actions into a single number. For example
A + B
or(A-B)/B
. The letters correspond to the order of theevents
oractions
lists.
Response
Request
POST
/api/projects/:project_id/insights/trend
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/insights/trend/\-d events=[{"id":"$pageview"}]
Response
Status 200
{"is_cached": true,"last_refresh": "2019-08-24T14:15:22Z","timezone": "UTC","result": [{"data": [0],"days": ["2019-08-24"],"labels": ["string"],"filter": {"events": [{"id": "string","properties": [{"type": "AND","values": [{"key": "string","value": "string","operator": "exact","type": "event"}]}],"math": "total"}],"actions": [{"id": "string","properties": [{"type": "AND","values": [{"key": "string","value": "string","operator": "exact","type": "event"}]}],"math": "total"}],"properties": {"type": "AND","values": [{"key": "string","value": "string","operator": "exact","type": "event"}]},"filter_test_accounts": false,"date_from": "-7d","date_to": "-7d"},"label": "string"}]}