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.

Last updated on 28 Oct, 2025

You can set your organization’s bulk metrics query to retrieve a subset of the total data collected by using the columns parameter to specify what data columns you want to include. All data columns are retrieved if the columns parameter is not included in the query.

The Example URL show a sample URL query using the columns parameter. Multiple data columns are concatenated using a pipe character “|”. The order of the data output will be the same as the order you put the columns in.

Note: In the Example URL, the apps parameter is using “all-active” instead of an api key. Setting this parameter retrieves data for all active apps in the organization.

Example URLs and Sample Data:

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

If no columns parameter is specified, the default order of the columns is listed below.

session_id
session_record_timestamp
session_opened_time
session_closed_time
user_id
user_name
app_name
app_identifier
app_version
session_latitude
session_longitude
session_location_blocked
session_idetail_version
session_ios_version
event_id
event_time
event_duration
event_container_id
event_container_name
event_container_type
event_component_id
event_resource_number
event_resource_name
event_resource_type
event_record_timestamp
metadata

How do I retrieve bulk metrics data for my organization?

Access and customize your organization’s metrics information.

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.

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?

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