Required Fields

This describes the minimum required fields Odyssey Attribution needs in order to run its analysis. Each row represents one session of one client. All sessions should be provided even when no transaction occurred. The data types referred to in the type column can be found here.

Field

Type

Description

Info

Example

Required

ClientId/VisitorId

STRING

A field that identifies a unique user on the website.

zRax8NvwuRE9rR5EpACEknJ46

Yes

SessionId

STRING

A field that identifies the 'session' for the user.

What a session is can be open for interpretation. https://support.google.com/analytics/answer/2731565

1606898496

Yes

VisitId

INTEGER

A counter that increases every session for this user.

Used for determine the order of sessions by this user

1

Yes

VisitStartTime

INTEGER

Timestamp of the start of this session.

Unix Timestamp

1606898496

Yes

Date

DATE

The date of the session

Unix Timestamp

1606898496

Yes

TrafficSource

RECORD

Information about the traffic source that can be attributed to having caused this session.

Yes

TrafficSource.campaign

STRING

Campaign

Often the utm_campaign value

Brand - Exact

No

TrafficSource.source

STRING

Source

Often the utm_source value or referrer

Google Ads

No

TrafficSource.medium

STRING

Medium

Often the utm_medium value

cpc

No

TrafficSource.keyword

STRING

Keyword

Often the utm_keyword value

Odyssey Attribution

No

TrafficSource...

STRING

-

Any other value that identifies the source that attributed this session

-

No

Transactions

REPEATED

transactions that happend this session

No

Transactions.transactionId

STRING

Unique identifier for this transaction

NL12345

Yes

Transactions.transactionrevenue

FLOAT

The transaction revenue

Tax and shipping excluded

20.35

Yes

Transactions.transactiontax

FLOAT

The transaction tax

1.25

No

Transactions.transactionshipping

FLOAT

The transaction shipping

3.95

No

Storing the data in BigQuery

We recommend storing the sessions a dataset with partitioned tables. Partitioned by the date the session occured. For setting up partitioned tables see the following documentation: https://cloud.google.com/bigquery/docs/partitioned-tables

Sharing the dataset

Odyssey Attribution uses service accounts to access datasets. Please share the dataset by giving the following service workers the roles/bigquery.dataEditor role.

Did this answer your question?