Skip to main content
Version: v1

Create Export

POST /segments/v1/exports

Schedules an export based on the provided segment. The progress and results of the export can be fetched from the operations API.

Segment Export is an Enterprise or Advanced pricing tier add-on. See pricing page for more details.

Export Types​

Two types of segment-related data are available: individuals and events.

Individual Exports​

An individual export will contain information about each of the individuals that match the provided segment. The fields that are available through this export are documented here.

Event Exports​

An event export will contain events performed by individuals that match the provided segment. The fields that are available through this export are documented here. Events are selected based on the type parameter. In order of increasing scope:

  • TYPE_EVENT: only events that match the segment's event criteria.
  • TYPE_PAGES: all events from each page where users performed matching event criteria.
  • TYPE_SESSIONS: all events from each session where users performed matching event criteria.
  • TYPE_INDIVIDUAL: all events for each individual who performed matching event criteria.

Time Ranges​

There are two time ranges that can be specified for an export: time_range and segment_time_rangeAll segments, as defined in Fullstory, have a time range associated with them. This time range is used to determine how the search filters apply to the data. For example, as segment may be defined to include events for users who visited a page in the last 30 days. The time_range parameter is used to filter the data for the provided segment. Using the previous example, 30 days of data could be many GB of data. The time_range parameter can be used to limit the export to a smaller,more manageable file. If the segment does not include a large amount of data, the time range start and end can be set to empty strings to include all data. The segment_time_range parameter can be used to override the segment's time range. The most common use case for this is for bulk data export, which should use the "everyone" segment and override the segment's time range (which defaults to the last 30 days) to match the time_range parameter. Another example would be if a segment is defined as the last 30 days, but a specific month's worth of data is required. In this case, the segment_time_range would be set to the specific month's time range and the time_range would be used to break the data into smaller chunks.

Additional Information​

Request​

Responses

200

A successful response.