# Optimise
# Introduction
The Optimise module enables automatic collection of data from your advertising system.
# An example of operation
- We configure the module in the platform by granting access to the Optimise
- We set the module on the schedule - the data will be collected and stored in witcloud dataset
- After the table is processed, you can use other reporting modules or combine it with analytics
# Data schema
After starting the module,new table will appear in the WitCloud dataset:
optimise_conversions
Expand for the data schema
Field name | Type | Mode |
---|---|---|
uniqueId | STRING | NULLABLE |
conversionId | STRING | NULLABLE |
advertiserRef | STRING | NULLABLE |
agencyId | STRING | NULLABLE |
legacyId | STRING | NULLABLE |
publisherId | STRING | NULLABLE |
campaignId | STRING | NULLABLE |
publisherCampaignId | STRING | NULLABLE |
advertiserId | STRING | NULLABLE |
publisherName | STRING | NULLABLE |
publisherType | STRING | NULLABLE |
campaignName | STRING | NULLABLE |
campaignTypeId | STRING | NULLABLE |
campaignTypeName | STRING | NULLABLE |
clickDate | TIMESTAMP | NULLABLE |
conversionDate | TIMESTAMP | NULLABLE |
status | STRING | NULLABLE |
invoiceDate | TIMESTAMP | NULLABLE |
rawConversionValue | RECORD | NULLABLE |
rawConversionValue. currency | STRING | NULLABLE |
rawConversionValue. amount | FLOAT | NULLABLE |
conversionValue | RECORD | NULLABLE |
conversionValue. currency | STRING | NULLABLE |
conversionValue. amount | FLOAT | NULLABLE |
origConversionValue | RECORD | NULLABLE |
origConversionValue. currency | STRING | NULLABLE |
origConversionValue. amount | FLOAT | NULLABLE |
ipAddress | STRING | NULLABLE |
item | RECORD | NULLABLE |
item. name | STRING | NULLABLE |
item. volume | STRING | NULLABLE |
item. sku | STRING | NULLABLE |
item. value | RECORD | NULLABLE |
item.value. amount | STRING | NULLABLE |
item.value. currency | STRING | NULLABLE |
voucher | STRING | NULLABLE |
extendedData | RECORD | NULLABLE |
extendedData. ex1 | STRING | NULLABLE |
extendedData. ex2 | STRING | NULLABLE |
extendedData. ex3 | STRING | NULLABLE |
extendedData. ex4 | STRING | NULLABLE |
extendedData. ex5 | STRING | NULLABLE |
extendedData. ex6 | STRING | NULLABLE |
extendedData. ex7 | STRING | NULLABLE |
extendedData. ex8 | STRING | NULLABLE |
extendedData. ex9 | STRING | NULLABLE |
extendedData. ex10 | STRING | NULLABLE |
extendedData. ex11 | STRING | NULLABLE |
cost | RECORD | NULLABLE |
cost. currency | STRING | NULLABLE |
cost. amount | FLOAT | NULLABLE |
cost. bandId | STRING | NULLABLE |
invoiceId | STRING | NULLABLE |
placement | RECORD | NULLABLE |
placement. id | STRING | NULLABLE |
placement. name | STRING | NULLABLE |
creative | RECORD | NULLABLE |
creative. id | INTEGER | NULLABLE |
creative. name | STRING | NULLABLE |
publisherWebsiteUrl | STRING | NULLABLE |
rejectionReason | STRING | NULLABLE |
rejectionCode | STRING | NULLABLE |
loyalty | BOOLEAN | NULLABLE |
country | STRING | NULLABLE |
custType | STRING | NULLABLE |
referrer | STRING | NULLABLE |
# Configuration
# Start creating the module
From the menu on the left, select the "Collect" tab, then click the "Add new data Collect" button.
Select "Optimise" from the list of available modules
# Initial settings
In the first step, we only have one field to fill.
Collect name - the name of our module. It will be visible under this name elsewhere on the platform.
# Authorization with Optimise
In the next step, we need to grant WitCloud access to Optimise. It is necessary for WitCloud to be able to download data.
To connect to Optimise you need to generate a service account token. Navigate to service accounts page by this link link (opens new window) and click on Service Account button.
Fill in the form by entering the name of your service account and click Create
Click on Generate button and copy the API key that you can paste in WitCloud
Next, go back to WitCloud and press the "Click here to authorize" button
Paste the API key into the form
After proper authorization, complete the rest of the fields
Agency - Select location of your agency from the list
Contact ID - The identifier of the advertiser. You can find it following this link link (opens new window) in Advertiser ID field
Screen from panel
Click on the Finish button to complete the setup
# Setting the module in the schedule
Your Optimise module is already created in WitCloud 📊. The last step is to establish a schedule and include our module in it. You can read about how to do it here link (opens new window)