The Analytics Open API allows you to export data from Agorapulse reports to external platforms.
By using the Open API, you can streamline your workflows and build customized reports in your preferred analytics, data visualization, or business intelligence (BI) tools outside of Agorapulse.
In this article, we will cover:
Note: Open API is available to users on a Custom subscription plan. If you would like to change your plan to access this feature, feel free to reach out to us here.
How to generate an API key
Before reporting data retrieval and other actions can be performed using our Open API, you will first need to generate an API key. This can be done by:
Click the avatar on the bottom-left of the screen
Select Personal settings
Click API Keys
At the top right of the screen, click Generate new API key
Add a name for the key and click Create
Once the key has been generated, click the Copy button
We do not display your secret API again after you generate it.After you have copied your API key, click Done.
Note: The API key is unique to each individual, and the permissions granted for API requests are contingent upon the access levels assigned to you. To be able to request data for all connected social profiles, it's recommended to use the API key of the org owner or manager with access to all social profiles.
How to obtain the required IDs
To be able to perform any actions over the Open API, you will need the following three IDs:
Organization ID
Workspace ID
Profile ID
Note: To retrieve these IDs, you will need to use our API Doc https://api.agorapulse.com/docs
How to retrieve your Organization ID
First, you will need your organization's ID. This can be done by:
Opening our API doc
Under Authentication, you will want to paste your API key and click Set
Then click on Get manager organizations on the left-hand side of the page
Click the Try button
In the Response box, you will see a list of all of the organizations that you are part of, along with the Organization IDs.
How to retrieve your Workspace ID
After you have copied the Organization ID of the Organization that you would like to use, you will need to retrieve the Workspace ID. This can be done by:
Scrolling down to the Workspace section, or clicking on Get organization workspaces on the left side of the page
Paste your Organization ID
Click the Try button
In the Response box, you will see a list of all of your workspaces in your organization, along with the Workspace ID.
How to retrieve your Profile ID
The last ID that you will need to retrieve is the ID of the social profile that you are going to be requesting data from. This can be done by:
Scrolling down to the Profile section, or clicking on Get workspace profiles on the left side of the page
Paste your Organization ID and Workspace ID in the appropriate fields
Click the Try button
In the Response box, you will see a list of all the social profiles added to your organization's workspace, along with the Profile ID.
How to request analytics data from the Open API
With your API key, Workspace, Organization, and Profile IDs, you can now generate reporting data from the Open API for your Audience, Content (Performance), and Community Management reports. Analytics data is available for:
Facebook
Instagram
LinkedIn
YouTube
TikTok
To request analytics data from the API you will need to:
In the Open API doc under Report on the left side of the page, select the reporting type:
Audience
Community Management
Content
Under the selected reporting type, you will need to enter the following under Path Parameters:
Organization ID
Workspace ID
Profile ID
Then, under Query-String Parameters, you will need to fill in the following fields to set the reporting period using the timestamp format*
Since
Until
Finally, click Try to retrieve your analytics data.
*Please Note: You can convert the dates for your reporting period to timestamp using a conversion tool like the one below
Important information
There is a limit of 500 requests per 30 minutes.
It's Read-only access - You won't be able to modify or action anything via the API.
Custom reports and Social Media ROI reports are not part of the API.
Listening data is not included in the API.