Locations Version 1

The documentation presented in this document refers to the table that contains location data collected from devices where Siprocal's SDK is installed. To collect this information, the device must have accepted the ACCESS_COARSE_LOCATION permission. The ACCESS_FINE_LOCATION permission improves the accuracy of the location samples and the ACCESS_BACKGROUND_LOCATION permission allows for collecting this sample even when the app isn't foregrounded. Please read the relevant SDK documentation for more details

The table contains historical data for locations collected.

IMPORTANT:

Some location samples might appear multiple times (the same sample). For some analyses it is important to remember to remove these duplicates.
Please note that there are some [DEPRECATED] fields, you can safely ignore them, even though they will be present in the data exchange. Deprecated fields refer to fields that were collected in the past, and are either not available anymore or cannot be captured for any reason. They are still kept on the database for backwards compatibility reasons;
[EXPERIMENTAL] features are undergoing active development and their definition or collection method may change at any moment without prior notice. We ask not to rely on them for decision making and reporting
Field data collection is made on a best effort basis. Since there are many permisson and device configuration scenarios, it is not possible to guarantee full data collection.

`clientid`

Type: STRING

Description

ID that identifies the users' device (deviceId, idfv or google_gaid). Devices may have the string "DR-" added as a prefix to them. This should be removed if willing to match to external sources.

Value Example

6e3c68ee-9003-4710-9caf-35e742cfab66

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

`location`

Type: STRING

Description

Geographical location. This field is composed, in order, by: country, region, locality, city, postal code. All lower case and divided by commas.

Value Example

brazil, state of são paulo, na, são paulo, 12345-123

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

ACCESS_COARSE_LOCATION

`latitude`

Type: STRING

Description

Latitude of collected location sample. This field can appear as 'na', therefore it's string formatted.

Value Example

23.1386610

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

ACCESS_COARSE_LOCATION

`longitude`

Type: STRING

Description

Longitude of collected location sample. This field can appear as 'na', therefore it's string formatted.

Value Example

-48.1291551

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

ACCESS_COARSE_LOCATION

`horizontalaccuracy`

Type: DOUBLE

Description

Accuracy of location data the horizontal plane (latitude and longitude). Value is the radius (in meters) around the coordinate in which there is 68% chance of containing the device. If unavailable, defaults to 0.0.

Value Example

10.0

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

ACCESS_COARSE_LOCATION

`verticalaccuracy`

Type: DOUBLE

Description

Accuracy of location data the vertical plane (altitude). Value is the vertical distance (in meters) around the altitude coordinate in which there is 68% chance of containing the device. If unavailable, defaults to 0.0.

Value Example

10.0

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

ACCESS_COARSE_LOCATION

`altitude`

Type: DOUBLE

Description

Altitude collected from location sample. Value in meters. If unavailable, defaults to 0.0.

Value Example

817.60

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

ACCESS_COARSE_LOCATION

`mockedlocation`

Type: BOOLEAN

Description

Whether the sample is a location fabricated by the device. The accuracy of this field is not guaranteed since there is no prevention from devices attempting to mask this information

Value Example

true

Possible Values (if category)

true
false

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

ACCESS_COARSE_LOCATION

`samplecollectiontime`

Type: BIGINT

Description

Timestamp when the location sample was collected. Unix timestamp in miliseconds.

Value Example

1666633986704

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

ACCESS_COARSE_LOCATION

`org`

Type: STRING

Description

Human readable partner ID for Siprocal. Internal purposes.

Value Example

tim brasil

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None

`timestamp`

Type: BIGINT

Description

Date when the data was received in the Siprocal servers. Formatted as an integer with the date values ass YYYYMMDD

Value Example

20230720

Possible Values (if category)

Android API Permissions

Technical permission needed to collect the information. Please note this is not a comprehensive list, check the relevant SDK documentation for details

None