Skip to content

Exports

API information

The export resource is managed by the Exports API.

XPKit Portal

It is recommended exports are performed in XPKit Portal, rather than making direct API requests.

Service URLs

Region URL
AMER https://exports.amer.xpkit.net
APAC https://exports.apac.xpkit.net
China https://exports.china.xpkit.cn
EMEA https://exports.emea.xpkit.net

OpenAPI Specification

Resource name Documentation Download
Export View Link

Example export

{
    "experience_id": "developer-conference-2022",
    "activity_type": "registration",
    "timezone": "Australia/Sydney",
    "update_datetime": "yes",
    "name": "Daily registrations for W/C 7th Dec 2022",
    "notify": "sarah.jones@abc.com",
    "start_date": "2022-12-07",
    "end_date": "2022-12-07",
    "profile_fields": [
        "id",
        "title",
        "first_name",
        "last_name",
        "email"
    ],
    "activity_fields": [
        "id",
        "experience_id",
        "activity_type",
        "payload.object_id",
        "created"
    ],
    "export_type": "list",
    "schedule_type": "multiple",
    "schedule": {
        "frequency": "daily",
        "runtime": "22:00:00",
        "start_date": "2022-12-07",
        "stop_date": "2022-12-14"
    }
}

Export types

  • An export_type field can be provided with a value of either count or list. If not provided count will be used.
  • By default the following profile fields are included in the export:
    • id
    • title
    • first_name
    • last_name
    • email
    • rfid
    • qr_code
  • To overwrite this a profile_fields array can be provided in the request (id is mandatory).
  • If a list export is requested the following activity fields are included in the export:
    • id
    • experience_id
    • created
    • activity_type
    • last_modified
    • payload.object_id
  • To overwrite this an activity_fields array can be provided in the request (id is mandatory).

Export scheduling

The schedule_type field can be set to either single or multiple for recurring exports. If multiple exports are required a schedule object is required that specifies the frequency.

If multiple is selected you can pass in an update_datetime field. If set to yes, the start and end dates will automatically update to the current date (at run time). Useful for end-of-day reports.

Notes on exports

  • The Exports API provides an endpoint that triggers an export task asynchronously. It returns a job ID (which can be used to query the job's status using the Jobs API).
  • Once finished an email is sent (to the address provided in the notify field) containing the download (XPKit Portal) link.
  • A timezone can be provided so lookups are performed using a specific timezone. The generated export file will display activity created and last_modified timestamps in the provided zone. If no timezone is supplied UTC will be used.
  • Exports are deleted 30 days after creation so ensure you download them within this time period.