Get Started with Power My Analytics API

Get Started with Power My Analytics API

Enterprise clients can use the Power My Analytics API for easy, flexible direct access to their report data. Learn how to use this powerful tool to design your custom solutions.

Who Can Use the API?

Access to the API is available only to customers on an Enterprise plan. Upgrade your plan at any time via your hub, or contact us at sales@powermyanalytics.com for assistance.

Learn with Our API Manual

Complete documentation of the API is available at https://app.swaggerhub.com/apis/DEV_62/PMA-V4/2.0.0. Our team is also available to answer any of your questions about using the API.

The best place to get all the information you need is the Swaggerhub manual. Please consult it before connecting to the API.

Available Data

The API allows you to access data directly via our connectors. This means the same data that can be accessed through Looker Studio is also available through our API. 

Limitations

  1. Data Explorer - The API cannot be used to access Data Explorer reports. Instead, build a similar query using the API.
  2. Exports - The API cannot provide exports to BigQuery or FTP.
Alert
Note: The following connectors have not yet been migrated to the new protocol.
  1. LinkedIn Ads
  2. LinkedIn Companies
  3. Twitter Ads
When making calls to these connectors, calls must be structured according to the following API documentation: https://app.swaggerhub.com/apis/DEV_62/PowerMyAnalytics/1.0.1

Create an API Key

Follow these instructions to create an API key in your hub. You may create as many as you need and they will remain active until discarded.

Your API key must be included in the authorization header when authenticating. Make sure your authorization header is in the format: 'authorization: Bearer API_KEY_HERE'

Find Your Organization ID for the API Endpoint

Go to your Hub at hub.powermyanalytics.com. Your organization ID will be included in the URL at https://hub.powermyanalytics.com/organizations/[organization ID]/overview.

A screenshot of the web address field in the browser, showing the Power My Analytics hub organization ID.

Use this organization ID to access the API endpoint at: /http-organizations/[organization ID]/accounts/[provider type]

"Provider type" is a string such as "facebook_ads" or "facebook_instagram". A full list of available connector strings is available via the /http-connectors endpoint.

Start Using the API

The API requires a few simple steps to get started.

1. Use the Organization endpoints to get a list of your accounts for your organization, and find a specific account.
2. Use the first two Connector endpoints to get the required configuration and specify the fields you want to retrieve. You can also use the Schema endpoint to return a list of all the schema fields you can use.

The configuration endpoint will return a list of configuration fields and their options. Note that every connector will have different names for the configuration parameters to specify. These may be used to select an account, a currency, an attribution setting, or other options.

3. Use the third Connector endpoint, the report endpoint, to retrieve the report data according to the configuration and fields specified. The report endpoint expects to receive the configuration in a URI-encoded JSON stringify format.

    • Related Articles

    • Enterprise Plan Guide

      Our Enterprise plan is a unique offering specially tailored for clients who require more tools and access. This article will explain the benefits of the Enterprise Plan. Exports Exports to SQL Warehouse, BigQuery, FTP, and our API are available only ...

    • Power My Analytics' Sovereign SQL Warehouse Solution

      Power My Analytics offers a Sovereign SQL Warehouse solution with your Enterprise plan. This article will help you learn about its uses and how to get started. With our hosted MySQL sovereign warehouse solution, you can achieve GDPR compliance by ...

    • How Can I Get Started with Embedded Analytics?

      Access your Marketing Analytics from the Tools You Use Every Day At Power My Analytics, we integrate directly with the platforms you already use to put insights at your fingertips. Rather than constantly exporting data or toggling between tools, our ...

    • Google Analytics (Universal Analytics) Sunset

      As of July 1, 2024, Universal Analytics has been fully shut down and is no longer available as a data source or data destination. Google's Universal Analytics was sunset on July 1, 2024 and has been removed as a feature of Power My Analytics. ...

    • How Do You Differ from Companies Like Supermetrics during API Outages?

      Direct Connect vs. Warehousing Many Looker Studio connectors, like those offered by Supermetrics, provide a "direct API connect" service. This means that they connect directly to the Facebook Insights API and retrieve your data whenever you need it. ...