Skip to main content

Customize API Requests

Learn how to tailor MNTN API calls with filters, fields, and parameters to get exactly the data you need.

Imani Clark avatar
Written by Imani Clark
Updated yesterday

Overview

The MNTN reporting platform allows you to generate an API request to export data for ingestion into third-party platforms. A standard API request looks like the below links and can be pulled directly from any data table in your Reporting Dashboard. You can customize our API requests by editing and defining the various parameters.

Pull API Requests

From Templated Reports:

The easiest way to create an API Request is to copy the existing link from any data table within your custom reports.

  1. Click Create R2 API Request in the top-right-hand corner of any templated reporting data table.

    This will automatically include all data parameters and formatting from the data table from which it was pulled, as well as the unique API key for your account.

  2. Click Copy and use it to export data for ingestion into your internal systems.

From Custom Reports:

If you'd like to add more metrics than those available on the templated report, you can create a custom data table using our Custom Report builder.

  1. Click Create R2 API Request in the top-right-hand corner of any custom reporting data table.

    A new API Request will be generated. This will automatically include all data parameters and formatting from the data table from which it was pulled, as well as the unique API key for your account.

  2. Click Copy and use it to export data for ingestion into your internal systems.

Customize API Requests

Set the API Key:

Your API key is used to access reporting data outside the MNTN reporting platform. You can locate your unique API key in the My Account section of the platform.

Once you've located your API key, you'll input it in the key parameter of the API request.

https://api3.mountain.com/apidata?key=123456789&begin=W&format=human&data=Advertiser.Impressions,Advertiser.Visits

Set the Begin Date:

You can set the date range of the data you want to pull using the Begin Date parameter. Dates should be specified in YYYY-MM-DD format. If you input a hardcoded date, you must specify the End Date.

Alternatively, you can utilize one of the time shortcuts outlined below. Note that all time shortcuts are T-1 and will not provide the current day's data in the final output.

Shortcut

Definition

D

The current day of data

Y

The previous day of data

W

The current week of data beginning with Sunday as the first day of the week

LastWeek

The prior week of data beginning with Sunday as the first day of the week

MTD

The current month of data

LastMonth

The prior month of data

Thirty

The last 30 days of data

YTD

The current year of data

If you are utilizing one of the above time shortcuts, you don't need to specify the End date parameter.


πŸ“˜ Example: Time shortcut


Set the End Date:

The End Date parameter allows you to set theΒ End DateΒ of the date range you'd like to pull. Dates should be specified in YYYY-MM-DD format. If you have hardcoded the Begin Date, you must specify the End date.


πŸ“˜ Example: End Date


Set the Format:

You can define the format in which you would like your data returned with the Format parameter. The format options are outlined below.

Format

Definition

CSV

Comma-separated values (downloads to your computer in CSV format)

Excel

Fully formatted Excel spreadsheet (downloads to your computer in Excel format)

Human

Human readable format in columns and rows

JSON

JSON formatted data


πŸ“˜ Example: Format


Define the Data:

You can pull in a variety of data metrics from the API request. You can view all available metrics and dimensions using the List Request. Simply input your API key in the key parameter field to view all reporting metrics and descriptions.

The data parameter is formatted as a comma-separated list of Dimension.Metric arguments, outlining the metrics you'd like to view. The API request should contain only metrics from the same dimension to generate a request successfully.


πŸ“˜ Example: Advertiser dimension


πŸ“˜ Example: Campaign Group dimension

The CampaignGroup dimension is the preferred format for generating campaign-level reporting.


Did this answer your question?