HIPE icon

HIPE

Interact with HIPE API

export → Create

AI-generated

Summary

Create a new export in the system by specifying the export type, optional start and end dates, and an optional list of user IDs to include in the export.

Inputs

  • Type (required) — The numerical type of export to create; determines the export's category or format.
  • Start Date — An optional ISO-formatted start date to define the beginning of the export's data range.
  • End Date — An optional ISO-formatted end date to define the end of the export's data range.
  • User IDs — An optional list of user IDs to filter which users' data will be included in the export.

Output shape

a single JSON object representing the created export entity with its details returned from the API

The exact structure of the returned export object depends on the API response and includes identifiers, status, and metadata about the export. There is no indication of pagination or streaming; one export object is returned per execution.

Links

Discussion