How do I retrieve bulk metrics data for my organization?

Access and customize your organization’s metrics information.

Last updated on 28 Oct, 2025

The iDetail Bulk Metrics Export version 2 uses a custom URL unique to the organization to provide raw information about iDetail app sessions and events. With the Bulk Metrics Export:

You can select specific apps or all apps within an organization
You can specify which data columns are included in the export and their order. For a complete list, see What data does the bulk metrics export retrieve (data columns)?
You can set a specific date and time range for your query with the start_date and end_date parameters, or you can choose the yesterday parameter to retrieve only the previous day’s data
You can use your local time zone for the query and results

Data Format

The default format for separating values in the Bulk Metrics Export is comma-separated values (CSV).

Retrieval

The URL below is an example of the parameters retrieved by the Bulk Metrics Export query. This format could be used for a reoccuring routine that you would program to run daily on your server to capture the prior day’s use data.

URL format:

An example of how this URL might be implemented appears below:

Example URL:

Sample Data:

The first row of data returned is a header label, followed by data records.

Parameters to modify the output

The following parameters are available for shaping your organization’s bulk metrics query:

For more information

For more details about specific aspects of setting up and running the Bulk Metrics Export query, see the Related Articles below.

Click here to read more about Coordinated Universal Time (UTC).

Where do I find the base URL for my organization’s bulk metrics?

Metrics Export access for your organization is provided under "Settings" on the iDetail Web Service.

How do I set a date and time range for the bulk metrics export?

Use the "yesterday" parameter or the "start_time" and "end_time" parameters to set time and date ranges for your bulk metrics export.

How do I set the bulk metrics to retrieve all the historical data for my organization?

Retrieve all of the historical data for your organization by using a special case of the "start_time" parameter.

How do I set the bulk metrics export to retrieve data for different apps in my organization?

Use the bulk metrics export "apps" parameter to build queries for the different apps in your organization.

How do I set the bulk metrics export for my time zone?

You can retrieve bulk metrics data corrected for your organization’s time zone.

How do I retrieve selected fields of the metrics data?

Use the "columns" parameter to specify which data are included in the bulk metrics export and what order they will appear in.

What data does the bulk metrics export retrieve (data columns)?

See the list of data fields captured by the iDetail app.

How do I set up the bulk metrics export to retrieve only the previous day’s data?

The bulk metrics export has a parameter for retrieving the last 24 hours of use data.

Did you find this article helpful?

Where do I find the base URL for my organization’s bulk metrics?