Table Of Contents

Previous topic

25.19. deploygame

Next topic

26. The Turbulenz Developer Client

This Page

25.20. exportevents

25.20.1. Usage

Syntax

exportevents [options] project

Export event logs and anonymised user information of a game.

25.20.2. Options

--version

Show version number and exit.

--help, -h

Show help message and exit.

--verbose, -v

Verbose output.

--silent, -s

Silent running.

--user=USER, -u USER

Hub login username (will be requested if not provided).

--password=PASSWORD, -p PASSWORD

Hub login password (will be requested if not provided).

--type=DATATYPE, -t DATATYPE

The type of data to download, either events or users (defaults to events).

--daterange=DATERANGE, -d DATERANGE

Individual ‘yyyy-mm-dd’ or range ‘yyyy-mm-dd : yyyy-mm-dd’ of dates to get the data for (defaults to today). This range gets clamped from when the project was created to today. The range of data queried is from midnight UTC at the start of the start date to either midnight UTC at the end of the start date (if only one date is given) or midnight UTC at the end of the end date.

--outputdir=OUTPUTDIR, -o OUTPUTDIR

Folder to output the downloaded files to (defaults to the current directory).

--overwrite, -w

If a file to be downloaded exists in the output directory, overwrite instead of skipping it.

--indent

Apply indentation to the JSON output.

--hub=HUBURL

Hub url, defaults to https://hub.turbulenz.com/.

25.20.3. Example

exportevents sampleapp -v -o sampleapp\events

When exporting user information:

exportevents sampleapp -v -o sampleapp\users -t users

Note

When exporting user information, the date range specified returns only the users acquired (i.e. who first played the game) during that time period.

Note

Entries in the downloaded user information may contain an additional isTurbulenz or isDeveloper flag. The isTurbulenz flag will be set for anyone who is a Turbulenz employee. The isDeveloper flag will be set for anyone listed as a game team member via the project Edit tab on the Hub.

Note

When requesting a daterange which includes the current day the output files will contain data up to the current point in time. The filenames will reflect the exact time range which was queried, and thus running the query multiple times will generate different filenames with potentially different events.

Note

All times and dateranges should be specified in UTC, all resulting metrics also specify times in UTC.