Our API has been upgraded to support the ability to pivot reporting data by multiple dimensions. If you want to pull in reporting data that leverages different data dimensions or is filtered by different data dimensions, you must update your R2 API to MNTN API 3.0.
Although we now have a new API system to support these data improvements, you are not required to update your existing APIs, as the MNTN API 1.0 will still work as expected with the ability to pull single-dimensional data
Key Upgrades with MNTN API 3.0
Able to query and filter on multiple dimensions simultaneously when retrieving data sets.
Our new API is offering up to 10x speed improvements.
Simplified API definitions for ease of use.
In this article, we'll review:
How to Upgrade to MNTN API 3.0 using Table APIs
The simplest way to upgrade your API to MNTN 3.0 will be to generate a new R2 API String from your default or custom data tables directly from your MNTN reporting suite. We recommend this approach if you are simply connecting to a B&I platform and need a completed API link, or do not want to make manual customizations on a table you already have built.
1️⃣ Go to the Reporitng Section of the MNTN UI
2️⃣ Either build a net-new data table, or access an existing table within one of your default or custom reports
3️⃣ Click on the link icon at the top right of the data table
4️⃣ This will populate an R2 API Request Link. Copy this link and paste it into your relevant endpoint. This link already includes your API key as well.
Note: Your format is defaulted to format=human, but this can be updated
How to Manually Upgrade to MNTN API 3.0
This will be a how-to guide for the more advanced data analysts who would like to upgrade existing APIs
1️⃣ New Domain Endpoint
Update your root domain to:
You can use /apidata or /apilist at the end of the domain accordingly to access your information.
API List is used to see a list of all available data summaries and metrics
API Data is used to pull your performance data via the API
2️⃣ Update your Data Retrieval
Info Tables
All INFO calls can remain intact.
Graph Tables
Anywhere you call a table that is not an INFO table or a DETAIL table, you can update that table to be a graph. For example:
Prior API:
advertiser.impressions,advertiser.visitrate
New API:
graph.impressions,graph.visitrate
Wherever you are calling ‘Name’ or ‘ID’ from a Summary table, you will need to update the table to be the corresponding Info table
Prior API:
advertiser.name,advertiser.impressions,advertiser.visitrate
New API:
advertiserinfo.name,graph.impressions,graph.visitrate
Detail Tables
Your detail tables (Conversions) will remain the same in this upgrade.
3️⃣ Update any Filters
Because we have more flexibility with reporting, we needed to format our filtration in a more scalable way; this requires a syntax that is not supported by HTTP protocol; therefore, the values will need to be encoded:
Prior API:
filter=campaigngroup.id=’200’
New API:
GET
needs to be encoded: but for display of syntax
filter={"campaigninfo.id":{"in":["200"]}}
POST
"filter":{
"campaigninfo.id": {
"in": ["28915"]
}
}
Example Upgrades
Prior API:
GET
New API:
GET
POST
{
"data": [
"campaigninfo.name",
"graph.day",
"graph.tvcommercialsaired"
],
"key": "<>",
"begin": "2024-01-01",
"end": "2024-01-31",
"format": "human"
}
Available Data Notes
Date Ranges Available:
Data prior to 11/1/2022 will not be supported in this new dimensional data set, data prior to 11/1/2022 will need to be retrieved via the legacy API
DataSets Not Available in new API yet:
Audience Segment Data:
We will be releasing a dimensional version of this data soon in the new API
This data should be retrieved via the legacy API for now
Table and Column Name Changes
Table Changes:
CampaignGroupInfo -> CampaignInfo
CreativeGroupInfo -> CreativeInfo
CreativeInfo -> AdInfo
Metric Changes: please read Table Changes first and apply to this section
CampaignGroupInfo.CampaignGroupID -> CampaignInfo.CampaignID
CreativeGroupInfo.GroupID -> CreativeInfo.CreativeID
CreativeInfo.CreativeID -> CreativeInfo.AdID
Key Changes
“sum=”
This is no longer a necessary parameter, by simply adding the info tables to your data request it will automatically summarize by those values
However, if you still wish to structure your requests with “sum=” you are welcome to continue doing that, it will automatically add these values as columns in your output
Segment Data
Segment data will continue to be retrieved via the api.mountain.com endpoint using the prior API syntax
Filter
Filtering will have new syntax and will require encoding before being leveraged in the GET version of our API
Custom Calculations:
Not supported in our new API version; coming soon