exports

post/api/projects/{project_id}/exports/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/exports/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

idinteger required
dashboardinteger nullable
insightinteger nullable
export_format'image/png' | 'application/pdf' | 'text/csv' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'video/webm' | 'video/mp4' | 'image/gif' | 'application/json' required
  • image/png - image/png
  • application/pdf - application/pdf
  • text/csv - text/csv
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • video/webm - video/webm
  • video/mp4 - video/mp4
  • image/gif - image/gif
  • application/json - application/json
created_atstring date-time required
has_contentboolean required

Whether the export finished and its content is ready to download. Create can return before the export finishes; poll the asset until has_content is true or exception is set.

export_contextunknown
filenamestring required
expires_afterstring date-time nullable required
exceptionstring nullable required
user_access_levelstring nullable required

The effective access level the user has for this object

Response

idinteger required
dashboardinteger nullable
insightinteger nullable
export_format'image/png' | 'application/pdf' | 'text/csv' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'video/webm' | 'video/mp4' | 'image/gif' | 'application/json' required
  • image/png - image/png
  • application/pdf - application/pdf
  • text/csv - text/csv
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • video/webm - video/webm
  • video/mp4 - video/mp4
  • image/gif - image/gif
  • application/json - application/json
created_atstring date-time required
has_contentboolean required

Whether the export finished and its content is ready to download. Create can return before the export finishes; poll the asset until has_content is true or exception is set.

export_contextunknown
filenamestring required
expires_afterstring date-time nullable required
exceptionstring nullable required
user_access_levelstring nullable required

The effective access level the user has for this object

Changes

No recorded changes to this operation across all 1 revision of this API.