The Media Intelligence API allows you to access Agility’s media monitoring data outside of the platform, so you can integrate coverage, insights, and analytics directly into your own tools, dashboards, or workflows.
This article provides a high-level overview of what the API does, when to use it, and how it fits into your PR and communications strategy.
What is the Media Intelligence API?
The Media Intelligence API gives you programmatic access to a large dataset of:
Online news and blogs
Print and broadcast coverage
Social media content
Instead of viewing mentions only within the Agility platform, the API lets you retrieve and use that data anywhere, such as internal dashboards, BI tools, or custom applications.
When Would You Use the API?
The API is best suited for teams that want to go beyond the standard platform experience.
Common use cases include:
1. Building custom dashboards
Pull media coverage into tools like Power BI, Tableau, or internal reporting systems.
2. Automating reporting workflows
Automatically retrieve mentions and generate reports without manual exports.
3. Integrating with internal systems
Combine media data with CRM, marketing platforms, or data warehouses.
4. Conducting advanced analysis
Run your own analysis on sentiment, reach, or trends using raw mention data.
5. Scaling data access
Retrieve large volumes of media mentions programmatically instead of relying on manual searches.
How It Works
The API works by sending requests to Agility’s servers and receiving structured data in return.
1. Authentication
API keys are generated from within your Agility account and are required for every request. See the Getting Started section below for details on how to obtain yours.
2. Make a Request
Define what you are searching for, including date range, source types, and any filters you want to apply.
3. Receive Results
The API returns a total number of matching mentions and a list of individual mentions with associated metadata.
Types of Searches You Can Run
Ad Hoc Search
Run one time searches using keywords or Boolean logic.
Best for quick analysis, exploratory searches, or custom queries.
Topic Search
Retrieve results from saved searches created in the Media Monitoring section of the platform. Best for ongoing monitoring, consistent reporting, and reusing existing search logic.
Saved Coverage Collections
Retrieve mentions from saved folders, tags, or tag groups created in the platform. Best for working with curated coverage sets and organizing reporting outputs.
What Data Can You Access?
Each mention returned by the API can include metadata such as:
Outlet or source name
Article or post title
Content snippet or excerpt
Sentiment, positive, negative, or neutral
Impressions or estimated reach
Publication date
Media type, such as news, blog, or social
Social engagement data, including shares, replies, likes, and views (requires Social Listening subscription)
The available fields may vary depending on your subscription and data source.
Filtering and Precision
You can refine your results using filters such as:
Media type
Location
Language
Sentiment
Specific journalists or contacts
Source or outlet
Tags and saved collections
You can also use standard queries for guided Boolean logic or expert queries for fully custom Boolean expressions.
Important Considerations
Licensing and Coverage
The data available through the API depends on your Agility subscription.
Rate Limits
Usage and Volume API usage is currently monitored on an audit basis. When you agree on a use case with your Agility representative, such as pulling one topic daily, please ensure your integration reflects that. Agility reserves the right to review usage and suspend API access if usage significantly exceeds agreed terms.
Security Best Practices
Keep your API key secure, do not share it publicly, rotate keys if compromised.
API keys are account-specific. A key generated for one Agility account cannot be used to access data from another account.
Social Data Limitations
Some platforms, such as X, may require additional API calls to retrieve full post content due to platform restrictions.
Is the API Right for You?
The Media Intelligence API is ideal if you:
Have access to development resources
Need to integrate media data into other systems
Want more flexibility than the platform provides
If your focus is viewing mentions, creating briefings, or standard reporting, the Agility platform may already meet your needs without requiring API integration.
Getting Started
1. Request API access Contact your Agility account representative to have the Media Intelligence API provisioned on your account.
2. Generate your API key Once provisioned, users designated as API Key Managers on your account can log into Agility, go to Account Settings, and generate keys directly — no need to contact Agility each time. You can generate multiple keys if your integration requires it.
3. Review the API documentation The full Swagger documentation is publicly available and covers all endpoints, request structures, response formats, and error codes. This is the primary reference for whoever is handling the technical integration on your side.
4. Test a basic request Start with a simple topic or ad hoc search to confirm your key is working and results are returning as expected.
5. Start integrating Build out your connection based on your use case — whether that's a daily pull, an hourly feed, or a live dashboard.
Need Help?
For setup, access, or integration support, reach out to your Agility account representative or contact support from your dashboard.