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?
Learn with Our API Manual
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
- Data Explorer - The API cannot be used to access Data Explorer reports. Instead, build a similar query using the API.
- Exports - The API cannot provide exports to BigQuery or FTP.
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
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.