Purpose
This article describes creating, formatting, and uploading a web/app response file.
If you need to manually upload a web or app response file, you can upload the data in a flat CSV, XLS, XLSX, ZIP, TAR, or GZ file.
Formatting guidelines
| How should I format my response file? | |||
| ✓ | Include all required columns | ✕ | Mix data formats in a column |
| ✓ | Make sure all columns have a heading | ✕ | Place words in number fields |
| ✓ | Ensure data formats are consistent by column | ✕ | Include empty fields in required data columns |
| ✓ | Include only a header row and data within the file | ||
| IMPORTANT | |
|
Required data
- The datetime/datadatetime column must be included for any attribution to happen.
- The datetime format should be as shown, YYYY-MM-DDThh:mm:ss, as this is the most acceptable for our platform.
Note: The date and time are separated by a T. Make sure you include the T in the datetime format. - Include sessions, which shows the total number of sessions or actions measured.
- If you want to include product types, we recommend less than 10. Any more than this, they will not load properly in the pivot tables.
- If your spot file uses a TV promocode, you can include the same code in the Promocode column in the response file, achieving even higher attribution.
- If you are a client in the U.S. using regional attribution, you must include the IP address or the zip code.
- If you are a client in Australia using regional attribution, you must include the postcode.
Note: While the IP address is not required to upload responses, it is required to provide OTT attribution and deterministic linear modeling.
InnovidXP can accept the file in the following groupings:
- Session is the preferred format and consists of a session-by-session breakdown of traffic, including user reference, promo code, session ID, user IP address, and other information that can increase attribution accuracy or enable certain features such as the lag model.
Note: Sessions will be deduplicated based on timestamp. - Minute consists of a minute-by-minute count of the sessions and actions on your site or app.
Measuring KPIs/actions
To measure any actions other than web visits, for example, sales, registrations, etc, you must include these actions within the file. Each action can have several fields:
- Action occurred (required)
- Total spent by the customer
- Product type related to action: we recommend including less than 10 product types. Otherwise, they won't load in the Pivot tables
- Promocode used: promocodes are matched against the spot data, and including them will result in much higher attribution
For each action, replace <ENTER ACTION> with the name of the action to be recorded. This name will be shown on the platform.
Example:
action_<ENTER ACTION> becomes action_sale with a value of 0 for no sale and 1 to indicate a sale has occurred.
The following tables list the required and optional column formats for actions:
| Required | ||
| Description | Column name | Format |
| Action occurred | action_<ENTER ACTION> | 0 or 1 |
| Optional (for Sessions groupings) | ||
| Description | Column name | Format |
| Total spent by customer | value_<ENTER ACTION> | Decimal number |
| Product Type | product_<ENTER ACTION> | Text |
| Promocode | promo_<ENTER ACTION> | Text |
| Optional (for Minutes groupings) | ||
| Description | Column name | Format |
| Total revenue for action | revenue_<ENTER ACTION> | Decimal number |
| Product Type | product_<ENTER ACTION> | Text |
Session Format
The session's date and time are required, but any additional information you can provide will add more value to the attribution.
It is important to note that the DateTime format doesn't have to match the file exactly, but the format of YYYY-MM-DDThh:mm:ss is the most acceptable for our platform, with the date and time separated by a T.
For example, 2023-01-01T13:45:30 for January 1st, 2023, at 1:45:30PM.
Make sure you include the T in the DateTime format.
| IMPORTANT |
| For web/app session files, make sure your file is in UTC (GMT) timezone format. |
The following tables list the required, conditional (recommended), and optional column formats for session groupings:
|
Required |
|||
| Description | Column name | Format | Alternative column names |
| Session Start Date and Time | sessiondatetime | YYYY-MM-DDTHH:MM:SS | datetime, datadatetime |
|
Conditional |
|||
| Description | Column name | Format | Alternative column names |
| User IP address | useripaddress | IP Address | useraddress, ipaddress, ip |
| User ID | userid | Text | userref |
|
Optional |
|||
| Description | Column name | Format | Alternative column names |
| Session ID | sessionid | Text | sessionref |
| Country | usercountry | Text | country |
| State | userstate | Text | state |
| City | usercity | Text | city |
| ReferrerURL / Search Text | referrer | Text | refurl |
| Device Type | device | Text | |
| Source Type | sourcetype | Text | |
| Search Keywords | keywords | Text | |
| Online Marketing Campaign | campaigncode | Text | |
Additional Information
- useripaddress or usercountry is used to filter out non-national traffic.
- userid can be used for our lag setting.
- sourcetype is a critical column that filters out 'out of scope' traffic. It can contain 'direct,' 'orgsearch,' 'paysearch,' 'campaign,' 'banner,' 'affiliate', or 'out of scope.' The attribution only focuses on direct, orgsearch, and paysearch traffic.
| IMPORTANT |
| If sourcetype is left blank, sessions will be classified as "Out of scope". |
Minute Format
The other format we accept is a minute-by-minute count of the sessions and actions on your site or in your app. The only action metadata that can accompany this is 'revenue_<ACTION NAME>,' which corresponds to the total revenue for the actions taking place that minute.
The following table lists the required column formats for minute groupings:
|
Required |
|||
| Description | Column name | Format | Alternative column names |
| Data Date and Time | datadatetime | YYYY-MM-DDTHH:MM:SS | datetime, datadatetime |
| Sessions / Actions Measured | sessions | Whole number | Responses, count |
Example:
How to upload your web/app response file
Complete the following steps, which apply to all file formats:
- Select Data > Responses > Upload File to display the Upload Response File screen.
- Select the type of grouping for Web, Phone, App, or SMS. A dropdown for each format lets you select how your file is grouped: by Session or Minutes, or Individual or Summary.
- Select Continue to Select File.
- In the Upload page, drag and drop your file into the upload bar or use the Select File button to search for a file to upload.
- Select Upload File to start the upload and select Finished when complete.
Need help?
If you have received an email advising that your Web/App sessions response file upload has failed, read the guidelines above to ensure your file is formatted correctly and includes all the required information, and try again. Use the example file below as a reference, and we have created a downloadable template to get you started.
Example file
Related content
Uploading Phone/SMS Response Files
Uploading Spot Files