Skip to main content

Upgrade to API 3.0

Learn what’s changed in MNTN’s latest API version and how to migrate from earlier versions.

Updated over a week ago

⚠️ Warning: API 1.0 Deprecation Notice

API 1.0 (https://api.mountain.com) will be deprecated at the end of this month. After April 1, 2026, requests made to API 1.0 will no longer return reporting data.

If you're currently using API 1.0, you must upgrade to API 3.0 to continue receiving data.

Overview

With MNTN API 3.0, you can take more control over your data and view the full impact your TV commercials have on full-funnel performance.


💡 Pro Tip: If you view MNTN data anywhere outside of the MNTN, Rockerbox, or GA4 Platforms, you're likely leveraging an API to pull in data. This data can range from spend data to performance metrics.


MNTN API 3.0 is the current version of the MNTN Reporting API. If you are using API 1.0, you will need to migrate before deprecation to avoid disruption to your reporting workflows.

This article covers:

  • What’s new in API 3.0

  • Confirm which API version you’re using

  • Upgrade using one of two available methods

What you'll get

  • First Touch is the default for Verified Visit and Conversion reporting, providing a holistic view of CTV performance. You still have access to Last Touch reporting metrics.

  • You can query and filter on multiple dimensions simultaneously when retrieving datasets.

  • We simplified API definitions for ease of use.

Characteristics

API 1.0

API 2.0

API 3.0

Multidimensional Reporting

Not Supported

Supported

Supported

Default Reporting Type

Last Touch

Last Touch

First Touch

API Domain

https://api.mountain.com

https://api2.mountain.com

https://api3.mountain.com

Confirm Your API Version

  1. Look at the domain in your API string:

    • API 1.0

      https://api.mountain.com

    • API 2.0

      https://api2.mountain.com

    • API 3.0

      https://api3.mountain.com

Example: API Strings

  • API 1.0

    https://api.mountain.com/apidata?begin=2024-01-01&end=2024-01-31&sum=campaigngroup.name&key=<>

  • API 3.0

    https://api3.mountain.com/apidata?format=human&begin=2024-01-01&end=2024-01-31&data=campaigninfo.name&key=<>

Upgrade Your Method

There are two ways to upgrade to API 3.0. Choose the method that fits your setup.

Option A: Generate a New API Link from Reporting (Recommended)

Use this method if you:

  • Connect to a BI platform

  • Don't require custom manual API structuring

  • Want the simplest upgrade path

Steps:

  1. Sign in to MNTN.

  2. Go to Reporting.

  3. Either build a net-new data table, or access an existing table within one of your default or custom reports.

  4. Click on the link icon at the top right of the data table.

    This will populate an R2 API Request Link.

  5. Copy this link and paste it into your relevant endpoint.

    This link includes your API key.


    💡 Pro Tip: Your format is defaulted to format=human, but this can be updated to format=json, format=excel, or format=csv.


Option B: Manually Update Your Existing API Integration

This method is intended for advanced users.

Steps:

  1. Update the root domain.

    Replace:

    https://api.mountain.com

    With:

    https://api3.mountain.com

    At the end of the domain, you may use:

    • /apidata for performance data

    • /apilist to view available summaries and metrics

    to access your information.

  2. Update data retrieval structure.

    • Info Tables: INFO calls remain valid.

    • Graph Tables: Any non-INFO and non-DETAIL table must be converted to graph.

      • Prior:

        advertiser.impressions,advertiser.visitrate

      • New:

        graph.impressions,graph.visitrate

      • Name / ID Calls from Summary Tables

        • Prior:

          advertiser.name,advertiser.impressions,advertiser.visitrate

        • New:

          advertiserinfo.name,graph.impressions,graph.visitrate

    • Detail Tables: Detail tables (including Conversions) remain unchanged.

  3. Update filters.

    Filtering uses a scalable JSON-style syntax.
    For GET requests, values must be encoded.

    • Prior

      filter=campaigngroup.id=’200’

    • New (display syntax must be encoded):

      filter={"campaigninfo.id":{"in":["200"]}}

    • Post:

      "filter":{
      "campaigninfo.id": {
      "in": ["28915"]
      }
      }

Data Availability Notes

Historical Data

Data prior to 1/1/2023 is not supported in the new dimensional dataset and must be retrieved via the legacy API.

Access the API request legend

For a full list of everything you can request through API 3.0:

  1. Copy the template URL:

  2. Paste the URL in your browser's address bar.

  3. Replace [YOURAPIKEY] with your actual API key in the URL link.
    You now have access to the legend.

  4. Press Enter.

Table and Metric 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

Additional Notes

sum=parameter

No longer required. Info tables automatically summarize data.
You may continue using sum= if preferred.

Segment data

Still retrieved via api.mountain.com using legacy 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 API 3.0 yet.

Access Last Touch Data

In the MNTN API 3.0 data set, Verified Visit and Conversion Data is defaulted to our First Touch Reporting model, but you still have access to Last Touch Reporting Metrics within your available metrics. Simply add in the additional Last Touch metrics to your custom reports or API calls to access that data.

Total Verified Visits

The total number of First-Touch visits to your site within your defined Verified Visit window after being exposed to a PTV ad.

Total Conversions

The total number of Conversions that resulted from a First-Touch Verified Visit within the conversion window.

Total Last Touch Verified Visits

The total number of Last-Touch visits to your site that visited through an organic or direct path within your defined Verified Visit window after being exposed to a PTV ad.

Total Last Touch Conversions

The total number of Conversions that resulted from a Last-Touch Verified Visit within the conversion window.


💡 Pro Tip: Additional Metrics that leverage Verified Visits and Conversions in their calculations have also been added. This includes:

  • Last Touch Cost Per Visit

  • Last Touch Visit Rate

  • Last Touch Average Order Value

  • Last Touch Conversion Rate

  • Last Touch CPA

  • Last Touch Order Value

  • Last Touch ROAS


Did this answer your question?