Exporting Data
Angelfish offers a few ways to export data:
- Export Button: save data from individual reports & import to a desktop application
- The QA Method: export custom report data, as needed
- API: export custom report data into 3rd party dashboards, databases, and visualization tools
The correct option to use depends on the scenario!
Export Button
The Export button lets you save report data to text file in a selected format (CSV, TSV, JSON, XML). You can import this file into a desktop application, like a spreadsheet.
Most reports in Angelfish have an Export button on the right side of the report header bar, below the line graph.
Click the button to see options.
- All Rows: exports the entire report dataset
- Shown Rows: only exports the rows currently shown in the datatable
The QA Method
The QA method is the easiest way to export custom data from Angelfish without having to use an API script. And yes, our QA team uses this option to test Angelfish.
Here's how it works:
- Determine the Dimensions & Metrics you want to export
- Configure filter settings in an existing, similar report
- Copy the API request for the report
- Edit the request to match the Dimensions & Metrics you want to export
- Paste the edited API request in a new browser tab
Let's walk through a full example of the QA Method.
The objective for this example is to export:
- Dimensions: Excel Documents and Usernames, by Day
- Metrics: Pageviews & Unique Views
Login to Angelfish, open the relevant Profile, and open the Documents report.
Next, open by your Browser's Developer Tools (press F12) and select the Network tab - this shows you the data API requests made when a report is requested.
Type "xlsx$" (no quotes) in the report filter field and press Enter. You will see a new request in the Network tab - copy this request and paste it into a text editor (e.g. notepad). The request will look something like this:
From here we need to add Dimensions, edit the Metrics, and update other settings. Use the API Field Reference help articles to determine the correct names to use for additional Dimensions and Metrics, and use %2C between each Dimension field name.
Here's what the edited request looks like - this request creates the export described in the objective:
Parameters you can change include:
- ids: the ID of the Profile
- dimensions: the Dimensions shown in the report | export
- metrics: the Metrics shown in the report | export
- start-time: starting date & time for the date range
- end-time: ending date & time for the date range
- max-results: the number of result rows in the export
- format: the format of the export - options are csv, tsv, xml, json, jsonfields
We recommend using an existing report to configure the "filter" and "sort" parameter settings.
Once you have the edited request, open a new browser tab and paste the request - the data will appear in the brower, or in a downloaded file.
You can bookmark the request, update it for a different Profile or date range, and re-use it as a template for future QA Method requests.
You can combine any Dimension & Metric with the QA Method - check the API documentation for other fields to use.
API
Internally, Angelfish uses a RESTful API for all data requests. Externally, 3rd party applications and scripts can request data from the same API.
Please visit the API section of the Help Center to learn how to use the Angelfish API:
Help Article: API Section