Skip to main content

Media Intelligence API: Overview & How to Use It

Overview of the Media Intelligence API and how to access and use your media coverage data.

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

Important

Media Intelligence API access is only available for accounts that have been provisioned for API access.

If you do not see the API Keys page, your account may not have API access enabled or your user may not have the required permissions. Contact your Agility representative for assistance.


1. Enable Media Intelligence API Access (Account Administrators Only)

Before API keys can be created, an Account Administrator must enable Media Intelligence API access for the account.

Click Admin Tools from the top navigation, then select Account Management.

Select the General tab, then check the Media Monitoring APIs box.

Once enabled, users with the API Key Manager permission can create and manage API keys.


2. View Existing API Keys

Select the Media Monitoring tab.

Scroll to the Media Monitoring APIs section.

Here you can view all API keys that have been created for the account, including:

  • API Key

  • Created By

  • Created Date

  • Status

This page allows Account Administrators to review API keys associated with the account.


3. Assign API Key Manager Permissions

Users who need to create and manage API keys must be granted the API Key Manager permission.

This permission allows users to create and manage Media Intelligence API keys within Agility.


4. Create an API Key

Once the API Key Manager permission has been assigned, navigate to:

Content Management → API Keys

Click Create API Key and enter:

  • A name for the key

  • Optional notes describing its purpose

  • Click Create.

After the key is created, it can be used to authenticate requests to the Media Intelligence API.

You can create multiple API keys for different integrations, applications, or environments.


5. Review the API Documentation

The Swagger documentation provides details on:

  • Available endpoints

  • Request parameters

  • Response structures

  • Authentication requirements

  • Error codes

This documentation should be used as the primary technical reference when building integrations.


6. Test Your Connection

Start with a simple Topic Search or Ad Hoc Search request to verify that your API key is working correctly and data is being returned as expected.


7. Build Your Integration

Once connected, you can begin integrating media monitoring data into:

  • Reporting dashboards

  • Business intelligence tools

  • CRM systems

  • Data warehouses

  • Internal applications


Need Help?

For setup, access, or integration support, reach out to your Agility account representative or contact support from your dashboard.

Did this answer your question?