Data Export
Nitro Studio Data Export is a tool that extracts raw data into scheduled or one-time reports. You can extract program data for users, missions, actions, and points and filter the data at a granular level. There are two types of reports:
- Transactional - Provides every row of data for the selected report category.
- Rollup - Provides sums, counts, and other metrics across data for the selected report category.
Data Export has a limit of 1,000,000 records. If you reach this limit, we recommend you split the data into smaller chunks and compile it in Excel after export. If you have an extremely large dataset and are interested in learning about custom report options, contact Nitro Support.
Manage Reports
The Data Export view lists your scheduled and one-time reports. Use this view to:
- Edit a report - Hover over a row and click the Edit button (
) on the right side of the row. You cannot edit one-time exports.
- Copy a report - Hover over a row and click the Clone button (
) on the right side of the view.
- Delete a report - Hover over a row and click the Delete button (
) on the right side of the row.
- View report status - Hover over the icon in the Status column. Status indicates Scheduled (
), Running (
), Generated Successfully (
), or Error (
). If the report errors, the system automatically retries at 15 and 90 minutes.
- View report details - Click the report name to expand its details.
- Download a report - Click the report name to expand its details, and then click Download File. Downloads expire after 7 days.
Import Report Data
Reports can be sent to email addresses but once created they can also be accessed programmatically via our standard REST APIs. This allows a CSV file containing report data to be ingested via a GET request and imported into a data warehouse utilizing custom code.
Once you've written and implemented custom code to move data to your data warehouse, that data can be turned into powerful measures, dimensions, and metrics that tell the story about your program's performance.
Common Use Case
You want all action, mission, and point transactions from the previous month available in your internal data warehouse. The high-level process is to:
-
Build a report in Data Export.
-
Note the report ID displayed in the Data Export list view after the report is created.
-
Your custom code makes a request using the /analytics-reports/{reportId}/downloads API on the first day of the month.
-
The report ID from step 2 is passed as a parameter in the API call.
-
The download URL for subsequent report GET requests is provided in the API response JSON body.
-
-
You make a GET request to the URL provided to download the report file.
API Example
In this example, 40287 is the report ID found in the Data Export list view.
API cURL Request
curl --location 'https://api.bunchball.com/analytics-reports/40287/downloads?' \
--header 'Authorization: ••••••'
Response
{"response":{"id":40287,"name":"Full User Export","downloads":[{"id":40287,"created_at":"2025-03-01T13:00:09.000Z","run_at":"2025-03-01T13:00:00.000Z","started_at":"2025-03-01T13:00:09.000Z","updated_at":"2025-03-01T13:01:13.000Z","details":null,"finished_at":"2025-03-01T13:01:13.000Z","request_id":"request-db493752-9502-44be-a09b-9daea371bbfc","status":"success","url":"https://bb-analytics-export-prod.s3.us-west-2.amazonaws.com/2/users/2025-02-28_to_2025-02-28/FullUserExport-request-db493752-9502-44be-a09b-9daea371bbfc.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256\\u0026X-Amz-Credential=AKIAIXOCWFKOV4R4PRHQ%2F20250301%2Fus-west-2%2Fs3%2Faws4_request\\u0026X-Amz-Date=20250301T130112Z\\u0026X-Amz-Expires=604800\\u0026X-Amz-SignedHeaders=host\\u0026X-Amz-Signature=8864fedfc32fb01dc8c131e57fbec3d122f9a411cd9c26198446d0645d403b4a"}]},"code":200}
Perform a GET request on the value provided in the “url” attribute to directly download the CSV file.
-
AWS returns the file URL parameter values as HTML escaped unicode characters. This will need to be replaced programmatically with their ASCII character representation, e.g. Unicode “\u0026” = “&” in ASCII so that the url above is accessed as https://bb-analytics-export-prod.s3.us-west-2.amazonaws.com/2/users/2025-02-28_to_2025-02-28/FullUserExport-request-db493752-9502-44be-a09b-9daea371bbfc.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIXOCWFKOV4R4PRHQ%2F20250301%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20250301T130112Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8864fedfc32fb01dc8c131e57fbec3d122f9a411cd9c26198446d0645d403b4a
-
If a report is based on a daily schedule, there may be 7 download files available in the API response. In this case, the most recent report will be the very latest report version available.
See also