provider batch_exportsbatch_exports POST /api/organizations/{organization_id}/batch_exports/
@utdk/posthog /api/organizations/{organization_id}/batch_exports/
org_organizations_batch_exports_create
organization_id path required
ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.
string

Try it

Authentication
Configure credentials for PostHog API
orgOrganizationsBatchExportsCreate
POST/api/organizations/{organization_id}/batch_exports/

Parameters

required

ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.

Input

required

Human-readable name for the batch export.

Which data model to export (events, persons, sessions). * `events` - Events * `persons` - Persons * `sessions` - Sessions

required

Destination configuration. Required integration_id is enforced per destination type.

required

How often the batch export should run. * `hour` - hour * `day` - day * `week` - week * `every 5 minutes` - every 5 minutes * `every 15 minutes` - every 15 minutes

Whether the batch export is paused.

Optional HogQL SELECT defining a custom model schema. Only recommended in advanced use cases.

Optional list of property filters to restrict which events are exported. Each filter is a serialized HogQL property filter object with a 'type' of one of: 'event', 'hogql', 'person' (e.g. {"key": "$browser", "operator": "exact", "type": "event", "value": ["Firefox"]}).

IANA timezone name (e.g. 'America/New_York', 'Europe/London', 'UTC') controlling daily and weekly interval boundaries.

Day-of-week offset for weekly intervals (0=Sunday, 6=Saturday).

Hour-of-day offset (0-23) for daily and weekly intervals.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.orgOrganizationsBatchExportsCreate()