Campaign Metrics Version 1

Suggest Edits

The documentation presented on this page refers to the table that contains records of campaign dispatches along with with information such as impressions, clicks, and other campaign actions and metrics.

The data for a given dispatch is only fed to this table if the ad opportunity was "completed" - either successfully clicked, or error, or expired. Thus ongoing campaigns will have an undercount of impressions, given that impression alone does not trigger a synchronization from the device to the server.

Note: as of September 2023, there are ongoing developments to add entries to this table as soon as an ad is rendered to improve real-time campaign steering. If such change passes, then analytical code must ensure to consider only a single impression per adid.

IMPORTANT:

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.

`adid`

Type: STRING

Description

Unique reference to the campaign/clientid/batch inside the platform. Important: Differs from field with same name on Campaign Dispatches table

Value Example

5fd15987cdae4e00013df2e4

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

`campaignid`

Type: STRING

Description

ID of the campaign associated with the ad

Value Example

5fd0f23c6ab07d00015476a7

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

`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

`srcpkg`

Type: STRING

Description

Name of the app package on which ad was displayed

Value Example

br.com.timbrasil.meutim

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

`displayed`

Type: BOOLEAN

Description

Set to true when either "adcontainershown" or "adnotifcationshown" is true. Only applies to Push Notification or Push + In App type ads

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

None

`displaytimeepoch`

Type: BIGINT

Description

Timestamp of when the ad was displayed to the user. Unix Timestamp in seconds format.

Value Example

1607605221

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

`addeliverytimeepoch`

Type: BIGINT

Description

Timestamp of when the ad delivery occurred. Unix Timestamp in seconds format.

Value Example

1607555463

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

`clicked`

Type: BOOLEAN

Description

Indicates whether the user clicked on the ad

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

None

`dismissed`

Type: BOOLEAN

Description

Indicates whether the ad was dismissed by the user

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

None

`videowatched`

Type: BOOLEAN

Description

Indicates whether the video ad was watched by the user. Only applies to In-App type ads.

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

None

`appinstalled`

Type: BOOLEAN

Description

Indicates whether the app associated with the ad was installed by the user. Relevant only for preload campaigns

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

None

`videopercentage`

Type: DOUBLE

Description

The percentage of the video ad watched by the user (0.0 to 100.0). Only applies to In-App type ads.

Value Example

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

`apkdownloaderroroccurred`

Type: BOOLEAN

Description

Indicates whether an error occurred during APK downloading the app. Relevant only for preload campaigns

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

None

`aderroroccurred`

Type: BOOLEAN

Description

Indicates whether any general error occurred during the Ad journey

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

None

`aderrorreason`

Type: STRING

Description

The reason for the general error ocurred during the Ad journey, if any

Value Example

Notification not enabled.

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

`actioncomplete`

Type: BOOLEAN

Description

Indicates whether the user interacted with the CTA button

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

None

`dragged`

Type: BOOLEAN

Description

Indicates whether the user dragged the ad. Only applies to In-App type ads.

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

None

`settingspressed`

Type: BOOLEAN

Description

Indicates whether the settings button was pressed when showing the ad. Only applies to In-App type ads.

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

None

`optoutrequested`

Type: BOOLEAN

Description

Indicates whether the user requested to opt-out from further ads

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

None

`notificationaction`

Type: BOOLEAN

Description

Indicates whether any action was performed on the notification. Only applies to Push Notification type ads.

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

None

`senttokafka`

Type: BOOLEAN

Description

Indicates whether the kafka message was a success, information added at the server. Internal purposes.

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

None

`geofenceexited`

Type: BOOLEAN

Description

Indicates whether the user visited the geo fence configuration

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

None

`actiontime`

Type: BIGINT

Description

The timestamp in seconds when the click action related to the campaign event occurred. Unix Timestamp in seconds format.

Value Example

1586754150

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

`addownloaded`

Type: BOOLEAN

Description

Indicates whether the device downloaded the campaign metadata (API Payload)

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

None

`adcontentdownloaded`

Type: BOOLEAN

Description

Indicates whether the device downloaded the ad assets (images, video, etc)

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

None

`adnotificationshown`

Type: BOOLEAN

Description

Indicates that the notification was rendered on the device. This flag does not ensure viewability

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

None

`adcontainershown`

Type: BOOLEAN

Description

Indicates whether the InApp message is shown. Only applies to In-App type ads.

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

None

`adintermediate`

Type: BOOLEAN

Description

True when the ad (addelivery API call) and assets (AdReady) have been downloaded by the device

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

None

`updatetimestamp`

Type: BIGINT

Description

Timestamp of when the information was updated. Unix Timestamp format.

Value Example

1586717471152

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

`adcontenterror`

Type: BOOLEAN

Description

Indicates whether the ad Images / Video download fails

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

None

`organization`

Type: STRING

Description

Human readable partner ID for Siprocal. All capslock. Internal purposes.

Value Example

VIVO

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

`closemethod`

Type: STRING

Description

The method used to close or dismiss the campaign ad (if applicable)

Value Example

Possible Values (if category)

SWIPE
X
BACK
TRASH
HOST_SWIPE
SETTINGS
SWIPE_CLEAR
AUTO_SWIPE_EXPIRY
NONE
OPENEDNEWNOTIFICATION
PUSH_REWARDS_OK
DESTROYED
PUSH_REWARDS_BACK

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

`installedapps`

Type: STRING

Description

[DEPRECATED] This information is currently located in the Installed Apps Table (Data Exchance Product)

Value Example

None

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

`country`

Type: STRING

Description

[DEPRECATED] This information is currently located in the Locations Table (Data Exchance Product)

Value Example

None

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

`region`

Type: STRING

Description

[DEPRECATED] This information is currently located in the Locations Table (Data Exchance Product)

Value Example

None

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

`locality`

Type: STRING

Description

[DEPRECATED] This information is currently located in the Locations Table (Data Exchance Product)

Value Example

None

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

`sublocality`

Type: STRING

Description

[DEPRECATED] This information is currently located in the Locations Table (Data Exchance Product)

Value Example

None

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

`postalcode`

Type: STRING

Description

[DEPRECATED] This information is currently located in the Locations Table (Data Exchance Product)

Value Example

None

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

`latitude`

Type: STRING

Description

[DEPRECATED] This information is currently located in the Locations Table (Data Exchance Product)

Value Example

None

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

`longitude`

Type: STRING

Description

[DEPRECATED] This information is currently located in the Locations Table (Data Exchance Product)

Value Example

None

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 as YYYYMMDD

Value Example

20201211

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

Updated 9 months ago