Skip to main content
Customizing an API Request

How to customize API requests in MNTN for tailored data retrieval.

Jazmine Jackson avatar
Written by Jazmine Jackson
Updated over 2 months ago

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.

⚡️ Looking to upgrade to our API 3.0 version to utilize multi-dimensional and first-touch reporting? You can easily upgrade your API calls using our API 3.0 Migration Guide.

In this article, we'll cover the required parameters for creating an API request:


Pulling an API Request Directly from a Templated Report

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

You will find a button in the top-right-hand corner of any templated reporting data table allowing you to Create R2 API Request:

A new API Request will be generated once you click the Create R2 API Request button. 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.

You can copy this request and use it immediately to export data for ingestion into your internal systems.


Pulling an API Request Directly from a Custom Report

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.

The custom data table has a button at the top-right corner allowing you to Create R2 API Request:

Once you click this button, 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.

You can copy this request and use it immediately to export data for ingestion into your internal systems.


Building & Customizing your API Request

Setting 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.

Defining 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.

  • 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.

Defining 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.

Setting 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.

  • 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

🧠 Pro Tip: see below for an example of how to implement the format parameter:

Defining 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.

🧠 Pro Tip: see below for an example of pulling data from the Advertiser dimension:

🧠 Pro Tip: see below for an example of pulling data from the Campaign Group dimension:

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

WHERE TO GO NEXT:

Did this answer your question?