# Convertiser
# Introduction
The Convertiser 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 Convertiser
- 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, two new tables will appear in the WitCloud dataset:
convertiser_conversions
Expand for the data schema
Field name | Type | Mode |
---|---|---|
id | STRING | NULLABLE |
ip | STRING | NULLABLE |
tracking_id | STRING | NULLABLE |
offer | STRING | NULLABLE |
offer_details | RECORD | NULLABLE |
offer_details. id | STRING | NULLABLE |
offer_details. title | STRING | NULLABLE |
offer_details. status | STRING | NULLABLE |
offer_details. status_name | STRING | NULLABLE |
offer_details. url | STRING | NULLABLE |
goal | STRING | NULLABLE |
goal_details | RECORD | NULLABLE |
goal_details. id | STRING | NULLABLE |
goal_details. title | STRING | NULLABLE |
goal_details. status | STRING | NULLABLE |
goal_details. status_name | STRING | NULLABLE |
goal_details. multiple_conversions | BOOLEAN | NULLABLE |
goal_details. auto_approve_conversions | BOOLEAN | NULLABLE |
goal_details. conversion_hold_period | INTEGER | NULLABLE |
goal_details. disable_automatic_approval | BOOLEAN | NULLABLE |
goal_details. payout_type | STRING | NULLABLE |
goal_details. payout | STRING | NULLABLE |
goal_details. revenue | STRING | NULLABLE |
goal_details. tracking_code | STRING | NULLABLE |
goal_details. is_flexible_commissions | BOOLEAN | NULLABLE |
goal_details. flexible_commissions_model | STRING | NULLABLE |
goal_details. url | STRING | NULLABLE |
currency | STRING | NULLABLE |
currency_details | RECORD | NULLABLE |
currency_details. currency | STRING | NULLABLE |
currency_details. currency_name | STRING | NULLABLE |
currency_details. is_default | BOOLEAN | NULLABLE |
website | STRING | NULLABLE |
website_details | RECORD | NULLABLE |
website_details. id | STRING | NULLABLE |
website_details. url | STRING | NULLABLE |
website_details. description | STRING | NULLABLE |
website_details. categories | INTEGER | REPEATED |
website_details. categories_details | RECORD | REPEATED |
website_details.categories_details. id | INTEGER | NULLABLE |
website_details.categories_details. category | STRING | NULLABLE |
website_details.categories_details. category_name | STRING | NULLABLE |
website_details. target_audience | STRING | NULLABLE |
website_details. target_audience_name | STRING | NULLABLE |
website_details. status | STRING | NULLABLE |
website_details. status_name | STRING | NULLABLE |
website_details. created_at | TIMESTAMP | NULLABLE |
website_details. traffic_type | STRING | NULLABLE |
website_details. traffic_type_details | RECORD | NULLABLE |
website_details.traffic_type_details. name | STRING | NULLABLE |
website_details.traffic_type_details. name_display | STRING | NULLABLE |
website_details. child_traffic_type | STRING | NULLABLE |
website_details. child_traffic_type_details | RECORD | NULLABLE |
website_details.child_traffic_type_details. name | STRING | NULLABLE |
website_details.child_traffic_type_details. name_display | STRING | NULLABLE |
is_refunded | BOOLEAN | NULLABLE |
is_paid | BOOLEAN | NULLABLE |
is_unmanaged | BOOLEAN | NULLABLE |
status | STRING | NULLABLE |
status_name | STRING | NULLABLE |
status_message | STRING | NULLABLE |
source | STRING | NULLABLE |
source_name | STRING | NULLABLE |
sale_amount | STRING | NULLABLE |
base_sale_amount | STRING | NULLABLE |
advertiser_expense | STRING | NULLABLE |
base_advertiser_expense | STRING | NULLABLE |
publisher_income | FLOAT | NULLABLE |
base_publisher_income | FLOAT | NULLABLE |
network_income | FLOAT | NULLABLE |
base_network_income | FLOAT | NULLABLE |
hold_until | TIMESTAMP | NULLABLE |
created_at | TIMESTAMP | NULLABLE |
processed_at | TIMESTAMP | NULLABLE |
_version | INTEGER | NULLABLE |
convertiser_cpc
Expand for the data schema
Field name | Type | Mode |
---|---|---|
date | DATE | NULLABLE |
offer_id | STRING | NULLABLE |
cpc_clicks | INTEGER | NULLABLE |
cpc_advertiser_expense | FLOAT | NULLABLE |
pe_transactions | INTEGER | NULLABLE |
pe_amount | FLOAT | NULLABLE |
pe_mean_amount | FLOAT | NULLABLE |
pe_conversion_rate | FLOAT | NULLABLE |
pe_cos | FLOAT | NULLABLE |
pe_roas | FLOAT | NULLABLE |
offer_title | 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 Convertiser 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 Convertiser
In the next step, we need to get the Convertiser API token. It is necessary for WitCloud to be able to collect data.
Navigate to API Credentials page by this link link (opens new window) and click on Add token button
Select both accesses and click Save button.
Copy the API token. You will need it to complete the configuration of the module in WitCloud.
To do this, press the Click here to authorize button.
Paste the token and click on Finish button.
Next select the currency in which you want to collect the data.
And click the Finish button.
# Setting the module in the schedule
Your Convertiser 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).