WEweb2wave

Start user visits TSV export (async)

Queue a background job that exports users matching the User Visits page filters (date range, UTM, experiment, subscription status, etc.) as a TSV with all user properties as columns. Poll GET /exports/{id} until completed, then use download_url.

post/exports/user-visits

Request

  • Base URL
    https://api.web2wave.com/api
  • URL
    https://api.web2wave.com/api/exports/user-visits
  • Auth
    API key in header api_key

Headers

api_keystring required

Request body

fromstring

ISO date (inclusive, project timezone). Default last 7 days.

tostring
searchstring
utm_sourcestring
utm_mediumstring
utm_campaignstring
utm_contentstring
utm_termstring
has_eventstring
has_event_mode'has' | 'not_has'
subscription'has' | 'not_has'
user_country_codestring
user_propertystring
user_property_valuestring
user_property_mode'has' | 'not_has'
experimentstring

{experiment_id}-{variant_index}

Response

Export queued.

successinteger

Example response

{
  "export": {
    "type": "subscriptions",
    "file_name": "subscriptions_export_2026-05-20_18-30-00.tsv",
    "file_size_human": "12.4 MB",
    "mime_type": "text/tab-separated-values"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.