Navigation
- Explore: In the top-left dropdown menu of Voltax, select ‘Analytics’ —> —> ‘Explore.’
- Dashboards: In the top-left dropdown menu of Voltax, select ‘Analytics’ —> ‘Dashboards’
Create New Report
Choose Source
To build a report, you must select which data sources you want to pull the data from.
You have access to two data sources:
| Data Source | Description |
| Unified Player Historic Revenue (UTC) | Estimated publisher performance data captured until yesterday (Only in UTC). |
| Monthly Net Payout | Net Payout by Month for previous months |
Date Range
Select a date range to analyze in your report
- Preset Date Ranges: You can easily select date ranges for:
- Today
- Yesterday
- Last 7 Days: Displays data from the previous seven days from the query date
- Last Month: Displays data from the previous full month
- Month to date: Displays data from the 1st day of the current month
- Custom Date Range: If you’d like to set a custom date range, use the calendar to select a start date and end date
Time Zone
Specify which time zone your report will be based on. This is available only for real-time data sources.
Dimensions
Select which dimensions, or attributes, of your data you’d like to build your report around. To view the full list of dimensions, check out our Glossary!
Note: Specific dimension options will vary depending on the original data source chosen
Dimensions Filter
To narrow down the results, you can set custom dimension filtering using string filtering within the system. String filtering is a way to narrow down a dataset by searching for specific patterns or characters within a string field. For example, you might use string filtering to search for records containing a specific word or phrase or find records matching a certain pattern.
- Select a Dimension from the dropdown menu
- Select whether to Include or Exclude this Dimension from the Filter
- Choose which rule to set on your filter
Exactly Matching
Starts With
Contains
Is Null
In
Regex - Type in the value you want to filter by in your report
Note: Dimension filter string must contain alphanumeric characters
Metrics
Select which metrics (quantifiable measurements) you’d like to build your report around. To view the full list of metrics, check out our Glossary!
Metric Constraints
Similar to dimension filtering, you can narrow down the results in your report depending on specified rules.
- Select a metric from the dropdown menu
- Choose which rule to set on your constraint
“=”
“>”
“=>”
“<”
“=<”
Between - Type in the exact value to complete the metric constraint
Note: Metric constraint string must be a numeric value. Only one metric constraint can be used per report.
Run Report
Users should click ‘Run Report’ after configuring their report. Once the report is run, users can schedule, save, and share it internally
- Save: Users can Save the configured report for future use by clicking the ‘Save’ button and naming the report
- Share: Clicking on the ‘Share’ button will copy the report’s URL to your clipboard and enable you to share it with internal users with the same data permissions
- Schedule Report: Use the ‘Schedule Report’ button if you’d like to receive your report sometime in the future or on a recurring basis. You must Save your report before you can schedule it for the future.
- Download as CSV or XLSX: Users can download the report as a .CSV or .xlsx file to their local device.
-
Report Constraints:
Each report has a maximum number of 5,000 rows
Saving and Loading Reports
Save Report
Users can quickly save a report using the ‘Save’ button on the right side of the screen
- Report Name: Before saving the report, users must give the report a unique name
Note: Only users with an active Voltax account and permissions to the relevant data sources can view reports sent using the ‘Share Report’ button
Schedule Report
Once a report is saved, users can schedule recurring updates of the report by clicking on the “Schedule Reports” button. Users can find their previously scheduled reports using the drop-down menu at the bottom left side of the page.
-
Report Information
- Report Name: Select which report to schedule recurring updates
- Time Zone: Select which time zone you’d like to base the schedule on
- Email: Enter the email you’d like to receive the reports. To add multiple emails, add the first email address and click on the Enter key on your keyboard to add it.
- Description: Write a short description of the report so you can easily find it in the future
- Activate Report: Select this checkbox to indicate the report is currently active
Note: Scheduled reports send the .csv file to the email provided. There is no requirement to have an active Voltax account to receive and open scheduled reports.
-
Schedule Details
- Report Sending Time: Select the interval to receive the scheduled reports
- Hourly
- Daily
- Sundays
- Weekly
- Monthly
- Time: Users can also specify the time they’d like to receive the scheduled report
- Report Sending Time: Select the interval to receive the scheduled reports
Three Dot Dropdown
On the right side of the screen, there is a “...” button that opens up into different options.
-
Load Report: To view previously saved reports, click on the “Load Report” button
- Report Name: Select one of your previously saved reports from the dropdown menu and click “Open” to view the report
- Create New: Use the ‘Create New’ button to generate a new report with default settings
-
“Save As” Report: After receiving a shared report, the user can click on the “...” button and click “Save As” to store the report in the system for future use.
- Report Name: Enter a unique report name to find it later
- Click “Save” to ensure that the report is stored successfully
Note: Shared reports can’t be modified, so the user must use ‘Save As’ to make any changes to the report
-
Delete a saved report:
Click on the “Load Report” button
Select one of your previously saved reports from the dropdown menu
Click on “Delete.”
API Access
Endpoint
To request a report, use the following endpoint:
- Choose Source: To pull data for the report, insert the desired data source as the ":id" parameter.
- Data Source: There are two available data sources:
|
Data Source |
Source slug |
Description |
|
Historical Revenue |
pubs_external |
Estimated publisher performance data captured until yesterday (Only in UTC). |
|
Monthly Net Payout |
pubs_monthly_payout |
Net Payout by Month for previous months |
API Key
API Key:
To access the API report, you need to include a valid API Key. The key can be obtained from the Explore screen in Voltax by clicking on the three dots menu and selecting "Generate API Key".
Copy the Key and add it to this header:
Key: X-MM-API-Key
Value: Your new API Key
The API Key has no expiration date.
Regenerate API Key:
If you want to replace your existing API Key, follow the same steps as in generating a new one, and click on “Regenerate API Key”.
If you regenerate it, you will have one hour until the old one will expire.
Please note:
- After copying the API key, it won’t be visible again.
- Make sure to store it in a secure location.
- You can always regenerate a new key.
Payload
{"dimensions": [
"date"
],
"metrics": [
"total"
],
"dateRange": {
"field": "date",
"type": "Yesterday",
"from": "2023-05-31",
"to": "2023-05-31"
},
"orderBy": "total",
"timezone": "UTC+0",
"limit": 5000
}
-
Date Range ("dateRange")- Select a date range to analyze in your report. Supported date Range types include: "Today", "Yesterday", "Last Week", "Last Month", "Last 30 Days", and "Last 7 Days".
-
Dimensions ("dimensions")- Choose the dimensions or attributes of your data to build the report. For a complete list of dimensions, refer to the Glossary API. Note that available dimension options depend on the chosen data source.
-
Metrics- ("metrics") Select the metrics (quantifiable measurements) you’d like to build your report. To view the full list of metrics, check out the Glossary API
-
Limit ("limit")- Each report has a maximum number of 5,000 rows
-
Order By ("orderBy")- must be included in the metrics array to specify the sorting order for the report.
-
Time Zone ("timezone")- Specify the time zone for your report. This option is only available for real-time data sources. You can use UTC±X or choose from the following options:
"America/New_York" (Eastern Time)
"America/Phoenix" (Mountain Time)
"America/Los_Angeles" (Pacific Time)
"Europe/London" (GMT)
"Europe/Berlin" (Central European Time)
"Asia/Bangkok" (Indochina Time)
"Australia/Sydney" (Australian Eastern Time)
"UTC" (Coordinated Universal Time)