Trend

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

Create

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/.

Query Parameters

  • format
    string
    One of: "csv""json"

Request Parameters

  • events
    Click to open
    array

    Events to filter on. One of events or actions is required.

  • actions
    Click to open
    array

    Actions to filter on. One of events or actions is required.

  • properties

    Filter events by event property, person property, cohort, groups and more.

  • filter_test_accounts
    boolean

    Whether to filter out internal and test accounts. See "project settings" in your PostHog account for the filters.

  • date_from
    string
    Default: -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 or yStart for the start of the year.

  • date_to
    string
    Default: -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 or yStart for the start of the year.

  • breakdown
    string

    A property or cohort to break down on. You can select the type of the property with breakdown_type.

    • event (default): a property key
    • person: a person property key
    • cohort: an array of cohort IDs (ie [9581,5812])
  • breakdown_type
    string
    Default: event
    One of: "event""person""cohort""group""session""hogql"

    Type of property to break down on.

  • display
    string
    Default: ActionsLineGraph
    One of: "ActionsLineGraph""ActionsLineGraphCumulative""ActionsTable""ActionsPie""ActionsBar""ActionsBarValue""WorldMap""BoldNumber"

    How to display the data. Will change how the data is returned.

  • formula
    string

    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 the events or actions lists.

  • compare
    boolean

    For each returned result show the current period and the previous period. The result will contain compare:true and a compare_label with either current or previous.

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" \
https://app.posthog.com/api/projects/:project_id/insights/trend/\
-d events=[{"id":"$pageview"}]

Response

Status 200
RESPONSE
{
"is_cached": true,
"last_refresh": "2019-08-24T14:15:22Z",
"timezone": "Africa/Abidjan",
"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"
}
]
}

Questions?

Was this page useful?