External Web

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

Get an overview of web analytics data.

Create external web analytics summary

Required API key scopes

query:read

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

Request parameters

  • date_from
    string
  • date_to
    string
  • explicit_date

Response


Request

POST /api/projects/:project_id/external_web_analytics/summary
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/external_web_analytics/summary/\
	-d date_from="string",\
	-d date_to="string"

Response

Status 200
RESPONSE
{
  "data": {},
  "error": null,
  "status": "success"
}

Community questions

Was this page useful?