API access is available to teams on Premier and legacy Enterprise subscriptions.
Introduction to the API
Our API enables Premier customers to communicate with the backend of our platform. With the help of a developer or engineer, this allows you to create a variety of custom features to suit your teams specific needs. Automate campaign workflows, impress clients with a custom login page, and more!
The in-app API playground is available to any Admin and Staff users on Enterprise or Premier plans, and contains important API information as well as a code builder.
We recommend inviting the engineer or developer working with you to your AgencyAnalytics account as a staff user, so they can easily access API resources.
Where to find API information
To locate the API playground and other relevant API information, click the cog icon on the left-hand sidebar to open Settings.
Scroll to the bottom of the Settings page menu to find all the available API information, broken down into sections as follows.
Introduction
Covers the terminology we use as well as some basic information about how the API works.
API Key
Your API key (also know as your API auth) is required to make any calls to the AgencyAnalytics API. Your accounts API key can be copied from this page by the account Admin. For security purposes, it's not available to Staff users.
Request
Shares example code blocks of the Read / Delete and Create / Update Operation - POST JSON.
Response
Covers Statuses, Codes, as well as Success and Error code examples.
API Code Builder
The API Playground is a code building sandbox that you can use to quickly generate and test the code you need.
To get started, select the provider from the dropdown on the left. Next, click the drop down menus to select the appropriate asset, operation, etc. for what you're trying to achieve.
The code block provided by the Playground should be edited to include your clients specifics. For example, if the API is being used to quickly create campaigns you would need to enter the Company name, and URL into the code for the test to run successfully.
When ready, click Execute at the top to test the code or click Copy to copy the code. We can see in this example below that the query executed was incomplete by reviewing the returned error on the right:
After successfully updating the query, executing will return a positive status instead, as shown on the right of the screenshot below.
Now that the code is returning a positive status, your engineer or developer can copy the code block to use in your own instance.
💬 Need additional help?
If you have any questions, concerns, or feedback contact our friendly support team for assistance! We're available 24/5 to help 😁