Campaign Dispatches Version 1

Suggest Edits

The documentation presented in this document refers to the table that contains per dispatch records from Siprocal's platform to our clients. In other words, each entry on this table should ideally become an impression if all the steps on the funnel converted 100%

This table's data are collected server-side. Besides timestamp, campaign ID and targeted user, there are also some additional information such as preload campaign information if applicable.

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.

organizationid

Type: STRING

Description

Partner ID for Siprocal. Internal purposes.

Value Example

abc1abc1abc1abc1abc1abc1

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

organizationname

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

campaignid

Type: STRING

Description

ID of the campaign sent

Value Example

5fdd1f98402b31033f418d4c4c

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

source

Type: STRING

Description

Source of the campaign. Internal purposes. Explanation for each value is in the "source Meanings" tab of this document.

Value Example

R

Possible Values (if category)

T
R

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

Possible Value Descriptions

  • A - [DEPRECATED]
  • R - Regular Campaign Flow, through approval process
  • T - Test push
  • unknown - [DEPRECATED]

senttime

Type: BIGINT

Description

Timestamp of the campaign being sent from our server. Unix Timestamp Format in miliseconds.

Value Example

1602873633689

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

enddate

Type: BIGINT

Description

End date of the campaign. Unix Timestamp Format in Seconds.

Value Example

1603083600

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

preloadflag

Type: BOOLEAN

Description

If the Ad is part of the Virtual Preload Install

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

slotnum

Type: INT

Description

Sequence number of the ad inside the adbundle. Only relevant for preload campaigns

Value Example

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

None

adbundleid

Type: STRING

Description

ID which contains one or more virtual preload install ads. Only relevant for preload campaigns

Value Example

1689640485502

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

totalslots

Type: INT

Description

Total number of ads present in a bundle. Only relevant for preload campaigns

Value Example

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

None

adid

Type: STRING

Description

[DEPRECATED] Same as campaignid

Value Example

63d17ab4534e24795f3f0773a0

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

jobid

Type: STRING

Description

Batch ID through which the campaign is delivered. Siprocal internal purposes

Value Example

64a3423d5e6a27414eadd3177_0_9

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

20201016

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